From 6a39f5ecd53c2cbc863efe51d1acc9da002fa260 Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Thu, 3 Oct 2024 13:51:52 -0500 Subject: [PATCH 01/16] TemplateResponseCCRole::TEMPLATES_LEFT -> TemplateResponseCCRole::NAME (#431) --- openapi-raw.yaml | 4 ++-- openapi-sdk.yaml | 2 +- openapi.yaml | 2 +- translations/en.yaml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index a0d21f20e..302eb4482 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -4568,7 +4568,7 @@ paths: 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: - $ref: '#/components/examples/TeamDoesNotExistResponseExample' + $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: @@ -10698,7 +10698,7 @@ components: TemplateResponseCCRole: properties: name: - description: '_t__TemplateResponseCCRole::TEMPLATES_LEFT' + description: '_t__TemplateResponseCCRole::NAME' type: string type: object x-internal-class: true diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index c7189fd24..592a587f1 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -4617,7 +4617,7 @@ paths: 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: - $ref: '#/components/examples/TeamDoesNotExistResponseExample' + $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: diff --git a/openapi.yaml b/openapi.yaml index 304a8d67b..d66309216 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -4617,7 +4617,7 @@ paths: 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: - $ref: '#/components/examples/TeamDoesNotExistResponseExample' + $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: diff --git a/translations/en.yaml b/translations/en.yaml index 6925e38a4..5cbf3ca41 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -1486,7 +1486,7 @@ "TemplateResponseAccountQuota::TEMPLATES_LEFT": API templates remaining. "TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT": SMS verifications remaining. -"TemplateResponseCCRole::TEMPLATES_LEFT": The name of the Role. +"TemplateResponseCCRole::NAME": The name of the Role. "TemplateResponseDocument::INDEX": Document ordering, the lowest index is displayed first and the highest last (0-based indexing). "TemplateResponseDocument::NAME": Name of the associated file. From 25a7c982d192e4767aff080d31b1a646b45f2ceb Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Fri, 11 Oct 2024 12:55:44 -0500 Subject: [PATCH 02/16] Improvements to BulkSendJob response; reduces nullability, sets defaults (#434) --- openapi-raw.yaml | 6 ++- openapi-sdk.yaml | 6 ++- openapi.yaml | 6 ++- sdks/dotnet/docs/BulkSendJobResponse.md | 2 +- .../Dropbox.Sign/Model/BulkSendJobResponse.cs | 21 +++++--- sdks/java-v1/docs/BulkSendJobResponse.md | 8 +-- .../sign/model/BulkSendJobResponse.java | 28 +++++----- sdks/java-v2/docs/BulkSendJobResponse.md | 8 +-- .../sign/model/BulkSendJobResponse.java | 24 ++++----- sdks/node/docs/model/BulkSendJobResponse.md | 8 +-- sdks/node/model/bulkSendJobResponse.ts | 8 +-- .../node/types/model/bulkSendJobResponse.d.ts | 8 +-- sdks/php/docs/Model/BulkSendJobResponse.md | 8 +-- sdks/php/src/Model/BulkSendJobResponse.php | 51 +++++++++++-------- sdks/python/docs/BulkSendJobResponse.md | 8 +-- .../models/bulk_send_job_response.py | 20 +++----- sdks/ruby/docs/BulkSendJobResponse.md | 8 +-- .../models/bulk_send_job_response.rb | 23 ++++++++- 18 files changed, 146 insertions(+), 105 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 302eb4482..f3a04870e 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -9915,11 +9915,15 @@ components: x-internal-class: true BulkSendJobResponse: description: '_t__BulkSendJobResponse::DESCRIPTION' + required: + - bulk_send_job_id + - created_at + - is_creator + - total properties: bulk_send_job_id: description: '_t__BulkSendJobResponse::BULK_SEND_JOB_ID' type: string - nullable: true total: description: '_t__BulkSendJobResponse::TOTAL' type: integer diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 592a587f1..7bf78e3b7 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -10523,11 +10523,15 @@ components: x-internal-class: true BulkSendJobResponse: description: 'Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.' + required: + - bulk_send_job_id + - created_at + - is_creator + - total properties: bulk_send_job_id: description: 'The id of the BulkSendJob.' type: string - nullable: true total: description: 'The total amount of Signature Requests queued for sending.' type: integer diff --git a/openapi.yaml b/openapi.yaml index d66309216..553806669 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -10501,11 +10501,15 @@ components: x-internal-class: true BulkSendJobResponse: description: 'Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.' + required: + - bulk_send_job_id + - created_at + - is_creator + - total properties: bulk_send_job_id: description: 'The id of the BulkSendJob.' type: string - nullable: true total: description: 'The total amount of Signature Requests queued for sending.' type: integer diff --git a/sdks/dotnet/docs/BulkSendJobResponse.md b/sdks/dotnet/docs/BulkSendJobResponse.md index 6a9e580db..f4678792b 100644 --- a/sdks/dotnet/docs/BulkSendJobResponse.md +++ b/sdks/dotnet/docs/BulkSendJobResponse.md @@ -5,7 +5,7 @@ Contains information about the BulkSendJob such as when it was created and how m Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**BulkSendJobId** | **string** | The id of the BulkSendJob. | [optional] **Total** | **int** | The total amount of Signature Requests queued for sending. | [optional] **IsCreator** | **bool** | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | [optional] **CreatedAt** | **int** | Time that the BulkSendJob was created. | [optional] +**BulkSendJobId** | **string** | The id of the BulkSendJob. | **Total** | **int** | The total amount of Signature Requests queued for sending. | **IsCreator** | **bool** | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | **CreatedAt** | **int** | Time that the BulkSendJob was created. | [[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/BulkSendJobResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobResponse.cs index ee798bc24..c643f4077 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobResponse.cs @@ -41,13 +41,18 @@ protected BulkSendJobResponse() { } /// /// Initializes a new instance of the class. /// - /// The id of the BulkSendJob.. - /// The total amount of Signature Requests queued for sending.. - /// True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member.. - /// Time that the BulkSendJob was created.. + /// The id of the BulkSendJob. (required). + /// The total amount of Signature Requests queued for sending. (required). + /// True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. (required). + /// Time that the BulkSendJob was created. (required). public BulkSendJobResponse(string bulkSendJobId = default(string), int total = default(int), bool isCreator = default(bool), int createdAt = default(int)) { + // to ensure "bulkSendJobId" is required (not null) + if (bulkSendJobId == null) + { + throw new ArgumentNullException("bulkSendJobId is a required property for BulkSendJobResponse and cannot be null"); + } this.BulkSendJobId = bulkSendJobId; this.Total = total; this.IsCreator = isCreator; @@ -74,28 +79,28 @@ public static BulkSendJobResponse Init(string jsonData) /// The id of the BulkSendJob. /// /// The id of the BulkSendJob. - [DataMember(Name = "bulk_send_job_id", EmitDefaultValue = true)] + [DataMember(Name = "bulk_send_job_id", IsRequired = true, EmitDefaultValue = true)] public string BulkSendJobId { get; set; } /// /// The total amount of Signature Requests queued for sending. /// /// The total amount of Signature Requests queued for sending. - [DataMember(Name = "total", EmitDefaultValue = true)] + [DataMember(Name = "total", IsRequired = true, EmitDefaultValue = true)] public int Total { get; set; } /// /// True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. /// /// True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. - [DataMember(Name = "is_creator", EmitDefaultValue = true)] + [DataMember(Name = "is_creator", IsRequired = true, EmitDefaultValue = true)] public bool IsCreator { get; set; } /// /// Time that the BulkSendJob was created. /// /// Time that the BulkSendJob was created. - [DataMember(Name = "created_at", EmitDefaultValue = true)] + [DataMember(Name = "created_at", IsRequired = true, EmitDefaultValue = true)] public int CreatedAt { get; set; } /// diff --git a/sdks/java-v1/docs/BulkSendJobResponse.md b/sdks/java-v1/docs/BulkSendJobResponse.md index eb2278a34..e177a023a 100644 --- a/sdks/java-v1/docs/BulkSendJobResponse.md +++ b/sdks/java-v1/docs/BulkSendJobResponse.md @@ -8,10 +8,10 @@ Contains information about the BulkSendJob such as when it was created and how m | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `bulkSendJobId` | ```String``` | The id of the BulkSendJob. | | -| `total` | ```Integer``` | The total amount of Signature Requests queued for sending. | | -| `isCreator` | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `createdAt` | ```Integer``` | Time that the BulkSendJob was created. | | +| `bulkSendJobId`*_required_ | ```String``` | The id of the BulkSendJob. | | +| `total`*_required_ | ```Integer``` | The total amount of Signature Requests queued for sending. | | +| `isCreator`*_required_ | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | +| `createdAt`*_required_ | ```Integer``` | Time that the BulkSendJob was created. | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java index bc366fdce..3deb8070c 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java @@ -76,14 +76,15 @@ public BulkSendJobResponse bulkSendJobId(String bulkSendJobId) { * * @return bulkSendJobId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getBulkSendJobId() { return bulkSendJobId; } @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setBulkSendJobId(String bulkSendJobId) { this.bulkSendJobId = bulkSendJobId; } @@ -98,14 +99,15 @@ public BulkSendJobResponse total(Integer total) { * * @return total */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TOTAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TOTAL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getTotal() { return total; } @JsonProperty(JSON_PROPERTY_TOTAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTotal(Integer total) { this.total = total; } @@ -121,14 +123,15 @@ public BulkSendJobResponse isCreator(Boolean isCreator) { * * @return isCreator */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_CREATOR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsCreator() { return isCreator; } @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsCreator(Boolean isCreator) { this.isCreator = isCreator; } @@ -143,14 +146,15 @@ public BulkSendJobResponse createdAt(Integer createdAt) { * * @return createdAt */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CREATED_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getCreatedAt() { return createdAt; } @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCreatedAt(Integer createdAt) { this.createdAt = createdAt; } diff --git a/sdks/java-v2/docs/BulkSendJobResponse.md b/sdks/java-v2/docs/BulkSendJobResponse.md index eb2278a34..e177a023a 100644 --- a/sdks/java-v2/docs/BulkSendJobResponse.md +++ b/sdks/java-v2/docs/BulkSendJobResponse.md @@ -8,10 +8,10 @@ Contains information about the BulkSendJob such as when it was created and how m | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `bulkSendJobId` | ```String``` | The id of the BulkSendJob. | | -| `total` | ```Integer``` | The total amount of Signature Requests queued for sending. | | -| `isCreator` | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `createdAt` | ```Integer``` | Time that the BulkSendJob was created. | | +| `bulkSendJobId`*_required_ | ```String``` | The id of the BulkSendJob. | | +| `total`*_required_ | ```Integer``` | The total amount of Signature Requests queued for sending. | | +| `isCreator`*_required_ | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | +| `createdAt`*_required_ | ```Integer``` | Time that the BulkSendJob was created. | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java index 88f0eec99..864eeb183 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java @@ -80,9 +80,9 @@ public BulkSendJobResponse bulkSendJobId(String bulkSendJobId) { * The id of the BulkSendJob. * @return bulkSendJobId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getBulkSendJobId() { return bulkSendJobId; @@ -90,7 +90,7 @@ public String getBulkSendJobId() { @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setBulkSendJobId(String bulkSendJobId) { this.bulkSendJobId = bulkSendJobId; } @@ -105,9 +105,9 @@ public BulkSendJobResponse total(Integer total) { * The total amount of Signature Requests queued for sending. * @return total */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TOTAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getTotal() { return total; @@ -115,7 +115,7 @@ public Integer getTotal() { @JsonProperty(JSON_PROPERTY_TOTAL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTotal(Integer total) { this.total = total; } @@ -130,9 +130,9 @@ public BulkSendJobResponse isCreator(Boolean isCreator) { * True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. * @return isCreator */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsCreator() { return isCreator; @@ -140,7 +140,7 @@ public Boolean getIsCreator() { @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsCreator(Boolean isCreator) { this.isCreator = isCreator; } @@ -155,9 +155,9 @@ public BulkSendJobResponse createdAt(Integer createdAt) { * Time that the BulkSendJob was created. * @return createdAt */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getCreatedAt() { return createdAt; @@ -165,7 +165,7 @@ public Integer getCreatedAt() { @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCreatedAt(Integer createdAt) { this.createdAt = createdAt; } diff --git a/sdks/node/docs/model/BulkSendJobResponse.md b/sdks/node/docs/model/BulkSendJobResponse.md index ecafe7ede..90b59a339 100644 --- a/sdks/node/docs/model/BulkSendJobResponse.md +++ b/sdks/node/docs/model/BulkSendJobResponse.md @@ -6,9 +6,9 @@ Contains information about the BulkSendJob such as when it was created and how m Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulkSendJobId` | ```string``` | The id of the BulkSendJob. | | -| `total` | ```number``` | The total amount of Signature Requests queued for sending. | | -| `isCreator` | ```boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `createdAt` | ```number``` | Time that the BulkSendJob was created. | | +| `bulkSendJobId`*_required_ | ```string``` | The id of the BulkSendJob. | | +| `total`*_required_ | ```number``` | The total amount of Signature Requests queued for sending. | | +| `isCreator`*_required_ | ```boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | +| `createdAt`*_required_ | ```number``` | Time that the BulkSendJob was created. | | [[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/bulkSendJobResponse.ts b/sdks/node/model/bulkSendJobResponse.ts index 115d7fb01..a7e1c5d0d 100644 --- a/sdks/node/model/bulkSendJobResponse.ts +++ b/sdks/node/model/bulkSendJobResponse.ts @@ -31,19 +31,19 @@ export class BulkSendJobResponse { /** * The id of the BulkSendJob. */ - "bulkSendJobId"?: string | null; + "bulkSendJobId": string; /** * The total amount of Signature Requests queued for sending. */ - "total"?: number; + "total": number; /** * True if you are the owner of this BulkSendJob, false if it\'s been shared with you by a team member. */ - "isCreator"?: boolean; + "isCreator": boolean; /** * Time that the BulkSendJob was created. */ - "createdAt"?: number; + "createdAt": number; static discriminator: string | undefined = undefined; diff --git a/sdks/node/types/model/bulkSendJobResponse.d.ts b/sdks/node/types/model/bulkSendJobResponse.d.ts index 11fa231bb..54ac0f889 100644 --- a/sdks/node/types/model/bulkSendJobResponse.d.ts +++ b/sdks/node/types/model/bulkSendJobResponse.d.ts @@ -1,9 +1,9 @@ import { AttributeTypeMap } from "./"; export declare class BulkSendJobResponse { - "bulkSendJobId"?: string | null; - "total"?: number; - "isCreator"?: boolean; - "createdAt"?: number; + "bulkSendJobId": string; + "total": number; + "isCreator": boolean; + "createdAt": number; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/php/docs/Model/BulkSendJobResponse.md b/sdks/php/docs/Model/BulkSendJobResponse.md index 16194fdd3..068d98bad 100644 --- a/sdks/php/docs/Model/BulkSendJobResponse.md +++ b/sdks/php/docs/Model/BulkSendJobResponse.md @@ -6,9 +6,9 @@ Contains information about the BulkSendJob such as when it was created and how m Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_job_id` | ```string``` | The id of the BulkSendJob. | | -| `total` | ```int``` | The total amount of Signature Requests queued for sending. | | -| `is_creator` | ```bool``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `created_at` | ```int``` | Time that the BulkSendJob was created. | | +| `bulk_send_job_id`*_required_ | ```string``` | The id of the BulkSendJob. | | +| `total`*_required_ | ```int``` | The total amount of Signature Requests queued for sending. | | +| `is_creator`*_required_ | ```bool``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | +| `created_at`*_required_ | ```int``` | Time that the BulkSendJob was created. | | [[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/BulkSendJobResponse.php b/sdks/php/src/Model/BulkSendJobResponse.php index fcd66e120..35578b8c8 100644 --- a/sdks/php/src/Model/BulkSendJobResponse.php +++ b/sdks/php/src/Model/BulkSendJobResponse.php @@ -84,7 +84,7 @@ class BulkSendJobResponse implements ModelInterface, ArrayAccess, JsonSerializab * @var bool[] */ protected static array $openAPINullables = [ - 'bulk_send_job_id' => true, + 'bulk_send_job_id' => false, 'total' => false, 'is_creator' => false, 'created_at' => false, @@ -303,7 +303,21 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['bulk_send_job_id'] === null) { + $invalidProperties[] = "'bulk_send_job_id' can't be null"; + } + if ($this->container['total'] === null) { + $invalidProperties[] = "'total' can't be null"; + } + if ($this->container['is_creator'] === null) { + $invalidProperties[] = "'is_creator' can't be null"; + } + if ($this->container['created_at'] === null) { + $invalidProperties[] = "'created_at' can't be null"; + } + return $invalidProperties; } /** @@ -320,7 +334,7 @@ public function valid() /** * Gets bulk_send_job_id * - * @return string|null + * @return string */ public function getBulkSendJobId() { @@ -330,21 +344,14 @@ public function getBulkSendJobId() /** * Sets bulk_send_job_id * - * @param string|null $bulk_send_job_id the id of the BulkSendJob + * @param string $bulk_send_job_id the id of the BulkSendJob * * @return self */ - public function setBulkSendJobId(?string $bulk_send_job_id) + public function setBulkSendJobId(string $bulk_send_job_id) { if (is_null($bulk_send_job_id)) { - array_push($this->openAPINullablesSetToNull, 'bulk_send_job_id'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('bulk_send_job_id', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + throw new InvalidArgumentException('non-nullable bulk_send_job_id cannot be null'); } $this->container['bulk_send_job_id'] = $bulk_send_job_id; @@ -354,7 +361,7 @@ public function setBulkSendJobId(?string $bulk_send_job_id) /** * Gets total * - * @return int|null + * @return int */ public function getTotal() { @@ -364,11 +371,11 @@ public function getTotal() /** * Sets total * - * @param int|null $total the total amount of Signature Requests queued for sending + * @param int $total the total amount of Signature Requests queued for sending * * @return self */ - public function setTotal(?int $total) + public function setTotal(int $total) { if (is_null($total)) { throw new InvalidArgumentException('non-nullable total cannot be null'); @@ -381,7 +388,7 @@ public function setTotal(?int $total) /** * Gets is_creator * - * @return bool|null + * @return bool */ public function getIsCreator() { @@ -391,11 +398,11 @@ public function getIsCreator() /** * Sets is_creator * - * @param bool|null $is_creator true if you are the owner of this BulkSendJob, false if it's been shared with you by a team member + * @param bool $is_creator true if you are the owner of this BulkSendJob, false if it's been shared with you by a team member * * @return self */ - public function setIsCreator(?bool $is_creator) + public function setIsCreator(bool $is_creator) { if (is_null($is_creator)) { throw new InvalidArgumentException('non-nullable is_creator cannot be null'); @@ -408,7 +415,7 @@ public function setIsCreator(?bool $is_creator) /** * Gets created_at * - * @return int|null + * @return int */ public function getCreatedAt() { @@ -418,11 +425,11 @@ public function getCreatedAt() /** * Sets created_at * - * @param int|null $created_at time that the BulkSendJob was created + * @param int $created_at time that the BulkSendJob was created * * @return self */ - public function setCreatedAt(?int $created_at) + public function setCreatedAt(int $created_at) { if (is_null($created_at)) { throw new InvalidArgumentException('non-nullable created_at cannot be null'); diff --git a/sdks/python/docs/BulkSendJobResponse.md b/sdks/python/docs/BulkSendJobResponse.md index 19e770fee..0c5051615 100644 --- a/sdks/python/docs/BulkSendJobResponse.md +++ b/sdks/python/docs/BulkSendJobResponse.md @@ -5,10 +5,10 @@ Contains information about the BulkSendJob such as when it was created and how m ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_job_id` | ```str``` | The id of the BulkSendJob. | | -| `total` | ```int``` | The total amount of Signature Requests queued for sending. | | -| `is_creator` | ```bool``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `created_at` | ```int``` | Time that the BulkSendJob was created. | | +| `bulk_send_job_id`*_required_ | ```str``` | The id of the BulkSendJob. | | +| `total`*_required_ | ```int``` | The total amount of Signature Requests queued for sending. | | +| `is_creator`*_required_ | ```bool``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | +| `created_at`*_required_ | ```int``` | Time that the BulkSendJob was created. | | [[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/bulk_send_job_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_response.py index 0812cb85d..70575bff9 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_response.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr -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,20 +32,14 @@ class BulkSendJobResponse(BaseModel): Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. """ # noqa: E501 - bulk_send_job_id: Optional[StrictStr] = Field( - default=None, description="The id of the BulkSendJob." + bulk_send_job_id: StrictStr = Field(description="The id of the BulkSendJob.") + total: StrictInt = Field( + description="The total amount of Signature Requests queued for sending." ) - total: Optional[StrictInt] = Field( - default=None, - description="The total amount of Signature Requests queued for sending.", - ) - is_creator: Optional[StrictBool] = Field( - default=None, - description="True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member.", - ) - created_at: Optional[StrictInt] = Field( - default=None, description="Time that the BulkSendJob was created." + is_creator: StrictBool = Field( + description="True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member." ) + created_at: StrictInt = Field(description="Time that the BulkSendJob was created.") __properties: ClassVar[List[str]] = [ "bulk_send_job_id", "total", diff --git a/sdks/ruby/docs/BulkSendJobResponse.md b/sdks/ruby/docs/BulkSendJobResponse.md index 30b30234d..ef640a841 100644 --- a/sdks/ruby/docs/BulkSendJobResponse.md +++ b/sdks/ruby/docs/BulkSendJobResponse.md @@ -6,8 +6,8 @@ Contains information about the BulkSendJob such as when it was created and how m | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `bulk_send_job_id` | ```String``` | The id of the BulkSendJob. | | -| `total` | ```Integer``` | The total amount of Signature Requests queued for sending. | | -| `is_creator` | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `created_at` | ```Integer``` | Time that the BulkSendJob was created. | | +| `bulk_send_job_id`*_required_ | ```String``` | The id of the BulkSendJob. | | +| `total`*_required_ | ```Integer``` | The total amount of Signature Requests queued for sending. | | +| `is_creator`*_required_ | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | +| `created_at`*_required_ | ```Integer``` | Time that the BulkSendJob was created. | | diff --git a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_response.rb b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_response.rb index b84d927a1..4037251c5 100644 --- a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_response.rb @@ -20,7 +20,7 @@ module Dropbox::Sign # Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. class BulkSendJobResponse # The id of the BulkSendJob. - # @return [String, nil] + # @return [String] attr_accessor :bulk_send_job_id # The total amount of Signature Requests queued for sending. @@ -63,7 +63,6 @@ def self.openapi_types # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'bulk_send_job_id', ]) end @@ -128,12 +127,32 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @bulk_send_job_id.nil? + invalid_properties.push('invalid value for "bulk_send_job_id", bulk_send_job_id cannot be nil.') + end + + if @total.nil? + invalid_properties.push('invalid value for "total", total cannot be nil.') + end + + if @is_creator.nil? + invalid_properties.push('invalid value for "is_creator", is_creator cannot be nil.') + end + + if @created_at.nil? + invalid_properties.push('invalid value for "created_at", created_at 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 @bulk_send_job_id.nil? + return false if @total.nil? + return false if @is_creator.nil? + return false if @created_at.nil? true end From 0606f8ba5e7d47ed7d7c0a231fc06a47cb13b0da Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Fri, 11 Oct 2024 15:38:13 -0500 Subject: [PATCH 03/16] ApiApp response improvements (#433) --- openapi-raw.yaml | 58 +++- openapi-sdk.yaml | 58 +++- openapi.yaml | 58 +++- sdks/dotnet/docs/ApiAppResponse.md | 2 +- sdks/dotnet/docs/ApiAppResponseOAuth.md | 2 +- sdks/dotnet/docs/ApiAppResponseOptions.md | 2 +- .../dotnet/docs/ApiAppResponseOwnerAccount.md | 2 +- .../ApiAppResponseWhiteLabelingOptions.md | 2 +- sdks/dotnet/docs/SubWhiteLabelingOptions.md | 2 +- .../src/Dropbox.Sign/Model/ApiAppResponse.cs | 151 ++++++----- .../Dropbox.Sign/Model/ApiAppResponseOAuth.cs | 72 ++--- .../Model/ApiAppResponseOptions.cs | 4 +- .../Model/ApiAppResponseOwnerAccount.cs | 18 +- .../ApiAppResponseWhiteLabelingOptions.cs | 126 +++++++-- .../Model/SubWhiteLabelingOptions.cs | 50 ++-- sdks/java-v1/docs/ApiAppResponse.md | 14 +- sdks/java-v1/docs/ApiAppResponseOAuth.md | 6 +- sdks/java-v1/docs/ApiAppResponseOptions.md | 2 +- .../docs/ApiAppResponseOwnerAccount.md | 4 +- .../ApiAppResponseWhiteLabelingOptions.md | 28 +- .../dropbox/sign/model/ApiAppResponse.java | 245 ++++++++--------- .../sign/model/ApiAppResponseOAuth.java | 121 ++++----- .../sign/model/ApiAppResponseOptions.java | 7 +- .../model/ApiAppResponseOwnerAccount.java | 14 +- .../ApiAppResponseWhiteLabelingOptions.java | 98 ++++--- .../sign/model/SubWhiteLabelingOptions.java | 24 +- sdks/java-v2/docs/ApiAppResponse.md | 14 +- sdks/java-v2/docs/ApiAppResponseOAuth.md | 6 +- sdks/java-v2/docs/ApiAppResponseOptions.md | 2 +- .../docs/ApiAppResponseOwnerAccount.md | 4 +- .../ApiAppResponseWhiteLabelingOptions.md | 28 +- .../dropbox/sign/model/ApiAppResponse.java | 248 +++++++++--------- .../sign/model/ApiAppResponseOAuth.java | 126 ++++----- .../sign/model/ApiAppResponseOptions.java | 6 +- .../model/ApiAppResponseOwnerAccount.java | 12 +- .../ApiAppResponseWhiteLabelingOptions.java | 84 +++--- .../sign/model/SubWhiteLabelingOptions.java | 24 +- sdks/node/dist/api.js | 54 ++-- sdks/node/docs/model/ApiAppResponse.md | 14 +- sdks/node/docs/model/ApiAppResponseOAuth.md | 6 +- sdks/node/docs/model/ApiAppResponseOptions.md | 2 +- .../docs/model/ApiAppResponseOwnerAccount.md | 4 +- .../ApiAppResponseWhiteLabelingOptions.md | 28 +- .../docs/model/SubWhiteLabelingOptions.md | 24 +- sdks/node/model/apiAppResponse.ts | 42 +-- sdks/node/model/apiAppResponseOAuth.ts | 24 +- sdks/node/model/apiAppResponseOptions.ts | 2 +- sdks/node/model/apiAppResponseOwnerAccount.ts | 4 +- .../apiAppResponseWhiteLabelingOptions.ts | 28 +- sdks/node/model/subWhiteLabelingOptions.ts | 24 +- sdks/node/types/model/apiAppResponse.d.ts | 14 +- .../node/types/model/apiAppResponseOAuth.d.ts | 8 +- .../types/model/apiAppResponseOptions.d.ts | 2 +- .../model/apiAppResponseOwnerAccount.d.ts | 4 +- .../apiAppResponseWhiteLabelingOptions.d.ts | 28 +- sdks/php/docs/Model/ApiAppResponse.md | 14 +- sdks/php/docs/Model/ApiAppResponseOAuth.md | 6 +- sdks/php/docs/Model/ApiAppResponseOptions.md | 2 +- .../docs/Model/ApiAppResponseOwnerAccount.md | 4 +- .../ApiAppResponseWhiteLabelingOptions.md | 28 +- .../php/docs/Model/SubWhiteLabelingOptions.md | 24 +- sdks/php/src/Model/ApiAppResponse.php | 222 ++++++++-------- sdks/php/src/Model/ApiAppResponseOAuth.php | 100 ++++--- sdks/php/src/Model/ApiAppResponseOptions.php | 13 +- .../src/Model/ApiAppResponseOwnerAccount.php | 22 +- .../ApiAppResponseWhiteLabelingOptions.php | 130 ++++++--- .../php/src/Model/SubWhiteLabelingOptions.php | 24 +- sdks/python/docs/ApiAppResponse.md | 14 +- sdks/python/docs/ApiAppResponseOAuth.md | 6 +- sdks/python/docs/ApiAppResponseOptions.md | 2 +- .../python/docs/ApiAppResponseOwnerAccount.md | 4 +- .../ApiAppResponseWhiteLabelingOptions.md | 28 +- sdks/python/docs/SubWhiteLabelingOptions.md | 24 +- .../dropbox_sign/models/api_app_response.py | 52 ++-- .../models/api_app_response_o_auth.py | 21 +- .../models/api_app_response_options.py | 7 +- .../models/api_app_response_owner_account.py | 10 +- ...api_app_response_white_labeling_options.py | 30 +-- .../models/sub_white_labeling_options.py | 48 ++-- sdks/ruby/docs/ApiAppResponse.md | 14 +- sdks/ruby/docs/ApiAppResponseOAuth.md | 6 +- sdks/ruby/docs/ApiAppResponseOptions.md | 2 +- sdks/ruby/docs/ApiAppResponseOwnerAccount.md | 4 +- .../ApiAppResponseWhiteLabelingOptions.md | 28 +- sdks/ruby/docs/SubWhiteLabelingOptions.md | 24 +- .../dropbox-sign/models/api_app_response.rb | 82 ++++-- .../models/api_app_response_o_auth.rb | 46 ++-- .../models/api_app_response_options.rb | 5 + .../models/api_app_response_owner_account.rb | 10 + ...api_app_response_white_labeling_options.rb | 70 +++++ .../models/sub_white_labeling_options.rb | 24 +- test_fixtures/ApiAppCreateRequest.json | 20 +- test_fixtures/ApiAppGetResponse.json | 21 +- test_fixtures/ApiAppListResponse.json | 8 +- test_fixtures/ApiAppUpdateRequest.json | 22 +- 95 files changed, 1865 insertions(+), 1392 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index f3a04870e..facc85abe 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -8671,7 +8671,7 @@ components: properties: header_background_color: type: string - default: '#1A1A1A' + default: '#1a1a1a' legal_version: type: string default: terms1 @@ -8680,40 +8680,40 @@ components: - terms2 link_color: type: string - default: '#00B3E6' + default: '#0061FE' page_background_color: type: string - default: '#F7F8F9' + default: '#f7f8f9' primary_button_color: type: string - default: '#00B3E6' + default: '#0061FE' primary_button_color_hover: type: string - default: '#00B3E6' + default: '#0061FE' primary_button_text_color: type: string - default: '#FFFFFF' + default: '#ffffff' primary_button_text_color_hover: type: string - default: '#FFFFFF' + default: '#ffffff' secondary_button_color: type: string - default: '#FFFFFF' + default: '#ffffff' secondary_button_color_hover: type: string - default: '#FFFFFF' + default: '#ffffff' secondary_button_text_color: type: string - default: '#00B3E6' + default: '#0061FE' secondary_button_text_color_hover: type: string - default: '#00B3E6' + default: '#0061FE' text_color1: type: string default: '#808080' text_color2: type: string - default: '#FFFFFF' + default: '#ffffff' reset_to_default: description: '_t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT' type: boolean @@ -9807,6 +9807,14 @@ components: x-internal-class: true ApiAppResponse: description: '_t__ApiAppResponse::DESCRIPTION' + required: + - client_id + - created_at + - domains + - is_approved + - name + - options + - owner_account properties: callback_url: description: '_t__ApiAppResponse::CALLBACK_URL' @@ -9841,6 +9849,10 @@ components: x-internal-class: true ApiAppResponseOAuth: description: '_t__ApiAppResponseOAuth::DESCRIPTION' + required: + - callback_url + - charges_users + - scopes properties: callback_url: description: '_t__ApiAppResponseOAuth::CALLBACK_URL' @@ -9848,6 +9860,7 @@ components: secret: description: '_t__ApiAppResponseOAuth::SECRET' type: string + nullable: true scopes: description: '_t__ApiAppResponseOAuth::SCOPES' type: array @@ -9861,15 +9874,19 @@ components: x-internal-class: true ApiAppResponseOptions: description: '_t__ApiAppResponseOptions::DESCRIPTION' + required: + - can_insert_everywhere properties: can_insert_everywhere: description: '_t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE' type: boolean type: object - nullable: true x-internal-class: true ApiAppResponseOwnerAccount: description: '_t__ApiAppResponseOwnerAccount::DESCRIPTION' + required: + - account_id + - email_address properties: account_id: description: '_t__ApiAppResponseOwnerAccount::ACCOUNT_ID' @@ -9881,6 +9898,21 @@ components: x-internal-class: true ApiAppResponseWhiteLabelingOptions: description: '_t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION' + required: + - header_background_color + - legal_version + - link_color + - page_background_color + - primary_button_color + - primary_button_color_hover + - primary_button_text_color + - primary_button_text_color_hover + - secondary_button_color + - secondary_button_color_hover + - secondary_button_text_color + - secondary_button_text_color_hover + - text_color1 + - text_color2 properties: header_background_color: type: string diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 7bf78e3b7..ae2e0628b 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -9091,7 +9091,7 @@ components: properties: header_background_color: type: string - default: '#1A1A1A' + default: '#1a1a1a' legal_version: type: string default: terms1 @@ -9100,40 +9100,40 @@ components: - terms2 link_color: type: string - default: '#00B3E6' + default: '#0061FE' page_background_color: type: string - default: '#F7F8F9' + default: '#f7f8f9' primary_button_color: type: string - default: '#00B3E6' + default: '#0061FE' primary_button_color_hover: type: string - default: '#00B3E6' + default: '#0061FE' primary_button_text_color: type: string - default: '#FFFFFF' + default: '#ffffff' primary_button_text_color_hover: type: string - default: '#FFFFFF' + default: '#ffffff' secondary_button_color: type: string - default: '#FFFFFF' + default: '#ffffff' secondary_button_color_hover: type: string - default: '#FFFFFF' + default: '#ffffff' secondary_button_text_color: type: string - default: '#00B3E6' + default: '#0061FE' secondary_button_text_color_hover: type: string - default: '#00B3E6' + default: '#0061FE' text_color1: type: string default: '#808080' text_color2: type: string - default: '#FFFFFF' + default: '#ffffff' reset_to_default: description: 'Resets white labeling options to defaults. Only useful when updating an API App.' type: boolean @@ -10415,6 +10415,14 @@ components: x-internal-class: true ApiAppResponse: description: 'Contains information about an API App.' + required: + - client_id + - created_at + - domains + - is_approved + - name + - options + - owner_account properties: callback_url: description: 'The app''s callback URL (for events)' @@ -10449,6 +10457,10 @@ components: x-internal-class: true ApiAppResponseOAuth: description: 'An object describing the app''s OAuth properties, or null if OAuth is not configured for the app.' + required: + - callback_url + - charges_users + - scopes properties: callback_url: description: 'The app''s OAuth callback URL.' @@ -10456,6 +10468,7 @@ components: secret: description: 'The app''s OAuth secret, or null if the app does not belong to user.' type: string + nullable: true scopes: description: 'Array of OAuth scopes used by the app.' type: array @@ -10469,15 +10482,19 @@ components: x-internal-class: true ApiAppResponseOptions: description: 'An object with options that override account settings.' + required: + - can_insert_everywhere properties: can_insert_everywhere: description: 'Boolean denoting if signers can "Insert Everywhere" in one click while signing a document' type: boolean type: object - nullable: true x-internal-class: true ApiAppResponseOwnerAccount: description: 'An object describing the app''s owner' + required: + - account_id + - email_address properties: account_id: description: 'The owner account''s ID' @@ -10489,6 +10506,21 @@ components: x-internal-class: true ApiAppResponseWhiteLabelingOptions: description: 'An object with options to customize the app''s signer page' + required: + - header_background_color + - legal_version + - link_color + - page_background_color + - primary_button_color + - primary_button_color_hover + - primary_button_text_color + - primary_button_text_color_hover + - secondary_button_color + - secondary_button_color_hover + - secondary_button_text_color + - secondary_button_text_color_hover + - text_color1 + - text_color2 properties: header_background_color: type: string diff --git a/openapi.yaml b/openapi.yaml index 553806669..84dce9f1e 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -9069,7 +9069,7 @@ components: properties: header_background_color: type: string - default: '#1A1A1A' + default: '#1a1a1a' legal_version: type: string default: terms1 @@ -9078,40 +9078,40 @@ components: - terms2 link_color: type: string - default: '#00B3E6' + default: '#0061FE' page_background_color: type: string - default: '#F7F8F9' + default: '#f7f8f9' primary_button_color: type: string - default: '#00B3E6' + default: '#0061FE' primary_button_color_hover: type: string - default: '#00B3E6' + default: '#0061FE' primary_button_text_color: type: string - default: '#FFFFFF' + default: '#ffffff' primary_button_text_color_hover: type: string - default: '#FFFFFF' + default: '#ffffff' secondary_button_color: type: string - default: '#FFFFFF' + default: '#ffffff' secondary_button_color_hover: type: string - default: '#FFFFFF' + default: '#ffffff' secondary_button_text_color: type: string - default: '#00B3E6' + default: '#0061FE' secondary_button_text_color_hover: type: string - default: '#00B3E6' + default: '#0061FE' text_color1: type: string default: '#808080' text_color2: type: string - default: '#FFFFFF' + default: '#ffffff' reset_to_default: description: 'Resets white labeling options to defaults. Only useful when updating an API App.' type: boolean @@ -10393,6 +10393,14 @@ components: x-internal-class: true ApiAppResponse: description: 'Contains information about an API App.' + required: + - client_id + - created_at + - domains + - is_approved + - name + - options + - owner_account properties: callback_url: description: 'The app''s callback URL (for events)' @@ -10427,6 +10435,10 @@ components: x-internal-class: true ApiAppResponseOAuth: description: 'An object describing the app''s OAuth properties, or null if OAuth is not configured for the app.' + required: + - callback_url + - charges_users + - scopes properties: callback_url: description: 'The app''s OAuth callback URL.' @@ -10434,6 +10446,7 @@ components: secret: description: 'The app''s OAuth secret, or null if the app does not belong to user.' type: string + nullable: true scopes: description: 'Array of OAuth scopes used by the app.' type: array @@ -10447,15 +10460,19 @@ components: x-internal-class: true ApiAppResponseOptions: description: 'An object with options that override account settings.' + required: + - can_insert_everywhere properties: can_insert_everywhere: description: 'Boolean denoting if signers can "Insert Everywhere" in one click while signing a document' type: boolean type: object - nullable: true x-internal-class: true ApiAppResponseOwnerAccount: description: 'An object describing the app''s owner' + required: + - account_id + - email_address properties: account_id: description: 'The owner account''s ID' @@ -10467,6 +10484,21 @@ components: x-internal-class: true ApiAppResponseWhiteLabelingOptions: description: 'An object with options to customize the app''s signer page' + required: + - header_background_color + - legal_version + - link_color + - page_background_color + - primary_button_color + - primary_button_color_hover + - primary_button_text_color + - primary_button_text_color_hover + - secondary_button_color + - secondary_button_color_hover + - secondary_button_text_color + - secondary_button_text_color_hover + - text_color1 + - text_color2 properties: header_background_color: type: string diff --git a/sdks/dotnet/docs/ApiAppResponse.md b/sdks/dotnet/docs/ApiAppResponse.md index f27ff0659..e7b3c6e30 100644 --- a/sdks/dotnet/docs/ApiAppResponse.md +++ b/sdks/dotnet/docs/ApiAppResponse.md @@ -5,7 +5,7 @@ Contains information about an API App. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CallbackUrl** | **string** | The app's callback URL (for events) | [optional] **ClientId** | **string** | The app's client id | [optional] **CreatedAt** | **int** | The time that the app was created | [optional] **Domains** | **List<string>** | The domain name(s) associated with the app | [optional] **Name** | **string** | The name of the app | [optional] **IsApproved** | **bool** | Boolean to indicate if the app has been approved | [optional] **Oauth** | [**ApiAppResponseOAuth**](ApiAppResponseOAuth.md) | | [optional] **Options** | [**ApiAppResponseOptions**](ApiAppResponseOptions.md) | | [optional] **OwnerAccount** | [**ApiAppResponseOwnerAccount**](ApiAppResponseOwnerAccount.md) | | [optional] **WhiteLabelingOptions** | [**ApiAppResponseWhiteLabelingOptions**](ApiAppResponseWhiteLabelingOptions.md) | | [optional] +**ClientId** | **string** | The app's client id | **CreatedAt** | **int** | The time that the app was created | **Domains** | **List<string>** | The domain name(s) associated with the app | **Name** | **string** | The name of the app | **IsApproved** | **bool** | Boolean to indicate if the app has been approved | **Options** | [**ApiAppResponseOptions**](ApiAppResponseOptions.md) | | **OwnerAccount** | [**ApiAppResponseOwnerAccount**](ApiAppResponseOwnerAccount.md) | | **CallbackUrl** | **string** | The app's callback URL (for events) | [optional] **Oauth** | [**ApiAppResponseOAuth**](ApiAppResponseOAuth.md) | | [optional] **WhiteLabelingOptions** | [**ApiAppResponseWhiteLabelingOptions**](ApiAppResponseWhiteLabelingOptions.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/ApiAppResponseOAuth.md b/sdks/dotnet/docs/ApiAppResponseOAuth.md index cffe8900f..69de8316d 100644 --- a/sdks/dotnet/docs/ApiAppResponseOAuth.md +++ b/sdks/dotnet/docs/ApiAppResponseOAuth.md @@ -5,7 +5,7 @@ An object describing the app's OAuth properties, or null if OAuth is not configu Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CallbackUrl** | **string** | The app's OAuth callback URL. | [optional] **Secret** | **string** | The app's OAuth secret, or null if the app does not belong to user. | [optional] **Scopes** | **List<string>** | Array of OAuth scopes used by the app. | [optional] **ChargesUsers** | **bool** | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | [optional] +**CallbackUrl** | **string** | The app's OAuth callback URL. | **Scopes** | **List<string>** | Array of OAuth scopes used by the app. | **ChargesUsers** | **bool** | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | **Secret** | **string** | The app's OAuth secret, or null if the app does not belong to user. | [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/ApiAppResponseOptions.md b/sdks/dotnet/docs/ApiAppResponseOptions.md index e484ad16b..97fdc5d08 100644 --- a/sdks/dotnet/docs/ApiAppResponseOptions.md +++ b/sdks/dotnet/docs/ApiAppResponseOptions.md @@ -5,7 +5,7 @@ An object with options that override account settings. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CanInsertEverywhere** | **bool** | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | [optional] +**CanInsertEverywhere** | **bool** | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | [[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/ApiAppResponseOwnerAccount.md b/sdks/dotnet/docs/ApiAppResponseOwnerAccount.md index eee4afc3e..fa9c19b3f 100644 --- a/sdks/dotnet/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/dotnet/docs/ApiAppResponseOwnerAccount.md @@ -5,7 +5,7 @@ An object describing the app's owner Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AccountId** | **string** | The owner account's ID | [optional] **EmailAddress** | **string** | The owner account's email address | [optional] +**AccountId** | **string** | The owner account's ID | **EmailAddress** | **string** | The owner account's email address | [[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/ApiAppResponseWhiteLabelingOptions.md b/sdks/dotnet/docs/ApiAppResponseWhiteLabelingOptions.md index 3f3eb34a3..0f3960188 100644 --- a/sdks/dotnet/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/dotnet/docs/ApiAppResponseWhiteLabelingOptions.md @@ -5,7 +5,7 @@ An object with options to customize the app's signer page Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HeaderBackgroundColor** | **string** | | [optional] **LegalVersion** | **string** | | [optional] **LinkColor** | **string** | | [optional] **PageBackgroundColor** | **string** | | [optional] **PrimaryButtonColor** | **string** | | [optional] **PrimaryButtonColorHover** | **string** | | [optional] **PrimaryButtonTextColor** | **string** | | [optional] **PrimaryButtonTextColorHover** | **string** | | [optional] **SecondaryButtonColor** | **string** | | [optional] **SecondaryButtonColorHover** | **string** | | [optional] **SecondaryButtonTextColor** | **string** | | [optional] **SecondaryButtonTextColorHover** | **string** | | [optional] **TextColor1** | **string** | | [optional] **TextColor2** | **string** | | [optional] +**HeaderBackgroundColor** | **string** | | **LegalVersion** | **string** | | **LinkColor** | **string** | | **PageBackgroundColor** | **string** | | **PrimaryButtonColor** | **string** | | **PrimaryButtonColorHover** | **string** | | **PrimaryButtonTextColor** | **string** | | **PrimaryButtonTextColorHover** | **string** | | **SecondaryButtonColor** | **string** | | **SecondaryButtonColorHover** | **string** | | **SecondaryButtonTextColor** | **string** | | **SecondaryButtonTextColorHover** | **string** | | **TextColor1** | **string** | | **TextColor2** | **string** | | [[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/SubWhiteLabelingOptions.md b/sdks/dotnet/docs/SubWhiteLabelingOptions.md index 930a345f5..1634a1afb 100644 --- a/sdks/dotnet/docs/SubWhiteLabelingOptions.md +++ b/sdks/dotnet/docs/SubWhiteLabelingOptions.md @@ -5,7 +5,7 @@ An array of elements and values serialized to a string, to be used to customize Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HeaderBackgroundColor** | **string** | | [optional] [default to "#1A1A1A"]**LegalVersion** | **string** | | [optional] [default to LegalVersionEnum.Terms1]**LinkColor** | **string** | | [optional] [default to "#00B3E6"]**PageBackgroundColor** | **string** | | [optional] [default to "#F7F8F9"]**PrimaryButtonColor** | **string** | | [optional] [default to "#00B3E6"]**PrimaryButtonColorHover** | **string** | | [optional] [default to "#00B3E6"]**PrimaryButtonTextColor** | **string** | | [optional] [default to "#FFFFFF"]**PrimaryButtonTextColorHover** | **string** | | [optional] [default to "#FFFFFF"]**SecondaryButtonColor** | **string** | | [optional] [default to "#FFFFFF"]**SecondaryButtonColorHover** | **string** | | [optional] [default to "#FFFFFF"]**SecondaryButtonTextColor** | **string** | | [optional] [default to "#00B3E6"]**SecondaryButtonTextColorHover** | **string** | | [optional] [default to "#00B3E6"]**TextColor1** | **string** | | [optional] [default to "#808080"]**TextColor2** | **string** | | [optional] [default to "#FFFFFF"]**ResetToDefault** | **bool** | Resets white labeling options to defaults. Only useful when updating an API App. | [optional] +**HeaderBackgroundColor** | **string** | | [optional] [default to "#1a1a1a"]**LegalVersion** | **string** | | [optional] [default to LegalVersionEnum.Terms1]**LinkColor** | **string** | | [optional] [default to "#0061FE"]**PageBackgroundColor** | **string** | | [optional] [default to "#f7f8f9"]**PrimaryButtonColor** | **string** | | [optional] [default to "#0061FE"]**PrimaryButtonColorHover** | **string** | | [optional] [default to "#0061FE"]**PrimaryButtonTextColor** | **string** | | [optional] [default to "#ffffff"]**PrimaryButtonTextColorHover** | **string** | | [optional] [default to "#ffffff"]**SecondaryButtonColor** | **string** | | [optional] [default to "#ffffff"]**SecondaryButtonColorHover** | **string** | | [optional] [default to "#ffffff"]**SecondaryButtonTextColor** | **string** | | [optional] [default to "#0061FE"]**SecondaryButtonTextColorHover** | **string** | | [optional] [default to "#0061FE"]**TextColor1** | **string** | | [optional] [default to "#808080"]**TextColor2** | **string** | | [optional] [default to "#ffffff"]**ResetToDefault** | **bool** | Resets white labeling options to defaults. Only useful when updating an API App. | [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/src/Dropbox.Sign/Model/ApiAppResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponse.cs index f4e1da05a..a1bfc7b45 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponse.cs @@ -42,27 +42,52 @@ protected ApiAppResponse() { } /// Initializes a new instance of the class. /// /// The app's callback URL (for events). - /// The app's client id. - /// The time that the app was created. - /// The domain name(s) associated with the app. - /// The name of the app. - /// Boolean to indicate if the app has been approved. + /// The app's client id (required). + /// The time that the app was created (required). + /// The domain name(s) associated with the app (required). + /// The name of the app (required). + /// Boolean to indicate if the app has been approved (required). /// oauth. - /// options. - /// ownerAccount. + /// options (required). + /// ownerAccount (required). /// whiteLabelingOptions. public ApiAppResponse(string callbackUrl = default(string), string clientId = default(string), int createdAt = default(int), List domains = default(List), string name = default(string), bool isApproved = default(bool), ApiAppResponseOAuth oauth = default(ApiAppResponseOAuth), ApiAppResponseOptions options = default(ApiAppResponseOptions), ApiAppResponseOwnerAccount ownerAccount = default(ApiAppResponseOwnerAccount), ApiAppResponseWhiteLabelingOptions whiteLabelingOptions = default(ApiAppResponseWhiteLabelingOptions)) { - this.CallbackUrl = callbackUrl; + // to ensure "clientId" is required (not null) + if (clientId == null) + { + throw new ArgumentNullException("clientId is a required property for ApiAppResponse and cannot be null"); + } this.ClientId = clientId; this.CreatedAt = createdAt; + // to ensure "domains" is required (not null) + if (domains == null) + { + throw new ArgumentNullException("domains is a required property for ApiAppResponse and cannot be null"); + } this.Domains = domains; + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for ApiAppResponse and cannot be null"); + } this.Name = name; this.IsApproved = isApproved; - this.Oauth = oauth; + // to ensure "options" is required (not null) + if (options == null) + { + throw new ArgumentNullException("options is a required property for ApiAppResponse and cannot be null"); + } this.Options = options; + // to ensure "ownerAccount" is required (not null) + if (ownerAccount == null) + { + throw new ArgumentNullException("ownerAccount is a required property for ApiAppResponse and cannot be null"); + } this.OwnerAccount = ownerAccount; + this.CallbackUrl = callbackUrl; + this.Oauth = oauth; this.WhiteLabelingOptions = whiteLabelingOptions; } @@ -82,66 +107,66 @@ public static ApiAppResponse Init(string jsonData) return obj; } - /// - /// The app's callback URL (for events) - /// - /// The app's callback URL (for events) - [DataMember(Name = "callback_url", EmitDefaultValue = true)] - public string CallbackUrl { get; set; } - /// /// The app's client id /// /// The app's client id - [DataMember(Name = "client_id", EmitDefaultValue = true)] + [DataMember(Name = "client_id", IsRequired = true, EmitDefaultValue = true)] public string ClientId { get; set; } /// /// The time that the app was created /// /// The time that the app was created - [DataMember(Name = "created_at", EmitDefaultValue = true)] + [DataMember(Name = "created_at", IsRequired = true, EmitDefaultValue = true)] public int CreatedAt { get; set; } /// /// The domain name(s) associated with the app /// /// The domain name(s) associated with the app - [DataMember(Name = "domains", EmitDefaultValue = true)] + [DataMember(Name = "domains", IsRequired = true, EmitDefaultValue = true)] public List Domains { get; set; } /// /// The name of the app /// /// The name of the app - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// /// Boolean to indicate if the app has been approved /// /// Boolean to indicate if the app has been approved - [DataMember(Name = "is_approved", EmitDefaultValue = true)] + [DataMember(Name = "is_approved", IsRequired = true, EmitDefaultValue = true)] public bool IsApproved { get; set; } - /// - /// Gets or Sets Oauth - /// - [DataMember(Name = "oauth", EmitDefaultValue = true)] - public ApiAppResponseOAuth Oauth { get; set; } - /// /// Gets or Sets Options /// - [DataMember(Name = "options", EmitDefaultValue = true)] + [DataMember(Name = "options", IsRequired = true, EmitDefaultValue = true)] public ApiAppResponseOptions Options { get; set; } /// /// Gets or Sets OwnerAccount /// - [DataMember(Name = "owner_account", EmitDefaultValue = true)] + [DataMember(Name = "owner_account", IsRequired = true, EmitDefaultValue = true)] public ApiAppResponseOwnerAccount OwnerAccount { get; set; } + /// + /// The app's callback URL (for events) + /// + /// The app's callback URL (for events) + [DataMember(Name = "callback_url", EmitDefaultValue = true)] + public string CallbackUrl { get; set; } + + /// + /// Gets or Sets Oauth + /// + [DataMember(Name = "oauth", EmitDefaultValue = true)] + public ApiAppResponseOAuth Oauth { get; set; } + /// /// Gets or Sets WhiteLabelingOptions /// @@ -156,15 +181,15 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ApiAppResponse {\n"); - sb.Append(" CallbackUrl: ").Append(CallbackUrl).Append("\n"); sb.Append(" ClientId: ").Append(ClientId).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" Domains: ").Append(Domains).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" IsApproved: ").Append(IsApproved).Append("\n"); - sb.Append(" Oauth: ").Append(Oauth).Append("\n"); sb.Append(" Options: ").Append(Options).Append("\n"); sb.Append(" OwnerAccount: ").Append(OwnerAccount).Append("\n"); + sb.Append(" CallbackUrl: ").Append(CallbackUrl).Append("\n"); + sb.Append(" Oauth: ").Append(Oauth).Append("\n"); sb.Append(" WhiteLabelingOptions: ").Append(WhiteLabelingOptions).Append("\n"); sb.Append("}\n"); return sb.ToString(); @@ -201,11 +226,6 @@ public bool Equals(ApiAppResponse input) return false; } return - ( - this.CallbackUrl == input.CallbackUrl || - (this.CallbackUrl != null && - this.CallbackUrl.Equals(input.CallbackUrl)) - ) && ( this.ClientId == input.ClientId || (this.ClientId != null && @@ -230,11 +250,6 @@ public bool Equals(ApiAppResponse input) this.IsApproved == input.IsApproved || this.IsApproved.Equals(input.IsApproved) ) && - ( - this.Oauth == input.Oauth || - (this.Oauth != null && - this.Oauth.Equals(input.Oauth)) - ) && ( this.Options == input.Options || (this.Options != null && @@ -245,6 +260,16 @@ public bool Equals(ApiAppResponse input) (this.OwnerAccount != null && this.OwnerAccount.Equals(input.OwnerAccount)) ) && + ( + this.CallbackUrl == input.CallbackUrl || + (this.CallbackUrl != null && + this.CallbackUrl.Equals(input.CallbackUrl)) + ) && + ( + this.Oauth == input.Oauth || + (this.Oauth != null && + this.Oauth.Equals(input.Oauth)) + ) && ( this.WhiteLabelingOptions == input.WhiteLabelingOptions || (this.WhiteLabelingOptions != null && @@ -261,10 +286,6 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; - if (this.CallbackUrl != null) - { - hashCode = (hashCode * 59) + this.CallbackUrl.GetHashCode(); - } if (this.ClientId != null) { hashCode = (hashCode * 59) + this.ClientId.GetHashCode(); @@ -279,10 +300,6 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Name.GetHashCode(); } hashCode = (hashCode * 59) + this.IsApproved.GetHashCode(); - if (this.Oauth != null) - { - hashCode = (hashCode * 59) + this.Oauth.GetHashCode(); - } if (this.Options != null) { hashCode = (hashCode * 59) + this.Options.GetHashCode(); @@ -291,6 +308,14 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.OwnerAccount.GetHashCode(); } + if (this.CallbackUrl != null) + { + hashCode = (hashCode * 59) + this.CallbackUrl.GetHashCode(); + } + if (this.Oauth != null) + { + hashCode = (hashCode * 59) + this.Oauth.GetHashCode(); + } if (this.WhiteLabelingOptions != null) { hashCode = (hashCode * 59) + this.WhiteLabelingOptions.GetHashCode(); @@ -312,13 +337,6 @@ public List GetOpenApiTypes() { var types = new List(); types.Add(new OpenApiType() - { - Name = "callback_url", - Property = "CallbackUrl", - Type = "string", - Value = CallbackUrl, - }); - types.Add(new OpenApiType() { Name = "client_id", Property = "ClientId", @@ -354,13 +372,6 @@ public List GetOpenApiTypes() Value = IsApproved, }); types.Add(new OpenApiType() - { - Name = "oauth", - Property = "Oauth", - Type = "ApiAppResponseOAuth", - Value = Oauth, - }); - types.Add(new OpenApiType() { Name = "options", Property = "Options", @@ -375,6 +386,20 @@ public List GetOpenApiTypes() Value = OwnerAccount, }); types.Add(new OpenApiType() + { + Name = "callback_url", + Property = "CallbackUrl", + Type = "string", + Value = CallbackUrl, + }); + types.Add(new OpenApiType() + { + Name = "oauth", + Property = "Oauth", + Type = "ApiAppResponseOAuth", + Value = Oauth, + }); + types.Add(new OpenApiType() { Name = "white_labeling_options", Property = "WhiteLabelingOptions", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOAuth.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOAuth.cs index d5ceebef6..cb35f5013 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOAuth.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOAuth.cs @@ -41,17 +41,27 @@ protected ApiAppResponseOAuth() { } /// /// Initializes a new instance of the class. /// - /// The app's OAuth callback URL.. + /// The app's OAuth callback URL. (required). /// The app's OAuth secret, or null if the app does not belong to user.. - /// Array of OAuth scopes used by the app.. - /// Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.. + /// Array of OAuth scopes used by the app. (required). + /// Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. (required). public ApiAppResponseOAuth(string callbackUrl = default(string), string secret = default(string), List scopes = default(List), bool chargesUsers = default(bool)) { + // to ensure "callbackUrl" is required (not null) + if (callbackUrl == null) + { + throw new ArgumentNullException("callbackUrl is a required property for ApiAppResponseOAuth and cannot be null"); + } this.CallbackUrl = callbackUrl; - this.Secret = secret; + // to ensure "scopes" is required (not null) + if (scopes == null) + { + throw new ArgumentNullException("scopes is a required property for ApiAppResponseOAuth and cannot be null"); + } this.Scopes = scopes; this.ChargesUsers = chargesUsers; + this.Secret = secret; } /// @@ -74,30 +84,30 @@ public static ApiAppResponseOAuth Init(string jsonData) /// The app's OAuth callback URL. /// /// The app's OAuth callback URL. - [DataMember(Name = "callback_url", EmitDefaultValue = true)] + [DataMember(Name = "callback_url", IsRequired = true, EmitDefaultValue = true)] public string CallbackUrl { get; set; } - /// - /// The app's OAuth secret, or null if the app does not belong to user. - /// - /// The app's OAuth secret, or null if the app does not belong to user. - [DataMember(Name = "secret", EmitDefaultValue = true)] - public string Secret { get; set; } - /// /// Array of OAuth scopes used by the app. /// /// Array of OAuth scopes used by the app. - [DataMember(Name = "scopes", EmitDefaultValue = true)] + [DataMember(Name = "scopes", IsRequired = true, EmitDefaultValue = true)] public List Scopes { get; set; } /// /// Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. /// /// Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. - [DataMember(Name = "charges_users", EmitDefaultValue = true)] + [DataMember(Name = "charges_users", IsRequired = true, EmitDefaultValue = true)] public bool ChargesUsers { get; set; } + /// + /// The app's OAuth secret, or null if the app does not belong to user. + /// + /// The app's OAuth secret, or null if the app does not belong to user. + [DataMember(Name = "secret", EmitDefaultValue = true)] + public string Secret { get; set; } + /// /// Returns the string presentation of the object /// @@ -107,9 +117,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ApiAppResponseOAuth {\n"); sb.Append(" CallbackUrl: ").Append(CallbackUrl).Append("\n"); - sb.Append(" Secret: ").Append(Secret).Append("\n"); sb.Append(" Scopes: ").Append(Scopes).Append("\n"); sb.Append(" ChargesUsers: ").Append(ChargesUsers).Append("\n"); + sb.Append(" Secret: ").Append(Secret).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -150,11 +160,6 @@ public bool Equals(ApiAppResponseOAuth input) (this.CallbackUrl != null && this.CallbackUrl.Equals(input.CallbackUrl)) ) && - ( - this.Secret == input.Secret || - (this.Secret != null && - this.Secret.Equals(input.Secret)) - ) && ( this.Scopes == input.Scopes || this.Scopes != null && @@ -164,6 +169,11 @@ public bool Equals(ApiAppResponseOAuth input) ( this.ChargesUsers == input.ChargesUsers || this.ChargesUsers.Equals(input.ChargesUsers) + ) && + ( + this.Secret == input.Secret || + (this.Secret != null && + this.Secret.Equals(input.Secret)) ); } @@ -180,15 +190,15 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.CallbackUrl.GetHashCode(); } - if (this.Secret != null) - { - hashCode = (hashCode * 59) + this.Secret.GetHashCode(); - } if (this.Scopes != null) { hashCode = (hashCode * 59) + this.Scopes.GetHashCode(); } hashCode = (hashCode * 59) + this.ChargesUsers.GetHashCode(); + if (this.Secret != null) + { + hashCode = (hashCode * 59) + this.Secret.GetHashCode(); + } return hashCode; } } @@ -213,13 +223,6 @@ public List GetOpenApiTypes() Value = CallbackUrl, }); types.Add(new OpenApiType() - { - Name = "secret", - Property = "Secret", - Type = "string", - Value = Secret, - }); - types.Add(new OpenApiType() { Name = "scopes", Property = "Scopes", @@ -233,6 +236,13 @@ public List GetOpenApiTypes() Type = "bool", Value = ChargesUsers, }); + types.Add(new OpenApiType() + { + Name = "secret", + Property = "Secret", + Type = "string", + Value = Secret, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOptions.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOptions.cs index 10d6df91a..345f572dc 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOptions.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOptions.cs @@ -41,7 +41,7 @@ protected ApiAppResponseOptions() { } /// /// Initializes a new instance of the class. /// - /// Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document. + /// Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document (required). public ApiAppResponseOptions(bool canInsertEverywhere = default(bool)) { @@ -68,7 +68,7 @@ public static ApiAppResponseOptions Init(string jsonData) /// Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document /// /// Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document - [DataMember(Name = "can_insert_everywhere", EmitDefaultValue = true)] + [DataMember(Name = "can_insert_everywhere", IsRequired = true, EmitDefaultValue = true)] public bool CanInsertEverywhere { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOwnerAccount.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOwnerAccount.cs index efb47222d..284dc155e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOwnerAccount.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOwnerAccount.cs @@ -41,12 +41,22 @@ protected ApiAppResponseOwnerAccount() { } /// /// Initializes a new instance of the class. /// - /// The owner account's ID. - /// The owner account's email address. + /// The owner account's ID (required). + /// The owner account's email address (required). public ApiAppResponseOwnerAccount(string accountId = default(string), string emailAddress = default(string)) { + // to ensure "accountId" is required (not null) + if (accountId == null) + { + throw new ArgumentNullException("accountId is a required property for ApiAppResponseOwnerAccount and cannot be null"); + } this.AccountId = accountId; + // to ensure "emailAddress" is required (not null) + if (emailAddress == null) + { + throw new ArgumentNullException("emailAddress is a required property for ApiAppResponseOwnerAccount and cannot be null"); + } this.EmailAddress = emailAddress; } @@ -70,14 +80,14 @@ public static ApiAppResponseOwnerAccount Init(string jsonData) /// The owner account's ID /// /// The owner account's ID - [DataMember(Name = "account_id", EmitDefaultValue = true)] + [DataMember(Name = "account_id", IsRequired = true, EmitDefaultValue = true)] public string AccountId { get; set; } /// /// The owner account's email address /// /// The owner account's email address - [DataMember(Name = "email_address", EmitDefaultValue = true)] + [DataMember(Name = "email_address", IsRequired = true, EmitDefaultValue = true)] public string EmailAddress { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseWhiteLabelingOptions.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseWhiteLabelingOptions.cs index 095ef8e70..005d6b50f 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseWhiteLabelingOptions.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseWhiteLabelingOptions.cs @@ -41,36 +41,106 @@ protected ApiAppResponseWhiteLabelingOptions() { } /// /// Initializes a new instance of the class. /// - /// headerBackgroundColor. - /// legalVersion. - /// linkColor. - /// pageBackgroundColor. - /// primaryButtonColor. - /// primaryButtonColorHover. - /// primaryButtonTextColor. - /// primaryButtonTextColorHover. - /// secondaryButtonColor. - /// secondaryButtonColorHover. - /// secondaryButtonTextColor. - /// secondaryButtonTextColorHover. - /// textColor1. - /// textColor2. + /// headerBackgroundColor (required). + /// legalVersion (required). + /// linkColor (required). + /// pageBackgroundColor (required). + /// primaryButtonColor (required). + /// primaryButtonColorHover (required). + /// primaryButtonTextColor (required). + /// primaryButtonTextColorHover (required). + /// secondaryButtonColor (required). + /// secondaryButtonColorHover (required). + /// secondaryButtonTextColor (required). + /// secondaryButtonTextColorHover (required). + /// textColor1 (required). + /// textColor2 (required). public ApiAppResponseWhiteLabelingOptions(string headerBackgroundColor = default(string), string legalVersion = default(string), string linkColor = default(string), string pageBackgroundColor = default(string), string primaryButtonColor = default(string), string primaryButtonColorHover = default(string), string primaryButtonTextColor = default(string), string primaryButtonTextColorHover = default(string), string secondaryButtonColor = default(string), string secondaryButtonColorHover = default(string), string secondaryButtonTextColor = default(string), string secondaryButtonTextColorHover = default(string), string textColor1 = default(string), string textColor2 = default(string)) { + // to ensure "headerBackgroundColor" is required (not null) + if (headerBackgroundColor == null) + { + throw new ArgumentNullException("headerBackgroundColor is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); + } this.HeaderBackgroundColor = headerBackgroundColor; + // to ensure "legalVersion" is required (not null) + if (legalVersion == null) + { + throw new ArgumentNullException("legalVersion is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); + } this.LegalVersion = legalVersion; + // to ensure "linkColor" is required (not null) + if (linkColor == null) + { + throw new ArgumentNullException("linkColor is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); + } this.LinkColor = linkColor; + // to ensure "pageBackgroundColor" is required (not null) + if (pageBackgroundColor == null) + { + throw new ArgumentNullException("pageBackgroundColor is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); + } this.PageBackgroundColor = pageBackgroundColor; + // to ensure "primaryButtonColor" is required (not null) + if (primaryButtonColor == null) + { + throw new ArgumentNullException("primaryButtonColor is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); + } this.PrimaryButtonColor = primaryButtonColor; + // to ensure "primaryButtonColorHover" is required (not null) + if (primaryButtonColorHover == null) + { + throw new ArgumentNullException("primaryButtonColorHover is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); + } this.PrimaryButtonColorHover = primaryButtonColorHover; + // to ensure "primaryButtonTextColor" is required (not null) + if (primaryButtonTextColor == null) + { + throw new ArgumentNullException("primaryButtonTextColor is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); + } this.PrimaryButtonTextColor = primaryButtonTextColor; + // to ensure "primaryButtonTextColorHover" is required (not null) + if (primaryButtonTextColorHover == null) + { + throw new ArgumentNullException("primaryButtonTextColorHover is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); + } this.PrimaryButtonTextColorHover = primaryButtonTextColorHover; + // to ensure "secondaryButtonColor" is required (not null) + if (secondaryButtonColor == null) + { + throw new ArgumentNullException("secondaryButtonColor is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); + } this.SecondaryButtonColor = secondaryButtonColor; + // to ensure "secondaryButtonColorHover" is required (not null) + if (secondaryButtonColorHover == null) + { + throw new ArgumentNullException("secondaryButtonColorHover is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); + } this.SecondaryButtonColorHover = secondaryButtonColorHover; + // to ensure "secondaryButtonTextColor" is required (not null) + if (secondaryButtonTextColor == null) + { + throw new ArgumentNullException("secondaryButtonTextColor is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); + } this.SecondaryButtonTextColor = secondaryButtonTextColor; + // to ensure "secondaryButtonTextColorHover" is required (not null) + if (secondaryButtonTextColorHover == null) + { + throw new ArgumentNullException("secondaryButtonTextColorHover is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); + } this.SecondaryButtonTextColorHover = secondaryButtonTextColorHover; + // to ensure "textColor1" is required (not null) + if (textColor1 == null) + { + throw new ArgumentNullException("textColor1 is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); + } this.TextColor1 = textColor1; + // to ensure "textColor2" is required (not null) + if (textColor2 == null) + { + throw new ArgumentNullException("textColor2 is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); + } this.TextColor2 = textColor2; } @@ -93,85 +163,85 @@ public static ApiAppResponseWhiteLabelingOptions Init(string jsonData) /// /// Gets or Sets HeaderBackgroundColor /// - [DataMember(Name = "header_background_color", EmitDefaultValue = true)] + [DataMember(Name = "header_background_color", IsRequired = true, EmitDefaultValue = true)] public string HeaderBackgroundColor { get; set; } /// /// Gets or Sets LegalVersion /// - [DataMember(Name = "legal_version", EmitDefaultValue = true)] + [DataMember(Name = "legal_version", IsRequired = true, EmitDefaultValue = true)] public string LegalVersion { get; set; } /// /// Gets or Sets LinkColor /// - [DataMember(Name = "link_color", EmitDefaultValue = true)] + [DataMember(Name = "link_color", IsRequired = true, EmitDefaultValue = true)] public string LinkColor { get; set; } /// /// Gets or Sets PageBackgroundColor /// - [DataMember(Name = "page_background_color", EmitDefaultValue = true)] + [DataMember(Name = "page_background_color", IsRequired = true, EmitDefaultValue = true)] public string PageBackgroundColor { get; set; } /// /// Gets or Sets PrimaryButtonColor /// - [DataMember(Name = "primary_button_color", EmitDefaultValue = true)] + [DataMember(Name = "primary_button_color", IsRequired = true, EmitDefaultValue = true)] public string PrimaryButtonColor { get; set; } /// /// Gets or Sets PrimaryButtonColorHover /// - [DataMember(Name = "primary_button_color_hover", EmitDefaultValue = true)] + [DataMember(Name = "primary_button_color_hover", IsRequired = true, EmitDefaultValue = true)] public string PrimaryButtonColorHover { get; set; } /// /// Gets or Sets PrimaryButtonTextColor /// - [DataMember(Name = "primary_button_text_color", EmitDefaultValue = true)] + [DataMember(Name = "primary_button_text_color", IsRequired = true, EmitDefaultValue = true)] public string PrimaryButtonTextColor { get; set; } /// /// Gets or Sets PrimaryButtonTextColorHover /// - [DataMember(Name = "primary_button_text_color_hover", EmitDefaultValue = true)] + [DataMember(Name = "primary_button_text_color_hover", IsRequired = true, EmitDefaultValue = true)] public string PrimaryButtonTextColorHover { get; set; } /// /// Gets or Sets SecondaryButtonColor /// - [DataMember(Name = "secondary_button_color", EmitDefaultValue = true)] + [DataMember(Name = "secondary_button_color", IsRequired = true, EmitDefaultValue = true)] public string SecondaryButtonColor { get; set; } /// /// Gets or Sets SecondaryButtonColorHover /// - [DataMember(Name = "secondary_button_color_hover", EmitDefaultValue = true)] + [DataMember(Name = "secondary_button_color_hover", IsRequired = true, EmitDefaultValue = true)] public string SecondaryButtonColorHover { get; set; } /// /// Gets or Sets SecondaryButtonTextColor /// - [DataMember(Name = "secondary_button_text_color", EmitDefaultValue = true)] + [DataMember(Name = "secondary_button_text_color", IsRequired = true, EmitDefaultValue = true)] public string SecondaryButtonTextColor { get; set; } /// /// Gets or Sets SecondaryButtonTextColorHover /// - [DataMember(Name = "secondary_button_text_color_hover", EmitDefaultValue = true)] + [DataMember(Name = "secondary_button_text_color_hover", IsRequired = true, EmitDefaultValue = true)] public string SecondaryButtonTextColorHover { get; set; } /// /// Gets or Sets TextColor1 /// - [DataMember(Name = "text_color1", EmitDefaultValue = true)] + [DataMember(Name = "text_color1", IsRequired = true, EmitDefaultValue = true)] public string TextColor1 { get; set; } /// /// Gets or Sets TextColor2 /// - [DataMember(Name = "text_color2", EmitDefaultValue = true)] + [DataMember(Name = "text_color2", IsRequired = true, EmitDefaultValue = true)] public string TextColor2 { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubWhiteLabelingOptions.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubWhiteLabelingOptions.cs index a38eaa0d7..72d4ebb30 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubWhiteLabelingOptions.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubWhiteLabelingOptions.cs @@ -66,51 +66,51 @@ protected SubWhiteLabelingOptions() { } /// /// Initializes a new instance of the class. /// - /// headerBackgroundColor (default to "#1A1A1A"). + /// headerBackgroundColor (default to "#1a1a1a"). /// legalVersion (default to LegalVersionEnum.Terms1). - /// linkColor (default to "#00B3E6"). - /// pageBackgroundColor (default to "#F7F8F9"). - /// primaryButtonColor (default to "#00B3E6"). - /// primaryButtonColorHover (default to "#00B3E6"). - /// primaryButtonTextColor (default to "#FFFFFF"). - /// primaryButtonTextColorHover (default to "#FFFFFF"). - /// secondaryButtonColor (default to "#FFFFFF"). - /// secondaryButtonColorHover (default to "#FFFFFF"). - /// secondaryButtonTextColor (default to "#00B3E6"). - /// secondaryButtonTextColorHover (default to "#00B3E6"). + /// linkColor (default to "#0061FE"). + /// pageBackgroundColor (default to "#f7f8f9"). + /// primaryButtonColor (default to "#0061FE"). + /// primaryButtonColorHover (default to "#0061FE"). + /// primaryButtonTextColor (default to "#ffffff"). + /// primaryButtonTextColorHover (default to "#ffffff"). + /// secondaryButtonColor (default to "#ffffff"). + /// secondaryButtonColorHover (default to "#ffffff"). + /// secondaryButtonTextColor (default to "#0061FE"). + /// secondaryButtonTextColorHover (default to "#0061FE"). /// textColor1 (default to "#808080"). - /// textColor2 (default to "#FFFFFF"). + /// textColor2 (default to "#ffffff"). /// Resets white labeling options to defaults. Only useful when updating an API App.. - public SubWhiteLabelingOptions(string headerBackgroundColor = @"#1A1A1A", LegalVersionEnum? legalVersion = LegalVersionEnum.Terms1, string linkColor = @"#00B3E6", string pageBackgroundColor = @"#F7F8F9", string primaryButtonColor = @"#00B3E6", string primaryButtonColorHover = @"#00B3E6", string primaryButtonTextColor = @"#FFFFFF", string primaryButtonTextColorHover = @"#FFFFFF", string secondaryButtonColor = @"#FFFFFF", string secondaryButtonColorHover = @"#FFFFFF", string secondaryButtonTextColor = @"#00B3E6", string secondaryButtonTextColorHover = @"#00B3E6", string textColor1 = @"#808080", string textColor2 = @"#FFFFFF", bool resetToDefault = default(bool)) + public SubWhiteLabelingOptions(string headerBackgroundColor = @"#1a1a1a", LegalVersionEnum? legalVersion = LegalVersionEnum.Terms1, string linkColor = @"#0061FE", string pageBackgroundColor = @"#f7f8f9", string primaryButtonColor = @"#0061FE", string primaryButtonColorHover = @"#0061FE", string primaryButtonTextColor = @"#ffffff", string primaryButtonTextColorHover = @"#ffffff", string secondaryButtonColor = @"#ffffff", string secondaryButtonColorHover = @"#ffffff", string secondaryButtonTextColor = @"#0061FE", string secondaryButtonTextColorHover = @"#0061FE", string textColor1 = @"#808080", string textColor2 = @"#ffffff", bool resetToDefault = default(bool)) { // use default value if no "headerBackgroundColor" provided - this.HeaderBackgroundColor = headerBackgroundColor ?? "#1A1A1A"; + this.HeaderBackgroundColor = headerBackgroundColor ?? "#1a1a1a"; this.LegalVersion = legalVersion; // use default value if no "linkColor" provided - this.LinkColor = linkColor ?? "#00B3E6"; + this.LinkColor = linkColor ?? "#0061FE"; // use default value if no "pageBackgroundColor" provided - this.PageBackgroundColor = pageBackgroundColor ?? "#F7F8F9"; + this.PageBackgroundColor = pageBackgroundColor ?? "#f7f8f9"; // use default value if no "primaryButtonColor" provided - this.PrimaryButtonColor = primaryButtonColor ?? "#00B3E6"; + this.PrimaryButtonColor = primaryButtonColor ?? "#0061FE"; // use default value if no "primaryButtonColorHover" provided - this.PrimaryButtonColorHover = primaryButtonColorHover ?? "#00B3E6"; + this.PrimaryButtonColorHover = primaryButtonColorHover ?? "#0061FE"; // use default value if no "primaryButtonTextColor" provided - this.PrimaryButtonTextColor = primaryButtonTextColor ?? "#FFFFFF"; + this.PrimaryButtonTextColor = primaryButtonTextColor ?? "#ffffff"; // use default value if no "primaryButtonTextColorHover" provided - this.PrimaryButtonTextColorHover = primaryButtonTextColorHover ?? "#FFFFFF"; + this.PrimaryButtonTextColorHover = primaryButtonTextColorHover ?? "#ffffff"; // use default value if no "secondaryButtonColor" provided - this.SecondaryButtonColor = secondaryButtonColor ?? "#FFFFFF"; + this.SecondaryButtonColor = secondaryButtonColor ?? "#ffffff"; // use default value if no "secondaryButtonColorHover" provided - this.SecondaryButtonColorHover = secondaryButtonColorHover ?? "#FFFFFF"; + this.SecondaryButtonColorHover = secondaryButtonColorHover ?? "#ffffff"; // use default value if no "secondaryButtonTextColor" provided - this.SecondaryButtonTextColor = secondaryButtonTextColor ?? "#00B3E6"; + this.SecondaryButtonTextColor = secondaryButtonTextColor ?? "#0061FE"; // use default value if no "secondaryButtonTextColorHover" provided - this.SecondaryButtonTextColorHover = secondaryButtonTextColorHover ?? "#00B3E6"; + this.SecondaryButtonTextColorHover = secondaryButtonTextColorHover ?? "#0061FE"; // use default value if no "textColor1" provided this.TextColor1 = textColor1 ?? "#808080"; // use default value if no "textColor2" provided - this.TextColor2 = textColor2 ?? "#FFFFFF"; + this.TextColor2 = textColor2 ?? "#ffffff"; this.ResetToDefault = resetToDefault; } diff --git a/sdks/java-v1/docs/ApiAppResponse.md b/sdks/java-v1/docs/ApiAppResponse.md index afe95c850..7eb6e967d 100644 --- a/sdks/java-v1/docs/ApiAppResponse.md +++ b/sdks/java-v1/docs/ApiAppResponse.md @@ -8,15 +8,15 @@ Contains information about an API App. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| `clientId`*_required_ | ```String``` | The app's client id | | +| `createdAt`*_required_ | ```Integer``` | The time that the app was created | | +| `domains`*_required_ | ```List``` | The domain name(s) associated with the app | | +| `name`*_required_ | ```String``` | The name of the app | | +| `isApproved`*_required_ | ```Boolean``` | Boolean to indicate if the app has been approved | | +| `options`*_required_ | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | +| `ownerAccount`*_required_ | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `callbackUrl` | ```String``` | The app's callback URL (for events) | | -| `clientId` | ```String``` | The app's client id | | -| `createdAt` | ```Integer``` | The time that the app was created | | -| `domains` | ```List``` | The domain name(s) associated with the app | | -| `name` | ```String``` | The name of the app | | -| `isApproved` | ```Boolean``` | Boolean to indicate if the app has been approved | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | -| `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | -| `ownerAccount` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `whiteLabelingOptions` | [```ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | | diff --git a/sdks/java-v1/docs/ApiAppResponseOAuth.md b/sdks/java-v1/docs/ApiAppResponseOAuth.md index c2f705c7a..93f22d3cc 100644 --- a/sdks/java-v1/docs/ApiAppResponseOAuth.md +++ b/sdks/java-v1/docs/ApiAppResponseOAuth.md @@ -8,10 +8,10 @@ An object describing the app's OAuth properties, or null if OAuth is not con | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `callbackUrl` | ```String``` | The app's OAuth callback URL. | | +| `callbackUrl`*_required_ | ```String``` | The app's OAuth callback URL. | | +| `scopes`*_required_ | ```List``` | Array of OAuth scopes used by the app. | | +| `chargesUsers`*_required_ | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | | `secret` | ```String``` | The app's OAuth secret, or null if the app does not belong to user. | | -| `scopes` | ```List``` | Array of OAuth scopes used by the app. | | -| `chargesUsers` | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | diff --git a/sdks/java-v1/docs/ApiAppResponseOptions.md b/sdks/java-v1/docs/ApiAppResponseOptions.md index 07979f387..e6694664d 100644 --- a/sdks/java-v1/docs/ApiAppResponseOptions.md +++ b/sdks/java-v1/docs/ApiAppResponseOptions.md @@ -8,7 +8,7 @@ An object with options that override account settings. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `canInsertEverywhere` | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `canInsertEverywhere`*_required_ | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | diff --git a/sdks/java-v1/docs/ApiAppResponseOwnerAccount.md b/sdks/java-v1/docs/ApiAppResponseOwnerAccount.md index b4d6d4249..a9c5142b3 100644 --- a/sdks/java-v1/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/java-v1/docs/ApiAppResponseOwnerAccount.md @@ -8,8 +8,8 @@ An object describing the app's owner | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId` | ```String``` | The owner account's ID | | -| `emailAddress` | ```String``` | The owner account's email address | | +| `accountId`*_required_ | ```String``` | The owner account's ID | | +| `emailAddress`*_required_ | ```String``` | The owner account's email address | | diff --git a/sdks/java-v1/docs/ApiAppResponseWhiteLabelingOptions.md b/sdks/java-v1/docs/ApiAppResponseWhiteLabelingOptions.md index be6d022fd..f26b0591e 100644 --- a/sdks/java-v1/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/java-v1/docs/ApiAppResponseWhiteLabelingOptions.md @@ -8,20 +8,20 @@ An object with options to customize the app's signer page | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `headerBackgroundColor` | ```String``` | | | -| `legalVersion` | ```String``` | | | -| `linkColor` | ```String``` | | | -| `pageBackgroundColor` | ```String``` | | | -| `primaryButtonColor` | ```String``` | | | -| `primaryButtonColorHover` | ```String``` | | | -| `primaryButtonTextColor` | ```String``` | | | -| `primaryButtonTextColorHover` | ```String``` | | | -| `secondaryButtonColor` | ```String``` | | | -| `secondaryButtonColorHover` | ```String``` | | | -| `secondaryButtonTextColor` | ```String``` | | | -| `secondaryButtonTextColorHover` | ```String``` | | | -| `textColor1` | ```String``` | | | -| `textColor2` | ```String``` | | | +| `headerBackgroundColor`*_required_ | ```String``` | | | +| `legalVersion`*_required_ | ```String``` | | | +| `linkColor`*_required_ | ```String``` | | | +| `pageBackgroundColor`*_required_ | ```String``` | | | +| `primaryButtonColor`*_required_ | ```String``` | | | +| `primaryButtonColorHover`*_required_ | ```String``` | | | +| `primaryButtonTextColor`*_required_ | ```String``` | | | +| `primaryButtonTextColorHover`*_required_ | ```String``` | | | +| `secondaryButtonColor`*_required_ | ```String``` | | | +| `secondaryButtonColorHover`*_required_ | ```String``` | | | +| `secondaryButtonTextColor`*_required_ | ```String``` | | | +| `secondaryButtonTextColorHover`*_required_ | ```String``` | | | +| `textColor1`*_required_ | ```String``` | | | +| `textColor2`*_required_ | ```String``` | | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponse.java index 9e5b0073d..434a38779 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponse.java @@ -27,15 +27,15 @@ /** Contains information about an API App. */ @JsonPropertyOrder({ - ApiAppResponse.JSON_PROPERTY_CALLBACK_URL, ApiAppResponse.JSON_PROPERTY_CLIENT_ID, ApiAppResponse.JSON_PROPERTY_CREATED_AT, ApiAppResponse.JSON_PROPERTY_DOMAINS, ApiAppResponse.JSON_PROPERTY_NAME, ApiAppResponse.JSON_PROPERTY_IS_APPROVED, - ApiAppResponse.JSON_PROPERTY_OAUTH, ApiAppResponse.JSON_PROPERTY_OPTIONS, ApiAppResponse.JSON_PROPERTY_OWNER_ACCOUNT, + ApiAppResponse.JSON_PROPERTY_CALLBACK_URL, + ApiAppResponse.JSON_PROPERTY_OAUTH, ApiAppResponse.JSON_PROPERTY_WHITE_LABELING_OPTIONS }) @javax.annotation.Generated( @@ -43,9 +43,6 @@ comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown = true) public class ApiAppResponse { - public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; - private String callbackUrl; - public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; private String clientId; @@ -53,7 +50,7 @@ public class ApiAppResponse { private Integer createdAt; public static final String JSON_PROPERTY_DOMAINS = "domains"; - private List domains = null; + private List domains = new ArrayList<>(); public static final String JSON_PROPERTY_NAME = "name"; private String name; @@ -61,15 +58,18 @@ public class ApiAppResponse { public static final String JSON_PROPERTY_IS_APPROVED = "is_approved"; private Boolean isApproved; - public static final String JSON_PROPERTY_OAUTH = "oauth"; - private ApiAppResponseOAuth oauth; - public static final String JSON_PROPERTY_OPTIONS = "options"; private ApiAppResponseOptions options; public static final String JSON_PROPERTY_OWNER_ACCOUNT = "owner_account"; private ApiAppResponseOwnerAccount ownerAccount; + public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; + private String callbackUrl; + + public static final String JSON_PROPERTY_OAUTH = "oauth"; + private ApiAppResponseOAuth oauth; + public static final String JSON_PROPERTY_WHITE_LABELING_OPTIONS = "white_labeling_options"; private ApiAppResponseWhiteLabelingOptions whiteLabelingOptions; @@ -89,28 +89,6 @@ public static ApiAppResponse init(HashMap data) throws Exception { .readValue(new ObjectMapper().writeValueAsString(data), ApiAppResponse.class); } - public ApiAppResponse callbackUrl(String callbackUrl) { - this.callbackUrl = callbackUrl; - return this; - } - - /** - * The app's callback URL (for events) - * - * @return callbackUrl - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getCallbackUrl() { - return callbackUrl; - } - - @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCallbackUrl(String callbackUrl) { - this.callbackUrl = callbackUrl; - } - public ApiAppResponse clientId(String clientId) { this.clientId = clientId; return this; @@ -121,14 +99,15 @@ public ApiAppResponse clientId(String clientId) { * * @return clientId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getClientId() { return clientId; } @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setClientId(String clientId) { this.clientId = clientId; } @@ -143,14 +122,15 @@ public ApiAppResponse createdAt(Integer createdAt) { * * @return createdAt */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CREATED_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getCreatedAt() { return createdAt; } @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCreatedAt(Integer createdAt) { this.createdAt = createdAt; } @@ -173,14 +153,15 @@ public ApiAppResponse addDomainsItem(String domainsItem) { * * @return domains */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_DOMAINS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DOMAINS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getDomains() { return domains; } @JsonProperty(JSON_PROPERTY_DOMAINS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setDomains(List domains) { this.domains = domains; } @@ -195,14 +176,15 @@ public ApiAppResponse name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } @@ -217,40 +199,19 @@ public ApiAppResponse isApproved(Boolean isApproved) { * * @return isApproved */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_APPROVED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_APPROVED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsApproved() { return isApproved; } @JsonProperty(JSON_PROPERTY_IS_APPROVED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsApproved(Boolean isApproved) { this.isApproved = isApproved; } - public ApiAppResponse oauth(ApiAppResponseOAuth oauth) { - this.oauth = oauth; - return this; - } - - /** - * Get oauth - * - * @return oauth - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_OAUTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public ApiAppResponseOAuth getOauth() { - return oauth; - } - - @JsonProperty(JSON_PROPERTY_OAUTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauth(ApiAppResponseOAuth oauth) { - this.oauth = oauth; - } - public ApiAppResponse options(ApiAppResponseOptions options) { this.options = options; return this; @@ -261,14 +222,15 @@ public ApiAppResponse options(ApiAppResponseOptions options) { * * @return options */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_OPTIONS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_OPTIONS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public ApiAppResponseOptions getOptions() { return options; } @JsonProperty(JSON_PROPERTY_OPTIONS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOptions(ApiAppResponseOptions options) { this.options = options; } @@ -283,18 +245,63 @@ public ApiAppResponse ownerAccount(ApiAppResponseOwnerAccount ownerAccount) { * * @return ownerAccount */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_OWNER_ACCOUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_OWNER_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public ApiAppResponseOwnerAccount getOwnerAccount() { return ownerAccount; } @JsonProperty(JSON_PROPERTY_OWNER_ACCOUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOwnerAccount(ApiAppResponseOwnerAccount ownerAccount) { this.ownerAccount = ownerAccount; } + public ApiAppResponse callbackUrl(String callbackUrl) { + this.callbackUrl = callbackUrl; + return this; + } + + /** + * The app's callback URL (for events) + * + * @return callbackUrl + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CALLBACK_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getCallbackUrl() { + return callbackUrl; + } + + @JsonProperty(JSON_PROPERTY_CALLBACK_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCallbackUrl(String callbackUrl) { + this.callbackUrl = callbackUrl; + } + + public ApiAppResponse oauth(ApiAppResponseOAuth oauth) { + this.oauth = oauth; + return this; + } + + /** + * Get oauth + * + * @return oauth + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_OAUTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public ApiAppResponseOAuth getOauth() { + return oauth; + } + + @JsonProperty(JSON_PROPERTY_OAUTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setOauth(ApiAppResponseOAuth oauth) { + this.oauth = oauth; + } + public ApiAppResponse whiteLabelingOptions( ApiAppResponseWhiteLabelingOptions whiteLabelingOptions) { this.whiteLabelingOptions = whiteLabelingOptions; @@ -328,30 +335,30 @@ public boolean equals(Object o) { return false; } ApiAppResponse apiAppResponse = (ApiAppResponse) o; - return Objects.equals(this.callbackUrl, apiAppResponse.callbackUrl) - && Objects.equals(this.clientId, apiAppResponse.clientId) + return Objects.equals(this.clientId, apiAppResponse.clientId) && Objects.equals(this.createdAt, apiAppResponse.createdAt) && Objects.equals(this.domains, apiAppResponse.domains) && Objects.equals(this.name, apiAppResponse.name) && Objects.equals(this.isApproved, apiAppResponse.isApproved) - && Objects.equals(this.oauth, apiAppResponse.oauth) && Objects.equals(this.options, apiAppResponse.options) && Objects.equals(this.ownerAccount, apiAppResponse.ownerAccount) + && Objects.equals(this.callbackUrl, apiAppResponse.callbackUrl) + && Objects.equals(this.oauth, apiAppResponse.oauth) && Objects.equals(this.whiteLabelingOptions, apiAppResponse.whiteLabelingOptions); } @Override public int hashCode() { return Objects.hash( - callbackUrl, clientId, createdAt, domains, name, isApproved, - oauth, options, ownerAccount, + callbackUrl, + oauth, whiteLabelingOptions); } @@ -359,15 +366,15 @@ public int hashCode() { public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ApiAppResponse {\n"); - sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n"); sb.append(" domains: ").append(toIndentedString(domains)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" isApproved: ").append(toIndentedString(isApproved)).append("\n"); - sb.append(" oauth: ").append(toIndentedString(oauth)).append("\n"); sb.append(" options: ").append(toIndentedString(options)).append("\n"); sb.append(" ownerAccount: ").append(toIndentedString(ownerAccount)).append("\n"); + sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); + sb.append(" oauth: ").append(toIndentedString(oauth)).append("\n"); sb.append(" whiteLabelingOptions: ") .append(toIndentedString(whiteLabelingOptions)) .append("\n"); @@ -379,26 +386,6 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { - if (callbackUrl != null) { - if (isFileTypeOrListOfFiles(callbackUrl)) { - fileTypeFound = true; - } - - if (callbackUrl.getClass().equals(java.io.File.class) - || callbackUrl.getClass().equals(Integer.class) - || callbackUrl.getClass().equals(String.class) - || callbackUrl.getClass().isEnum()) { - map.put("callback_url", callbackUrl); - } else if (isListOfFile(callbackUrl)) { - for (int i = 0; i < getListSize(callbackUrl); i++) { - map.put("callback_url[" + i + "]", getFromList(callbackUrl, i)); - } - } else { - map.put( - "callback_url", - JSON.getDefault().getMapper().writeValueAsString(callbackUrl)); - } - } if (clientId != null) { if (isFileTypeOrListOfFiles(clientId)) { fileTypeFound = true; @@ -495,24 +482,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(isApproved)); } } - if (oauth != null) { - if (isFileTypeOrListOfFiles(oauth)) { - fileTypeFound = true; - } - - if (oauth.getClass().equals(java.io.File.class) - || oauth.getClass().equals(Integer.class) - || oauth.getClass().equals(String.class) - || oauth.getClass().isEnum()) { - map.put("oauth", oauth); - } else if (isListOfFile(oauth)) { - for (int i = 0; i < getListSize(oauth); i++) { - map.put("oauth[" + i + "]", getFromList(oauth, i)); - } - } else { - map.put("oauth", JSON.getDefault().getMapper().writeValueAsString(oauth)); - } - } if (options != null) { if (isFileTypeOrListOfFiles(options)) { fileTypeFound = true; @@ -551,6 +520,44 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(ownerAccount)); } } + if (callbackUrl != null) { + if (isFileTypeOrListOfFiles(callbackUrl)) { + fileTypeFound = true; + } + + if (callbackUrl.getClass().equals(java.io.File.class) + || callbackUrl.getClass().equals(Integer.class) + || callbackUrl.getClass().equals(String.class) + || callbackUrl.getClass().isEnum()) { + map.put("callback_url", callbackUrl); + } else if (isListOfFile(callbackUrl)) { + for (int i = 0; i < getListSize(callbackUrl); i++) { + map.put("callback_url[" + i + "]", getFromList(callbackUrl, i)); + } + } else { + map.put( + "callback_url", + JSON.getDefault().getMapper().writeValueAsString(callbackUrl)); + } + } + if (oauth != null) { + if (isFileTypeOrListOfFiles(oauth)) { + fileTypeFound = true; + } + + if (oauth.getClass().equals(java.io.File.class) + || oauth.getClass().equals(Integer.class) + || oauth.getClass().equals(String.class) + || oauth.getClass().isEnum()) { + map.put("oauth", oauth); + } else if (isListOfFile(oauth)) { + for (int i = 0; i < getListSize(oauth); i++) { + map.put("oauth[" + i + "]", getFromList(oauth, i)); + } + } else { + map.put("oauth", JSON.getDefault().getMapper().writeValueAsString(oauth)); + } + } if (whiteLabelingOptions != null) { if (isFileTypeOrListOfFiles(whiteLabelingOptions)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java index 74ba41e86..71e53d84c 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java @@ -31,9 +31,9 @@ */ @JsonPropertyOrder({ ApiAppResponseOAuth.JSON_PROPERTY_CALLBACK_URL, - ApiAppResponseOAuth.JSON_PROPERTY_SECRET, ApiAppResponseOAuth.JSON_PROPERTY_SCOPES, - ApiAppResponseOAuth.JSON_PROPERTY_CHARGES_USERS + ApiAppResponseOAuth.JSON_PROPERTY_CHARGES_USERS, + ApiAppResponseOAuth.JSON_PROPERTY_SECRET }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -43,15 +43,15 @@ public class ApiAppResponseOAuth { public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; private String callbackUrl; - public static final String JSON_PROPERTY_SECRET = "secret"; - private String secret; - public static final String JSON_PROPERTY_SCOPES = "scopes"; - private List scopes = null; + private List scopes = new ArrayList<>(); public static final String JSON_PROPERTY_CHARGES_USERS = "charges_users"; private Boolean chargesUsers; + public static final String JSON_PROPERTY_SECRET = "secret"; + private String secret; + public ApiAppResponseOAuth() {} /** @@ -78,40 +78,19 @@ public ApiAppResponseOAuth callbackUrl(String callbackUrl) { * * @return callbackUrl */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CALLBACK_URL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getCallbackUrl() { return callbackUrl; } @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCallbackUrl(String callbackUrl) { this.callbackUrl = callbackUrl; } - public ApiAppResponseOAuth secret(String secret) { - this.secret = secret; - return this; - } - - /** - * The app's OAuth secret, or null if the app does not belong to user. - * - * @return secret - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getSecret() { - return secret; - } - - @JsonProperty(JSON_PROPERTY_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSecret(String secret) { - this.secret = secret; - } - public ApiAppResponseOAuth scopes(List scopes) { this.scopes = scopes; return this; @@ -130,14 +109,15 @@ public ApiAppResponseOAuth addScopesItem(String scopesItem) { * * @return scopes */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SCOPES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SCOPES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getScopes() { return scopes; } @JsonProperty(JSON_PROPERTY_SCOPES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setScopes(List scopes) { this.scopes = scopes; } @@ -153,18 +133,41 @@ public ApiAppResponseOAuth chargesUsers(Boolean chargesUsers) { * * @return chargesUsers */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CHARGES_USERS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CHARGES_USERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getChargesUsers() { return chargesUsers; } @JsonProperty(JSON_PROPERTY_CHARGES_USERS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setChargesUsers(Boolean chargesUsers) { this.chargesUsers = chargesUsers; } + public ApiAppResponseOAuth secret(String secret) { + this.secret = secret; + return this; + } + + /** + * The app's OAuth secret, or null if the app does not belong to user. + * + * @return secret + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getSecret() { + return secret; + } + + @JsonProperty(JSON_PROPERTY_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSecret(String secret) { + this.secret = secret; + } + /** Return true if this ApiAppResponseOAuth object is equal to o. */ @Override public boolean equals(Object o) { @@ -176,14 +179,14 @@ public boolean equals(Object o) { } ApiAppResponseOAuth apiAppResponseOAuth = (ApiAppResponseOAuth) o; return Objects.equals(this.callbackUrl, apiAppResponseOAuth.callbackUrl) - && Objects.equals(this.secret, apiAppResponseOAuth.secret) && Objects.equals(this.scopes, apiAppResponseOAuth.scopes) - && Objects.equals(this.chargesUsers, apiAppResponseOAuth.chargesUsers); + && Objects.equals(this.chargesUsers, apiAppResponseOAuth.chargesUsers) + && Objects.equals(this.secret, apiAppResponseOAuth.secret); } @Override public int hashCode() { - return Objects.hash(callbackUrl, secret, scopes, chargesUsers); + return Objects.hash(callbackUrl, scopes, chargesUsers, secret); } @Override @@ -191,9 +194,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ApiAppResponseOAuth {\n"); sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); - sb.append(" secret: ").append(toIndentedString(secret)).append("\n"); sb.append(" scopes: ").append(toIndentedString(scopes)).append("\n"); sb.append(" chargesUsers: ").append(toIndentedString(chargesUsers)).append("\n"); + sb.append(" secret: ").append(toIndentedString(secret)).append("\n"); sb.append("}"); return sb.toString(); } @@ -222,24 +225,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(callbackUrl)); } } - if (secret != null) { - if (isFileTypeOrListOfFiles(secret)) { - fileTypeFound = true; - } - - if (secret.getClass().equals(java.io.File.class) - || secret.getClass().equals(Integer.class) - || secret.getClass().equals(String.class) - || secret.getClass().isEnum()) { - map.put("secret", secret); - } else if (isListOfFile(secret)) { - for (int i = 0; i < getListSize(secret); i++) { - map.put("secret[" + i + "]", getFromList(secret, i)); - } - } else { - map.put("secret", JSON.getDefault().getMapper().writeValueAsString(secret)); - } - } if (scopes != null) { if (isFileTypeOrListOfFiles(scopes)) { fileTypeFound = true; @@ -278,6 +263,24 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(chargesUsers)); } } + if (secret != null) { + if (isFileTypeOrListOfFiles(secret)) { + fileTypeFound = true; + } + + if (secret.getClass().equals(java.io.File.class) + || secret.getClass().equals(Integer.class) + || secret.getClass().equals(String.class) + || secret.getClass().isEnum()) { + map.put("secret", secret); + } else if (isListOfFile(secret)) { + for (int i = 0; i < getListSize(secret); i++) { + map.put("secret[" + i + "]", getFromList(secret, i)); + } + } else { + map.put("secret", JSON.getDefault().getMapper().writeValueAsString(secret)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java index e2d672dda..4ad1d6b51 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java @@ -61,14 +61,15 @@ public ApiAppResponseOptions canInsertEverywhere(Boolean canInsertEverywhere) { * * @return canInsertEverywhere */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CAN_INSERT_EVERYWHERE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CAN_INSERT_EVERYWHERE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getCanInsertEverywhere() { return canInsertEverywhere; } @JsonProperty(JSON_PROPERTY_CAN_INSERT_EVERYWHERE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCanInsertEverywhere(Boolean canInsertEverywhere) { this.canInsertEverywhere = canInsertEverywhere; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java index 7107a4329..be257dcf7 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java @@ -67,14 +67,15 @@ public ApiAppResponseOwnerAccount 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; } @@ -89,14 +90,15 @@ public ApiAppResponseOwnerAccount emailAddress(String emailAddress) { * * @return emailAddress */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getEmailAddress() { return emailAddress; } @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setEmailAddress(String emailAddress) { this.emailAddress = emailAddress; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java index 6efd8fc40..a788eb405 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java @@ -121,14 +121,15 @@ public ApiAppResponseWhiteLabelingOptions headerBackgroundColor(String headerBac * * @return headerBackgroundColor */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEADER_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_HEADER_BACKGROUND_COLOR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getHeaderBackgroundColor() { return headerBackgroundColor; } @JsonProperty(JSON_PROPERTY_HEADER_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setHeaderBackgroundColor(String headerBackgroundColor) { this.headerBackgroundColor = headerBackgroundColor; } @@ -143,14 +144,15 @@ public ApiAppResponseWhiteLabelingOptions legalVersion(String legalVersion) { * * @return legalVersion */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_LEGAL_VERSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_LEGAL_VERSION) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getLegalVersion() { return legalVersion; } @JsonProperty(JSON_PROPERTY_LEGAL_VERSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setLegalVersion(String legalVersion) { this.legalVersion = legalVersion; } @@ -165,14 +167,15 @@ public ApiAppResponseWhiteLabelingOptions linkColor(String linkColor) { * * @return linkColor */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_LINK_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_LINK_COLOR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getLinkColor() { return linkColor; } @JsonProperty(JSON_PROPERTY_LINK_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setLinkColor(String linkColor) { this.linkColor = linkColor; } @@ -187,14 +190,15 @@ public ApiAppResponseWhiteLabelingOptions pageBackgroundColor(String pageBackgro * * @return pageBackgroundColor */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_PAGE_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_PAGE_BACKGROUND_COLOR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getPageBackgroundColor() { return pageBackgroundColor; } @JsonProperty(JSON_PROPERTY_PAGE_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setPageBackgroundColor(String pageBackgroundColor) { this.pageBackgroundColor = pageBackgroundColor; } @@ -209,14 +213,15 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonColor(String primaryButto * * @return primaryButtonColor */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getPrimaryButtonColor() { return primaryButtonColor; } @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setPrimaryButtonColor(String primaryButtonColor) { this.primaryButtonColor = primaryButtonColor; } @@ -232,14 +237,15 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonColorHover( * * @return primaryButtonColorHover */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getPrimaryButtonColorHover() { return primaryButtonColorHover; } @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setPrimaryButtonColorHover(String primaryButtonColorHover) { this.primaryButtonColorHover = primaryButtonColorHover; } @@ -255,14 +261,15 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonTextColor( * * @return primaryButtonTextColor */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getPrimaryButtonTextColor() { return primaryButtonTextColor; } @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setPrimaryButtonTextColor(String primaryButtonTextColor) { this.primaryButtonTextColor = primaryButtonTextColor; } @@ -278,14 +285,15 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonTextColorHover( * * @return primaryButtonTextColorHover */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getPrimaryButtonTextColorHover() { return primaryButtonTextColorHover; } @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setPrimaryButtonTextColorHover(String primaryButtonTextColorHover) { this.primaryButtonTextColorHover = primaryButtonTextColorHover; } @@ -300,14 +308,15 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonColor(String secondaryB * * @return secondaryButtonColor */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSecondaryButtonColor() { return secondaryButtonColor; } @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSecondaryButtonColor(String secondaryButtonColor) { this.secondaryButtonColor = secondaryButtonColor; } @@ -323,14 +332,15 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonColorHover( * * @return secondaryButtonColorHover */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSecondaryButtonColorHover() { return secondaryButtonColorHover; } @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSecondaryButtonColorHover(String secondaryButtonColorHover) { this.secondaryButtonColorHover = secondaryButtonColorHover; } @@ -346,14 +356,15 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonTextColor( * * @return secondaryButtonTextColor */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSecondaryButtonTextColor() { return secondaryButtonTextColor; } @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSecondaryButtonTextColor(String secondaryButtonTextColor) { this.secondaryButtonTextColor = secondaryButtonTextColor; } @@ -369,14 +380,15 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonTextColorHover( * * @return secondaryButtonTextColorHover */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSecondaryButtonTextColorHover() { return secondaryButtonTextColorHover; } @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSecondaryButtonTextColorHover(String secondaryButtonTextColorHover) { this.secondaryButtonTextColorHover = secondaryButtonTextColorHover; } @@ -391,14 +403,15 @@ public ApiAppResponseWhiteLabelingOptions textColor1(String textColor1) { * * @return textColor1 */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEXT_COLOR1) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEXT_COLOR1) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTextColor1() { return textColor1; } @JsonProperty(JSON_PROPERTY_TEXT_COLOR1) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTextColor1(String textColor1) { this.textColor1 = textColor1; } @@ -413,14 +426,15 @@ public ApiAppResponseWhiteLabelingOptions textColor2(String textColor2) { * * @return textColor2 */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEXT_COLOR2) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEXT_COLOR2) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTextColor2() { return textColor2; } @JsonProperty(JSON_PROPERTY_TEXT_COLOR2) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTextColor2(String textColor2) { this.textColor2 = textColor2; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java index 450ca3d7c..2737e1b6d 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java @@ -53,7 +53,7 @@ @JsonIgnoreProperties(ignoreUnknown = true) public class SubWhiteLabelingOptions { public static final String JSON_PROPERTY_HEADER_BACKGROUND_COLOR = "header_background_color"; - private String headerBackgroundColor = "#1A1A1A"; + private String headerBackgroundColor = "#1a1a1a"; /** Gets or Sets legalVersion */ public enum LegalVersionEnum { @@ -92,46 +92,46 @@ public static LegalVersionEnum fromValue(String value) { private LegalVersionEnum legalVersion = LegalVersionEnum.TERMS1; public static final String JSON_PROPERTY_LINK_COLOR = "link_color"; - private String linkColor = "#00B3E6"; + private String linkColor = "#0061FE"; public static final String JSON_PROPERTY_PAGE_BACKGROUND_COLOR = "page_background_color"; - private String pageBackgroundColor = "#F7F8F9"; + private String pageBackgroundColor = "#f7f8f9"; public static final String JSON_PROPERTY_PRIMARY_BUTTON_COLOR = "primary_button_color"; - private String primaryButtonColor = "#00B3E6"; + private String primaryButtonColor = "#0061FE"; public static final String JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER = "primary_button_color_hover"; - private String primaryButtonColorHover = "#00B3E6"; + private String primaryButtonColorHover = "#0061FE"; public static final String JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR = "primary_button_text_color"; - private String primaryButtonTextColor = "#FFFFFF"; + private String primaryButtonTextColor = "#ffffff"; public static final String JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER = "primary_button_text_color_hover"; - private String primaryButtonTextColorHover = "#FFFFFF"; + private String primaryButtonTextColorHover = "#ffffff"; public static final String JSON_PROPERTY_SECONDARY_BUTTON_COLOR = "secondary_button_color"; - private String secondaryButtonColor = "#FFFFFF"; + private String secondaryButtonColor = "#ffffff"; public static final String JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER = "secondary_button_color_hover"; - private String secondaryButtonColorHover = "#FFFFFF"; + private String secondaryButtonColorHover = "#ffffff"; public static final String JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR = "secondary_button_text_color"; - private String secondaryButtonTextColor = "#00B3E6"; + private String secondaryButtonTextColor = "#0061FE"; public static final String JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER = "secondary_button_text_color_hover"; - private String secondaryButtonTextColorHover = "#00B3E6"; + private String secondaryButtonTextColorHover = "#0061FE"; public static final String JSON_PROPERTY_TEXT_COLOR1 = "text_color1"; private String textColor1 = "#808080"; public static final String JSON_PROPERTY_TEXT_COLOR2 = "text_color2"; - private String textColor2 = "#FFFFFF"; + private String textColor2 = "#ffffff"; public static final String JSON_PROPERTY_RESET_TO_DEFAULT = "reset_to_default"; private Boolean resetToDefault; diff --git a/sdks/java-v2/docs/ApiAppResponse.md b/sdks/java-v2/docs/ApiAppResponse.md index afe95c850..7eb6e967d 100644 --- a/sdks/java-v2/docs/ApiAppResponse.md +++ b/sdks/java-v2/docs/ApiAppResponse.md @@ -8,15 +8,15 @@ Contains information about an API App. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| `clientId`*_required_ | ```String``` | The app's client id | | +| `createdAt`*_required_ | ```Integer``` | The time that the app was created | | +| `domains`*_required_ | ```List``` | The domain name(s) associated with the app | | +| `name`*_required_ | ```String``` | The name of the app | | +| `isApproved`*_required_ | ```Boolean``` | Boolean to indicate if the app has been approved | | +| `options`*_required_ | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | +| `ownerAccount`*_required_ | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `callbackUrl` | ```String``` | The app's callback URL (for events) | | -| `clientId` | ```String``` | The app's client id | | -| `createdAt` | ```Integer``` | The time that the app was created | | -| `domains` | ```List``` | The domain name(s) associated with the app | | -| `name` | ```String``` | The name of the app | | -| `isApproved` | ```Boolean``` | Boolean to indicate if the app has been approved | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | -| `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | -| `ownerAccount` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `whiteLabelingOptions` | [```ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | | diff --git a/sdks/java-v2/docs/ApiAppResponseOAuth.md b/sdks/java-v2/docs/ApiAppResponseOAuth.md index c2f705c7a..93f22d3cc 100644 --- a/sdks/java-v2/docs/ApiAppResponseOAuth.md +++ b/sdks/java-v2/docs/ApiAppResponseOAuth.md @@ -8,10 +8,10 @@ An object describing the app's OAuth properties, or null if OAuth is not con | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `callbackUrl` | ```String``` | The app's OAuth callback URL. | | +| `callbackUrl`*_required_ | ```String``` | The app's OAuth callback URL. | | +| `scopes`*_required_ | ```List``` | Array of OAuth scopes used by the app. | | +| `chargesUsers`*_required_ | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | | `secret` | ```String``` | The app's OAuth secret, or null if the app does not belong to user. | | -| `scopes` | ```List``` | Array of OAuth scopes used by the app. | | -| `chargesUsers` | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | diff --git a/sdks/java-v2/docs/ApiAppResponseOptions.md b/sdks/java-v2/docs/ApiAppResponseOptions.md index 07979f387..e6694664d 100644 --- a/sdks/java-v2/docs/ApiAppResponseOptions.md +++ b/sdks/java-v2/docs/ApiAppResponseOptions.md @@ -8,7 +8,7 @@ An object with options that override account settings. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `canInsertEverywhere` | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `canInsertEverywhere`*_required_ | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | diff --git a/sdks/java-v2/docs/ApiAppResponseOwnerAccount.md b/sdks/java-v2/docs/ApiAppResponseOwnerAccount.md index b4d6d4249..a9c5142b3 100644 --- a/sdks/java-v2/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/java-v2/docs/ApiAppResponseOwnerAccount.md @@ -8,8 +8,8 @@ An object describing the app's owner | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId` | ```String``` | The owner account's ID | | -| `emailAddress` | ```String``` | The owner account's email address | | +| `accountId`*_required_ | ```String``` | The owner account's ID | | +| `emailAddress`*_required_ | ```String``` | The owner account's email address | | diff --git a/sdks/java-v2/docs/ApiAppResponseWhiteLabelingOptions.md b/sdks/java-v2/docs/ApiAppResponseWhiteLabelingOptions.md index be6d022fd..f26b0591e 100644 --- a/sdks/java-v2/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/java-v2/docs/ApiAppResponseWhiteLabelingOptions.md @@ -8,20 +8,20 @@ An object with options to customize the app's signer page | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `headerBackgroundColor` | ```String``` | | | -| `legalVersion` | ```String``` | | | -| `linkColor` | ```String``` | | | -| `pageBackgroundColor` | ```String``` | | | -| `primaryButtonColor` | ```String``` | | | -| `primaryButtonColorHover` | ```String``` | | | -| `primaryButtonTextColor` | ```String``` | | | -| `primaryButtonTextColorHover` | ```String``` | | | -| `secondaryButtonColor` | ```String``` | | | -| `secondaryButtonColorHover` | ```String``` | | | -| `secondaryButtonTextColor` | ```String``` | | | -| `secondaryButtonTextColorHover` | ```String``` | | | -| `textColor1` | ```String``` | | | -| `textColor2` | ```String``` | | | +| `headerBackgroundColor`*_required_ | ```String``` | | | +| `legalVersion`*_required_ | ```String``` | | | +| `linkColor`*_required_ | ```String``` | | | +| `pageBackgroundColor`*_required_ | ```String``` | | | +| `primaryButtonColor`*_required_ | ```String``` | | | +| `primaryButtonColorHover`*_required_ | ```String``` | | | +| `primaryButtonTextColor`*_required_ | ```String``` | | | +| `primaryButtonTextColorHover`*_required_ | ```String``` | | | +| `secondaryButtonColor`*_required_ | ```String``` | | | +| `secondaryButtonColorHover`*_required_ | ```String``` | | | +| `secondaryButtonTextColor`*_required_ | ```String``` | | | +| `secondaryButtonTextColorHover`*_required_ | ```String``` | | | +| `textColor1`*_required_ | ```String``` | | | +| `textColor2`*_required_ | ```String``` | | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponse.java index ee5f12eaf..a77dd8745 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponse.java @@ -39,23 +39,20 @@ * Contains information about an API App. */ @JsonPropertyOrder({ - ApiAppResponse.JSON_PROPERTY_CALLBACK_URL, ApiAppResponse.JSON_PROPERTY_CLIENT_ID, ApiAppResponse.JSON_PROPERTY_CREATED_AT, ApiAppResponse.JSON_PROPERTY_DOMAINS, ApiAppResponse.JSON_PROPERTY_NAME, ApiAppResponse.JSON_PROPERTY_IS_APPROVED, - ApiAppResponse.JSON_PROPERTY_OAUTH, ApiAppResponse.JSON_PROPERTY_OPTIONS, ApiAppResponse.JSON_PROPERTY_OWNER_ACCOUNT, + ApiAppResponse.JSON_PROPERTY_CALLBACK_URL, + ApiAppResponse.JSON_PROPERTY_OAUTH, ApiAppResponse.JSON_PROPERTY_WHITE_LABELING_OPTIONS }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ApiAppResponse { - public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; - private String callbackUrl; - public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; private String clientId; @@ -63,7 +60,7 @@ public class ApiAppResponse { private Integer createdAt; public static final String JSON_PROPERTY_DOMAINS = "domains"; - private List domains = null; + private List domains = new ArrayList<>(); public static final String JSON_PROPERTY_NAME = "name"; private String name; @@ -71,15 +68,18 @@ public class ApiAppResponse { public static final String JSON_PROPERTY_IS_APPROVED = "is_approved"; private Boolean isApproved; - public static final String JSON_PROPERTY_OAUTH = "oauth"; - private ApiAppResponseOAuth oauth; - public static final String JSON_PROPERTY_OPTIONS = "options"; private ApiAppResponseOptions options; public static final String JSON_PROPERTY_OWNER_ACCOUNT = "owner_account"; private ApiAppResponseOwnerAccount ownerAccount; + public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; + private String callbackUrl; + + public static final String JSON_PROPERTY_OAUTH = "oauth"; + private ApiAppResponseOAuth oauth; + public static final String JSON_PROPERTY_WHITE_LABELING_OPTIONS = "white_labeling_options"; private ApiAppResponseWhiteLabelingOptions whiteLabelingOptions; @@ -101,31 +101,6 @@ static public ApiAppResponse init(HashMap data) throws Exception { ); } - public ApiAppResponse callbackUrl(String callbackUrl) { - this.callbackUrl = callbackUrl; - return this; - } - - /** - * The app's callback URL (for events) - * @return callbackUrl - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCallbackUrl() { - return callbackUrl; - } - - - @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCallbackUrl(String callbackUrl) { - this.callbackUrl = callbackUrl; - } - - public ApiAppResponse clientId(String clientId) { this.clientId = clientId; return this; @@ -135,9 +110,9 @@ public ApiAppResponse clientId(String clientId) { * The app's client id * @return clientId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getClientId() { return clientId; @@ -145,7 +120,7 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setClientId(String clientId) { this.clientId = clientId; } @@ -160,9 +135,9 @@ public ApiAppResponse createdAt(Integer createdAt) { * The time that the app was created * @return createdAt */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getCreatedAt() { return createdAt; @@ -170,7 +145,7 @@ public Integer getCreatedAt() { @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCreatedAt(Integer createdAt) { this.createdAt = createdAt; } @@ -193,9 +168,9 @@ public ApiAppResponse addDomainsItem(String domainsItem) { * The domain name(s) associated with the app * @return domains */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_DOMAINS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getDomains() { return domains; @@ -203,7 +178,7 @@ public List getDomains() { @JsonProperty(JSON_PROPERTY_DOMAINS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setDomains(List domains) { this.domains = domains; } @@ -218,9 +193,9 @@ public ApiAppResponse name(String name) { * The name of the app * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -228,7 +203,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } @@ -243,9 +218,9 @@ public ApiAppResponse isApproved(Boolean isApproved) { * Boolean to indicate if the app has been approved * @return isApproved */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_APPROVED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsApproved() { return isApproved; @@ -253,37 +228,12 @@ public Boolean getIsApproved() { @JsonProperty(JSON_PROPERTY_IS_APPROVED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsApproved(Boolean isApproved) { this.isApproved = isApproved; } - public ApiAppResponse oauth(ApiAppResponseOAuth oauth) { - this.oauth = oauth; - return this; - } - - /** - * Get oauth - * @return oauth - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ApiAppResponseOAuth getOauth() { - return oauth; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauth(ApiAppResponseOAuth oauth) { - this.oauth = oauth; - } - - public ApiAppResponse options(ApiAppResponseOptions options) { this.options = options; return this; @@ -293,9 +243,9 @@ public ApiAppResponse options(ApiAppResponseOptions options) { * Get options * @return options */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_OPTIONS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public ApiAppResponseOptions getOptions() { return options; @@ -303,7 +253,7 @@ public ApiAppResponseOptions getOptions() { @JsonProperty(JSON_PROPERTY_OPTIONS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOptions(ApiAppResponseOptions options) { this.options = options; } @@ -318,9 +268,9 @@ public ApiAppResponse ownerAccount(ApiAppResponseOwnerAccount ownerAccount) { * Get ownerAccount * @return ownerAccount */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_OWNER_ACCOUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public ApiAppResponseOwnerAccount getOwnerAccount() { return ownerAccount; @@ -328,12 +278,62 @@ public ApiAppResponseOwnerAccount getOwnerAccount() { @JsonProperty(JSON_PROPERTY_OWNER_ACCOUNT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOwnerAccount(ApiAppResponseOwnerAccount ownerAccount) { this.ownerAccount = ownerAccount; } + public ApiAppResponse callbackUrl(String callbackUrl) { + this.callbackUrl = callbackUrl; + return this; + } + + /** + * The app's callback URL (for events) + * @return callbackUrl + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CALLBACK_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCallbackUrl() { + return callbackUrl; + } + + + @JsonProperty(JSON_PROPERTY_CALLBACK_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCallbackUrl(String callbackUrl) { + this.callbackUrl = callbackUrl; + } + + + public ApiAppResponse oauth(ApiAppResponseOAuth oauth) { + this.oauth = oauth; + return this; + } + + /** + * Get oauth + * @return oauth + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_OAUTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public ApiAppResponseOAuth getOauth() { + return oauth; + } + + + @JsonProperty(JSON_PROPERTY_OAUTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setOauth(ApiAppResponseOAuth oauth) { + this.oauth = oauth; + } + + public ApiAppResponse whiteLabelingOptions(ApiAppResponseWhiteLabelingOptions whiteLabelingOptions) { this.whiteLabelingOptions = whiteLabelingOptions; return this; @@ -371,36 +371,36 @@ public boolean equals(Object o) { return false; } ApiAppResponse apiAppResponse = (ApiAppResponse) o; - return Objects.equals(this.callbackUrl, apiAppResponse.callbackUrl) && - Objects.equals(this.clientId, apiAppResponse.clientId) && + return Objects.equals(this.clientId, apiAppResponse.clientId) && Objects.equals(this.createdAt, apiAppResponse.createdAt) && Objects.equals(this.domains, apiAppResponse.domains) && Objects.equals(this.name, apiAppResponse.name) && Objects.equals(this.isApproved, apiAppResponse.isApproved) && - Objects.equals(this.oauth, apiAppResponse.oauth) && Objects.equals(this.options, apiAppResponse.options) && Objects.equals(this.ownerAccount, apiAppResponse.ownerAccount) && + Objects.equals(this.callbackUrl, apiAppResponse.callbackUrl) && + Objects.equals(this.oauth, apiAppResponse.oauth) && Objects.equals(this.whiteLabelingOptions, apiAppResponse.whiteLabelingOptions); } @Override public int hashCode() { - return Objects.hash(callbackUrl, clientId, createdAt, domains, name, isApproved, oauth, options, ownerAccount, whiteLabelingOptions); + return Objects.hash(clientId, createdAt, domains, name, isApproved, options, ownerAccount, callbackUrl, oauth, whiteLabelingOptions); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ApiAppResponse {\n"); - sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n"); sb.append(" domains: ").append(toIndentedString(domains)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" isApproved: ").append(toIndentedString(isApproved)).append("\n"); - sb.append(" oauth: ").append(toIndentedString(oauth)).append("\n"); sb.append(" options: ").append(toIndentedString(options)).append("\n"); sb.append(" ownerAccount: ").append(toIndentedString(ownerAccount)).append("\n"); + sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); + sb.append(" oauth: ").append(toIndentedString(oauth)).append("\n"); sb.append(" whiteLabelingOptions: ").append(toIndentedString(whiteLabelingOptions)).append("\n"); sb.append("}"); return sb.toString(); @@ -410,25 +410,6 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { - if (callbackUrl != null) { - if (isFileTypeOrListOfFiles(callbackUrl)) { - fileTypeFound = true; - } - - if (callbackUrl.getClass().equals(java.io.File.class) || - callbackUrl.getClass().equals(Integer.class) || - callbackUrl.getClass().equals(String.class) || - callbackUrl.getClass().isEnum()) { - map.put("callback_url", callbackUrl); - } else if (isListOfFile(callbackUrl)) { - for(int i = 0; i< getListSize(callbackUrl); i++) { - map.put("callback_url[" + i + "]", getFromList(callbackUrl, i)); - } - } - else { - map.put("callback_url", JSON.getDefault().getMapper().writeValueAsString(callbackUrl)); - } - } if (clientId != null) { if (isFileTypeOrListOfFiles(clientId)) { fileTypeFound = true; @@ -524,25 +505,6 @@ public Map createFormData() throws ApiException { map.put("is_approved", JSON.getDefault().getMapper().writeValueAsString(isApproved)); } } - if (oauth != null) { - if (isFileTypeOrListOfFiles(oauth)) { - fileTypeFound = true; - } - - if (oauth.getClass().equals(java.io.File.class) || - oauth.getClass().equals(Integer.class) || - oauth.getClass().equals(String.class) || - oauth.getClass().isEnum()) { - map.put("oauth", oauth); - } else if (isListOfFile(oauth)) { - for(int i = 0; i< getListSize(oauth); i++) { - map.put("oauth[" + i + "]", getFromList(oauth, i)); - } - } - else { - map.put("oauth", JSON.getDefault().getMapper().writeValueAsString(oauth)); - } - } if (options != null) { if (isFileTypeOrListOfFiles(options)) { fileTypeFound = true; @@ -581,6 +543,44 @@ public Map createFormData() throws ApiException { map.put("owner_account", JSON.getDefault().getMapper().writeValueAsString(ownerAccount)); } } + if (callbackUrl != null) { + if (isFileTypeOrListOfFiles(callbackUrl)) { + fileTypeFound = true; + } + + if (callbackUrl.getClass().equals(java.io.File.class) || + callbackUrl.getClass().equals(Integer.class) || + callbackUrl.getClass().equals(String.class) || + callbackUrl.getClass().isEnum()) { + map.put("callback_url", callbackUrl); + } else if (isListOfFile(callbackUrl)) { + for(int i = 0; i< getListSize(callbackUrl); i++) { + map.put("callback_url[" + i + "]", getFromList(callbackUrl, i)); + } + } + else { + map.put("callback_url", JSON.getDefault().getMapper().writeValueAsString(callbackUrl)); + } + } + if (oauth != null) { + if (isFileTypeOrListOfFiles(oauth)) { + fileTypeFound = true; + } + + if (oauth.getClass().equals(java.io.File.class) || + oauth.getClass().equals(Integer.class) || + oauth.getClass().equals(String.class) || + oauth.getClass().isEnum()) { + map.put("oauth", oauth); + } else if (isListOfFile(oauth)) { + for(int i = 0; i< getListSize(oauth); i++) { + map.put("oauth[" + i + "]", getFromList(oauth, i)); + } + } + else { + map.put("oauth", JSON.getDefault().getMapper().writeValueAsString(oauth)); + } + } if (whiteLabelingOptions != null) { if (isFileTypeOrListOfFiles(whiteLabelingOptions)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java index b071e4067..ae0ebedbd 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java @@ -36,9 +36,9 @@ */ @JsonPropertyOrder({ ApiAppResponseOAuth.JSON_PROPERTY_CALLBACK_URL, - ApiAppResponseOAuth.JSON_PROPERTY_SECRET, ApiAppResponseOAuth.JSON_PROPERTY_SCOPES, - ApiAppResponseOAuth.JSON_PROPERTY_CHARGES_USERS + ApiAppResponseOAuth.JSON_PROPERTY_CHARGES_USERS, + ApiAppResponseOAuth.JSON_PROPERTY_SECRET }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -46,15 +46,15 @@ public class ApiAppResponseOAuth { public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; private String callbackUrl; - public static final String JSON_PROPERTY_SECRET = "secret"; - private String secret; - public static final String JSON_PROPERTY_SCOPES = "scopes"; - private List scopes = null; + private List scopes = new ArrayList<>(); public static final String JSON_PROPERTY_CHARGES_USERS = "charges_users"; private Boolean chargesUsers; + public static final String JSON_PROPERTY_SECRET = "secret"; + private String secret; + public ApiAppResponseOAuth() { } @@ -82,9 +82,9 @@ public ApiAppResponseOAuth callbackUrl(String callbackUrl) { * The app's OAuth callback URL. * @return callbackUrl */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getCallbackUrl() { return callbackUrl; @@ -92,37 +92,12 @@ public String getCallbackUrl() { @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCallbackUrl(String callbackUrl) { this.callbackUrl = callbackUrl; } - public ApiAppResponseOAuth secret(String secret) { - this.secret = secret; - return this; - } - - /** - * The app's OAuth secret, or null if the app does not belong to user. - * @return secret - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSecret() { - return secret; - } - - - @JsonProperty(JSON_PROPERTY_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSecret(String secret) { - this.secret = secret; - } - - public ApiAppResponseOAuth scopes(List scopes) { this.scopes = scopes; return this; @@ -140,9 +115,9 @@ public ApiAppResponseOAuth addScopesItem(String scopesItem) { * Array of OAuth scopes used by the app. * @return scopes */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_SCOPES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getScopes() { return scopes; @@ -150,7 +125,7 @@ public List getScopes() { @JsonProperty(JSON_PROPERTY_SCOPES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setScopes(List scopes) { this.scopes = scopes; } @@ -165,9 +140,9 @@ public ApiAppResponseOAuth chargesUsers(Boolean chargesUsers) { * Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. * @return chargesUsers */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_CHARGES_USERS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getChargesUsers() { return chargesUsers; @@ -175,12 +150,37 @@ public Boolean getChargesUsers() { @JsonProperty(JSON_PROPERTY_CHARGES_USERS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setChargesUsers(Boolean chargesUsers) { this.chargesUsers = chargesUsers; } + public ApiAppResponseOAuth secret(String secret) { + this.secret = secret; + return this; + } + + /** + * The app's OAuth secret, or null if the app does not belong to user. + * @return secret + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSecret() { + return secret; + } + + + @JsonProperty(JSON_PROPERTY_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSecret(String secret) { + this.secret = secret; + } + + /** * Return true if this ApiAppResponseOAuth object is equal to o. */ @@ -194,14 +194,14 @@ public boolean equals(Object o) { } ApiAppResponseOAuth apiAppResponseOAuth = (ApiAppResponseOAuth) o; return Objects.equals(this.callbackUrl, apiAppResponseOAuth.callbackUrl) && - Objects.equals(this.secret, apiAppResponseOAuth.secret) && Objects.equals(this.scopes, apiAppResponseOAuth.scopes) && - Objects.equals(this.chargesUsers, apiAppResponseOAuth.chargesUsers); + Objects.equals(this.chargesUsers, apiAppResponseOAuth.chargesUsers) && + Objects.equals(this.secret, apiAppResponseOAuth.secret); } @Override public int hashCode() { - return Objects.hash(callbackUrl, secret, scopes, chargesUsers); + return Objects.hash(callbackUrl, scopes, chargesUsers, secret); } @Override @@ -209,9 +209,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ApiAppResponseOAuth {\n"); sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); - sb.append(" secret: ").append(toIndentedString(secret)).append("\n"); sb.append(" scopes: ").append(toIndentedString(scopes)).append("\n"); sb.append(" chargesUsers: ").append(toIndentedString(chargesUsers)).append("\n"); + sb.append(" secret: ").append(toIndentedString(secret)).append("\n"); sb.append("}"); return sb.toString(); } @@ -239,25 +239,6 @@ public Map createFormData() throws ApiException { map.put("callback_url", JSON.getDefault().getMapper().writeValueAsString(callbackUrl)); } } - if (secret != null) { - if (isFileTypeOrListOfFiles(secret)) { - fileTypeFound = true; - } - - if (secret.getClass().equals(java.io.File.class) || - secret.getClass().equals(Integer.class) || - secret.getClass().equals(String.class) || - secret.getClass().isEnum()) { - map.put("secret", secret); - } else if (isListOfFile(secret)) { - for(int i = 0; i< getListSize(secret); i++) { - map.put("secret[" + i + "]", getFromList(secret, i)); - } - } - else { - map.put("secret", JSON.getDefault().getMapper().writeValueAsString(secret)); - } - } if (scopes != null) { if (isFileTypeOrListOfFiles(scopes)) { fileTypeFound = true; @@ -296,6 +277,25 @@ public Map createFormData() throws ApiException { map.put("charges_users", JSON.getDefault().getMapper().writeValueAsString(chargesUsers)); } } + if (secret != null) { + if (isFileTypeOrListOfFiles(secret)) { + fileTypeFound = true; + } + + if (secret.getClass().equals(java.io.File.class) || + secret.getClass().equals(Integer.class) || + secret.getClass().equals(String.class) || + secret.getClass().isEnum()) { + map.put("secret", secret); + } else if (isListOfFile(secret)) { + for(int i = 0; i< getListSize(secret); i++) { + map.put("secret[" + i + "]", getFromList(secret, i)); + } + } + else { + map.put("secret", JSON.getDefault().getMapper().writeValueAsString(secret)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java index 2cffd69d5..8ef6ba51f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java @@ -68,9 +68,9 @@ public ApiAppResponseOptions canInsertEverywhere(Boolean canInsertEverywhere) { * Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document * @return canInsertEverywhere */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_CAN_INSERT_EVERYWHERE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getCanInsertEverywhere() { return canInsertEverywhere; @@ -78,7 +78,7 @@ public Boolean getCanInsertEverywhere() { @JsonProperty(JSON_PROPERTY_CAN_INSERT_EVERYWHERE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCanInsertEverywhere(Boolean canInsertEverywhere) { this.canInsertEverywhere = canInsertEverywhere; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java index 80f95b50a..f1e350634 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java @@ -72,9 +72,9 @@ public ApiAppResponseOwnerAccount accountId(String accountId) { * The owner account's ID * @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; @@ -82,7 +82,7 @@ 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; } @@ -97,9 +97,9 @@ public ApiAppResponseOwnerAccount emailAddress(String emailAddress) { * The owner account's email address * @return emailAddress */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getEmailAddress() { return emailAddress; @@ -107,7 +107,7 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setEmailAddress(String emailAddress) { this.emailAddress = emailAddress; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java index 44b6f6e1e..9f0fb11d3 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java @@ -120,9 +120,9 @@ public ApiAppResponseWhiteLabelingOptions headerBackgroundColor(String headerBac * Get headerBackgroundColor * @return headerBackgroundColor */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_HEADER_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getHeaderBackgroundColor() { return headerBackgroundColor; @@ -130,7 +130,7 @@ public String getHeaderBackgroundColor() { @JsonProperty(JSON_PROPERTY_HEADER_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setHeaderBackgroundColor(String headerBackgroundColor) { this.headerBackgroundColor = headerBackgroundColor; } @@ -145,9 +145,9 @@ public ApiAppResponseWhiteLabelingOptions legalVersion(String legalVersion) { * Get legalVersion * @return legalVersion */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_LEGAL_VERSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getLegalVersion() { return legalVersion; @@ -155,7 +155,7 @@ public String getLegalVersion() { @JsonProperty(JSON_PROPERTY_LEGAL_VERSION) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setLegalVersion(String legalVersion) { this.legalVersion = legalVersion; } @@ -170,9 +170,9 @@ public ApiAppResponseWhiteLabelingOptions linkColor(String linkColor) { * Get linkColor * @return linkColor */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_LINK_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getLinkColor() { return linkColor; @@ -180,7 +180,7 @@ public String getLinkColor() { @JsonProperty(JSON_PROPERTY_LINK_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setLinkColor(String linkColor) { this.linkColor = linkColor; } @@ -195,9 +195,9 @@ public ApiAppResponseWhiteLabelingOptions pageBackgroundColor(String pageBackgro * Get pageBackgroundColor * @return pageBackgroundColor */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_PAGE_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getPageBackgroundColor() { return pageBackgroundColor; @@ -205,7 +205,7 @@ public String getPageBackgroundColor() { @JsonProperty(JSON_PROPERTY_PAGE_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setPageBackgroundColor(String pageBackgroundColor) { this.pageBackgroundColor = pageBackgroundColor; } @@ -220,9 +220,9 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonColor(String primaryButto * Get primaryButtonColor * @return primaryButtonColor */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getPrimaryButtonColor() { return primaryButtonColor; @@ -230,7 +230,7 @@ public String getPrimaryButtonColor() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setPrimaryButtonColor(String primaryButtonColor) { this.primaryButtonColor = primaryButtonColor; } @@ -245,9 +245,9 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonColorHover(String primary * Get primaryButtonColorHover * @return primaryButtonColorHover */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getPrimaryButtonColorHover() { return primaryButtonColorHover; @@ -255,7 +255,7 @@ public String getPrimaryButtonColorHover() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setPrimaryButtonColorHover(String primaryButtonColorHover) { this.primaryButtonColorHover = primaryButtonColorHover; } @@ -270,9 +270,9 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonTextColor(String primaryB * Get primaryButtonTextColor * @return primaryButtonTextColor */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getPrimaryButtonTextColor() { return primaryButtonTextColor; @@ -280,7 +280,7 @@ public String getPrimaryButtonTextColor() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setPrimaryButtonTextColor(String primaryButtonTextColor) { this.primaryButtonTextColor = primaryButtonTextColor; } @@ -295,9 +295,9 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonTextColorHover(String pri * Get primaryButtonTextColorHover * @return primaryButtonTextColorHover */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getPrimaryButtonTextColorHover() { return primaryButtonTextColorHover; @@ -305,7 +305,7 @@ public String getPrimaryButtonTextColorHover() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setPrimaryButtonTextColorHover(String primaryButtonTextColorHover) { this.primaryButtonTextColorHover = primaryButtonTextColorHover; } @@ -320,9 +320,9 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonColor(String secondaryB * Get secondaryButtonColor * @return secondaryButtonColor */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSecondaryButtonColor() { return secondaryButtonColor; @@ -330,7 +330,7 @@ public String getSecondaryButtonColor() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSecondaryButtonColor(String secondaryButtonColor) { this.secondaryButtonColor = secondaryButtonColor; } @@ -345,9 +345,9 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonColorHover(String secon * Get secondaryButtonColorHover * @return secondaryButtonColorHover */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSecondaryButtonColorHover() { return secondaryButtonColorHover; @@ -355,7 +355,7 @@ public String getSecondaryButtonColorHover() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSecondaryButtonColorHover(String secondaryButtonColorHover) { this.secondaryButtonColorHover = secondaryButtonColorHover; } @@ -370,9 +370,9 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonTextColor(String second * Get secondaryButtonTextColor * @return secondaryButtonTextColor */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSecondaryButtonTextColor() { return secondaryButtonTextColor; @@ -380,7 +380,7 @@ public String getSecondaryButtonTextColor() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSecondaryButtonTextColor(String secondaryButtonTextColor) { this.secondaryButtonTextColor = secondaryButtonTextColor; } @@ -395,9 +395,9 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonTextColorHover(String s * Get secondaryButtonTextColorHover * @return secondaryButtonTextColorHover */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSecondaryButtonTextColorHover() { return secondaryButtonTextColorHover; @@ -405,7 +405,7 @@ public String getSecondaryButtonTextColorHover() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSecondaryButtonTextColorHover(String secondaryButtonTextColorHover) { this.secondaryButtonTextColorHover = secondaryButtonTextColorHover; } @@ -420,9 +420,9 @@ public ApiAppResponseWhiteLabelingOptions textColor1(String textColor1) { * Get textColor1 * @return textColor1 */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TEXT_COLOR1) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTextColor1() { return textColor1; @@ -430,7 +430,7 @@ public String getTextColor1() { @JsonProperty(JSON_PROPERTY_TEXT_COLOR1) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTextColor1(String textColor1) { this.textColor1 = textColor1; } @@ -445,9 +445,9 @@ public ApiAppResponseWhiteLabelingOptions textColor2(String textColor2) { * Get textColor2 * @return textColor2 */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TEXT_COLOR2) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTextColor2() { return textColor2; @@ -455,7 +455,7 @@ public String getTextColor2() { @JsonProperty(JSON_PROPERTY_TEXT_COLOR2) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTextColor2(String textColor2) { this.textColor2 = textColor2; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java index 4f0a57b1f..a14d8cc1a 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java @@ -53,7 +53,7 @@ @JsonIgnoreProperties(ignoreUnknown=true) public class SubWhiteLabelingOptions { public static final String JSON_PROPERTY_HEADER_BACKGROUND_COLOR = "header_background_color"; - private String headerBackgroundColor = "#1A1A1A"; + private String headerBackgroundColor = "#1a1a1a"; /** * Gets or Sets legalVersion @@ -94,40 +94,40 @@ public static LegalVersionEnum fromValue(String value) { private LegalVersionEnum legalVersion = LegalVersionEnum.TERMS1; public static final String JSON_PROPERTY_LINK_COLOR = "link_color"; - private String linkColor = "#00B3E6"; + private String linkColor = "#0061FE"; public static final String JSON_PROPERTY_PAGE_BACKGROUND_COLOR = "page_background_color"; - private String pageBackgroundColor = "#F7F8F9"; + private String pageBackgroundColor = "#f7f8f9"; public static final String JSON_PROPERTY_PRIMARY_BUTTON_COLOR = "primary_button_color"; - private String primaryButtonColor = "#00B3E6"; + private String primaryButtonColor = "#0061FE"; public static final String JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER = "primary_button_color_hover"; - private String primaryButtonColorHover = "#00B3E6"; + private String primaryButtonColorHover = "#0061FE"; public static final String JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR = "primary_button_text_color"; - private String primaryButtonTextColor = "#FFFFFF"; + private String primaryButtonTextColor = "#ffffff"; public static final String JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER = "primary_button_text_color_hover"; - private String primaryButtonTextColorHover = "#FFFFFF"; + private String primaryButtonTextColorHover = "#ffffff"; public static final String JSON_PROPERTY_SECONDARY_BUTTON_COLOR = "secondary_button_color"; - private String secondaryButtonColor = "#FFFFFF"; + private String secondaryButtonColor = "#ffffff"; public static final String JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER = "secondary_button_color_hover"; - private String secondaryButtonColorHover = "#FFFFFF"; + private String secondaryButtonColorHover = "#ffffff"; public static final String JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR = "secondary_button_text_color"; - private String secondaryButtonTextColor = "#00B3E6"; + private String secondaryButtonTextColor = "#0061FE"; public static final String JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER = "secondary_button_text_color_hover"; - private String secondaryButtonTextColorHover = "#00B3E6"; + private String secondaryButtonTextColorHover = "#0061FE"; public static final String JSON_PROPERTY_TEXT_COLOR1 = "text_color1"; private String textColor1 = "#808080"; public static final String JSON_PROPERTY_TEXT_COLOR2 = "text_color2"; - private String textColor2 = "#FFFFFF"; + private String textColor2 = "#ffffff"; public static final String JSON_PROPERTY_RESET_TO_DEFAULT = "reset_to_default"; private Boolean resetToDefault; diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 69fdca0c9..94fc0d284 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -16784,11 +16784,6 @@ var _ApiAppResponse = class { var ApiAppResponse = _ApiAppResponse; ApiAppResponse.discriminator = void 0; ApiAppResponse.attributeTypeMap = [ - { - name: "callbackUrl", - baseName: "callback_url", - type: "string" - }, { name: "clientId", baseName: "client_id", @@ -16814,11 +16809,6 @@ ApiAppResponse.attributeTypeMap = [ baseName: "is_approved", type: "boolean" }, - { - name: "oauth", - baseName: "oauth", - type: "ApiAppResponseOAuth" - }, { name: "options", baseName: "options", @@ -16829,6 +16819,16 @@ ApiAppResponse.attributeTypeMap = [ baseName: "owner_account", type: "ApiAppResponseOwnerAccount" }, + { + name: "callbackUrl", + baseName: "callback_url", + type: "string" + }, + { + name: "oauth", + baseName: "oauth", + type: "ApiAppResponseOAuth" + }, { name: "whiteLabelingOptions", baseName: "white_labeling_options", @@ -16853,11 +16853,6 @@ ApiAppResponseOAuth.attributeTypeMap = [ baseName: "callback_url", type: "string" }, - { - name: "secret", - baseName: "secret", - type: "string" - }, { name: "scopes", baseName: "scopes", @@ -16867,6 +16862,11 @@ ApiAppResponseOAuth.attributeTypeMap = [ name: "chargesUsers", baseName: "charges_users", type: "boolean" + }, + { + name: "secret", + baseName: "secret", + type: "string" } ]; @@ -21433,20 +21433,20 @@ SubUnclaimedDraftTemplateSigner.attributeTypeMap = [ // model/subWhiteLabelingOptions.ts var _SubWhiteLabelingOptions = class { constructor() { - this["headerBackgroundColor"] = "#1A1A1A"; + this["headerBackgroundColor"] = "#1a1a1a"; this["legalVersion"] = _SubWhiteLabelingOptions.LegalVersionEnum.Terms1; - this["linkColor"] = "#00B3E6"; - this["pageBackgroundColor"] = "#F7F8F9"; - this["primaryButtonColor"] = "#00B3E6"; - this["primaryButtonColorHover"] = "#00B3E6"; - this["primaryButtonTextColor"] = "#FFFFFF"; - this["primaryButtonTextColorHover"] = "#FFFFFF"; - this["secondaryButtonColor"] = "#FFFFFF"; - this["secondaryButtonColorHover"] = "#FFFFFF"; - this["secondaryButtonTextColor"] = "#00B3E6"; - this["secondaryButtonTextColorHover"] = "#00B3E6"; + this["linkColor"] = "#0061FE"; + this["pageBackgroundColor"] = "#f7f8f9"; + this["primaryButtonColor"] = "#0061FE"; + this["primaryButtonColorHover"] = "#0061FE"; + this["primaryButtonTextColor"] = "#ffffff"; + this["primaryButtonTextColorHover"] = "#ffffff"; + this["secondaryButtonColor"] = "#ffffff"; + this["secondaryButtonColorHover"] = "#ffffff"; + this["secondaryButtonTextColor"] = "#0061FE"; + this["secondaryButtonTextColorHover"] = "#0061FE"; this["textColor1"] = "#808080"; - this["textColor2"] = "#FFFFFF"; + this["textColor2"] = "#ffffff"; } static getAttributeTypeMap() { return _SubWhiteLabelingOptions.attributeTypeMap; diff --git a/sdks/node/docs/model/ApiAppResponse.md b/sdks/node/docs/model/ApiAppResponse.md index 4c0e4a9ca..19ff0fc6c 100644 --- a/sdks/node/docs/model/ApiAppResponse.md +++ b/sdks/node/docs/model/ApiAppResponse.md @@ -6,15 +6,15 @@ Contains information about an API App. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `clientId`*_required_ | ```string``` | The app's client id | | +| `createdAt`*_required_ | ```number``` | The time that the app was created | | +| `domains`*_required_ | ```Array``` | The domain name(s) associated with the app | | +| `name`*_required_ | ```string``` | The name of the app | | +| `isApproved`*_required_ | ```boolean``` | Boolean to indicate if the app has been approved | | +| `options`*_required_ | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | +| `ownerAccount`*_required_ | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `callbackUrl` | ```string``` | The app's callback URL (for events) | | -| `clientId` | ```string``` | The app's client id | | -| `createdAt` | ```number``` | The time that the app was created | | -| `domains` | ```Array``` | The domain name(s) associated with the app | | -| `name` | ```string``` | The name of the app | | -| `isApproved` | ```boolean``` | Boolean to indicate if the app has been approved | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | -| `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | -| `ownerAccount` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `whiteLabelingOptions` | [```ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | | [[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/ApiAppResponseOAuth.md b/sdks/node/docs/model/ApiAppResponseOAuth.md index 5f3376c3e..f0ecb2872 100644 --- a/sdks/node/docs/model/ApiAppResponseOAuth.md +++ b/sdks/node/docs/model/ApiAppResponseOAuth.md @@ -6,9 +6,9 @@ An object describing the app's OAuth properties, or null if OAuth is not con Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callbackUrl` | ```string``` | The app's OAuth callback URL. | | +| `callbackUrl`*_required_ | ```string``` | The app's OAuth callback URL. | | +| `scopes`*_required_ | ```Array``` | Array of OAuth scopes used by the app. | | +| `chargesUsers`*_required_ | ```boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | | `secret` | ```string``` | The app's OAuth secret, or null if the app does not belong to user. | | -| `scopes` | ```Array``` | Array of OAuth scopes used by the app. | | -| `chargesUsers` | ```boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | [[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/ApiAppResponseOptions.md b/sdks/node/docs/model/ApiAppResponseOptions.md index 2a3fcbabc..28dde9c26 100644 --- a/sdks/node/docs/model/ApiAppResponseOptions.md +++ b/sdks/node/docs/model/ApiAppResponseOptions.md @@ -6,6 +6,6 @@ An object with options that override account settings. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `canInsertEverywhere` | ```boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `canInsertEverywhere`*_required_ | ```boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | [[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/ApiAppResponseOwnerAccount.md b/sdks/node/docs/model/ApiAppResponseOwnerAccount.md index 5d1001008..8d25a2b50 100644 --- a/sdks/node/docs/model/ApiAppResponseOwnerAccount.md +++ b/sdks/node/docs/model/ApiAppResponseOwnerAccount.md @@ -6,7 +6,7 @@ An object describing the app's owner Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `accountId` | ```string``` | The owner account's ID | | -| `emailAddress` | ```string``` | The owner account's email address | | +| `accountId`*_required_ | ```string``` | The owner account's ID | | +| `emailAddress`*_required_ | ```string``` | The owner account's email address | | [[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/ApiAppResponseWhiteLabelingOptions.md b/sdks/node/docs/model/ApiAppResponseWhiteLabelingOptions.md index 927f4521e..fc420ef4c 100644 --- a/sdks/node/docs/model/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/node/docs/model/ApiAppResponseWhiteLabelingOptions.md @@ -6,19 +6,19 @@ An object with options to customize the app's signer page Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `headerBackgroundColor` | ```string``` | | | -| `legalVersion` | ```string``` | | | -| `linkColor` | ```string``` | | | -| `pageBackgroundColor` | ```string``` | | | -| `primaryButtonColor` | ```string``` | | | -| `primaryButtonColorHover` | ```string``` | | | -| `primaryButtonTextColor` | ```string``` | | | -| `primaryButtonTextColorHover` | ```string``` | | | -| `secondaryButtonColor` | ```string``` | | | -| `secondaryButtonColorHover` | ```string``` | | | -| `secondaryButtonTextColor` | ```string``` | | | -| `secondaryButtonTextColorHover` | ```string``` | | | -| `textColor1` | ```string``` | | | -| `textColor2` | ```string``` | | | +| `headerBackgroundColor`*_required_ | ```string``` | | | +| `legalVersion`*_required_ | ```string``` | | | +| `linkColor`*_required_ | ```string``` | | | +| `pageBackgroundColor`*_required_ | ```string``` | | | +| `primaryButtonColor`*_required_ | ```string``` | | | +| `primaryButtonColorHover`*_required_ | ```string``` | | | +| `primaryButtonTextColor`*_required_ | ```string``` | | | +| `primaryButtonTextColorHover`*_required_ | ```string``` | | | +| `secondaryButtonColor`*_required_ | ```string``` | | | +| `secondaryButtonColorHover`*_required_ | ```string``` | | | +| `secondaryButtonTextColor`*_required_ | ```string``` | | | +| `secondaryButtonTextColorHover`*_required_ | ```string``` | | | +| `textColor1`*_required_ | ```string``` | | | +| `textColor2`*_required_ | ```string``` | | | [[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/SubWhiteLabelingOptions.md b/sdks/node/docs/model/SubWhiteLabelingOptions.md index 6306db07d..b800c3f6b 100644 --- a/sdks/node/docs/model/SubWhiteLabelingOptions.md +++ b/sdks/node/docs/model/SubWhiteLabelingOptions.md @@ -8,20 +8,20 @@ Take a look at our [white labeling guide](https://developers.hellosign.com/api/r Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `headerBackgroundColor` | ```string``` | | [default to '#1A1A1A'] | +| `headerBackgroundColor` | ```string``` | | [default to '#1a1a1a'] | | `legalVersion` | ```string``` | | [default to LegalVersionEnum.Terms1] | -| `linkColor` | ```string``` | | [default to '#00B3E6'] | -| `pageBackgroundColor` | ```string``` | | [default to '#F7F8F9'] | -| `primaryButtonColor` | ```string``` | | [default to '#00B3E6'] | -| `primaryButtonColorHover` | ```string``` | | [default to '#00B3E6'] | -| `primaryButtonTextColor` | ```string``` | | [default to '#FFFFFF'] | -| `primaryButtonTextColorHover` | ```string``` | | [default to '#FFFFFF'] | -| `secondaryButtonColor` | ```string``` | | [default to '#FFFFFF'] | -| `secondaryButtonColorHover` | ```string``` | | [default to '#FFFFFF'] | -| `secondaryButtonTextColor` | ```string``` | | [default to '#00B3E6'] | -| `secondaryButtonTextColorHover` | ```string``` | | [default to '#00B3E6'] | +| `linkColor` | ```string``` | | [default to '#0061FE'] | +| `pageBackgroundColor` | ```string``` | | [default to '#f7f8f9'] | +| `primaryButtonColor` | ```string``` | | [default to '#0061FE'] | +| `primaryButtonColorHover` | ```string``` | | [default to '#0061FE'] | +| `primaryButtonTextColor` | ```string``` | | [default to '#ffffff'] | +| `primaryButtonTextColorHover` | ```string``` | | [default to '#ffffff'] | +| `secondaryButtonColor` | ```string``` | | [default to '#ffffff'] | +| `secondaryButtonColorHover` | ```string``` | | [default to '#ffffff'] | +| `secondaryButtonTextColor` | ```string``` | | [default to '#0061FE'] | +| `secondaryButtonTextColorHover` | ```string``` | | [default to '#0061FE'] | | `textColor1` | ```string``` | | [default to '#808080'] | -| `textColor2` | ```string``` | | [default to '#FFFFFF'] | +| `textColor2` | ```string``` | | [default to '#ffffff'] | | `resetToDefault` | ```boolean``` | Resets white labeling options to defaults. Only useful when updating an API App. | | [[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/apiAppResponse.ts b/sdks/node/model/apiAppResponse.ts index 167b3eb15..848cab40a 100644 --- a/sdks/node/model/apiAppResponse.ts +++ b/sdks/node/model/apiAppResponse.ts @@ -32,43 +32,38 @@ import { ApiAppResponseWhiteLabelingOptions } from "./apiAppResponseWhiteLabelin * Contains information about an API App. */ export class ApiAppResponse { - /** - * The app\'s callback URL (for events) - */ - "callbackUrl"?: string | null; /** * The app\'s client id */ - "clientId"?: string; + "clientId": string; /** * The time that the app was created */ - "createdAt"?: number; + "createdAt": number; /** * The domain name(s) associated with the app */ - "domains"?: Array; + "domains": Array; /** * The name of the app */ - "name"?: string; + "name": string; /** * Boolean to indicate if the app has been approved */ - "isApproved"?: boolean; + "isApproved": boolean; + "options": ApiAppResponseOptions; + "ownerAccount": ApiAppResponseOwnerAccount; + /** + * The app\'s callback URL (for events) + */ + "callbackUrl"?: string | null; "oauth"?: ApiAppResponseOAuth | null; - "options"?: ApiAppResponseOptions | null; - "ownerAccount"?: ApiAppResponseOwnerAccount; "whiteLabelingOptions"?: ApiAppResponseWhiteLabelingOptions | null; static discriminator: string | undefined = undefined; static attributeTypeMap: AttributeTypeMap = [ - { - name: "callbackUrl", - baseName: "callback_url", - type: "string", - }, { name: "clientId", baseName: "client_id", @@ -94,11 +89,6 @@ export class ApiAppResponse { baseName: "is_approved", type: "boolean", }, - { - name: "oauth", - baseName: "oauth", - type: "ApiAppResponseOAuth", - }, { name: "options", baseName: "options", @@ -109,6 +99,16 @@ export class ApiAppResponse { baseName: "owner_account", type: "ApiAppResponseOwnerAccount", }, + { + name: "callbackUrl", + baseName: "callback_url", + type: "string", + }, + { + name: "oauth", + baseName: "oauth", + type: "ApiAppResponseOAuth", + }, { name: "whiteLabelingOptions", baseName: "white_labeling_options", diff --git a/sdks/node/model/apiAppResponseOAuth.ts b/sdks/node/model/apiAppResponseOAuth.ts index bd8d8fd29..9399bad82 100644 --- a/sdks/node/model/apiAppResponseOAuth.ts +++ b/sdks/node/model/apiAppResponseOAuth.ts @@ -31,19 +31,19 @@ export class ApiAppResponseOAuth { /** * The app\'s OAuth callback URL. */ - "callbackUrl"?: string; - /** - * The app\'s OAuth secret, or null if the app does not belong to user. - */ - "secret"?: string; + "callbackUrl": string; /** * Array of OAuth scopes used by the app. */ - "scopes"?: Array; + "scopes": Array; /** * Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. */ - "chargesUsers"?: boolean; + "chargesUsers": boolean; + /** + * The app\'s OAuth secret, or null if the app does not belong to user. + */ + "secret"?: string | null; static discriminator: string | undefined = undefined; @@ -53,11 +53,6 @@ export class ApiAppResponseOAuth { baseName: "callback_url", type: "string", }, - { - name: "secret", - baseName: "secret", - type: "string", - }, { name: "scopes", baseName: "scopes", @@ -68,6 +63,11 @@ export class ApiAppResponseOAuth { baseName: "charges_users", type: "boolean", }, + { + name: "secret", + baseName: "secret", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/apiAppResponseOptions.ts b/sdks/node/model/apiAppResponseOptions.ts index 3d36cd672..8f121b054 100644 --- a/sdks/node/model/apiAppResponseOptions.ts +++ b/sdks/node/model/apiAppResponseOptions.ts @@ -31,7 +31,7 @@ export class ApiAppResponseOptions { /** * Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document */ - "canInsertEverywhere"?: boolean; + "canInsertEverywhere": boolean; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/apiAppResponseOwnerAccount.ts b/sdks/node/model/apiAppResponseOwnerAccount.ts index 8abfae818..89d0a6735 100644 --- a/sdks/node/model/apiAppResponseOwnerAccount.ts +++ b/sdks/node/model/apiAppResponseOwnerAccount.ts @@ -31,11 +31,11 @@ export class ApiAppResponseOwnerAccount { /** * The owner account\'s ID */ - "accountId"?: string; + "accountId": string; /** * The owner account\'s email address */ - "emailAddress"?: string; + "emailAddress": string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/apiAppResponseWhiteLabelingOptions.ts b/sdks/node/model/apiAppResponseWhiteLabelingOptions.ts index 6c4beeebe..0ee36f0aa 100644 --- a/sdks/node/model/apiAppResponseWhiteLabelingOptions.ts +++ b/sdks/node/model/apiAppResponseWhiteLabelingOptions.ts @@ -28,20 +28,20 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; * An object with options to customize the app\'s signer page */ export class ApiAppResponseWhiteLabelingOptions { - "headerBackgroundColor"?: string; - "legalVersion"?: string; - "linkColor"?: string; - "pageBackgroundColor"?: string; - "primaryButtonColor"?: string; - "primaryButtonColorHover"?: string; - "primaryButtonTextColor"?: string; - "primaryButtonTextColorHover"?: string; - "secondaryButtonColor"?: string; - "secondaryButtonColorHover"?: string; - "secondaryButtonTextColor"?: string; - "secondaryButtonTextColorHover"?: string; - "textColor1"?: string; - "textColor2"?: string; + "headerBackgroundColor": string; + "legalVersion": string; + "linkColor": string; + "pageBackgroundColor": string; + "primaryButtonColor": string; + "primaryButtonColorHover": string; + "primaryButtonTextColor": string; + "primaryButtonTextColorHover": string; + "secondaryButtonColor": string; + "secondaryButtonColorHover": string; + "secondaryButtonTextColor": string; + "secondaryButtonTextColorHover": string; + "textColor1": string; + "textColor2": string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/subWhiteLabelingOptions.ts b/sdks/node/model/subWhiteLabelingOptions.ts index 17a64f32e..0c1c50286 100644 --- a/sdks/node/model/subWhiteLabelingOptions.ts +++ b/sdks/node/model/subWhiteLabelingOptions.ts @@ -28,21 +28,21 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; * An array of elements and values serialized to a string, to be used to customize the app\'s signer page. (Only applies to some API plans) Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. */ export class SubWhiteLabelingOptions { - "headerBackgroundColor"?: string = "#1A1A1A"; + "headerBackgroundColor"?: string = "#1a1a1a"; "legalVersion"?: SubWhiteLabelingOptions.LegalVersionEnum = SubWhiteLabelingOptions.LegalVersionEnum.Terms1; - "linkColor"?: string = "#00B3E6"; - "pageBackgroundColor"?: string = "#F7F8F9"; - "primaryButtonColor"?: string = "#00B3E6"; - "primaryButtonColorHover"?: string = "#00B3E6"; - "primaryButtonTextColor"?: string = "#FFFFFF"; - "primaryButtonTextColorHover"?: string = "#FFFFFF"; - "secondaryButtonColor"?: string = "#FFFFFF"; - "secondaryButtonColorHover"?: string = "#FFFFFF"; - "secondaryButtonTextColor"?: string = "#00B3E6"; - "secondaryButtonTextColorHover"?: string = "#00B3E6"; + "linkColor"?: string = "#0061FE"; + "pageBackgroundColor"?: string = "#f7f8f9"; + "primaryButtonColor"?: string = "#0061FE"; + "primaryButtonColorHover"?: string = "#0061FE"; + "primaryButtonTextColor"?: string = "#ffffff"; + "primaryButtonTextColorHover"?: string = "#ffffff"; + "secondaryButtonColor"?: string = "#ffffff"; + "secondaryButtonColorHover"?: string = "#ffffff"; + "secondaryButtonTextColor"?: string = "#0061FE"; + "secondaryButtonTextColorHover"?: string = "#0061FE"; "textColor1"?: string = "#808080"; - "textColor2"?: string = "#FFFFFF"; + "textColor2"?: string = "#ffffff"; /** * Resets white labeling options to defaults. Only useful when updating an API App. */ diff --git a/sdks/node/types/model/apiAppResponse.d.ts b/sdks/node/types/model/apiAppResponse.d.ts index f0646b2c4..a85692e95 100644 --- a/sdks/node/types/model/apiAppResponse.d.ts +++ b/sdks/node/types/model/apiAppResponse.d.ts @@ -4,15 +4,15 @@ import { ApiAppResponseOptions } from "./apiAppResponseOptions"; import { ApiAppResponseOwnerAccount } from "./apiAppResponseOwnerAccount"; import { ApiAppResponseWhiteLabelingOptions } from "./apiAppResponseWhiteLabelingOptions"; export declare class ApiAppResponse { + "clientId": string; + "createdAt": number; + "domains": Array; + "name": string; + "isApproved": boolean; + "options": ApiAppResponseOptions; + "ownerAccount": ApiAppResponseOwnerAccount; "callbackUrl"?: string | null; - "clientId"?: string; - "createdAt"?: number; - "domains"?: Array; - "name"?: string; - "isApproved"?: boolean; "oauth"?: ApiAppResponseOAuth | null; - "options"?: ApiAppResponseOptions | null; - "ownerAccount"?: ApiAppResponseOwnerAccount; "whiteLabelingOptions"?: ApiAppResponseWhiteLabelingOptions | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/apiAppResponseOAuth.d.ts b/sdks/node/types/model/apiAppResponseOAuth.d.ts index 13f00a82d..23a7e12b1 100644 --- a/sdks/node/types/model/apiAppResponseOAuth.d.ts +++ b/sdks/node/types/model/apiAppResponseOAuth.d.ts @@ -1,9 +1,9 @@ import { AttributeTypeMap } from "./"; export declare class ApiAppResponseOAuth { - "callbackUrl"?: string; - "secret"?: string; - "scopes"?: Array; - "chargesUsers"?: boolean; + "callbackUrl": string; + "scopes": Array; + "chargesUsers": boolean; + "secret"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/apiAppResponseOptions.d.ts b/sdks/node/types/model/apiAppResponseOptions.d.ts index 2b869e068..19814cffe 100644 --- a/sdks/node/types/model/apiAppResponseOptions.d.ts +++ b/sdks/node/types/model/apiAppResponseOptions.d.ts @@ -1,6 +1,6 @@ import { AttributeTypeMap } from "./"; export declare class ApiAppResponseOptions { - "canInsertEverywhere"?: boolean; + "canInsertEverywhere": boolean; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/apiAppResponseOwnerAccount.d.ts b/sdks/node/types/model/apiAppResponseOwnerAccount.d.ts index a1e4d7c5f..4a415c72d 100644 --- a/sdks/node/types/model/apiAppResponseOwnerAccount.d.ts +++ b/sdks/node/types/model/apiAppResponseOwnerAccount.d.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "./"; export declare class ApiAppResponseOwnerAccount { - "accountId"?: string; - "emailAddress"?: string; + "accountId": string; + "emailAddress": string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/apiAppResponseWhiteLabelingOptions.d.ts b/sdks/node/types/model/apiAppResponseWhiteLabelingOptions.d.ts index 67ce3d5e8..ada78a6bc 100644 --- a/sdks/node/types/model/apiAppResponseWhiteLabelingOptions.d.ts +++ b/sdks/node/types/model/apiAppResponseWhiteLabelingOptions.d.ts @@ -1,19 +1,19 @@ import { AttributeTypeMap } from "./"; export declare class ApiAppResponseWhiteLabelingOptions { - "headerBackgroundColor"?: string; - "legalVersion"?: string; - "linkColor"?: string; - "pageBackgroundColor"?: string; - "primaryButtonColor"?: string; - "primaryButtonColorHover"?: string; - "primaryButtonTextColor"?: string; - "primaryButtonTextColorHover"?: string; - "secondaryButtonColor"?: string; - "secondaryButtonColorHover"?: string; - "secondaryButtonTextColor"?: string; - "secondaryButtonTextColorHover"?: string; - "textColor1"?: string; - "textColor2"?: string; + "headerBackgroundColor": string; + "legalVersion": string; + "linkColor": string; + "pageBackgroundColor": string; + "primaryButtonColor": string; + "primaryButtonColorHover": string; + "primaryButtonTextColor": string; + "primaryButtonTextColorHover": string; + "secondaryButtonColor": string; + "secondaryButtonColorHover": string; + "secondaryButtonTextColor": string; + "secondaryButtonTextColorHover": string; + "textColor1": string; + "textColor2": string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/php/docs/Model/ApiAppResponse.md b/sdks/php/docs/Model/ApiAppResponse.md index 975df4b5c..389d4f22d 100644 --- a/sdks/php/docs/Model/ApiAppResponse.md +++ b/sdks/php/docs/Model/ApiAppResponse.md @@ -6,15 +6,15 @@ Contains information about an API App. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `client_id`*_required_ | ```string``` | The app's client id | | +| `created_at`*_required_ | ```int``` | The time that the app was created | | +| `domains`*_required_ | ```string[]``` | The domain name(s) associated with the app | | +| `name`*_required_ | ```string``` | The name of the app | | +| `is_approved`*_required_ | ```bool``` | Boolean to indicate if the app has been approved | | +| `options`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | +| `owner_account`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `callback_url` | ```string``` | The app's callback URL (for events) | | -| `client_id` | ```string``` | The app's client id | | -| `created_at` | ```int``` | The time that the app was created | | -| `domains` | ```string[]``` | The domain name(s) associated with the app | | -| `name` | ```string``` | The name of the app | | -| `is_approved` | ```bool``` | Boolean to indicate if the app has been approved | | | `oauth` | [```\Dropbox\Sign\Model\ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | -| `options` | [```\Dropbox\Sign\Model\ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | -| `owner_account` | [```\Dropbox\Sign\Model\ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `white_labeling_options` | [```\Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | | [[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/ApiAppResponseOAuth.md b/sdks/php/docs/Model/ApiAppResponseOAuth.md index f6010fe20..b6b938d1f 100644 --- a/sdks/php/docs/Model/ApiAppResponseOAuth.md +++ b/sdks/php/docs/Model/ApiAppResponseOAuth.md @@ -6,9 +6,9 @@ An object describing the app's OAuth properties, or null if OAuth is not con Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```string``` | The app's OAuth callback URL. | | +| `callback_url`*_required_ | ```string``` | The app's OAuth callback URL. | | +| `scopes`*_required_ | ```string[]``` | Array of OAuth scopes used by the app. | | +| `charges_users`*_required_ | ```bool``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | | `secret` | ```string``` | The app's OAuth secret, or null if the app does not belong to user. | | -| `scopes` | ```string[]``` | Array of OAuth scopes used by the app. | | -| `charges_users` | ```bool``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | [[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/ApiAppResponseOptions.md b/sdks/php/docs/Model/ApiAppResponseOptions.md index 872e8ed0f..7aa892f36 100644 --- a/sdks/php/docs/Model/ApiAppResponseOptions.md +++ b/sdks/php/docs/Model/ApiAppResponseOptions.md @@ -6,6 +6,6 @@ An object with options that override account settings. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `can_insert_everywhere` | ```bool``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `can_insert_everywhere`*_required_ | ```bool``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | [[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/ApiAppResponseOwnerAccount.md b/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md index 8f1ce1963..2d3a9256d 100644 --- a/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md +++ b/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md @@ -6,7 +6,7 @@ An object describing the app's owner Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | The owner account's ID | | -| `email_address` | ```string``` | The owner account's email address | | +| `account_id`*_required_ | ```string``` | The owner account's ID | | +| `email_address`*_required_ | ```string``` | The owner account's email address | | [[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/ApiAppResponseWhiteLabelingOptions.md b/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md index 6e963383c..49b3472b6 100644 --- a/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md @@ -6,19 +6,19 @@ An object with options to customize the app's signer page Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `header_background_color` | ```string``` | | | -| `legal_version` | ```string``` | | | -| `link_color` | ```string``` | | | -| `page_background_color` | ```string``` | | | -| `primary_button_color` | ```string``` | | | -| `primary_button_color_hover` | ```string``` | | | -| `primary_button_text_color` | ```string``` | | | -| `primary_button_text_color_hover` | ```string``` | | | -| `secondary_button_color` | ```string``` | | | -| `secondary_button_color_hover` | ```string``` | | | -| `secondary_button_text_color` | ```string``` | | | -| `secondary_button_text_color_hover` | ```string``` | | | -| `text_color1` | ```string``` | | | -| `text_color2` | ```string``` | | | +| `header_background_color`*_required_ | ```string``` | | | +| `legal_version`*_required_ | ```string``` | | | +| `link_color`*_required_ | ```string``` | | | +| `page_background_color`*_required_ | ```string``` | | | +| `primary_button_color`*_required_ | ```string``` | | | +| `primary_button_color_hover`*_required_ | ```string``` | | | +| `primary_button_text_color`*_required_ | ```string``` | | | +| `primary_button_text_color_hover`*_required_ | ```string``` | | | +| `secondary_button_color`*_required_ | ```string``` | | | +| `secondary_button_color_hover`*_required_ | ```string``` | | | +| `secondary_button_text_color`*_required_ | ```string``` | | | +| `secondary_button_text_color_hover`*_required_ | ```string``` | | | +| `text_color1`*_required_ | ```string``` | | | +| `text_color2`*_required_ | ```string``` | | | [[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/SubWhiteLabelingOptions.md b/sdks/php/docs/Model/SubWhiteLabelingOptions.md index a8a07faac..976f55aaa 100644 --- a/sdks/php/docs/Model/SubWhiteLabelingOptions.md +++ b/sdks/php/docs/Model/SubWhiteLabelingOptions.md @@ -8,20 +8,20 @@ Take a look at our [white labeling guide](https://developers.hellosign.com/api/r Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `header_background_color` | ```string``` | | [default to '#1A1A1A'] | +| `header_background_color` | ```string``` | | [default to '#1a1a1a'] | | `legal_version` | ```string``` | | [default to 'terms1'] | -| `link_color` | ```string``` | | [default to '#00B3E6'] | -| `page_background_color` | ```string``` | | [default to '#F7F8F9'] | -| `primary_button_color` | ```string``` | | [default to '#00B3E6'] | -| `primary_button_color_hover` | ```string``` | | [default to '#00B3E6'] | -| `primary_button_text_color` | ```string``` | | [default to '#FFFFFF'] | -| `primary_button_text_color_hover` | ```string``` | | [default to '#FFFFFF'] | -| `secondary_button_color` | ```string``` | | [default to '#FFFFFF'] | -| `secondary_button_color_hover` | ```string``` | | [default to '#FFFFFF'] | -| `secondary_button_text_color` | ```string``` | | [default to '#00B3E6'] | -| `secondary_button_text_color_hover` | ```string``` | | [default to '#00B3E6'] | +| `link_color` | ```string``` | | [default to '#0061FE'] | +| `page_background_color` | ```string``` | | [default to '#f7f8f9'] | +| `primary_button_color` | ```string``` | | [default to '#0061FE'] | +| `primary_button_color_hover` | ```string``` | | [default to '#0061FE'] | +| `primary_button_text_color` | ```string``` | | [default to '#ffffff'] | +| `primary_button_text_color_hover` | ```string``` | | [default to '#ffffff'] | +| `secondary_button_color` | ```string``` | | [default to '#ffffff'] | +| `secondary_button_color_hover` | ```string``` | | [default to '#ffffff'] | +| `secondary_button_text_color` | ```string``` | | [default to '#0061FE'] | +| `secondary_button_text_color_hover` | ```string``` | | [default to '#0061FE'] | | `text_color1` | ```string``` | | [default to '#808080'] | -| `text_color2` | ```string``` | | [default to '#FFFFFF'] | +| `text_color2` | ```string``` | | [default to '#ffffff'] | | `reset_to_default` | ```bool``` | Resets white labeling options to defaults. Only useful when updating an API App. | | [[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/ApiAppResponse.php b/sdks/php/src/Model/ApiAppResponse.php index 3e214031d..886069fcf 100644 --- a/sdks/php/src/Model/ApiAppResponse.php +++ b/sdks/php/src/Model/ApiAppResponse.php @@ -58,15 +58,15 @@ class ApiAppResponse implements ModelInterface, ArrayAccess, JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'callback_url' => 'string', 'client_id' => 'string', 'created_at' => 'int', 'domains' => 'string[]', 'name' => 'string', 'is_approved' => 'bool', - 'oauth' => '\Dropbox\Sign\Model\ApiAppResponseOAuth', 'options' => '\Dropbox\Sign\Model\ApiAppResponseOptions', 'owner_account' => '\Dropbox\Sign\Model\ApiAppResponseOwnerAccount', + 'callback_url' => 'string', + 'oauth' => '\Dropbox\Sign\Model\ApiAppResponseOAuth', 'white_labeling_options' => '\Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions', ]; @@ -78,15 +78,15 @@ class ApiAppResponse implements ModelInterface, ArrayAccess, JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'callback_url' => null, 'client_id' => null, 'created_at' => null, 'domains' => null, 'name' => null, 'is_approved' => null, - 'oauth' => null, 'options' => null, 'owner_account' => null, + 'callback_url' => null, + 'oauth' => null, 'white_labeling_options' => null, ]; @@ -96,15 +96,15 @@ class ApiAppResponse implements ModelInterface, ArrayAccess, JsonSerializable * @var bool[] */ protected static array $openAPINullables = [ - 'callback_url' => true, 'client_id' => false, 'created_at' => false, 'domains' => false, 'name' => false, 'is_approved' => false, - 'oauth' => true, - 'options' => true, + 'options' => false, 'owner_account' => false, + 'callback_url' => true, + 'oauth' => true, 'white_labeling_options' => true, ]; @@ -186,15 +186,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'callback_url' => 'callback_url', 'client_id' => 'client_id', 'created_at' => 'created_at', 'domains' => 'domains', 'name' => 'name', 'is_approved' => 'is_approved', - 'oauth' => 'oauth', 'options' => 'options', 'owner_account' => 'owner_account', + 'callback_url' => 'callback_url', + 'oauth' => 'oauth', 'white_labeling_options' => 'white_labeling_options', ]; @@ -204,15 +204,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'callback_url' => 'setCallbackUrl', 'client_id' => 'setClientId', 'created_at' => 'setCreatedAt', 'domains' => 'setDomains', 'name' => 'setName', 'is_approved' => 'setIsApproved', - 'oauth' => 'setOauth', 'options' => 'setOptions', 'owner_account' => 'setOwnerAccount', + 'callback_url' => 'setCallbackUrl', + 'oauth' => 'setOauth', 'white_labeling_options' => 'setWhiteLabelingOptions', ]; @@ -222,15 +222,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'callback_url' => 'getCallbackUrl', 'client_id' => 'getClientId', 'created_at' => 'getCreatedAt', 'domains' => 'getDomains', 'name' => 'getName', 'is_approved' => 'getIsApproved', - 'oauth' => 'getOauth', 'options' => 'getOptions', 'owner_account' => 'getOwnerAccount', + 'callback_url' => 'getCallbackUrl', + 'oauth' => 'getOauth', 'white_labeling_options' => 'getWhiteLabelingOptions', ]; @@ -290,15 +290,15 @@ public function getModelName() */ public function __construct(array $data = null) { - $this->setIfExists('callback_url', $data ?? [], null); $this->setIfExists('client_id', $data ?? [], null); $this->setIfExists('created_at', $data ?? [], null); $this->setIfExists('domains', $data ?? [], null); $this->setIfExists('name', $data ?? [], null); $this->setIfExists('is_approved', $data ?? [], null); - $this->setIfExists('oauth', $data ?? [], null); $this->setIfExists('options', $data ?? [], null); $this->setIfExists('owner_account', $data ?? [], null); + $this->setIfExists('callback_url', $data ?? [], null); + $this->setIfExists('oauth', $data ?? [], null); $this->setIfExists('white_labeling_options', $data ?? [], null); } @@ -345,7 +345,30 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['client_id'] === null) { + $invalidProperties[] = "'client_id' can't be null"; + } + if ($this->container['created_at'] === null) { + $invalidProperties[] = "'created_at' can't be null"; + } + if ($this->container['domains'] === null) { + $invalidProperties[] = "'domains' can't be null"; + } + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } + if ($this->container['is_approved'] === null) { + $invalidProperties[] = "'is_approved' can't be null"; + } + if ($this->container['options'] === null) { + $invalidProperties[] = "'options' can't be null"; + } + if ($this->container['owner_account'] === null) { + $invalidProperties[] = "'owner_account' can't be null"; + } + return $invalidProperties; } /** @@ -359,44 +382,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** - * Gets callback_url - * - * @return string|null - */ - public function getCallbackUrl() - { - return $this->container['callback_url']; - } - - /** - * Sets callback_url - * - * @param string|null $callback_url The app's callback URL (for events) - * - * @return self - */ - public function setCallbackUrl(?string $callback_url) - { - if (is_null($callback_url)) { - array_push($this->openAPINullablesSetToNull, 'callback_url'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('callback_url', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } - } - $this->container['callback_url'] = $callback_url; - - return $this; - } - /** * Gets client_id * - * @return string|null + * @return string */ public function getClientId() { @@ -406,11 +395,11 @@ public function getClientId() /** * Sets client_id * - * @param string|null $client_id The app's client id + * @param string $client_id The app's client id * * @return self */ - public function setClientId(?string $client_id) + public function setClientId(string $client_id) { if (is_null($client_id)) { throw new InvalidArgumentException('non-nullable client_id cannot be null'); @@ -423,7 +412,7 @@ public function setClientId(?string $client_id) /** * Gets created_at * - * @return int|null + * @return int */ public function getCreatedAt() { @@ -433,11 +422,11 @@ public function getCreatedAt() /** * Sets created_at * - * @param int|null $created_at The time that the app was created + * @param int $created_at The time that the app was created * * @return self */ - public function setCreatedAt(?int $created_at) + public function setCreatedAt(int $created_at) { if (is_null($created_at)) { throw new InvalidArgumentException('non-nullable created_at cannot be null'); @@ -450,7 +439,7 @@ public function setCreatedAt(?int $created_at) /** * Gets domains * - * @return string[]|null + * @return string[] */ public function getDomains() { @@ -460,11 +449,11 @@ public function getDomains() /** * Sets domains * - * @param string[]|null $domains The domain name(s) associated with the app + * @param string[] $domains The domain name(s) associated with the app * * @return self */ - public function setDomains(?array $domains) + public function setDomains(array $domains) { if (is_null($domains)) { throw new InvalidArgumentException('non-nullable domains cannot be null'); @@ -477,7 +466,7 @@ public function setDomains(?array $domains) /** * Gets name * - * @return string|null + * @return string */ public function getName() { @@ -487,11 +476,11 @@ public function getName() /** * Sets name * - * @param string|null $name The name of the app + * @param string $name The name of the app * * @return self */ - public function setName(?string $name) + public function setName(string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); @@ -504,7 +493,7 @@ public function setName(?string $name) /** * Gets is_approved * - * @return bool|null + * @return bool */ public function getIsApproved() { @@ -514,11 +503,11 @@ public function getIsApproved() /** * Sets is_approved * - * @param bool|null $is_approved Boolean to indicate if the app has been approved + * @param bool $is_approved Boolean to indicate if the app has been approved * * @return self */ - public function setIsApproved(?bool $is_approved) + public function setIsApproved(bool $is_approved) { if (is_null($is_approved)) { throw new InvalidArgumentException('non-nullable is_approved cannot be null'); @@ -529,96 +518,123 @@ public function setIsApproved(?bool $is_approved) } /** - * Gets oauth + * Gets options * - * @return ApiAppResponseOAuth|null + * @return ApiAppResponseOptions */ - public function getOauth() + public function getOptions() { - return $this->container['oauth']; + return $this->container['options']; } /** - * Sets oauth + * Sets options * - * @param ApiAppResponseOAuth|null $oauth oauth + * @param ApiAppResponseOptions $options options * * @return self */ - public function setOauth(?ApiAppResponseOAuth $oauth) + public function setOptions(ApiAppResponseOptions $options) { - if (is_null($oauth)) { - array_push($this->openAPINullablesSetToNull, 'oauth'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('oauth', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + if (is_null($options)) { + throw new InvalidArgumentException('non-nullable options cannot be null'); } - $this->container['oauth'] = $oauth; + $this->container['options'] = $options; return $this; } /** - * Gets options + * Gets owner_account * - * @return ApiAppResponseOptions|null + * @return ApiAppResponseOwnerAccount */ - public function getOptions() + public function getOwnerAccount() { - return $this->container['options']; + return $this->container['owner_account']; } /** - * Sets options + * Sets owner_account * - * @param ApiAppResponseOptions|null $options options + * @param ApiAppResponseOwnerAccount $owner_account owner_account * * @return self */ - public function setOptions(?ApiAppResponseOptions $options) + public function setOwnerAccount(ApiAppResponseOwnerAccount $owner_account) { - if (is_null($options)) { - array_push($this->openAPINullablesSetToNull, 'options'); + if (is_null($owner_account)) { + throw new InvalidArgumentException('non-nullable owner_account cannot be null'); + } + $this->container['owner_account'] = $owner_account; + + return $this; + } + + /** + * Gets callback_url + * + * @return string|null + */ + public function getCallbackUrl() + { + return $this->container['callback_url']; + } + + /** + * Sets callback_url + * + * @param string|null $callback_url The app's callback URL (for events) + * + * @return self + */ + public function setCallbackUrl(?string $callback_url) + { + if (is_null($callback_url)) { + array_push($this->openAPINullablesSetToNull, 'callback_url'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('options', $nullablesSetToNull); + $index = array_search('callback_url', $nullablesSetToNull); if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } } - $this->container['options'] = $options; + $this->container['callback_url'] = $callback_url; return $this; } /** - * Gets owner_account + * Gets oauth * - * @return ApiAppResponseOwnerAccount|null + * @return ApiAppResponseOAuth|null */ - public function getOwnerAccount() + public function getOauth() { - return $this->container['owner_account']; + return $this->container['oauth']; } /** - * Sets owner_account + * Sets oauth * - * @param ApiAppResponseOwnerAccount|null $owner_account owner_account + * @param ApiAppResponseOAuth|null $oauth oauth * * @return self */ - public function setOwnerAccount(?ApiAppResponseOwnerAccount $owner_account) + public function setOauth(?ApiAppResponseOAuth $oauth) { - if (is_null($owner_account)) { - throw new InvalidArgumentException('non-nullable owner_account cannot be null'); + if (is_null($oauth)) { + array_push($this->openAPINullablesSetToNull, 'oauth'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('oauth', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } } - $this->container['owner_account'] = $owner_account; + $this->container['oauth'] = $oauth; return $this; } diff --git a/sdks/php/src/Model/ApiAppResponseOAuth.php b/sdks/php/src/Model/ApiAppResponseOAuth.php index 57a61134a..0c7a3a08e 100644 --- a/sdks/php/src/Model/ApiAppResponseOAuth.php +++ b/sdks/php/src/Model/ApiAppResponseOAuth.php @@ -59,9 +59,9 @@ class ApiAppResponseOAuth implements ModelInterface, ArrayAccess, JsonSerializab */ protected static $openAPITypes = [ 'callback_url' => 'string', - 'secret' => 'string', 'scopes' => 'string[]', 'charges_users' => 'bool', + 'secret' => 'string', ]; /** @@ -73,9 +73,9 @@ class ApiAppResponseOAuth implements ModelInterface, ArrayAccess, JsonSerializab */ protected static $openAPIFormats = [ 'callback_url' => null, - 'secret' => null, 'scopes' => null, 'charges_users' => null, + 'secret' => null, ]; /** @@ -85,9 +85,9 @@ class ApiAppResponseOAuth implements ModelInterface, ArrayAccess, JsonSerializab */ protected static array $openAPINullables = [ 'callback_url' => false, - 'secret' => false, 'scopes' => false, 'charges_users' => false, + 'secret' => true, ]; /** @@ -169,9 +169,9 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'callback_url' => 'callback_url', - 'secret' => 'secret', 'scopes' => 'scopes', 'charges_users' => 'charges_users', + 'secret' => 'secret', ]; /** @@ -181,9 +181,9 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'callback_url' => 'setCallbackUrl', - 'secret' => 'setSecret', 'scopes' => 'setScopes', 'charges_users' => 'setChargesUsers', + 'secret' => 'setSecret', ]; /** @@ -193,9 +193,9 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'callback_url' => 'getCallbackUrl', - 'secret' => 'getSecret', 'scopes' => 'getScopes', 'charges_users' => 'getChargesUsers', + 'secret' => 'getSecret', ]; /** @@ -255,9 +255,9 @@ public function getModelName() public function __construct(array $data = null) { $this->setIfExists('callback_url', $data ?? [], null); - $this->setIfExists('secret', $data ?? [], null); $this->setIfExists('scopes', $data ?? [], null); $this->setIfExists('charges_users', $data ?? [], null); + $this->setIfExists('secret', $data ?? [], null); } /** @@ -303,7 +303,18 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['callback_url'] === null) { + $invalidProperties[] = "'callback_url' can't be null"; + } + if ($this->container['scopes'] === null) { + $invalidProperties[] = "'scopes' can't be null"; + } + if ($this->container['charges_users'] === null) { + $invalidProperties[] = "'charges_users' can't be null"; + } + return $invalidProperties; } /** @@ -320,7 +331,7 @@ public function valid() /** * Gets callback_url * - * @return string|null + * @return string */ public function getCallbackUrl() { @@ -330,11 +341,11 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url the app's OAuth callback URL + * @param string $callback_url the app's OAuth callback URL * * @return self */ - public function setCallbackUrl(?string $callback_url) + public function setCallbackUrl(string $callback_url) { if (is_null($callback_url)) { throw new InvalidArgumentException('non-nullable callback_url cannot be null'); @@ -345,82 +356,89 @@ public function setCallbackUrl(?string $callback_url) } /** - * Gets secret + * Gets scopes * - * @return string|null + * @return string[] */ - public function getSecret() + public function getScopes() { - return $this->container['secret']; + return $this->container['scopes']; } /** - * Sets secret + * Sets scopes * - * @param string|null $secret the app's OAuth secret, or null if the app does not belong to user + * @param string[] $scopes array of OAuth scopes used by the app * * @return self */ - public function setSecret(?string $secret) + public function setScopes(array $scopes) { - if (is_null($secret)) { - throw new InvalidArgumentException('non-nullable secret cannot be null'); + if (is_null($scopes)) { + throw new InvalidArgumentException('non-nullable scopes cannot be null'); } - $this->container['secret'] = $secret; + $this->container['scopes'] = $scopes; return $this; } /** - * Gets scopes + * Gets charges_users * - * @return string[]|null + * @return bool */ - public function getScopes() + public function getChargesUsers() { - return $this->container['scopes']; + return $this->container['charges_users']; } /** - * Sets scopes + * Sets charges_users * - * @param string[]|null $scopes array of OAuth scopes used by the app + * @param bool $charges_users boolean indicating whether the app owner or the account granting permission is billed for OAuth requests * * @return self */ - public function setScopes(?array $scopes) + public function setChargesUsers(bool $charges_users) { - if (is_null($scopes)) { - throw new InvalidArgumentException('non-nullable scopes cannot be null'); + if (is_null($charges_users)) { + throw new InvalidArgumentException('non-nullable charges_users cannot be null'); } - $this->container['scopes'] = $scopes; + $this->container['charges_users'] = $charges_users; return $this; } /** - * Gets charges_users + * Gets secret * - * @return bool|null + * @return string|null */ - public function getChargesUsers() + public function getSecret() { - return $this->container['charges_users']; + return $this->container['secret']; } /** - * Sets charges_users + * Sets secret * - * @param bool|null $charges_users boolean indicating whether the app owner or the account granting permission is billed for OAuth requests + * @param string|null $secret the app's OAuth secret, or null if the app does not belong to user * * @return self */ - public function setChargesUsers(?bool $charges_users) + public function setSecret(?string $secret) { - if (is_null($charges_users)) { - throw new InvalidArgumentException('non-nullable charges_users cannot be null'); + if (is_null($secret)) { + array_push($this->openAPINullablesSetToNull, 'secret'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('secret', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } } - $this->container['charges_users'] = $charges_users; + $this->container['secret'] = $secret; return $this; } diff --git a/sdks/php/src/Model/ApiAppResponseOptions.php b/sdks/php/src/Model/ApiAppResponseOptions.php index 99c11f02a..af4718a13 100644 --- a/sdks/php/src/Model/ApiAppResponseOptions.php +++ b/sdks/php/src/Model/ApiAppResponseOptions.php @@ -282,7 +282,12 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['can_insert_everywhere'] === null) { + $invalidProperties[] = "'can_insert_everywhere' can't be null"; + } + return $invalidProperties; } /** @@ -299,7 +304,7 @@ public function valid() /** * Gets can_insert_everywhere * - * @return bool|null + * @return bool */ public function getCanInsertEverywhere() { @@ -309,11 +314,11 @@ public function getCanInsertEverywhere() /** * Sets can_insert_everywhere * - * @param bool|null $can_insert_everywhere Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document + * @param bool $can_insert_everywhere Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document * * @return self */ - public function setCanInsertEverywhere(?bool $can_insert_everywhere) + public function setCanInsertEverywhere(bool $can_insert_everywhere) { if (is_null($can_insert_everywhere)) { throw new InvalidArgumentException('non-nullable can_insert_everywhere cannot be null'); diff --git a/sdks/php/src/Model/ApiAppResponseOwnerAccount.php b/sdks/php/src/Model/ApiAppResponseOwnerAccount.php index ffc120960..02f1f44d8 100644 --- a/sdks/php/src/Model/ApiAppResponseOwnerAccount.php +++ b/sdks/php/src/Model/ApiAppResponseOwnerAccount.php @@ -289,7 +289,15 @@ 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['email_address'] === null) { + $invalidProperties[] = "'email_address' can't be null"; + } + return $invalidProperties; } /** @@ -306,7 +314,7 @@ public function valid() /** * Gets account_id * - * @return string|null + * @return string */ public function getAccountId() { @@ -316,11 +324,11 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id The owner account's ID + * @param string $account_id The owner account's ID * * @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'); @@ -333,7 +341,7 @@ public function setAccountId(?string $account_id) /** * Gets email_address * - * @return string|null + * @return string */ public function getEmailAddress() { @@ -343,11 +351,11 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address The owner account's email address + * @param string $email_address The owner account's email address * * @return self */ - public function setEmailAddress(?string $email_address) + public function setEmailAddress(string $email_address) { if (is_null($email_address)) { throw new InvalidArgumentException('non-nullable email_address cannot be null'); diff --git a/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php b/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php index 95f29f5f4..185d3782c 100644 --- a/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php +++ b/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php @@ -373,7 +373,51 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['header_background_color'] === null) { + $invalidProperties[] = "'header_background_color' can't be null"; + } + if ($this->container['legal_version'] === null) { + $invalidProperties[] = "'legal_version' can't be null"; + } + if ($this->container['link_color'] === null) { + $invalidProperties[] = "'link_color' can't be null"; + } + if ($this->container['page_background_color'] === null) { + $invalidProperties[] = "'page_background_color' can't be null"; + } + if ($this->container['primary_button_color'] === null) { + $invalidProperties[] = "'primary_button_color' can't be null"; + } + if ($this->container['primary_button_color_hover'] === null) { + $invalidProperties[] = "'primary_button_color_hover' can't be null"; + } + if ($this->container['primary_button_text_color'] === null) { + $invalidProperties[] = "'primary_button_text_color' can't be null"; + } + if ($this->container['primary_button_text_color_hover'] === null) { + $invalidProperties[] = "'primary_button_text_color_hover' can't be null"; + } + if ($this->container['secondary_button_color'] === null) { + $invalidProperties[] = "'secondary_button_color' can't be null"; + } + if ($this->container['secondary_button_color_hover'] === null) { + $invalidProperties[] = "'secondary_button_color_hover' can't be null"; + } + if ($this->container['secondary_button_text_color'] === null) { + $invalidProperties[] = "'secondary_button_text_color' can't be null"; + } + if ($this->container['secondary_button_text_color_hover'] === null) { + $invalidProperties[] = "'secondary_button_text_color_hover' can't be null"; + } + if ($this->container['text_color1'] === null) { + $invalidProperties[] = "'text_color1' can't be null"; + } + if ($this->container['text_color2'] === null) { + $invalidProperties[] = "'text_color2' can't be null"; + } + return $invalidProperties; } /** @@ -390,7 +434,7 @@ public function valid() /** * Gets header_background_color * - * @return string|null + * @return string */ public function getHeaderBackgroundColor() { @@ -400,11 +444,11 @@ public function getHeaderBackgroundColor() /** * Sets header_background_color * - * @param string|null $header_background_color header_background_color + * @param string $header_background_color header_background_color * * @return self */ - public function setHeaderBackgroundColor(?string $header_background_color) + public function setHeaderBackgroundColor(string $header_background_color) { if (is_null($header_background_color)) { throw new InvalidArgumentException('non-nullable header_background_color cannot be null'); @@ -417,7 +461,7 @@ public function setHeaderBackgroundColor(?string $header_background_color) /** * Gets legal_version * - * @return string|null + * @return string */ public function getLegalVersion() { @@ -427,11 +471,11 @@ public function getLegalVersion() /** * Sets legal_version * - * @param string|null $legal_version legal_version + * @param string $legal_version legal_version * * @return self */ - public function setLegalVersion(?string $legal_version) + public function setLegalVersion(string $legal_version) { if (is_null($legal_version)) { throw new InvalidArgumentException('non-nullable legal_version cannot be null'); @@ -444,7 +488,7 @@ public function setLegalVersion(?string $legal_version) /** * Gets link_color * - * @return string|null + * @return string */ public function getLinkColor() { @@ -454,11 +498,11 @@ public function getLinkColor() /** * Sets link_color * - * @param string|null $link_color link_color + * @param string $link_color link_color * * @return self */ - public function setLinkColor(?string $link_color) + public function setLinkColor(string $link_color) { if (is_null($link_color)) { throw new InvalidArgumentException('non-nullable link_color cannot be null'); @@ -471,7 +515,7 @@ public function setLinkColor(?string $link_color) /** * Gets page_background_color * - * @return string|null + * @return string */ public function getPageBackgroundColor() { @@ -481,11 +525,11 @@ public function getPageBackgroundColor() /** * Sets page_background_color * - * @param string|null $page_background_color page_background_color + * @param string $page_background_color page_background_color * * @return self */ - public function setPageBackgroundColor(?string $page_background_color) + public function setPageBackgroundColor(string $page_background_color) { if (is_null($page_background_color)) { throw new InvalidArgumentException('non-nullable page_background_color cannot be null'); @@ -498,7 +542,7 @@ public function setPageBackgroundColor(?string $page_background_color) /** * Gets primary_button_color * - * @return string|null + * @return string */ public function getPrimaryButtonColor() { @@ -508,11 +552,11 @@ public function getPrimaryButtonColor() /** * Sets primary_button_color * - * @param string|null $primary_button_color primary_button_color + * @param string $primary_button_color primary_button_color * * @return self */ - public function setPrimaryButtonColor(?string $primary_button_color) + public function setPrimaryButtonColor(string $primary_button_color) { if (is_null($primary_button_color)) { throw new InvalidArgumentException('non-nullable primary_button_color cannot be null'); @@ -525,7 +569,7 @@ public function setPrimaryButtonColor(?string $primary_button_color) /** * Gets primary_button_color_hover * - * @return string|null + * @return string */ public function getPrimaryButtonColorHover() { @@ -535,11 +579,11 @@ public function getPrimaryButtonColorHover() /** * Sets primary_button_color_hover * - * @param string|null $primary_button_color_hover primary_button_color_hover + * @param string $primary_button_color_hover primary_button_color_hover * * @return self */ - public function setPrimaryButtonColorHover(?string $primary_button_color_hover) + public function setPrimaryButtonColorHover(string $primary_button_color_hover) { if (is_null($primary_button_color_hover)) { throw new InvalidArgumentException('non-nullable primary_button_color_hover cannot be null'); @@ -552,7 +596,7 @@ public function setPrimaryButtonColorHover(?string $primary_button_color_hover) /** * Gets primary_button_text_color * - * @return string|null + * @return string */ public function getPrimaryButtonTextColor() { @@ -562,11 +606,11 @@ public function getPrimaryButtonTextColor() /** * Sets primary_button_text_color * - * @param string|null $primary_button_text_color primary_button_text_color + * @param string $primary_button_text_color primary_button_text_color * * @return self */ - public function setPrimaryButtonTextColor(?string $primary_button_text_color) + public function setPrimaryButtonTextColor(string $primary_button_text_color) { if (is_null($primary_button_text_color)) { throw new InvalidArgumentException('non-nullable primary_button_text_color cannot be null'); @@ -579,7 +623,7 @@ public function setPrimaryButtonTextColor(?string $primary_button_text_color) /** * Gets primary_button_text_color_hover * - * @return string|null + * @return string */ public function getPrimaryButtonTextColorHover() { @@ -589,11 +633,11 @@ public function getPrimaryButtonTextColorHover() /** * Sets primary_button_text_color_hover * - * @param string|null $primary_button_text_color_hover primary_button_text_color_hover + * @param string $primary_button_text_color_hover primary_button_text_color_hover * * @return self */ - public function setPrimaryButtonTextColorHover(?string $primary_button_text_color_hover) + public function setPrimaryButtonTextColorHover(string $primary_button_text_color_hover) { if (is_null($primary_button_text_color_hover)) { throw new InvalidArgumentException('non-nullable primary_button_text_color_hover cannot be null'); @@ -606,7 +650,7 @@ public function setPrimaryButtonTextColorHover(?string $primary_button_text_colo /** * Gets secondary_button_color * - * @return string|null + * @return string */ public function getSecondaryButtonColor() { @@ -616,11 +660,11 @@ public function getSecondaryButtonColor() /** * Sets secondary_button_color * - * @param string|null $secondary_button_color secondary_button_color + * @param string $secondary_button_color secondary_button_color * * @return self */ - public function setSecondaryButtonColor(?string $secondary_button_color) + public function setSecondaryButtonColor(string $secondary_button_color) { if (is_null($secondary_button_color)) { throw new InvalidArgumentException('non-nullable secondary_button_color cannot be null'); @@ -633,7 +677,7 @@ public function setSecondaryButtonColor(?string $secondary_button_color) /** * Gets secondary_button_color_hover * - * @return string|null + * @return string */ public function getSecondaryButtonColorHover() { @@ -643,11 +687,11 @@ public function getSecondaryButtonColorHover() /** * Sets secondary_button_color_hover * - * @param string|null $secondary_button_color_hover secondary_button_color_hover + * @param string $secondary_button_color_hover secondary_button_color_hover * * @return self */ - public function setSecondaryButtonColorHover(?string $secondary_button_color_hover) + public function setSecondaryButtonColorHover(string $secondary_button_color_hover) { if (is_null($secondary_button_color_hover)) { throw new InvalidArgumentException('non-nullable secondary_button_color_hover cannot be null'); @@ -660,7 +704,7 @@ public function setSecondaryButtonColorHover(?string $secondary_button_color_hov /** * Gets secondary_button_text_color * - * @return string|null + * @return string */ public function getSecondaryButtonTextColor() { @@ -670,11 +714,11 @@ public function getSecondaryButtonTextColor() /** * Sets secondary_button_text_color * - * @param string|null $secondary_button_text_color secondary_button_text_color + * @param string $secondary_button_text_color secondary_button_text_color * * @return self */ - public function setSecondaryButtonTextColor(?string $secondary_button_text_color) + public function setSecondaryButtonTextColor(string $secondary_button_text_color) { if (is_null($secondary_button_text_color)) { throw new InvalidArgumentException('non-nullable secondary_button_text_color cannot be null'); @@ -687,7 +731,7 @@ public function setSecondaryButtonTextColor(?string $secondary_button_text_color /** * Gets secondary_button_text_color_hover * - * @return string|null + * @return string */ public function getSecondaryButtonTextColorHover() { @@ -697,11 +741,11 @@ public function getSecondaryButtonTextColorHover() /** * Sets secondary_button_text_color_hover * - * @param string|null $secondary_button_text_color_hover secondary_button_text_color_hover + * @param string $secondary_button_text_color_hover secondary_button_text_color_hover * * @return self */ - public function setSecondaryButtonTextColorHover(?string $secondary_button_text_color_hover) + public function setSecondaryButtonTextColorHover(string $secondary_button_text_color_hover) { if (is_null($secondary_button_text_color_hover)) { throw new InvalidArgumentException('non-nullable secondary_button_text_color_hover cannot be null'); @@ -714,7 +758,7 @@ public function setSecondaryButtonTextColorHover(?string $secondary_button_text_ /** * Gets text_color1 * - * @return string|null + * @return string */ public function getTextColor1() { @@ -724,11 +768,11 @@ public function getTextColor1() /** * Sets text_color1 * - * @param string|null $text_color1 text_color1 + * @param string $text_color1 text_color1 * * @return self */ - public function setTextColor1(?string $text_color1) + public function setTextColor1(string $text_color1) { if (is_null($text_color1)) { throw new InvalidArgumentException('non-nullable text_color1 cannot be null'); @@ -741,7 +785,7 @@ public function setTextColor1(?string $text_color1) /** * Gets text_color2 * - * @return string|null + * @return string */ public function getTextColor2() { @@ -751,11 +795,11 @@ public function getTextColor2() /** * Sets text_color2 * - * @param string|null $text_color2 text_color2 + * @param string $text_color2 text_color2 * * @return self */ - public function setTextColor2(?string $text_color2) + public function setTextColor2(string $text_color2) { if (is_null($text_color2)) { throw new InvalidArgumentException('non-nullable text_color2 cannot be null'); diff --git a/sdks/php/src/Model/SubWhiteLabelingOptions.php b/sdks/php/src/Model/SubWhiteLabelingOptions.php index 4f16b4928..0abcbd111 100644 --- a/sdks/php/src/Model/SubWhiteLabelingOptions.php +++ b/sdks/php/src/Model/SubWhiteLabelingOptions.php @@ -336,20 +336,20 @@ public function getLegalVersionAllowableValues() */ public function __construct(array $data = null) { - $this->setIfExists('header_background_color', $data ?? [], '#1A1A1A'); + $this->setIfExists('header_background_color', $data ?? [], '#1a1a1a'); $this->setIfExists('legal_version', $data ?? [], 'terms1'); - $this->setIfExists('link_color', $data ?? [], '#00B3E6'); - $this->setIfExists('page_background_color', $data ?? [], '#F7F8F9'); - $this->setIfExists('primary_button_color', $data ?? [], '#00B3E6'); - $this->setIfExists('primary_button_color_hover', $data ?? [], '#00B3E6'); - $this->setIfExists('primary_button_text_color', $data ?? [], '#FFFFFF'); - $this->setIfExists('primary_button_text_color_hover', $data ?? [], '#FFFFFF'); - $this->setIfExists('secondary_button_color', $data ?? [], '#FFFFFF'); - $this->setIfExists('secondary_button_color_hover', $data ?? [], '#FFFFFF'); - $this->setIfExists('secondary_button_text_color', $data ?? [], '#00B3E6'); - $this->setIfExists('secondary_button_text_color_hover', $data ?? [], '#00B3E6'); + $this->setIfExists('link_color', $data ?? [], '#0061FE'); + $this->setIfExists('page_background_color', $data ?? [], '#f7f8f9'); + $this->setIfExists('primary_button_color', $data ?? [], '#0061FE'); + $this->setIfExists('primary_button_color_hover', $data ?? [], '#0061FE'); + $this->setIfExists('primary_button_text_color', $data ?? [], '#ffffff'); + $this->setIfExists('primary_button_text_color_hover', $data ?? [], '#ffffff'); + $this->setIfExists('secondary_button_color', $data ?? [], '#ffffff'); + $this->setIfExists('secondary_button_color_hover', $data ?? [], '#ffffff'); + $this->setIfExists('secondary_button_text_color', $data ?? [], '#0061FE'); + $this->setIfExists('secondary_button_text_color_hover', $data ?? [], '#0061FE'); $this->setIfExists('text_color1', $data ?? [], '#808080'); - $this->setIfExists('text_color2', $data ?? [], '#FFFFFF'); + $this->setIfExists('text_color2', $data ?? [], '#ffffff'); $this->setIfExists('reset_to_default', $data ?? [], null); } diff --git a/sdks/python/docs/ApiAppResponse.md b/sdks/python/docs/ApiAppResponse.md index ae25a38c4..c3461ca70 100644 --- a/sdks/python/docs/ApiAppResponse.md +++ b/sdks/python/docs/ApiAppResponse.md @@ -5,15 +5,15 @@ Contains information about an API App. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `client_id`*_required_ | ```str``` | The app's client id | | +| `created_at`*_required_ | ```int``` | The time that the app was created | | +| `domains`*_required_ | ```List[str]``` | The domain name(s) associated with the app | | +| `name`*_required_ | ```str``` | The name of the app | | +| `is_approved`*_required_ | ```bool``` | Boolean to indicate if the app has been approved | | +| `options`*_required_ | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | +| `owner_account`*_required_ | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `callback_url` | ```str``` | The app's callback URL (for events) | | -| `client_id` | ```str``` | The app's client id | | -| `created_at` | ```int``` | The time that the app was created | | -| `domains` | ```List[str]``` | The domain name(s) associated with the app | | -| `name` | ```str``` | The name of the app | | -| `is_approved` | ```bool``` | Boolean to indicate if the app has been approved | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | -| `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | -| `owner_account` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `white_labeling_options` | [```ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | | [[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/ApiAppResponseOAuth.md b/sdks/python/docs/ApiAppResponseOAuth.md index 0c18e5f1e..a5aa95788 100644 --- a/sdks/python/docs/ApiAppResponseOAuth.md +++ b/sdks/python/docs/ApiAppResponseOAuth.md @@ -5,10 +5,10 @@ An object describing the app's OAuth properties, or null if OAuth is not con ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```str``` | The app's OAuth callback URL. | | +| `callback_url`*_required_ | ```str``` | The app's OAuth callback URL. | | +| `scopes`*_required_ | ```List[str]``` | Array of OAuth scopes used by the app. | | +| `charges_users`*_required_ | ```bool``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | | `secret` | ```str``` | The app's OAuth secret, or null if the app does not belong to user. | | -| `scopes` | ```List[str]``` | Array of OAuth scopes used by the app. | | -| `charges_users` | ```bool``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | [[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/ApiAppResponseOptions.md b/sdks/python/docs/ApiAppResponseOptions.md index 42f8144e5..96f399312 100644 --- a/sdks/python/docs/ApiAppResponseOptions.md +++ b/sdks/python/docs/ApiAppResponseOptions.md @@ -5,7 +5,7 @@ An object with options that override account settings. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `can_insert_everywhere` | ```bool``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `can_insert_everywhere`*_required_ | ```bool``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | [[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/ApiAppResponseOwnerAccount.md b/sdks/python/docs/ApiAppResponseOwnerAccount.md index 9b8e22f08..b11b8402e 100644 --- a/sdks/python/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/python/docs/ApiAppResponseOwnerAccount.md @@ -5,8 +5,8 @@ An object describing the app's owner ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```str``` | The owner account's ID | | -| `email_address` | ```str``` | The owner account's email address | | +| `account_id`*_required_ | ```str``` | The owner account's ID | | +| `email_address`*_required_ | ```str``` | The owner account's email address | | [[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/ApiAppResponseWhiteLabelingOptions.md b/sdks/python/docs/ApiAppResponseWhiteLabelingOptions.md index 375c8f2cf..ee9742c8e 100644 --- a/sdks/python/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/python/docs/ApiAppResponseWhiteLabelingOptions.md @@ -5,20 +5,20 @@ An object with options to customize the app's signer page ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `header_background_color` | ```str``` | | | -| `legal_version` | ```str``` | | | -| `link_color` | ```str``` | | | -| `page_background_color` | ```str``` | | | -| `primary_button_color` | ```str``` | | | -| `primary_button_color_hover` | ```str``` | | | -| `primary_button_text_color` | ```str``` | | | -| `primary_button_text_color_hover` | ```str``` | | | -| `secondary_button_color` | ```str``` | | | -| `secondary_button_color_hover` | ```str``` | | | -| `secondary_button_text_color` | ```str``` | | | -| `secondary_button_text_color_hover` | ```str``` | | | -| `text_color1` | ```str``` | | | -| `text_color2` | ```str``` | | | +| `header_background_color`*_required_ | ```str``` | | | +| `legal_version`*_required_ | ```str``` | | | +| `link_color`*_required_ | ```str``` | | | +| `page_background_color`*_required_ | ```str``` | | | +| `primary_button_color`*_required_ | ```str``` | | | +| `primary_button_color_hover`*_required_ | ```str``` | | | +| `primary_button_text_color`*_required_ | ```str``` | | | +| `primary_button_text_color_hover`*_required_ | ```str``` | | | +| `secondary_button_color`*_required_ | ```str``` | | | +| `secondary_button_color_hover`*_required_ | ```str``` | | | +| `secondary_button_text_color`*_required_ | ```str``` | | | +| `secondary_button_text_color_hover`*_required_ | ```str``` | | | +| `text_color1`*_required_ | ```str``` | | | +| `text_color2`*_required_ | ```str``` | | | [[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/SubWhiteLabelingOptions.md b/sdks/python/docs/SubWhiteLabelingOptions.md index ac301537d..f911527c3 100644 --- a/sdks/python/docs/SubWhiteLabelingOptions.md +++ b/sdks/python/docs/SubWhiteLabelingOptions.md @@ -7,20 +7,20 @@ Take a look at our [white labeling guide](https://developers.hellosign.com/api/r ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `header_background_color` | ```str``` | | [default to '#1A1A1A'] | +| `header_background_color` | ```str``` | | [default to '#1a1a1a'] | | `legal_version` | ```str``` | | [default to 'terms1'] | -| `link_color` | ```str``` | | [default to '#00B3E6'] | -| `page_background_color` | ```str``` | | [default to '#F7F8F9'] | -| `primary_button_color` | ```str``` | | [default to '#00B3E6'] | -| `primary_button_color_hover` | ```str``` | | [default to '#00B3E6'] | -| `primary_button_text_color` | ```str``` | | [default to '#FFFFFF'] | -| `primary_button_text_color_hover` | ```str``` | | [default to '#FFFFFF'] | -| `secondary_button_color` | ```str``` | | [default to '#FFFFFF'] | -| `secondary_button_color_hover` | ```str``` | | [default to '#FFFFFF'] | -| `secondary_button_text_color` | ```str``` | | [default to '#00B3E6'] | -| `secondary_button_text_color_hover` | ```str``` | | [default to '#00B3E6'] | +| `link_color` | ```str``` | | [default to '#0061FE'] | +| `page_background_color` | ```str``` | | [default to '#f7f8f9'] | +| `primary_button_color` | ```str``` | | [default to '#0061FE'] | +| `primary_button_color_hover` | ```str``` | | [default to '#0061FE'] | +| `primary_button_text_color` | ```str``` | | [default to '#ffffff'] | +| `primary_button_text_color_hover` | ```str``` | | [default to '#ffffff'] | +| `secondary_button_color` | ```str``` | | [default to '#ffffff'] | +| `secondary_button_color_hover` | ```str``` | | [default to '#ffffff'] | +| `secondary_button_text_color` | ```str``` | | [default to '#0061FE'] | +| `secondary_button_text_color_hover` | ```str``` | | [default to '#0061FE'] | | `text_color1` | ```str``` | | [default to '#808080'] | -| `text_color2` | ```str``` | | [default to '#FFFFFF'] | +| `text_color2` | ```str``` | | [default to '#ffffff'] | | `reset_to_default` | ```bool``` | Resets white labeling options to defaults. Only useful when updating an API App. | | [[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/api_app_response.py b/sdks/python/dropbox_sign/models/api_app_response.py index a1f0bf157..9381e2f88 100644 --- a/sdks/python/dropbox_sign/models/api_app_response.py +++ b/sdks/python/dropbox_sign/models/api_app_response.py @@ -40,36 +40,32 @@ class ApiAppResponse(BaseModel): Contains information about an API App. """ # noqa: E501 - callback_url: Optional[StrictStr] = Field( - default=None, description="The app's callback URL (for events)" - ) - client_id: Optional[StrictStr] = Field( - default=None, description="The app's client id" - ) - created_at: Optional[StrictInt] = Field( - default=None, description="The time that the app was created" + client_id: StrictStr = Field(description="The app's client id") + created_at: StrictInt = Field(description="The time that the app was created") + domains: List[StrictStr] = Field( + description="The domain name(s) associated with the app" ) - domains: Optional[List[StrictStr]] = Field( - default=None, description="The domain name(s) associated with the app" + name: StrictStr = Field(description="The name of the app") + is_approved: StrictBool = Field( + description="Boolean to indicate if the app has been approved" ) - name: Optional[StrictStr] = Field(default=None, description="The name of the app") - is_approved: Optional[StrictBool] = Field( - default=None, description="Boolean to indicate if the app has been approved" + options: ApiAppResponseOptions + owner_account: ApiAppResponseOwnerAccount + callback_url: Optional[StrictStr] = Field( + default=None, description="The app's callback URL (for events)" ) oauth: Optional[ApiAppResponseOAuth] = None - options: Optional[ApiAppResponseOptions] = None - owner_account: Optional[ApiAppResponseOwnerAccount] = None white_labeling_options: Optional[ApiAppResponseWhiteLabelingOptions] = None __properties: ClassVar[List[str]] = [ - "callback_url", "client_id", "created_at", "domains", "name", "is_approved", - "oauth", "options", "owner_account", + "callback_url", + "oauth", "white_labeling_options", ] @@ -123,15 +119,15 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # override the default output from pydantic by calling `to_dict()` of oauth - if self.oauth: - _dict["oauth"] = self.oauth.to_dict() # override the default output from pydantic by calling `to_dict()` of options if self.options: _dict["options"] = self.options.to_dict() # override the default output from pydantic by calling `to_dict()` of owner_account if self.owner_account: _dict["owner_account"] = self.owner_account.to_dict() + # override the default output from pydantic by calling `to_dict()` of oauth + if self.oauth: + _dict["oauth"] = self.oauth.to_dict() # override the default output from pydantic by calling `to_dict()` of white_labeling_options if self.white_labeling_options: _dict["white_labeling_options"] = self.white_labeling_options.to_dict() @@ -148,17 +144,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "callback_url": obj.get("callback_url"), "client_id": obj.get("client_id"), "created_at": obj.get("created_at"), "domains": obj.get("domains"), "name": obj.get("name"), "is_approved": obj.get("is_approved"), - "oauth": ( - ApiAppResponseOAuth.from_dict(obj["oauth"]) - if obj.get("oauth") is not None - else None - ), "options": ( ApiAppResponseOptions.from_dict(obj["options"]) if obj.get("options") is not None @@ -169,6 +159,12 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("owner_account") is not None else None ), + "callback_url": obj.get("callback_url"), + "oauth": ( + ApiAppResponseOAuth.from_dict(obj["oauth"]) + if obj.get("oauth") is not None + else None + ), "white_labeling_options": ( ApiAppResponseWhiteLabelingOptions.from_dict( obj["white_labeling_options"] @@ -193,15 +189,15 @@ def init(cls, data: Any) -> Self: @classmethod def openapi_types(cls) -> Dict[str, str]: return { - "callback_url": "(str,)", "client_id": "(str,)", "created_at": "(int,)", "domains": "(List[str],)", "name": "(str,)", "is_approved": "(bool,)", - "oauth": "(ApiAppResponseOAuth,)", "options": "(ApiAppResponseOptions,)", "owner_account": "(ApiAppResponseOwnerAccount,)", + "callback_url": "(str,)", + "oauth": "(ApiAppResponseOAuth,)", "white_labeling_options": "(ApiAppResponseWhiteLabelingOptions,)", } diff --git a/sdks/python/dropbox_sign/models/api_app_response_o_auth.py b/sdks/python/dropbox_sign/models/api_app_response_o_auth.py index 981f94d9f..cd0f83dfa 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_o_auth.py +++ b/sdks/python/dropbox_sign/models/api_app_response_o_auth.py @@ -32,25 +32,22 @@ class ApiAppResponseOAuth(BaseModel): An object describing the app's OAuth properties, or null if OAuth is not configured for the app. """ # noqa: E501 - callback_url: Optional[StrictStr] = Field( - default=None, description="The app's OAuth callback URL." + callback_url: StrictStr = Field(description="The app's OAuth callback URL.") + scopes: List[StrictStr] = Field( + description="Array of OAuth scopes used by the app." + ) + charges_users: StrictBool = Field( + description="Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests." ) secret: Optional[StrictStr] = Field( default=None, description="The app's OAuth secret, or null if the app does not belong to user.", ) - scopes: Optional[List[StrictStr]] = Field( - default=None, description="Array of OAuth scopes used by the app." - ) - charges_users: Optional[StrictBool] = Field( - default=None, - description="Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.", - ) __properties: ClassVar[List[str]] = [ "callback_url", - "secret", "scopes", "charges_users", + "secret", ] model_config = ConfigDict( @@ -117,9 +114,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { "callback_url": obj.get("callback_url"), - "secret": obj.get("secret"), "scopes": obj.get("scopes"), "charges_users": obj.get("charges_users"), + "secret": obj.get("secret"), } ) return _obj @@ -138,9 +135,9 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "callback_url": "(str,)", - "secret": "(str,)", "scopes": "(List[str],)", "charges_users": "(bool,)", + "secret": "(str,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/api_app_response_options.py b/sdks/python/dropbox_sign/models/api_app_response_options.py index 751daf0de..cedaa70a5 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_options.py +++ b/sdks/python/dropbox_sign/models/api_app_response_options.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool -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,8 @@ class ApiAppResponseOptions(BaseModel): An object with options that override account settings. """ # noqa: E501 - can_insert_everywhere: Optional[StrictBool] = Field( - default=None, - description='Boolean denoting if signers can "Insert Everywhere" in one click while signing a document', + can_insert_everywhere: StrictBool = Field( + description='Boolean denoting if signers can "Insert Everywhere" in one click while signing a document' ) __properties: ClassVar[List[str]] = ["can_insert_everywhere"] diff --git a/sdks/python/dropbox_sign/models/api_app_response_owner_account.py b/sdks/python/dropbox_sign/models/api_app_response_owner_account.py index c1ed456c8..a3710b418 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_owner_account.py +++ b/sdks/python/dropbox_sign/models/api_app_response_owner_account.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -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,12 +32,8 @@ class ApiAppResponseOwnerAccount(BaseModel): An object describing the app's owner """ # noqa: E501 - account_id: Optional[StrictStr] = Field( - default=None, description="The owner account's ID" - ) - email_address: Optional[StrictStr] = Field( - default=None, description="The owner account's email address" - ) + account_id: StrictStr = Field(description="The owner account's ID") + email_address: StrictStr = Field(description="The owner account's email address") __properties: ClassVar[List[str]] = ["account_id", "email_address"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py b/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py index 734022f90..b3f7a02f6 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py +++ b/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, StrictStr -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,20 +32,20 @@ class ApiAppResponseWhiteLabelingOptions(BaseModel): An object with options to customize the app's signer page """ # noqa: E501 - header_background_color: Optional[StrictStr] = None - legal_version: Optional[StrictStr] = None - link_color: Optional[StrictStr] = None - page_background_color: Optional[StrictStr] = None - primary_button_color: Optional[StrictStr] = None - primary_button_color_hover: Optional[StrictStr] = None - primary_button_text_color: Optional[StrictStr] = None - primary_button_text_color_hover: Optional[StrictStr] = None - secondary_button_color: Optional[StrictStr] = None - secondary_button_color_hover: Optional[StrictStr] = None - secondary_button_text_color: Optional[StrictStr] = None - secondary_button_text_color_hover: Optional[StrictStr] = None - text_color1: Optional[StrictStr] = None - text_color2: Optional[StrictStr] = None + header_background_color: StrictStr + legal_version: StrictStr + link_color: StrictStr + page_background_color: StrictStr + primary_button_color: StrictStr + primary_button_color_hover: StrictStr + primary_button_text_color: StrictStr + primary_button_text_color_hover: StrictStr + secondary_button_color: StrictStr + secondary_button_color_hover: StrictStr + secondary_button_text_color: StrictStr + secondary_button_text_color_hover: StrictStr + text_color1: StrictStr + text_color2: StrictStr __properties: ClassVar[List[str]] = [ "header_background_color", "legal_version", diff --git a/sdks/python/dropbox_sign/models/sub_white_labeling_options.py b/sdks/python/dropbox_sign/models/sub_white_labeling_options.py index 63b8b6f98..218da2aea 100644 --- a/sdks/python/dropbox_sign/models/sub_white_labeling_options.py +++ b/sdks/python/dropbox_sign/models/sub_white_labeling_options.py @@ -39,20 +39,20 @@ class SubWhiteLabelingOptions(BaseModel): An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. """ # noqa: E501 - header_background_color: Optional[StrictStr] = "#1A1A1A" + header_background_color: Optional[StrictStr] = "#1a1a1a" legal_version: Optional[StrictStr] = "terms1" - link_color: Optional[StrictStr] = "#00B3E6" - page_background_color: Optional[StrictStr] = "#F7F8F9" - primary_button_color: Optional[StrictStr] = "#00B3E6" - primary_button_color_hover: Optional[StrictStr] = "#00B3E6" - primary_button_text_color: Optional[StrictStr] = "#FFFFFF" - primary_button_text_color_hover: Optional[StrictStr] = "#FFFFFF" - secondary_button_color: Optional[StrictStr] = "#FFFFFF" - secondary_button_color_hover: Optional[StrictStr] = "#FFFFFF" - secondary_button_text_color: Optional[StrictStr] = "#00B3E6" - secondary_button_text_color_hover: Optional[StrictStr] = "#00B3E6" + link_color: Optional[StrictStr] = "#0061FE" + page_background_color: Optional[StrictStr] = "#f7f8f9" + primary_button_color: Optional[StrictStr] = "#0061FE" + primary_button_color_hover: Optional[StrictStr] = "#0061FE" + primary_button_text_color: Optional[StrictStr] = "#ffffff" + primary_button_text_color_hover: Optional[StrictStr] = "#ffffff" + secondary_button_color: Optional[StrictStr] = "#ffffff" + secondary_button_color_hover: Optional[StrictStr] = "#ffffff" + secondary_button_text_color: Optional[StrictStr] = "#0061FE" + secondary_button_text_color_hover: Optional[StrictStr] = "#0061FE" text_color1: Optional[StrictStr] = "#808080" - text_color2: Optional[StrictStr] = "#FFFFFF" + text_color2: Optional[StrictStr] = "#ffffff" reset_to_default: Optional[StrictBool] = Field( default=None, description="Resets white labeling options to defaults. Only useful when updating an API App.", @@ -151,7 +151,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "header_background_color": ( obj.get("header_background_color") if obj.get("header_background_color") is not None - else "#1A1A1A" + else "#1a1a1a" ), "legal_version": ( obj.get("legal_version") @@ -161,52 +161,52 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "link_color": ( obj.get("link_color") if obj.get("link_color") is not None - else "#00B3E6" + else "#0061FE" ), "page_background_color": ( obj.get("page_background_color") if obj.get("page_background_color") is not None - else "#F7F8F9" + else "#f7f8f9" ), "primary_button_color": ( obj.get("primary_button_color") if obj.get("primary_button_color") is not None - else "#00B3E6" + else "#0061FE" ), "primary_button_color_hover": ( obj.get("primary_button_color_hover") if obj.get("primary_button_color_hover") is not None - else "#00B3E6" + else "#0061FE" ), "primary_button_text_color": ( obj.get("primary_button_text_color") if obj.get("primary_button_text_color") is not None - else "#FFFFFF" + else "#ffffff" ), "primary_button_text_color_hover": ( obj.get("primary_button_text_color_hover") if obj.get("primary_button_text_color_hover") is not None - else "#FFFFFF" + else "#ffffff" ), "secondary_button_color": ( obj.get("secondary_button_color") if obj.get("secondary_button_color") is not None - else "#FFFFFF" + else "#ffffff" ), "secondary_button_color_hover": ( obj.get("secondary_button_color_hover") if obj.get("secondary_button_color_hover") is not None - else "#FFFFFF" + else "#ffffff" ), "secondary_button_text_color": ( obj.get("secondary_button_text_color") if obj.get("secondary_button_text_color") is not None - else "#00B3E6" + else "#0061FE" ), "secondary_button_text_color_hover": ( obj.get("secondary_button_text_color_hover") if obj.get("secondary_button_text_color_hover") is not None - else "#00B3E6" + else "#0061FE" ), "text_color1": ( obj.get("text_color1") @@ -216,7 +216,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "text_color2": ( obj.get("text_color2") if obj.get("text_color2") is not None - else "#FFFFFF" + else "#ffffff" ), "reset_to_default": obj.get("reset_to_default"), } diff --git a/sdks/ruby/docs/ApiAppResponse.md b/sdks/ruby/docs/ApiAppResponse.md index ff1067f07..aabe14b57 100644 --- a/sdks/ruby/docs/ApiAppResponse.md +++ b/sdks/ruby/docs/ApiAppResponse.md @@ -6,14 +6,14 @@ Contains information about an API App. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| `client_id`*_required_ | ```String``` | The app's client id | | +| `created_at`*_required_ | ```Integer``` | The time that the app was created | | +| `domains`*_required_ | ```Array``` | The domain name(s) associated with the app | | +| `name`*_required_ | ```String``` | The name of the app | | +| `is_approved`*_required_ | ```Boolean``` | Boolean to indicate if the app has been approved | | +| `options`*_required_ | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | +| `owner_account`*_required_ | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `callback_url` | ```String``` | The app's callback URL (for events) | | -| `client_id` | ```String``` | The app's client id | | -| `created_at` | ```Integer``` | The time that the app was created | | -| `domains` | ```Array``` | The domain name(s) associated with the app | | -| `name` | ```String``` | The name of the app | | -| `is_approved` | ```Boolean``` | Boolean to indicate if the app has been approved | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | -| `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | -| `owner_account` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `white_labeling_options` | [```ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | | diff --git a/sdks/ruby/docs/ApiAppResponseOAuth.md b/sdks/ruby/docs/ApiAppResponseOAuth.md index b39bcc302..f4ee09acd 100644 --- a/sdks/ruby/docs/ApiAppResponseOAuth.md +++ b/sdks/ruby/docs/ApiAppResponseOAuth.md @@ -6,8 +6,8 @@ An object describing the app's OAuth properties, or null if OAuth is not con | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `callback_url` | ```String``` | The app's OAuth callback URL. | | +| `callback_url`*_required_ | ```String``` | The app's OAuth callback URL. | | +| `scopes`*_required_ | ```Array``` | Array of OAuth scopes used by the app. | | +| `charges_users`*_required_ | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | | `secret` | ```String``` | The app's OAuth secret, or null if the app does not belong to user. | | -| `scopes` | ```Array``` | Array of OAuth scopes used by the app. | | -| `charges_users` | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | diff --git a/sdks/ruby/docs/ApiAppResponseOptions.md b/sdks/ruby/docs/ApiAppResponseOptions.md index 6661e960f..1e25ee967 100644 --- a/sdks/ruby/docs/ApiAppResponseOptions.md +++ b/sdks/ruby/docs/ApiAppResponseOptions.md @@ -6,5 +6,5 @@ An object with options that override account settings. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `can_insert_everywhere` | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `can_insert_everywhere`*_required_ | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | diff --git a/sdks/ruby/docs/ApiAppResponseOwnerAccount.md b/sdks/ruby/docs/ApiAppResponseOwnerAccount.md index 6ae8b315d..0ed1d1466 100644 --- a/sdks/ruby/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/ruby/docs/ApiAppResponseOwnerAccount.md @@ -6,6 +6,6 @@ An object describing the app's owner | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `account_id` | ```String``` | The owner account's ID | | -| `email_address` | ```String``` | The owner account's email address | | +| `account_id`*_required_ | ```String``` | The owner account's ID | | +| `email_address`*_required_ | ```String``` | The owner account's email address | | diff --git a/sdks/ruby/docs/ApiAppResponseWhiteLabelingOptions.md b/sdks/ruby/docs/ApiAppResponseWhiteLabelingOptions.md index 3b02d6762..7f567105e 100644 --- a/sdks/ruby/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/ruby/docs/ApiAppResponseWhiteLabelingOptions.md @@ -6,18 +6,18 @@ An object with options to customize the app's signer page | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `header_background_color` | ```String``` | | | -| `legal_version` | ```String``` | | | -| `link_color` | ```String``` | | | -| `page_background_color` | ```String``` | | | -| `primary_button_color` | ```String``` | | | -| `primary_button_color_hover` | ```String``` | | | -| `primary_button_text_color` | ```String``` | | | -| `primary_button_text_color_hover` | ```String``` | | | -| `secondary_button_color` | ```String``` | | | -| `secondary_button_color_hover` | ```String``` | | | -| `secondary_button_text_color` | ```String``` | | | -| `secondary_button_text_color_hover` | ```String``` | | | -| `text_color1` | ```String``` | | | -| `text_color2` | ```String``` | | | +| `header_background_color`*_required_ | ```String``` | | | +| `legal_version`*_required_ | ```String``` | | | +| `link_color`*_required_ | ```String``` | | | +| `page_background_color`*_required_ | ```String``` | | | +| `primary_button_color`*_required_ | ```String``` | | | +| `primary_button_color_hover`*_required_ | ```String``` | | | +| `primary_button_text_color`*_required_ | ```String``` | | | +| `primary_button_text_color_hover`*_required_ | ```String``` | | | +| `secondary_button_color`*_required_ | ```String``` | | | +| `secondary_button_color_hover`*_required_ | ```String``` | | | +| `secondary_button_text_color`*_required_ | ```String``` | | | +| `secondary_button_text_color_hover`*_required_ | ```String``` | | | +| `text_color1`*_required_ | ```String``` | | | +| `text_color2`*_required_ | ```String``` | | | diff --git a/sdks/ruby/docs/SubWhiteLabelingOptions.md b/sdks/ruby/docs/SubWhiteLabelingOptions.md index cf92be65b..5be083c58 100644 --- a/sdks/ruby/docs/SubWhiteLabelingOptions.md +++ b/sdks/ruby/docs/SubWhiteLabelingOptions.md @@ -8,19 +8,19 @@ Take a look at our [white labeling guide](https://developers.hellosign.com/api/r | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `header_background_color` | ```String``` | | [default to '#1A1A1A'] | +| `header_background_color` | ```String``` | | [default to '#1a1a1a'] | | `legal_version` | ```String``` | | [default to 'terms1'] | -| `link_color` | ```String``` | | [default to '#00B3E6'] | -| `page_background_color` | ```String``` | | [default to '#F7F8F9'] | -| `primary_button_color` | ```String``` | | [default to '#00B3E6'] | -| `primary_button_color_hover` | ```String``` | | [default to '#00B3E6'] | -| `primary_button_text_color` | ```String``` | | [default to '#FFFFFF'] | -| `primary_button_text_color_hover` | ```String``` | | [default to '#FFFFFF'] | -| `secondary_button_color` | ```String``` | | [default to '#FFFFFF'] | -| `secondary_button_color_hover` | ```String``` | | [default to '#FFFFFF'] | -| `secondary_button_text_color` | ```String``` | | [default to '#00B3E6'] | -| `secondary_button_text_color_hover` | ```String``` | | [default to '#00B3E6'] | +| `link_color` | ```String``` | | [default to '#0061FE'] | +| `page_background_color` | ```String``` | | [default to '#f7f8f9'] | +| `primary_button_color` | ```String``` | | [default to '#0061FE'] | +| `primary_button_color_hover` | ```String``` | | [default to '#0061FE'] | +| `primary_button_text_color` | ```String``` | | [default to '#ffffff'] | +| `primary_button_text_color_hover` | ```String``` | | [default to '#ffffff'] | +| `secondary_button_color` | ```String``` | | [default to '#ffffff'] | +| `secondary_button_color_hover` | ```String``` | | [default to '#ffffff'] | +| `secondary_button_text_color` | ```String``` | | [default to '#0061FE'] | +| `secondary_button_text_color_hover` | ```String``` | | [default to '#0061FE'] | | `text_color1` | ```String``` | | [default to '#808080'] | -| `text_color2` | ```String``` | | [default to '#FFFFFF'] | +| `text_color2` | ```String``` | | [default to '#ffffff'] | | `reset_to_default` | ```Boolean``` | Resets white labeling options to defaults. Only useful when updating an API App. | | diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response.rb index 2f7923ed0..e7b21b8d0 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response.rb @@ -19,10 +19,6 @@ module Dropbox module Dropbox::Sign # Contains information about an API App. class ApiAppResponse - # The app's callback URL (for events) - # @return [String, nil] - attr_accessor :callback_url - # The app's client id # @return [String] attr_accessor :client_id @@ -43,30 +39,34 @@ class ApiAppResponse # @return [Boolean] attr_accessor :is_approved - # @return [ApiAppResponseOAuth, nil] - attr_accessor :oauth - - # @return [ApiAppResponseOptions, nil] + # @return [ApiAppResponseOptions] attr_accessor :options # @return [ApiAppResponseOwnerAccount] attr_accessor :owner_account + # The app's callback URL (for events) + # @return [String, nil] + attr_accessor :callback_url + + # @return [ApiAppResponseOAuth, nil] + attr_accessor :oauth + # @return [ApiAppResponseWhiteLabelingOptions, nil] attr_accessor :white_labeling_options # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'callback_url' => :'callback_url', :'client_id' => :'client_id', :'created_at' => :'created_at', :'domains' => :'domains', :'name' => :'name', :'is_approved' => :'is_approved', - :'oauth' => :'oauth', :'options' => :'options', :'owner_account' => :'owner_account', + :'callback_url' => :'callback_url', + :'oauth' => :'oauth', :'white_labeling_options' => :'white_labeling_options' } end @@ -79,15 +79,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'callback_url' => :'String', :'client_id' => :'String', :'created_at' => :'Integer', :'domains' => :'Array', :'name' => :'String', :'is_approved' => :'Boolean', - :'oauth' => :'ApiAppResponseOAuth', :'options' => :'ApiAppResponseOptions', :'owner_account' => :'ApiAppResponseOwnerAccount', + :'callback_url' => :'String', + :'oauth' => :'ApiAppResponseOAuth', :'white_labeling_options' => :'ApiAppResponseWhiteLabelingOptions' } end @@ -97,7 +97,6 @@ def self.openapi_nullable Set.new([ :'callback_url', :'oauth', - :'options', :'white_labeling_options' ]) end @@ -142,10 +141,6 @@ def initialize(attributes = {}) h[k.to_sym] = v } - if attributes.key?(:'callback_url') - self.callback_url = attributes[:'callback_url'] - end - if attributes.key?(:'client_id') self.client_id = attributes[:'client_id'] end @@ -168,10 +163,6 @@ def initialize(attributes = {}) self.is_approved = attributes[:'is_approved'] end - if attributes.key?(:'oauth') - self.oauth = attributes[:'oauth'] - end - if attributes.key?(:'options') self.options = attributes[:'options'] end @@ -180,6 +171,14 @@ def initialize(attributes = {}) self.owner_account = attributes[:'owner_account'] end + if attributes.key?(:'callback_url') + self.callback_url = attributes[:'callback_url'] + end + + if attributes.key?(:'oauth') + self.oauth = attributes[:'oauth'] + end + if attributes.key?(:'white_labeling_options') self.white_labeling_options = attributes[:'white_labeling_options'] end @@ -189,12 +188,47 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @client_id.nil? + invalid_properties.push('invalid value for "client_id", client_id cannot be nil.') + end + + if @created_at.nil? + invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') + end + + if @domains.nil? + invalid_properties.push('invalid value for "domains", domains cannot be nil.') + end + + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + + if @is_approved.nil? + invalid_properties.push('invalid value for "is_approved", is_approved cannot be nil.') + end + + if @options.nil? + invalid_properties.push('invalid value for "options", options cannot be nil.') + end + + if @owner_account.nil? + invalid_properties.push('invalid value for "owner_account", owner_account 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 @client_id.nil? + return false if @created_at.nil? + return false if @domains.nil? + return false if @name.nil? + return false if @is_approved.nil? + return false if @options.nil? + return false if @owner_account.nil? true end @@ -203,15 +237,15 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - callback_url == o.callback_url && client_id == o.client_id && created_at == o.created_at && domains == o.domains && name == o.name && is_approved == o.is_approved && - oauth == o.oauth && options == o.options && owner_account == o.owner_account && + callback_url == o.callback_url && + oauth == o.oauth && white_labeling_options == o.white_labeling_options end @@ -224,7 +258,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [callback_url, client_id, created_at, domains, name, is_approved, oauth, options, owner_account, white_labeling_options].hash + [client_id, created_at, domains, name, is_approved, options, owner_account, callback_url, oauth, white_labeling_options].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response_o_auth.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response_o_auth.rb index c17650a5b..1cc322299 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response_o_auth.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response_o_auth.rb @@ -23,10 +23,6 @@ class ApiAppResponseOAuth # @return [String] attr_accessor :callback_url - # The app's OAuth secret, or null if the app does not belong to user. - # @return [String] - attr_accessor :secret - # Array of OAuth scopes used by the app. # @return [Array] attr_accessor :scopes @@ -35,13 +31,17 @@ class ApiAppResponseOAuth # @return [Boolean] attr_accessor :charges_users + # The app's OAuth secret, or null if the app does not belong to user. + # @return [String, nil] + attr_accessor :secret + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'callback_url' => :'callback_url', - :'secret' => :'secret', :'scopes' => :'scopes', - :'charges_users' => :'charges_users' + :'charges_users' => :'charges_users', + :'secret' => :'secret' } end @@ -54,15 +54,16 @@ def self.acceptable_attributes def self.openapi_types { :'callback_url' => :'String', - :'secret' => :'String', :'scopes' => :'Array', - :'charges_users' => :'Boolean' + :'charges_users' => :'Boolean', + :'secret' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'secret' ]) end @@ -110,10 +111,6 @@ def initialize(attributes = {}) self.callback_url = attributes[:'callback_url'] end - if attributes.key?(:'secret') - self.secret = attributes[:'secret'] - end - if attributes.key?(:'scopes') if (value = attributes[:'scopes']).is_a?(Array) self.scopes = value @@ -123,18 +120,37 @@ def initialize(attributes = {}) if attributes.key?(:'charges_users') self.charges_users = attributes[:'charges_users'] end + + if attributes.key?(:'secret') + self.secret = attributes[:'secret'] + end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @callback_url.nil? + invalid_properties.push('invalid value for "callback_url", callback_url cannot be nil.') + end + + if @scopes.nil? + invalid_properties.push('invalid value for "scopes", scopes cannot be nil.') + end + + if @charges_users.nil? + invalid_properties.push('invalid value for "charges_users", charges_users 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 @callback_url.nil? + return false if @scopes.nil? + return false if @charges_users.nil? true end @@ -144,9 +160,9 @@ def ==(o) return true if self.equal?(o) self.class == o.class && callback_url == o.callback_url && - secret == o.secret && scopes == o.scopes && - charges_users == o.charges_users + charges_users == o.charges_users && + secret == o.secret end # @see the `==` method @@ -158,7 +174,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [callback_url, secret, scopes, charges_users].hash + [callback_url, scopes, charges_users, secret].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response_options.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response_options.rb index 8e7742ae2..7370fdbea 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response_options.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response_options.rb @@ -97,12 +97,17 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @can_insert_everywhere.nil? + invalid_properties.push('invalid value for "can_insert_everywhere", can_insert_everywhere 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 @can_insert_everywhere.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response_owner_account.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response_owner_account.rb index 50abb33d1..067aa02f4 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response_owner_account.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response_owner_account.rb @@ -107,12 +107,22 @@ 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 @email_address.nil? + invalid_properties.push('invalid value for "email_address", email_address 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 @email_address.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb index 99f0227d1..be704ff9f 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb @@ -213,12 +213,82 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @header_background_color.nil? + invalid_properties.push('invalid value for "header_background_color", header_background_color cannot be nil.') + end + + if @legal_version.nil? + invalid_properties.push('invalid value for "legal_version", legal_version cannot be nil.') + end + + if @link_color.nil? + invalid_properties.push('invalid value for "link_color", link_color cannot be nil.') + end + + if @page_background_color.nil? + invalid_properties.push('invalid value for "page_background_color", page_background_color cannot be nil.') + end + + if @primary_button_color.nil? + invalid_properties.push('invalid value for "primary_button_color", primary_button_color cannot be nil.') + end + + if @primary_button_color_hover.nil? + invalid_properties.push('invalid value for "primary_button_color_hover", primary_button_color_hover cannot be nil.') + end + + if @primary_button_text_color.nil? + invalid_properties.push('invalid value for "primary_button_text_color", primary_button_text_color cannot be nil.') + end + + if @primary_button_text_color_hover.nil? + invalid_properties.push('invalid value for "primary_button_text_color_hover", primary_button_text_color_hover cannot be nil.') + end + + if @secondary_button_color.nil? + invalid_properties.push('invalid value for "secondary_button_color", secondary_button_color cannot be nil.') + end + + if @secondary_button_color_hover.nil? + invalid_properties.push('invalid value for "secondary_button_color_hover", secondary_button_color_hover cannot be nil.') + end + + if @secondary_button_text_color.nil? + invalid_properties.push('invalid value for "secondary_button_text_color", secondary_button_text_color cannot be nil.') + end + + if @secondary_button_text_color_hover.nil? + invalid_properties.push('invalid value for "secondary_button_text_color_hover", secondary_button_text_color_hover cannot be nil.') + end + + if @text_color1.nil? + invalid_properties.push('invalid value for "text_color1", text_color1 cannot be nil.') + end + + if @text_color2.nil? + invalid_properties.push('invalid value for "text_color2", text_color2 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 @header_background_color.nil? + return false if @legal_version.nil? + return false if @link_color.nil? + return false if @page_background_color.nil? + return false if @primary_button_color.nil? + return false if @primary_button_color_hover.nil? + return false if @primary_button_text_color.nil? + return false if @primary_button_text_color_hover.nil? + return false if @secondary_button_color.nil? + return false if @secondary_button_color_hover.nil? + return false if @secondary_button_text_color.nil? + return false if @secondary_button_text_color_hover.nil? + return false if @text_color1.nil? + return false if @text_color2.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_white_labeling_options.rb b/sdks/ruby/lib/dropbox-sign/models/sub_white_labeling_options.rb index 023a55297..d6c25e221 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_white_labeling_options.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_white_labeling_options.rb @@ -183,7 +183,7 @@ def initialize(attributes = {}) if attributes.key?(:'header_background_color') self.header_background_color = attributes[:'header_background_color'] else - self.header_background_color = '#1A1A1A' + self.header_background_color = '#1a1a1a' end if attributes.key?(:'legal_version') @@ -195,61 +195,61 @@ def initialize(attributes = {}) if attributes.key?(:'link_color') self.link_color = attributes[:'link_color'] else - self.link_color = '#00B3E6' + self.link_color = '#0061FE' end if attributes.key?(:'page_background_color') self.page_background_color = attributes[:'page_background_color'] else - self.page_background_color = '#F7F8F9' + self.page_background_color = '#f7f8f9' end if attributes.key?(:'primary_button_color') self.primary_button_color = attributes[:'primary_button_color'] else - self.primary_button_color = '#00B3E6' + self.primary_button_color = '#0061FE' end if attributes.key?(:'primary_button_color_hover') self.primary_button_color_hover = attributes[:'primary_button_color_hover'] else - self.primary_button_color_hover = '#00B3E6' + self.primary_button_color_hover = '#0061FE' end if attributes.key?(:'primary_button_text_color') self.primary_button_text_color = attributes[:'primary_button_text_color'] else - self.primary_button_text_color = '#FFFFFF' + self.primary_button_text_color = '#ffffff' end if attributes.key?(:'primary_button_text_color_hover') self.primary_button_text_color_hover = attributes[:'primary_button_text_color_hover'] else - self.primary_button_text_color_hover = '#FFFFFF' + self.primary_button_text_color_hover = '#ffffff' end if attributes.key?(:'secondary_button_color') self.secondary_button_color = attributes[:'secondary_button_color'] else - self.secondary_button_color = '#FFFFFF' + self.secondary_button_color = '#ffffff' end if attributes.key?(:'secondary_button_color_hover') self.secondary_button_color_hover = attributes[:'secondary_button_color_hover'] else - self.secondary_button_color_hover = '#FFFFFF' + self.secondary_button_color_hover = '#ffffff' end if attributes.key?(:'secondary_button_text_color') self.secondary_button_text_color = attributes[:'secondary_button_text_color'] else - self.secondary_button_text_color = '#00B3E6' + self.secondary_button_text_color = '#0061FE' end if attributes.key?(:'secondary_button_text_color_hover') self.secondary_button_text_color_hover = attributes[:'secondary_button_text_color_hover'] else - self.secondary_button_text_color_hover = '#00B3E6' + self.secondary_button_text_color_hover = '#0061FE' end if attributes.key?(:'text_color1') @@ -261,7 +261,7 @@ def initialize(attributes = {}) if attributes.key?(:'text_color2') self.text_color2 = attributes[:'text_color2'] else - self.text_color2 = '#FFFFFF' + self.text_color2 = '#ffffff' end if attributes.key?(:'reset_to_default') diff --git a/test_fixtures/ApiAppCreateRequest.json b/test_fixtures/ApiAppCreateRequest.json index ac9729d12..2ee8e41a2 100644 --- a/test_fixtures/ApiAppCreateRequest.json +++ b/test_fixtures/ApiAppCreateRequest.json @@ -18,18 +18,18 @@ "white_labeling_options": { "header_background_color": "#1A1A1A", "legal_version": "terms1", - "link_color": "#00B3E6", - "page_background_color": "#F7F8F9", - "primary_button_color": "#00b3e6", - "primary_button_color_hover": "#00B3E6", + "link_color": "#0061FE", + "page_background_color": "#f7f8f9", + "primary_button_color": "#0061FE", + "primary_button_color_hover": "#0061FE", "primary_button_text_color": "#ffffff", - "primary_button_text_color_hover": "#FFFFFF", - "secondary_button_color": "#FFFFFF", - "secondary_button_color_hover": "#FFFFFF", - "secondary_button_text_color": "#00B3E6", - "secondary_button_text_color_hover": "#00B3E6", + "primary_button_text_color_hover": "#ffffff", + "secondary_button_color": "#ffffff", + "secondary_button_color_hover": "#ffffff", + "secondary_button_text_color": "#0061FE", + "secondary_button_text_color_hover": "#0061FE", "text_color1": "#808080", - "text_color2": "#FFFFFF" + "text_color2": "#ffffff" } } } diff --git a/test_fixtures/ApiAppGetResponse.json b/test_fixtures/ApiAppGetResponse.json index 07843c389..f7d799fe7 100644 --- a/test_fixtures/ApiAppGetResponse.json +++ b/test_fixtures/ApiAppGetResponse.json @@ -7,7 +7,7 @@ "is_approved": false, "name": "My Production App", "oauth": { - "callback_url": "http://example.com/oauth", + "callback_url": "https://example.com/oauth", "scopes": [ "basic_account_info", "request_signature" @@ -15,13 +15,28 @@ "charges_users": false, "secret": "98891a1b59f312d04cd88e4e0c498d75" }, + "options": { + "can_insert_everywhere": true + }, "owner_account": { "account_id": "dc5deeb9e10b044c591ef2475aafad1d1d3bd888", "email_address": "john@example.com" }, "white_labeling_options": { - "primary_button_color": "#00b3e6", - "primary_button_text_color": "#ffffff" + "header_background_color": "#1A1A1A", + "legal_version": "terms1", + "link_color": "#0061FE", + "page_background_color": "#f7f8f9", + "primary_button_color": "#0061FE", + "primary_button_color_hover": "#0061FE", + "primary_button_text_color": "#ffffff", + "primary_button_text_color_hover": "#ffffff", + "secondary_button_color": "#ffffff", + "secondary_button_color_hover": "#ffffff", + "secondary_button_text_color": "#0061FE", + "secondary_button_text_color_hover": "#0061FE", + "text_color1": "#808080", + "text_color2": "#ffffff" } } } diff --git a/test_fixtures/ApiAppListResponse.json b/test_fixtures/ApiAppListResponse.json index 6bbacb494..cc17d45d3 100644 --- a/test_fixtures/ApiAppListResponse.json +++ b/test_fixtures/ApiAppListResponse.json @@ -8,7 +8,7 @@ "is_approved": true, "name": "My Production App", "oauth": { - "callback_url": "http://example.com/oauth", + "callback_url": "https://example.com/oauth", "scopes": [ "basic_account_info", "request_signature" @@ -16,6 +16,9 @@ "charges_users": false, "secret": "98891a1b59f312d04cd88e4e0c498d75" }, + "options": { + "can_insert_everywhere": true + }, "owner_account": { "account_id": "dc5deeb9e10b044c591ef2475aafad1d1d3bd888", "email_address": "john@example.com" @@ -27,6 +30,9 @@ "domains": ["example.com"], "is_approved": false, "name": "My Other App", + "options": { + "can_insert_everywhere": true + }, "owner_account": { "account_id": "dc5deeb9e10b044c591ef2475aafad1d1d3bd888", "email_address": "john@example.com" diff --git a/test_fixtures/ApiAppUpdateRequest.json b/test_fixtures/ApiAppUpdateRequest.json index 4744e05f1..ee4e9ffc8 100644 --- a/test_fixtures/ApiAppUpdateRequest.json +++ b/test_fixtures/ApiAppUpdateRequest.json @@ -4,7 +4,7 @@ "domains": [ "example.com" ], - "callback_url": "http://example.com/dropboxsign", + "callback_url": "https://example.com/dropboxsign", "oauth": { "callback_url": "https://example.com/oauth", "scopes": [ @@ -18,18 +18,18 @@ "white_labeling_options": { "header_background_color": "#1A1A1A", "legal_version": "terms1", - "link_color": "#00B3E6", - "page_background_color": "#F7F8F9", - "primary_button_color": "#00b3e6", - "primary_button_color_hover": "#00B3E6", + "link_color": "#0061FE", + "page_background_color": "#f7f8f9", + "primary_button_color": "#0061FE", + "primary_button_color_hover": "#0061FE", "primary_button_text_color": "#ffffff", - "primary_button_text_color_hover": "#FFFFFF", - "secondary_button_color": "#FFFFFF", - "secondary_button_color_hover": "#FFFFFF", - "secondary_button_text_color": "#00B3E6", - "secondary_button_text_color_hover": "#00B3E6", + "primary_button_text_color_hover": "#ffffff", + "secondary_button_color": "#ffffff", + "secondary_button_color_hover": "#ffffff", + "secondary_button_text_color": "#0061FE", + "secondary_button_text_color_hover": "#0061FE", "text_color1": "#808080", - "text_color2": "#FFFFFF" + "text_color2": "#ffffff" } } } From af1b651c622142333593c526733c5ec7781ca2e1 Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Mon, 14 Oct 2024 12:44:49 -0500 Subject: [PATCH 04/16] Adding docker token to avoid rate limiting (#437) --- .github/workflows/github-actions.yml | 45 ++++++++++++++++++++++++++++ bin/php | 5 ++++ sdks/dotnet/run-build | 5 ++++ sdks/java-v1/run-build | 5 ++++ sdks/java-v2/run-build | 5 ++++ sdks/node/run-build | 5 ++++ sdks/php/run-build | 5 ++++ sdks/python/run-build | 5 ++++ sdks/ruby/run-build | 5 ++++ 9 files changed, 85 insertions(+) diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml index 057d221ac..04e77f00a 100644 --- a/.github/workflows/github-actions.yml +++ b/.github/workflows/github-actions.yml @@ -8,6 +8,9 @@ jobs: - name: Build OpenAPI Spec run: ./build + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Ensure no changes in Generated Code run: ./bin/check-clean-git-status oas @@ -20,9 +23,15 @@ jobs: - name: Build OpenAPI Spec run: ./build + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Build PHP SDK run: ./generate-sdks -t php + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Ensure no changes in Generated Code run: ./bin/check-clean-git-status php @@ -35,9 +44,15 @@ jobs: - name: Build OpenAPI Spec run: ./build + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Build Python SDK run: ./generate-sdks -t python + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Ensure no changes in Generated Code run: ./bin/check-clean-git-status python @@ -50,9 +65,15 @@ jobs: - name: Build OpenAPI Spec run: ./build + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Build Ruby SDK run: ./generate-sdks -t ruby + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Ensure no changes in Generated Code run: ./bin/check-clean-git-status ruby @@ -65,9 +86,15 @@ jobs: - name: Build OpenAPI Spec run: ./build + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Build NodeJs SDK run: ./generate-sdks -t node + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Ensure no changes in Generated Code run: ./bin/check-clean-git-status node @@ -80,9 +107,15 @@ jobs: - name: Build OpenAPI Spec run: ./build + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Build Java SDK run: ./generate-sdks -t java-v1 + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Ensure no changes in Generated Code run: ./bin/check-clean-git-status java-v1 @@ -95,9 +128,15 @@ jobs: - name: Build OpenAPI Spec run: ./build + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Build Java SDK run: ./generate-sdks -t java-v2 + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Ensure no changes in Generated Code run: ./bin/check-clean-git-status java-v2 @@ -110,9 +149,15 @@ jobs: - name: Build OpenAPI Spec run: ./build + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Build DotNet SDK run: ./generate-sdks -t dotnet + env: + DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} + DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}} - name: Ensure no changes in Generated Code run: ./bin/check-clean-git-status dotnet diff --git a/bin/php b/bin/php index 64e039023..e0aa3ee10 100755 --- a/bin/php +++ b/bin/php @@ -8,6 +8,11 @@ DIR=$(cd `dirname $0` && pwd) ROOT_DIR="${DIR}/.." WORKING_DIR="/app/openapi" +if [[ -n "$GITHUB_ACTIONS" ]]; then + printf "\nLogging in to docker.com ...\n" + echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin +fi + docker run --rm \ -v "${ROOT_DIR}:${WORKING_DIR}" \ -v "dropbox-sign-sdk-composer-cache:/.composer" \ diff --git a/sdks/dotnet/run-build b/sdks/dotnet/run-build index 808568a19..06d6bb4c7 100755 --- a/sdks/dotnet/run-build +++ b/sdks/dotnet/run-build @@ -7,6 +7,11 @@ set -e DIR=$(cd `dirname $0` && pwd) WORKING_DIR="/app/dotnet" +if [[ -n "$GITHUB_ACTIONS" ]]; then + printf "\nLogging in to docker.com ...\n" + echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin +fi + docker run --rm \ -v "${DIR}/:/local" \ openapitools/openapi-generator-cli:v7.8.0 generate \ diff --git a/sdks/java-v1/run-build b/sdks/java-v1/run-build index 44a8c5501..63fcb5cbe 100755 --- a/sdks/java-v1/run-build +++ b/sdks/java-v1/run-build @@ -7,6 +7,11 @@ set -e DIR=$(cd `dirname $0` && pwd) WORKING_DIR="/app/java" +if [[ -n "$GITHUB_ACTIONS" ]]; then + printf "\nLogging in to docker.com ...\n" + echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin +fi + docker run --rm \ -v "${DIR}/:/local" \ openapitools/openapi-generator-cli:v7.8.0 generate \ diff --git a/sdks/java-v2/run-build b/sdks/java-v2/run-build index 1e1cfec3e..ad13373ef 100755 --- a/sdks/java-v2/run-build +++ b/sdks/java-v2/run-build @@ -7,6 +7,11 @@ set -e DIR=$(cd `dirname $0` && pwd) WORKING_DIR="/app/java" +if [[ -n "$GITHUB_ACTIONS" ]]; then + printf "\nLogging in to docker.com ...\n" + echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin +fi + docker run --rm \ -v "${DIR}/:/local" \ openapitools/openapi-generator-cli:v7.8.0 generate \ diff --git a/sdks/node/run-build b/sdks/node/run-build index 9bf210d4a..500687ba5 100755 --- a/sdks/node/run-build +++ b/sdks/node/run-build @@ -7,6 +7,11 @@ set -e DIR=$(cd `dirname $0` && pwd) WORKING_DIR="/app/javascript" +if [[ -n "$GITHUB_ACTIONS" ]]; then + printf "\nLogging in to docker.com ...\n" + echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin +fi + # Generate code docker run --rm \ -v "${DIR}/:/local" \ diff --git a/sdks/php/run-build b/sdks/php/run-build index f2d645a92..f96ffef24 100755 --- a/sdks/php/run-build +++ b/sdks/php/run-build @@ -7,6 +7,11 @@ set -e DIR=$(cd `dirname $0` && pwd) WORKING_DIR="/app/php" +if [[ -z "$GITHUB_ACTIONS" ]]; then + printf "\nLogging in to docker.com ...\n" + echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin +fi + docker run --rm \ -v "${DIR}/:/local" \ -v "${DIR}/openapi-sdk.yaml:/local/openapi-sdk.yaml" \ diff --git a/sdks/python/run-build b/sdks/python/run-build index 08a15aa11..94829a43a 100755 --- a/sdks/python/run-build +++ b/sdks/python/run-build @@ -7,6 +7,11 @@ set -e DIR=$(cd `dirname $0` && pwd) WORKING_DIR="/app/python" +if [[ -n "$GITHUB_ACTIONS" ]]; then + printf "\nLogging in to docker.com ...\n" + echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin +fi + docker run --rm \ -v "${DIR}/:/local" \ openapitools/openapi-generator-cli:v7.8.0 generate \ diff --git a/sdks/ruby/run-build b/sdks/ruby/run-build index bf772d8c8..5df7ba9d4 100755 --- a/sdks/ruby/run-build +++ b/sdks/ruby/run-build @@ -7,6 +7,11 @@ set -e DIR=$(cd `dirname $0` && pwd) WORKING_DIR="/app/ruby" +if [[ -n "$GITHUB_ACTIONS" ]]; then + printf "\nLogging in to docker.com ...\n" + echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin +fi + docker run --rm \ -v "${DIR}/:/local" \ openapitools/openapi-generator-cli:v7.8.0 generate \ From 0cfe9362afa7187e0e4f9b8dfbb6b85d8715ad02 Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Mon, 14 Oct 2024 14:41:17 -0500 Subject: [PATCH 05/16] Adding docker token to avoid rate limiting; wrong flag (#438) --- sdks/php/run-build | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdks/php/run-build b/sdks/php/run-build index f96ffef24..de3579e42 100755 --- a/sdks/php/run-build +++ b/sdks/php/run-build @@ -7,7 +7,7 @@ set -e DIR=$(cd `dirname $0` && pwd) WORKING_DIR="/app/php" -if [[ -z "$GITHUB_ACTIONS" ]]; then +if [[ -n "$GITHUB_ACTIONS" ]]; then printf "\nLogging in to docker.com ...\n" echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin fi From 7caa9d80e51e17745de5e720624eb5db2d6a4e4f Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Tue, 15 Oct 2024 08:52:33 -0500 Subject: [PATCH 06/16] Improvements to FaxLine response; reduces nullability (#436) --- openapi-raw.yaml | 5 +++ openapi-sdk.yaml | 5 +++ openapi.yaml | 5 +++ sdks/dotnet/docs/FaxLineResponseFaxLine.md | 2 +- .../Model/FaxLineResponseFaxLine.cs | 26 ++++++++---- sdks/java-v1/docs/FaxLineResponseFaxLine.md | 8 ++-- .../sign/model/FaxLineResponseFaxLine.java | 30 ++++++++------ sdks/java-v2/docs/FaxLineResponseFaxLine.md | 8 ++-- .../sign/model/FaxLineResponseFaxLine.java | 26 ++++++------ .../node/docs/model/FaxLineResponseFaxLine.md | 8 ++-- sdks/node/model/faxLineResponseFaxLine.ts | 8 ++-- .../types/model/faxLineResponseFaxLine.d.ts | 8 ++-- sdks/php/docs/Model/FaxLineResponseFaxLine.md | 8 ++-- sdks/php/src/Model/FaxLineResponseFaxLine.php | 40 +++++++++++++------ sdks/python/docs/FaxLineResponseFaxLine.md | 8 ++-- .../models/fax_line_response_fax_line.py | 10 ++--- sdks/ruby/docs/FaxLineResponseFaxLine.md | 8 ++-- .../models/fax_line_response_fax_line.rb | 20 ++++++++++ 18 files changed, 148 insertions(+), 85 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index facc85abe..3a6326c0e 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -10018,6 +10018,11 @@ components: type: string type: object FaxLineResponseFaxLine: + required: + - accounts + - created_at + - number + - updated_at properties: number: description: '_t__FaxLineResponseFaxLine::NUMBER' diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index ae2e0628b..fdf51e5e2 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -10626,6 +10626,11 @@ components: type: string type: object FaxLineResponseFaxLine: + required: + - accounts + - created_at + - number + - updated_at properties: number: description: Number diff --git a/openapi.yaml b/openapi.yaml index 84dce9f1e..6d7da267d 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -10604,6 +10604,11 @@ components: type: string type: object FaxLineResponseFaxLine: + required: + - accounts + - created_at + - number + - updated_at properties: number: description: Number diff --git a/sdks/dotnet/docs/FaxLineResponseFaxLine.md b/sdks/dotnet/docs/FaxLineResponseFaxLine.md index 672e73d56..d540d8ead 100644 --- a/sdks/dotnet/docs/FaxLineResponseFaxLine.md +++ b/sdks/dotnet/docs/FaxLineResponseFaxLine.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Number** | **string** | Number | [optional] **CreatedAt** | **int** | Created at | [optional] **UpdatedAt** | **int** | Updated at | [optional] **Accounts** | [**List<AccountResponse>**](AccountResponse.md) | | [optional] +**Number** | **string** | Number | **CreatedAt** | **int** | Created at | **UpdatedAt** | **int** | Updated at | **Accounts** | [**List<AccountResponse>**](AccountResponse.md) | | [[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/FaxLineResponseFaxLine.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineResponseFaxLine.cs index f52374953..c2261e452 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineResponseFaxLine.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineResponseFaxLine.cs @@ -41,16 +41,26 @@ protected FaxLineResponseFaxLine() { } /// /// Initializes a new instance of the class. /// - /// Number. - /// Created at. - /// Updated at. - /// accounts. + /// Number (required). + /// Created at (required). + /// Updated at (required). + /// accounts (required). public FaxLineResponseFaxLine(string number = default(string), int createdAt = default(int), int updatedAt = default(int), List accounts = default(List)) { + // to ensure "number" is required (not null) + if (number == null) + { + throw new ArgumentNullException("number is a required property for FaxLineResponseFaxLine and cannot be null"); + } this.Number = number; this.CreatedAt = createdAt; this.UpdatedAt = updatedAt; + // to ensure "accounts" is required (not null) + if (accounts == null) + { + throw new ArgumentNullException("accounts is a required property for FaxLineResponseFaxLine and cannot be null"); + } this.Accounts = accounts; } @@ -74,27 +84,27 @@ public static FaxLineResponseFaxLine Init(string jsonData) /// Number /// /// Number - [DataMember(Name = "number", EmitDefaultValue = true)] + [DataMember(Name = "number", IsRequired = true, EmitDefaultValue = true)] public string Number { get; set; } /// /// Created at /// /// Created at - [DataMember(Name = "created_at", EmitDefaultValue = true)] + [DataMember(Name = "created_at", IsRequired = true, EmitDefaultValue = true)] public int CreatedAt { get; set; } /// /// Updated at /// /// Updated at - [DataMember(Name = "updated_at", EmitDefaultValue = true)] + [DataMember(Name = "updated_at", IsRequired = true, EmitDefaultValue = true)] public int UpdatedAt { get; set; } /// /// Gets or Sets Accounts /// - [DataMember(Name = "accounts", EmitDefaultValue = true)] + [DataMember(Name = "accounts", IsRequired = true, EmitDefaultValue = true)] public List Accounts { get; set; } /// diff --git a/sdks/java-v1/docs/FaxLineResponseFaxLine.md b/sdks/java-v1/docs/FaxLineResponseFaxLine.md index daf0d206a..eac0a881f 100644 --- a/sdks/java-v1/docs/FaxLineResponseFaxLine.md +++ b/sdks/java-v1/docs/FaxLineResponseFaxLine.md @@ -8,10 +8,10 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number` | ```String``` | Number | | -| `createdAt` | ```Integer``` | Created at | | -| `updatedAt` | ```Integer``` | Updated at | | -| `accounts` | [```List```](AccountResponse.md) | | | +| `number`*_required_ | ```String``` | Number | | +| `createdAt`*_required_ | ```Integer``` | Created at | | +| `updatedAt`*_required_ | ```Integer``` | Updated at | | +| `accounts`*_required_ | [```List```](AccountResponse.md) | | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java index 63ef50b37..a10a53a32 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java @@ -47,7 +47,7 @@ public class FaxLineResponseFaxLine { private Integer updatedAt; public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private List accounts = null; + private List accounts = new ArrayList<>(); public FaxLineResponseFaxLine() {} @@ -76,14 +76,15 @@ public FaxLineResponseFaxLine number(String number) { * * @return number */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NUMBER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NUMBER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getNumber() { return number; } @JsonProperty(JSON_PROPERTY_NUMBER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setNumber(String number) { this.number = number; } @@ -98,14 +99,15 @@ public FaxLineResponseFaxLine createdAt(Integer createdAt) { * * @return createdAt */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CREATED_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getCreatedAt() { return createdAt; } @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCreatedAt(Integer createdAt) { this.createdAt = createdAt; } @@ -120,14 +122,15 @@ public FaxLineResponseFaxLine updatedAt(Integer updatedAt) { * * @return updatedAt */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getUpdatedAt() { return updatedAt; } @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setUpdatedAt(Integer updatedAt) { this.updatedAt = updatedAt; } @@ -150,14 +153,15 @@ public FaxLineResponseFaxLine addAccountsItem(AccountResponse accountsItem) { * * @return accounts */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getAccounts() { return accounts; } @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAccounts(List accounts) { this.accounts = accounts; } diff --git a/sdks/java-v2/docs/FaxLineResponseFaxLine.md b/sdks/java-v2/docs/FaxLineResponseFaxLine.md index daf0d206a..eac0a881f 100644 --- a/sdks/java-v2/docs/FaxLineResponseFaxLine.md +++ b/sdks/java-v2/docs/FaxLineResponseFaxLine.md @@ -8,10 +8,10 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number` | ```String``` | Number | | -| `createdAt` | ```Integer``` | Created at | | -| `updatedAt` | ```Integer``` | Updated at | | -| `accounts` | [```List```](AccountResponse.md) | | | +| `number`*_required_ | ```String``` | Number | | +| `createdAt`*_required_ | ```Integer``` | Created at | | +| `updatedAt`*_required_ | ```Integer``` | Updated at | | +| `accounts`*_required_ | [```List```](AccountResponse.md) | | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java index 9b6b8c893..3dfe4de09 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java @@ -54,7 +54,7 @@ public class FaxLineResponseFaxLine { private Integer updatedAt; public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private List accounts = null; + private List accounts = new ArrayList<>(); public FaxLineResponseFaxLine() { } @@ -83,9 +83,9 @@ public FaxLineResponseFaxLine number(String number) { * Number * @return number */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NUMBER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getNumber() { return number; @@ -93,7 +93,7 @@ public String getNumber() { @JsonProperty(JSON_PROPERTY_NUMBER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setNumber(String number) { this.number = number; } @@ -108,9 +108,9 @@ public FaxLineResponseFaxLine createdAt(Integer createdAt) { * Created at * @return createdAt */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getCreatedAt() { return createdAt; @@ -118,7 +118,7 @@ public Integer getCreatedAt() { @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCreatedAt(Integer createdAt) { this.createdAt = createdAt; } @@ -133,9 +133,9 @@ public FaxLineResponseFaxLine updatedAt(Integer updatedAt) { * Updated at * @return updatedAt */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getUpdatedAt() { return updatedAt; @@ -143,7 +143,7 @@ public Integer getUpdatedAt() { @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setUpdatedAt(Integer updatedAt) { this.updatedAt = updatedAt; } @@ -166,9 +166,9 @@ public FaxLineResponseFaxLine addAccountsItem(AccountResponse accountsItem) { * Get accounts * @return accounts */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getAccounts() { return accounts; @@ -176,7 +176,7 @@ public List getAccounts() { @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAccounts(List accounts) { this.accounts = accounts; } diff --git a/sdks/node/docs/model/FaxLineResponseFaxLine.md b/sdks/node/docs/model/FaxLineResponseFaxLine.md index aaf5b0f21..c3b4d6cb8 100644 --- a/sdks/node/docs/model/FaxLineResponseFaxLine.md +++ b/sdks/node/docs/model/FaxLineResponseFaxLine.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number` | ```string``` | Number | | -| `createdAt` | ```number``` | Created at | | -| `updatedAt` | ```number``` | Updated at | | -| `accounts` | [```Array```](AccountResponse.md) | | | +| `number`*_required_ | ```string``` | Number | | +| `createdAt`*_required_ | ```number``` | Created at | | +| `updatedAt`*_required_ | ```number``` | Updated at | | +| `accounts`*_required_ | [```Array```](AccountResponse.md) | | | [[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/faxLineResponseFaxLine.ts b/sdks/node/model/faxLineResponseFaxLine.ts index aeefe37e2..4aa2b965d 100644 --- a/sdks/node/model/faxLineResponseFaxLine.ts +++ b/sdks/node/model/faxLineResponseFaxLine.ts @@ -29,16 +29,16 @@ export class FaxLineResponseFaxLine { /** * Number */ - "number"?: string; + "number": string; /** * Created at */ - "createdAt"?: number; + "createdAt": number; /** * Updated at */ - "updatedAt"?: number; - "accounts"?: Array; + "updatedAt": number; + "accounts": Array; static discriminator: string | undefined = undefined; diff --git a/sdks/node/types/model/faxLineResponseFaxLine.d.ts b/sdks/node/types/model/faxLineResponseFaxLine.d.ts index d5f8c4aa7..0a7f43ef1 100644 --- a/sdks/node/types/model/faxLineResponseFaxLine.d.ts +++ b/sdks/node/types/model/faxLineResponseFaxLine.d.ts @@ -1,10 +1,10 @@ import { AttributeTypeMap } from "./"; import { AccountResponse } from "./accountResponse"; export declare class FaxLineResponseFaxLine { - "number"?: string; - "createdAt"?: number; - "updatedAt"?: number; - "accounts"?: Array; + "number": string; + "createdAt": number; + "updatedAt": number; + "accounts": Array; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/php/docs/Model/FaxLineResponseFaxLine.md b/sdks/php/docs/Model/FaxLineResponseFaxLine.md index 51f479adc..b9865f1fd 100644 --- a/sdks/php/docs/Model/FaxLineResponseFaxLine.md +++ b/sdks/php/docs/Model/FaxLineResponseFaxLine.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number` | ```string``` | Number | | -| `created_at` | ```int``` | Created at | | -| `updated_at` | ```int``` | Updated at | | -| `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | | +| `number`*_required_ | ```string``` | Number | | +| `created_at`*_required_ | ```int``` | Created at | | +| `updated_at`*_required_ | ```int``` | Updated at | | +| `accounts`*_required_ | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | | [[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/FaxLineResponseFaxLine.php b/sdks/php/src/Model/FaxLineResponseFaxLine.php index 4a3fe8fa7..be4353981 100644 --- a/sdks/php/src/Model/FaxLineResponseFaxLine.php +++ b/sdks/php/src/Model/FaxLineResponseFaxLine.php @@ -302,7 +302,21 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['number'] === null) { + $invalidProperties[] = "'number' can't be null"; + } + if ($this->container['created_at'] === null) { + $invalidProperties[] = "'created_at' can't be null"; + } + if ($this->container['updated_at'] === null) { + $invalidProperties[] = "'updated_at' can't be null"; + } + if ($this->container['accounts'] === null) { + $invalidProperties[] = "'accounts' can't be null"; + } + return $invalidProperties; } /** @@ -319,7 +333,7 @@ public function valid() /** * Gets number * - * @return string|null + * @return string */ public function getNumber() { @@ -329,11 +343,11 @@ public function getNumber() /** * Sets number * - * @param string|null $number Number + * @param string $number Number * * @return self */ - public function setNumber(?string $number) + public function setNumber(string $number) { if (is_null($number)) { throw new InvalidArgumentException('non-nullable number cannot be null'); @@ -346,7 +360,7 @@ public function setNumber(?string $number) /** * Gets created_at * - * @return int|null + * @return int */ public function getCreatedAt() { @@ -356,11 +370,11 @@ public function getCreatedAt() /** * Sets created_at * - * @param int|null $created_at Created at + * @param int $created_at Created at * * @return self */ - public function setCreatedAt(?int $created_at) + public function setCreatedAt(int $created_at) { if (is_null($created_at)) { throw new InvalidArgumentException('non-nullable created_at cannot be null'); @@ -373,7 +387,7 @@ public function setCreatedAt(?int $created_at) /** * Gets updated_at * - * @return int|null + * @return int */ public function getUpdatedAt() { @@ -383,11 +397,11 @@ public function getUpdatedAt() /** * Sets updated_at * - * @param int|null $updated_at Updated at + * @param int $updated_at Updated at * * @return self */ - public function setUpdatedAt(?int $updated_at) + public function setUpdatedAt(int $updated_at) { if (is_null($updated_at)) { throw new InvalidArgumentException('non-nullable updated_at cannot be null'); @@ -400,7 +414,7 @@ public function setUpdatedAt(?int $updated_at) /** * Gets accounts * - * @return AccountResponse[]|null + * @return AccountResponse[] */ public function getAccounts() { @@ -410,11 +424,11 @@ public function getAccounts() /** * Sets accounts * - * @param AccountResponse[]|null $accounts accounts + * @param AccountResponse[] $accounts accounts * * @return self */ - public function setAccounts(?array $accounts) + public function setAccounts(array $accounts) { if (is_null($accounts)) { throw new InvalidArgumentException('non-nullable accounts cannot be null'); diff --git a/sdks/python/docs/FaxLineResponseFaxLine.md b/sdks/python/docs/FaxLineResponseFaxLine.md index f3e14c0f7..ac5821f1b 100644 --- a/sdks/python/docs/FaxLineResponseFaxLine.md +++ b/sdks/python/docs/FaxLineResponseFaxLine.md @@ -5,10 +5,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number` | ```str``` | Number | | -| `created_at` | ```int``` | Created at | | -| `updated_at` | ```int``` | Updated at | | -| `accounts` | [```List[AccountResponse]```](AccountResponse.md) | | | +| `number`*_required_ | ```str``` | Number | | +| `created_at`*_required_ | ```int``` | Created at | | +| `updated_at`*_required_ | ```int``` | Updated at | | +| `accounts`*_required_ | [```List[AccountResponse]```](AccountResponse.md) | | | [[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/fax_line_response_fax_line.py b/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py index 7d89f44cc..ac486d75d 100644 --- a/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py +++ b/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Optional +from typing import Any, ClassVar, Dict, List from dropbox_sign.models.account_response import AccountResponse from typing import Optional, Set, Tuple from typing_extensions import Self @@ -33,10 +33,10 @@ class FaxLineResponseFaxLine(BaseModel): FaxLineResponseFaxLine """ # noqa: E501 - number: Optional[StrictStr] = Field(default=None, description="Number") - created_at: Optional[StrictInt] = Field(default=None, description="Created at") - updated_at: Optional[StrictInt] = Field(default=None, description="Updated at") - accounts: Optional[List[AccountResponse]] = None + number: StrictStr = Field(description="Number") + created_at: StrictInt = Field(description="Created at") + updated_at: StrictInt = Field(description="Updated at") + accounts: List[AccountResponse] __properties: ClassVar[List[str]] = [ "number", "created_at", diff --git a/sdks/ruby/docs/FaxLineResponseFaxLine.md b/sdks/ruby/docs/FaxLineResponseFaxLine.md index 03d2a1d95..390bdd37f 100644 --- a/sdks/ruby/docs/FaxLineResponseFaxLine.md +++ b/sdks/ruby/docs/FaxLineResponseFaxLine.md @@ -6,8 +6,8 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number` | ```String``` | Number | | -| `created_at` | ```Integer``` | Created at | | -| `updated_at` | ```Integer``` | Updated at | | -| `accounts` | [```Array```](AccountResponse.md) | | | +| `number`*_required_ | ```String``` | Number | | +| `created_at`*_required_ | ```Integer``` | Created at | | +| `updated_at`*_required_ | ```Integer``` | Updated at | | +| `accounts`*_required_ | [```Array```](AccountResponse.md) | | | diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_line_response_fax_line.rb b/sdks/ruby/lib/dropbox-sign/models/fax_line_response_fax_line.rb index 02d7797ab..a293f3e77 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_line_response_fax_line.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_line_response_fax_line.rb @@ -127,12 +127,32 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @number.nil? + invalid_properties.push('invalid value for "number", number cannot be nil.') + end + + if @created_at.nil? + invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') + end + + if @updated_at.nil? + invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.') + end + + if @accounts.nil? + invalid_properties.push('invalid value for "accounts", accounts 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 @number.nil? + return false if @created_at.nil? + return false if @updated_at.nil? + return false if @accounts.nil? true end From 6a2a39b3a0a5165c39da60c99b8bd6cba7be8447 Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Tue, 15 Oct 2024 13:17:32 -0500 Subject: [PATCH 07/16] Improvements to Team response; reduces nullability (#439) --- .../json/TeamAddMemberResponseExample.json | 6 ++- examples/json/TeamGetResponseExample.json | 21 +++++++++- .../json/TeamRemoveMemberResponseExample.json | 21 +++++++++- examples/json/TeamUpdateResponseExample.json | 21 +++++++++- openapi-raw.yaml | 5 +++ openapi-sdk.yaml | 5 +++ openapi.yaml | 5 +++ sdks/dotnet/docs/TeamResponse.md | 2 +- .../src/Dropbox.Sign/Model/TeamResponse.cs | 36 +++++++++++++---- sdks/java-v1/docs/TeamResponse.md | 8 ++-- .../com/dropbox/sign/model/TeamResponse.java | 34 +++++++++------- sdks/java-v2/docs/TeamResponse.md | 8 ++-- .../com/dropbox/sign/model/TeamResponse.java | 30 +++++++------- sdks/node/docs/model/TeamResponse.md | 8 ++-- sdks/node/model/teamResponse.ts | 8 ++-- sdks/node/types/model/teamResponse.d.ts | 8 ++-- sdks/php/docs/Model/TeamResponse.md | 8 ++-- sdks/php/src/Model/TeamResponse.php | 40 +++++++++++++------ sdks/python/docs/TeamResponse.md | 8 ++-- .../dropbox_sign/models/team_response.py | 16 ++++---- sdks/ruby/docs/TeamResponse.md | 8 ++-- .../lib/dropbox-sign/models/team_response.rb | 20 ++++++++++ test_fixtures/TeamGetResponse.json | 5 +++ 23 files changed, 231 insertions(+), 100 deletions(-) diff --git a/examples/json/TeamAddMemberResponseExample.json b/examples/json/TeamAddMemberResponseExample.json index 01cc872b6..c0131e0b5 100644 --- a/examples/json/TeamAddMemberResponseExample.json +++ b/examples/json/TeamAddMemberResponseExample.json @@ -30,6 +30,10 @@ } } ], - "invited_emails": [] + "invited_emails": [ + "invite_1@example.com", + "invite_2@example.com", + "invite_3@example.com" + ] } } diff --git a/examples/json/TeamGetResponseExample.json b/examples/json/TeamGetResponseExample.json index 6136d4172..56117a96e 100644 --- a/examples/json/TeamGetResponseExample.json +++ b/examples/json/TeamGetResponseExample.json @@ -29,7 +29,24 @@ "role_code": "m" } ], - "invited_accounts": [], - "invited_emails": [] + "invited_accounts": [ + { + "account_id": "8e239b5a50eac117fdd9a0e2359620aa57cb2463", + "email_address": "george@hellofax.com", + "is_locked": false, + "is_paid_hs": false, + "is_paid_hf": false, + "quotas": { + "templates_left": 0, + "documents_left": 3, + "api_signature_requests_left": 0 + } + } + ], + "invited_emails": [ + "invite_1@example.com", + "invite_2@example.com", + "invite_3@example.com" + ] } } diff --git a/examples/json/TeamRemoveMemberResponseExample.json b/examples/json/TeamRemoveMemberResponseExample.json index 0f9d0cb4c..e31b8a809 100644 --- a/examples/json/TeamRemoveMemberResponseExample.json +++ b/examples/json/TeamRemoveMemberResponseExample.json @@ -16,7 +16,24 @@ "role_code": "a" } ], - "invited_accounts": [], - "invited_emails": [] + "invited_accounts": [ + { + "account_id": "8e239b5a50eac117fdd9a0e2359620aa57cb2463", + "email_address": "george@hellofax.com", + "is_locked": false, + "is_paid_hs": false, + "is_paid_hf": false, + "quotas": { + "templates_left": 0, + "documents_left": 3, + "api_signature_requests_left": 0 + } + } + ], + "invited_emails": [ + "invite_1@example.com", + "invite_2@example.com", + "invite_3@example.com" + ] } } diff --git a/examples/json/TeamUpdateResponseExample.json b/examples/json/TeamUpdateResponseExample.json index 9e91f9856..c0131e0b5 100644 --- a/examples/json/TeamUpdateResponseExample.json +++ b/examples/json/TeamUpdateResponseExample.json @@ -16,7 +16,24 @@ "role_code": "a" } ], - "invited_accounts": [], - "invited_emails": [] + "invited_accounts": [ + { + "account_id": "8e239b5a50eac117fdd9a0e2359620aa57cb2463", + "email_address": "george@hellofax.com", + "is_locked": false, + "is_paid_hs": false, + "is_paid_hf": false, + "quotas": { + "templates_left": 0, + "documents_left": 3, + "api_signature_requests_left": 0 + } + } + ], + "invited_emails": [ + "invite_1@example.com", + "invite_2@example.com", + "invite_3@example.com" + ] } } diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 3a6326c0e..f610c00d2 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -10532,6 +10532,11 @@ components: x-internal-class: true TeamResponse: description: '_t__TeamResponse::DESCRIPTION' + required: + - name + - accounts + - invited_accounts + - invited_emails properties: name: description: '_t__Team::NAME' diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index fdf51e5e2..896668221 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -11148,6 +11148,11 @@ components: x-internal-class: true TeamResponse: description: 'Contains information about your team and its members' + required: + - name + - accounts + - invited_accounts + - invited_emails properties: name: description: 'The name of your Team' diff --git a/openapi.yaml b/openapi.yaml index 6d7da267d..487826fac 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -11126,6 +11126,11 @@ components: x-internal-class: true TeamResponse: description: 'Contains information about your team and its members' + required: + - name + - accounts + - invited_accounts + - invited_emails properties: name: description: 'The name of your Team' diff --git a/sdks/dotnet/docs/TeamResponse.md b/sdks/dotnet/docs/TeamResponse.md index 977696c0a..65276cf8e 100644 --- a/sdks/dotnet/docs/TeamResponse.md +++ b/sdks/dotnet/docs/TeamResponse.md @@ -5,7 +5,7 @@ Contains information about your team and its members Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of your Team | [optional] **Accounts** | [**List<AccountResponse>**](AccountResponse.md) | | [optional] **InvitedAccounts** | [**List<AccountResponse>**](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | [optional] **InvitedEmails** | **List<string>** | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | [optional] +**Name** | **string** | The name of your Team | **Accounts** | [**List<AccountResponse>**](AccountResponse.md) | | **InvitedAccounts** | [**List<AccountResponse>**](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | **InvitedEmails** | **List<string>** | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | [[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/TeamResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs index 56d78eb53..11b18b70a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs @@ -41,16 +41,36 @@ protected TeamResponse() { } /// /// Initializes a new instance of the class. /// - /// The name of your Team. - /// accounts. - /// A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`.. - /// A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account.. + /// The name of your Team (required). + /// accounts (required). + /// A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. (required). + /// A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. (required). public TeamResponse(string name = default(string), List accounts = default(List), List invitedAccounts = default(List), List invitedEmails = default(List)) { + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TeamResponse and cannot be null"); + } this.Name = name; + // to ensure "accounts" is required (not null) + if (accounts == null) + { + throw new ArgumentNullException("accounts is a required property for TeamResponse and cannot be null"); + } this.Accounts = accounts; + // to ensure "invitedAccounts" is required (not null) + if (invitedAccounts == null) + { + throw new ArgumentNullException("invitedAccounts is a required property for TeamResponse and cannot be null"); + } this.InvitedAccounts = invitedAccounts; + // to ensure "invitedEmails" is required (not null) + if (invitedEmails == null) + { + throw new ArgumentNullException("invitedEmails is a required property for TeamResponse and cannot be null"); + } this.InvitedEmails = invitedEmails; } @@ -74,27 +94,27 @@ public static TeamResponse Init(string jsonData) /// The name of your Team /// /// The name of your Team - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// /// Gets or Sets Accounts /// - [DataMember(Name = "accounts", EmitDefaultValue = true)] + [DataMember(Name = "accounts", IsRequired = true, EmitDefaultValue = true)] public List Accounts { get; set; } /// /// A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. /// /// A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. - [DataMember(Name = "invited_accounts", EmitDefaultValue = true)] + [DataMember(Name = "invited_accounts", IsRequired = true, EmitDefaultValue = true)] public List InvitedAccounts { get; set; } /// /// A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. /// /// A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. - [DataMember(Name = "invited_emails", EmitDefaultValue = true)] + [DataMember(Name = "invited_emails", IsRequired = true, EmitDefaultValue = true)] public List InvitedEmails { get; set; } /// diff --git a/sdks/java-v1/docs/TeamResponse.md b/sdks/java-v1/docs/TeamResponse.md index ca6344cfc..6dfe49923 100644 --- a/sdks/java-v1/docs/TeamResponse.md +++ b/sdks/java-v1/docs/TeamResponse.md @@ -8,10 +8,10 @@ Contains information about your team and its members | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of your Team | | -| `accounts` | [```List```](AccountResponse.md) | | | -| `invitedAccounts` | [```List```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | -| `invitedEmails` | ```List``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `name`*_required_ | ```String``` | The name of your Team | | +| `accounts`*_required_ | [```List```](AccountResponse.md) | | | +| `invitedAccounts`*_required_ | [```List```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | +| `invitedEmails`*_required_ | ```List``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java index 2abc906c6..10d54cb32 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java @@ -41,13 +41,13 @@ public class TeamResponse { private String name; public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private List accounts = null; + private List accounts = new ArrayList<>(); public static final String JSON_PROPERTY_INVITED_ACCOUNTS = "invited_accounts"; - private List invitedAccounts = null; + private List invitedAccounts = new ArrayList<>(); public static final String JSON_PROPERTY_INVITED_EMAILS = "invited_emails"; - private List invitedEmails = null; + private List invitedEmails = new ArrayList<>(); public TeamResponse() {} @@ -75,14 +75,15 @@ public TeamResponse name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } @@ -105,14 +106,15 @@ public TeamResponse addAccountsItem(AccountResponse accountsItem) { * * @return accounts */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getAccounts() { return accounts; } @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAccounts(List accounts) { this.accounts = accounts; } @@ -136,14 +138,15 @@ public TeamResponse addInvitedAccountsItem(AccountResponse invitedAccountsItem) * * @return invitedAccounts */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_INVITED_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_INVITED_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getInvitedAccounts() { return invitedAccounts; } @JsonProperty(JSON_PROPERTY_INVITED_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setInvitedAccounts(List invitedAccounts) { this.invitedAccounts = invitedAccounts; } @@ -167,14 +170,15 @@ public TeamResponse addInvitedEmailsItem(String invitedEmailsItem) { * * @return invitedEmails */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_INVITED_EMAILS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_INVITED_EMAILS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getInvitedEmails() { return invitedEmails; } @JsonProperty(JSON_PROPERTY_INVITED_EMAILS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setInvitedEmails(List invitedEmails) { this.invitedEmails = invitedEmails; } diff --git a/sdks/java-v2/docs/TeamResponse.md b/sdks/java-v2/docs/TeamResponse.md index ca6344cfc..6dfe49923 100644 --- a/sdks/java-v2/docs/TeamResponse.md +++ b/sdks/java-v2/docs/TeamResponse.md @@ -8,10 +8,10 @@ Contains information about your team and its members | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of your Team | | -| `accounts` | [```List```](AccountResponse.md) | | | -| `invitedAccounts` | [```List```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | -| `invitedEmails` | ```List``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `name`*_required_ | ```String``` | The name of your Team | | +| `accounts`*_required_ | [```List```](AccountResponse.md) | | | +| `invitedAccounts`*_required_ | [```List```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | +| `invitedEmails`*_required_ | ```List``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java index 39a93c476..2460f8a72 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java @@ -48,13 +48,13 @@ public class TeamResponse { private String name; public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private List accounts = null; + private List accounts = new ArrayList<>(); public static final String JSON_PROPERTY_INVITED_ACCOUNTS = "invited_accounts"; - private List invitedAccounts = null; + private List invitedAccounts = new ArrayList<>(); public static final String JSON_PROPERTY_INVITED_EMAILS = "invited_emails"; - private List invitedEmails = null; + private List invitedEmails = new ArrayList<>(); public TeamResponse() { } @@ -83,9 +83,9 @@ public TeamResponse name(String name) { * The name of your Team * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -93,7 +93,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } @@ -116,9 +116,9 @@ public TeamResponse addAccountsItem(AccountResponse accountsItem) { * Get accounts * @return accounts */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getAccounts() { return accounts; @@ -126,7 +126,7 @@ public List getAccounts() { @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAccounts(List accounts) { this.accounts = accounts; } @@ -149,9 +149,9 @@ public TeamResponse addInvitedAccountsItem(AccountResponse invitedAccountsItem) * A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. * @return invitedAccounts */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_INVITED_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getInvitedAccounts() { return invitedAccounts; @@ -159,7 +159,7 @@ public List getInvitedAccounts() { @JsonProperty(JSON_PROPERTY_INVITED_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setInvitedAccounts(List invitedAccounts) { this.invitedAccounts = invitedAccounts; } @@ -182,9 +182,9 @@ public TeamResponse addInvitedEmailsItem(String invitedEmailsItem) { * A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. * @return invitedEmails */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_INVITED_EMAILS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getInvitedEmails() { return invitedEmails; @@ -192,7 +192,7 @@ public List getInvitedEmails() { @JsonProperty(JSON_PROPERTY_INVITED_EMAILS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setInvitedEmails(List invitedEmails) { this.invitedEmails = invitedEmails; } diff --git a/sdks/node/docs/model/TeamResponse.md b/sdks/node/docs/model/TeamResponse.md index 39f6ae7fb..db6303351 100644 --- a/sdks/node/docs/model/TeamResponse.md +++ b/sdks/node/docs/model/TeamResponse.md @@ -6,9 +6,9 @@ Contains information about your team and its members Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of your Team | | -| `accounts` | [```Array```](AccountResponse.md) | | | -| `invitedAccounts` | [```Array```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | -| `invitedEmails` | ```Array``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `name`*_required_ | ```string``` | The name of your Team | | +| `accounts`*_required_ | [```Array```](AccountResponse.md) | | | +| `invitedAccounts`*_required_ | [```Array```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | +| `invitedEmails`*_required_ | ```Array``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | [[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/teamResponse.ts b/sdks/node/model/teamResponse.ts index 4d0a233d0..3cefae27f 100644 --- a/sdks/node/model/teamResponse.ts +++ b/sdks/node/model/teamResponse.ts @@ -32,16 +32,16 @@ export class TeamResponse { /** * The name of your Team */ - "name"?: string; - "accounts"?: Array; + "name": string; + "accounts": Array; /** * A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. */ - "invitedAccounts"?: Array; + "invitedAccounts": Array; /** * A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. */ - "invitedEmails"?: Array; + "invitedEmails": Array; static discriminator: string | undefined = undefined; diff --git a/sdks/node/types/model/teamResponse.d.ts b/sdks/node/types/model/teamResponse.d.ts index cb7861bd9..40b654a8b 100644 --- a/sdks/node/types/model/teamResponse.d.ts +++ b/sdks/node/types/model/teamResponse.d.ts @@ -1,10 +1,10 @@ import { AttributeTypeMap } from "./"; import { AccountResponse } from "./accountResponse"; export declare class TeamResponse { - "name"?: string; - "accounts"?: Array; - "invitedAccounts"?: Array; - "invitedEmails"?: Array; + "name": string; + "accounts": Array; + "invitedAccounts": Array; + "invitedEmails": Array; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/php/docs/Model/TeamResponse.md b/sdks/php/docs/Model/TeamResponse.md index 4aea582c9..926e6e00c 100644 --- a/sdks/php/docs/Model/TeamResponse.md +++ b/sdks/php/docs/Model/TeamResponse.md @@ -6,9 +6,9 @@ Contains information about your team and its members Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of your Team | | -| `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | | -| `invited_accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | -| `invited_emails` | ```string[]``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `name`*_required_ | ```string``` | The name of your Team | | +| `accounts`*_required_ | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | | +| `invited_accounts`*_required_ | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | +| `invited_emails`*_required_ | ```string[]``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | [[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/TeamResponse.php b/sdks/php/src/Model/TeamResponse.php index 402916a49..e2b2be949 100644 --- a/sdks/php/src/Model/TeamResponse.php +++ b/sdks/php/src/Model/TeamResponse.php @@ -303,7 +303,21 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } + if ($this->container['accounts'] === null) { + $invalidProperties[] = "'accounts' can't be null"; + } + if ($this->container['invited_accounts'] === null) { + $invalidProperties[] = "'invited_accounts' can't be null"; + } + if ($this->container['invited_emails'] === null) { + $invalidProperties[] = "'invited_emails' can't be null"; + } + return $invalidProperties; } /** @@ -320,7 +334,7 @@ public function valid() /** * Gets name * - * @return string|null + * @return string */ public function getName() { @@ -330,11 +344,11 @@ public function getName() /** * Sets name * - * @param string|null $name The name of your Team + * @param string $name The name of your Team * * @return self */ - public function setName(?string $name) + public function setName(string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); @@ -347,7 +361,7 @@ public function setName(?string $name) /** * Gets accounts * - * @return AccountResponse[]|null + * @return AccountResponse[] */ public function getAccounts() { @@ -357,11 +371,11 @@ public function getAccounts() /** * Sets accounts * - * @param AccountResponse[]|null $accounts accounts + * @param AccountResponse[] $accounts accounts * * @return self */ - public function setAccounts(?array $accounts) + public function setAccounts(array $accounts) { if (is_null($accounts)) { throw new InvalidArgumentException('non-nullable accounts cannot be null'); @@ -374,7 +388,7 @@ public function setAccounts(?array $accounts) /** * Gets invited_accounts * - * @return AccountResponse[]|null + * @return AccountResponse[] */ public function getInvitedAccounts() { @@ -384,11 +398,11 @@ public function getInvitedAccounts() /** * Sets invited_accounts * - * @param AccountResponse[]|null $invited_accounts A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. + * @param AccountResponse[] $invited_accounts A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. * * @return self */ - public function setInvitedAccounts(?array $invited_accounts) + public function setInvitedAccounts(array $invited_accounts) { if (is_null($invited_accounts)) { throw new InvalidArgumentException('non-nullable invited_accounts cannot be null'); @@ -401,7 +415,7 @@ public function setInvitedAccounts(?array $invited_accounts) /** * Gets invited_emails * - * @return string[]|null + * @return string[] */ public function getInvitedEmails() { @@ -411,11 +425,11 @@ public function getInvitedEmails() /** * Sets invited_emails * - * @param string[]|null $invited_emails a list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account + * @param string[] $invited_emails a list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account * * @return self */ - public function setInvitedEmails(?array $invited_emails) + public function setInvitedEmails(array $invited_emails) { if (is_null($invited_emails)) { throw new InvalidArgumentException('non-nullable invited_emails cannot be null'); diff --git a/sdks/python/docs/TeamResponse.md b/sdks/python/docs/TeamResponse.md index 150fd646e..05256b88e 100644 --- a/sdks/python/docs/TeamResponse.md +++ b/sdks/python/docs/TeamResponse.md @@ -5,10 +5,10 @@ Contains information about your team and its members ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | The name of your Team | | -| `accounts` | [```List[AccountResponse]```](AccountResponse.md) | | | -| `invited_accounts` | [```List[AccountResponse]```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | -| `invited_emails` | ```List[str]``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `name`*_required_ | ```str``` | The name of your Team | | +| `accounts`*_required_ | [```List[AccountResponse]```](AccountResponse.md) | | | +| `invited_accounts`*_required_ | [```List[AccountResponse]```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | +| `invited_emails`*_required_ | ```List[str]``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | [[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/team_response.py b/sdks/python/dropbox_sign/models/team_response.py index 57bec3332..ad0521d0e 100644 --- a/sdks/python/dropbox_sign/models/team_response.py +++ b/sdks/python/dropbox_sign/models/team_response.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List, Optional +from typing import Any, ClassVar, Dict, List from dropbox_sign.models.account_response import AccountResponse from typing import Optional, Set, Tuple from typing_extensions import Self @@ -33,15 +33,13 @@ class TeamResponse(BaseModel): Contains information about your team and its members """ # noqa: E501 - name: Optional[StrictStr] = Field(default=None, description="The name of your Team") - accounts: Optional[List[AccountResponse]] = None - invited_accounts: Optional[List[AccountResponse]] = Field( - default=None, - description="A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`.", + name: StrictStr = Field(description="The name of your Team") + accounts: List[AccountResponse] + invited_accounts: List[AccountResponse] = Field( + description="A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`." ) - invited_emails: Optional[List[StrictStr]] = Field( - default=None, - description="A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account.", + invited_emails: List[StrictStr] = Field( + description="A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account." ) __properties: ClassVar[List[str]] = [ "name", diff --git a/sdks/ruby/docs/TeamResponse.md b/sdks/ruby/docs/TeamResponse.md index b7b847604..777d1eb52 100644 --- a/sdks/ruby/docs/TeamResponse.md +++ b/sdks/ruby/docs/TeamResponse.md @@ -6,8 +6,8 @@ Contains information about your team and its members | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | The name of your Team | | -| `accounts` | [```Array```](AccountResponse.md) | | | -| `invited_accounts` | [```Array```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | -| `invited_emails` | ```Array``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `name`*_required_ | ```String``` | The name of your Team | | +| `accounts`*_required_ | [```Array```](AccountResponse.md) | | | +| `invited_accounts`*_required_ | [```Array```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | +| `invited_emails`*_required_ | ```Array``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | diff --git a/sdks/ruby/lib/dropbox-sign/models/team_response.rb b/sdks/ruby/lib/dropbox-sign/models/team_response.rb index b3362473c..25aa2627d 100644 --- a/sdks/ruby/lib/dropbox-sign/models/team_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/team_response.rb @@ -132,12 +132,32 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + + if @accounts.nil? + invalid_properties.push('invalid value for "accounts", accounts cannot be nil.') + end + + if @invited_accounts.nil? + invalid_properties.push('invalid value for "invited_accounts", invited_accounts cannot be nil.') + end + + if @invited_emails.nil? + invalid_properties.push('invalid value for "invited_emails", invited_emails 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 @name.nil? + return false if @accounts.nil? + return false if @invited_accounts.nil? + return false if @invited_emails.nil? true end diff --git a/test_fixtures/TeamGetResponse.json b/test_fixtures/TeamGetResponse.json index 2ed1d16c3..327d26c25 100644 --- a/test_fixtures/TeamGetResponse.json +++ b/test_fixtures/TeamGetResponse.json @@ -28,6 +28,11 @@ "api_signature_requests_left": 0 } } + ], + "invited_emails": [ + "invite_1@example.com", + "invite_2@example.com", + "invite_3@example.com" ] } } From 3ecd2a1e786ac8a8a94e775c6e2ae6fbfc7ba9ef Mon Sep 17 00:00:00 2001 From: Sainish Momin <130490494+sainishm2@users.noreply.github.com> Date: Tue, 15 Oct 2024 14:45:42 -0700 Subject: [PATCH 08/16] added client_id and client_secret for refreshing token (#435) --- openapi-raw.yaml | 40 ++++++ openapi-sdk.yaml | 40 ++++++ openapi.yaml | 40 ++++++ sdks/dotnet/docs/OAuthApi.md | 2 + sdks/dotnet/docs/OAuthTokenRefreshRequest.md | 2 +- .../Model/OAuthTokenRefreshRequest.cs | 54 +++++++- sdks/java-v1/docs/OAuthApi.md | 2 + sdks/java-v1/docs/OAuthTokenRefreshRequest.md | 2 + .../java/com/dropbox/sign/api/OAuthApi.java | 4 + .../sign/model/OAuthTokenRefreshRequest.java | 106 +++++++++++++- sdks/java-v2/docs/OAuthApi.md | 2 + sdks/java-v2/docs/OAuthTokenRefreshRequest.md | 2 + .../java/com/dropbox/sign/api/OAuthApi.java | 5 + .../sign/model/OAuthTokenRefreshRequest.java | 106 +++++++++++++- sdks/node/api/oAuthApi.ts | 22 +++ sdks/node/dist/api.js | 130 +++++++++++------- .../docs/model/OAuthTokenRefreshRequest.md | 2 + sdks/node/model/oAuthTokenRefreshRequest.ts | 18 +++ .../types/model/oAuthTokenRefreshRequest.d.ts | 2 + .../docs/Model/OAuthTokenRefreshRequest.md | 2 + sdks/php/src/Api/OAuthApi.php | 24 ++++ .../src/Model/OAuthTokenRefreshRequest.php | 68 +++++++++ sdks/python/docs/OAuthApi.md | 2 + sdks/python/docs/OAuthTokenRefreshRequest.md | 2 + sdks/python/dropbox_sign/api/o_auth_api.py | 6 + .../models/o_auth_token_refresh_request.py | 21 ++- sdks/ruby/docs/OAuthTokenRefreshRequest.md | 2 + sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb | 28 ++++ .../models/o_auth_token_refresh_request.rb | 30 +++- translations/en.yaml | 2 + 30 files changed, 707 insertions(+), 61 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index f610c00d2..5889894a4 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -2233,6 +2233,23 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -2316,6 +2333,23 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -7288,6 +7322,12 @@ components: refresh_token: description: '_t__OAuthTokenRefresh::REFRESH_TOKEN' type: string + client_id: + description: '_t__OAuthTokenRefresh::CLIENT_ID' + type: string + client_secret: + description: '_t__OAuthTokenRefresh::CLIENT_SECRET' + type: string type: object ReportCreateRequest: required: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 896668221..17a5b7f81 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -2239,6 +2239,23 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -2322,6 +2339,23 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -7382,6 +7416,12 @@ components: refresh_token: description: 'The token provided when you got the expired access token.' type: string + client_id: + description: 'The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.' + type: string + client_secret: + description: 'The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.' + type: string type: object ReportCreateRequest: required: diff --git a/openapi.yaml b/openapi.yaml index 487826fac..4b14bfca4 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -2239,6 +2239,23 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -2322,6 +2339,23 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -7382,6 +7416,12 @@ components: refresh_token: description: 'The token provided when you got the expired access token.' type: string + client_id: + description: 'The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.' + type: string + client_secret: + description: 'The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.' + type: string type: object ReportCreateRequest: required: diff --git a/sdks/dotnet/docs/OAuthApi.md b/sdks/dotnet/docs/OAuthApi.md index 5af912344..c80ee2758 100644 --- a/sdks/dotnet/docs/OAuthApi.md +++ b/sdks/dotnet/docs/OAuthApi.md @@ -99,6 +99,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -191,6 +192,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/OAuthTokenRefreshRequest.md b/sdks/dotnet/docs/OAuthTokenRefreshRequest.md index c9866d3bf..5e33e77d9 100644 --- a/sdks/dotnet/docs/OAuthTokenRefreshRequest.md +++ b/sdks/dotnet/docs/OAuthTokenRefreshRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**GrantType** | **string** | When refreshing an existing token use `refresh_token`. | [default to "refresh_token"]**RefreshToken** | **string** | The token provided when you got the expired access token. | +**GrantType** | **string** | When refreshing an existing token use `refresh_token`. | [default to "refresh_token"]**RefreshToken** | **string** | The token provided when you got the expired access token. | **ClientId** | **string** | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | [optional] **ClientSecret** | **string** | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | [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/src/Dropbox.Sign/Model/OAuthTokenRefreshRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/OAuthTokenRefreshRequest.cs index dbfb22b5f..934de0d88 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/OAuthTokenRefreshRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/OAuthTokenRefreshRequest.cs @@ -43,7 +43,9 @@ protected OAuthTokenRefreshRequest() { } /// /// When refreshing an existing token use `refresh_token`. (required) (default to "refresh_token"). /// The token provided when you got the expired access token. (required). - public OAuthTokenRefreshRequest(string grantType = @"refresh_token", string refreshToken = default(string)) + /// The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled.. + /// The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled.. + public OAuthTokenRefreshRequest(string grantType = @"refresh_token", string refreshToken = default(string), string clientId = default(string), string clientSecret = default(string)) { // to ensure "grantType" is required (not null) @@ -58,6 +60,8 @@ protected OAuthTokenRefreshRequest() { } throw new ArgumentNullException("refreshToken is a required property for OAuthTokenRefreshRequest and cannot be null"); } this.RefreshToken = refreshToken; + this.ClientId = clientId; + this.ClientSecret = clientSecret; } /// @@ -90,6 +94,20 @@ public static OAuthTokenRefreshRequest Init(string jsonData) [DataMember(Name = "refresh_token", IsRequired = true, EmitDefaultValue = true)] public string RefreshToken { get; set; } + /// + /// The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + /// + /// The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + [DataMember(Name = "client_id", EmitDefaultValue = true)] + public string ClientId { get; set; } + + /// + /// The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + /// + /// The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + [DataMember(Name = "client_secret", EmitDefaultValue = true)] + public string ClientSecret { get; set; } + /// /// Returns the string presentation of the object /// @@ -100,6 +118,8 @@ public override string ToString() sb.Append("class OAuthTokenRefreshRequest {\n"); sb.Append(" GrantType: ").Append(GrantType).Append("\n"); sb.Append(" RefreshToken: ").Append(RefreshToken).Append("\n"); + sb.Append(" ClientId: ").Append(ClientId).Append("\n"); + sb.Append(" ClientSecret: ").Append(ClientSecret).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -144,6 +164,16 @@ public bool Equals(OAuthTokenRefreshRequest input) this.RefreshToken == input.RefreshToken || (this.RefreshToken != null && this.RefreshToken.Equals(input.RefreshToken)) + ) && + ( + this.ClientId == input.ClientId || + (this.ClientId != null && + this.ClientId.Equals(input.ClientId)) + ) && + ( + this.ClientSecret == input.ClientSecret || + (this.ClientSecret != null && + this.ClientSecret.Equals(input.ClientSecret)) ); } @@ -164,6 +194,14 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.RefreshToken.GetHashCode(); } + if (this.ClientId != null) + { + hashCode = (hashCode * 59) + this.ClientId.GetHashCode(); + } + if (this.ClientSecret != null) + { + hashCode = (hashCode * 59) + this.ClientSecret.GetHashCode(); + } return hashCode; } } @@ -194,6 +232,20 @@ public List GetOpenApiTypes() Type = "string", Value = RefreshToken, }); + types.Add(new OpenApiType() + { + Name = "client_id", + Property = "ClientId", + Type = "string", + Value = ClientId, + }); + types.Add(new OpenApiType() + { + Name = "client_secret", + Property = "ClientSecret", + Type = "string", + Value = ClientSecret, + }); return types; } diff --git a/sdks/java-v1/docs/OAuthApi.md b/sdks/java-v1/docs/OAuthApi.md index 533052ba2..a2eaa2508 100644 --- a/sdks/java-v1/docs/OAuthApi.md +++ b/sdks/java-v1/docs/OAuthApi.md @@ -77,6 +77,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | ## oauthTokenRefresh @@ -144,4 +145,5 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | diff --git a/sdks/java-v1/docs/OAuthTokenRefreshRequest.md b/sdks/java-v1/docs/OAuthTokenRefreshRequest.md index 2b985fa91..f0ce43061 100644 --- a/sdks/java-v1/docs/OAuthTokenRefreshRequest.md +++ b/sdks/java-v1/docs/OAuthTokenRefreshRequest.md @@ -10,6 +10,8 @@ |------------ | ------------- | ------------- | -------------| | `grantType`*_required_ | ```String``` | When refreshing an existing token use `refresh_token`. | | | `refreshToken`*_required_ | ```String``` | The token provided when you got the expired access token. | | +| `clientId` | ```String``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `clientSecret` | ```String``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/api/OAuthApi.java b/sdks/java-v1/src/main/java/com/dropbox/sign/api/OAuthApi.java index f9e6d08f3..db4fbb10c 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/api/OAuthApi.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/api/OAuthApi.java @@ -55,6 +55,7 @@ public void setApiClient(ApiClient apiClient) { * * * + * *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public OAuthTokenResponse oauthTokenGenerate( @@ -73,6 +74,7 @@ public OAuthTokenResponse oauthTokenGenerate( * * * + * *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public ApiResponse oauthTokenGenerateWithHttpInfo( @@ -125,6 +127,7 @@ public ApiResponse oauthTokenGenerateWithHttpInfo( * * * + * *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenRefreshRequest) @@ -145,6 +148,7 @@ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenR * * * + * *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public ApiResponse oauthTokenRefreshWithHttpInfo( diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java index 6aa0a0552..75979827e 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java @@ -26,7 +26,9 @@ /** OAuthTokenRefreshRequest */ @JsonPropertyOrder({ OAuthTokenRefreshRequest.JSON_PROPERTY_GRANT_TYPE, - OAuthTokenRefreshRequest.JSON_PROPERTY_REFRESH_TOKEN + OAuthTokenRefreshRequest.JSON_PROPERTY_REFRESH_TOKEN, + OAuthTokenRefreshRequest.JSON_PROPERTY_CLIENT_ID, + OAuthTokenRefreshRequest.JSON_PROPERTY_CLIENT_SECRET }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -39,6 +41,12 @@ public class OAuthTokenRefreshRequest { public static final String JSON_PROPERTY_REFRESH_TOKEN = "refresh_token"; private String refreshToken; + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + private String clientId; + + public static final String JSON_PROPERTY_CLIENT_SECRET = "client_secret"; + private String clientSecret; + public OAuthTokenRefreshRequest() {} /** @@ -103,6 +111,54 @@ public void setRefreshToken(String refreshToken) { this.refreshToken = refreshToken; } + public OAuthTokenRefreshRequest clientId(String clientId) { + this.clientId = clientId; + return this; + } + + /** + * The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the + * \"Client Credentials Required\" setting is enabled for token refresh; optional if + * disabled. + * + * @return clientId + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getClientId() { + return clientId; + } + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setClientId(String clientId) { + this.clientId = clientId; + } + + public OAuthTokenRefreshRequest clientSecret(String clientSecret) { + this.clientSecret = clientSecret; + return this; + } + + /** + * The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if + * the \"Client Credentials Required\" setting is enabled for token refresh; optional + * if disabled. + * + * @return clientSecret + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getClientSecret() { + return clientSecret; + } + + @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setClientSecret(String clientSecret) { + this.clientSecret = clientSecret; + } + /** Return true if this OAuthTokenRefreshRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -114,12 +170,14 @@ public boolean equals(Object o) { } OAuthTokenRefreshRequest oauthTokenRefreshRequest = (OAuthTokenRefreshRequest) o; return Objects.equals(this.grantType, oauthTokenRefreshRequest.grantType) - && Objects.equals(this.refreshToken, oauthTokenRefreshRequest.refreshToken); + && Objects.equals(this.refreshToken, oauthTokenRefreshRequest.refreshToken) + && Objects.equals(this.clientId, oauthTokenRefreshRequest.clientId) + && Objects.equals(this.clientSecret, oauthTokenRefreshRequest.clientSecret); } @Override public int hashCode() { - return Objects.hash(grantType, refreshToken); + return Objects.hash(grantType, refreshToken, clientId, clientSecret); } @Override @@ -128,6 +186,8 @@ public String toString() { sb.append("class OAuthTokenRefreshRequest {\n"); sb.append(" grantType: ").append(toIndentedString(grantType)).append("\n"); sb.append(" refreshToken: ").append(toIndentedString(refreshToken)).append("\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" clientSecret: ").append(toIndentedString(clientSecret)).append("\n"); sb.append("}"); return sb.toString(); } @@ -176,6 +236,46 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(refreshToken)); } } + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) + || clientId.getClass().equals(Integer.class) + || clientId.getClass().equals(String.class) + || clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for (int i = 0; i < getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } else { + map.put( + "client_id", + JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (clientSecret != null) { + if (isFileTypeOrListOfFiles(clientSecret)) { + fileTypeFound = true; + } + + if (clientSecret.getClass().equals(java.io.File.class) + || clientSecret.getClass().equals(Integer.class) + || clientSecret.getClass().equals(String.class) + || clientSecret.getClass().isEnum()) { + map.put("client_secret", clientSecret); + } else if (isListOfFile(clientSecret)) { + for (int i = 0; i < getListSize(clientSecret); i++) { + map.put("client_secret[" + i + "]", getFromList(clientSecret, i)); + } + } else { + map.put( + "client_secret", + JSON.getDefault().getMapper().writeValueAsString(clientSecret)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/docs/OAuthApi.md b/sdks/java-v2/docs/OAuthApi.md index 533052ba2..a2eaa2508 100644 --- a/sdks/java-v2/docs/OAuthApi.md +++ b/sdks/java-v2/docs/OAuthApi.md @@ -77,6 +77,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | ## oauthTokenRefresh @@ -144,4 +145,5 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | diff --git a/sdks/java-v2/docs/OAuthTokenRefreshRequest.md b/sdks/java-v2/docs/OAuthTokenRefreshRequest.md index 2b985fa91..f0ce43061 100644 --- a/sdks/java-v2/docs/OAuthTokenRefreshRequest.md +++ b/sdks/java-v2/docs/OAuthTokenRefreshRequest.md @@ -10,6 +10,8 @@ |------------ | ------------- | ------------- | -------------| | `grantType`*_required_ | ```String``` | When refreshing an existing token use `refresh_token`. | | | `refreshToken`*_required_ | ```String``` | The token provided when you got the expired access token. | | +| `clientId` | ```String``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `clientSecret` | ```String``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java index 98b580202..4d881a94e 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java @@ -8,6 +8,7 @@ import jakarta.ws.rs.core.GenericType; +import com.dropbox.sign.model.ErrorResponse; import com.dropbox.sign.model.OAuthTokenGenerateRequest; import com.dropbox.sign.model.OAuthTokenRefreshRequest; import com.dropbox.sign.model.OAuthTokenResponse; @@ -58,6 +59,7 @@ public void setApiClient(ApiClient apiClient) { +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public OAuthTokenResponse oauthTokenGenerate(OAuthTokenGenerateRequest oauthTokenGenerateRequest) throws ApiException { @@ -75,6 +77,7 @@ public OAuthTokenResponse oauthTokenGenerate(OAuthTokenGenerateRequest oauthToke +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public ApiResponse oauthTokenGenerateWithHttpInfo(OAuthTokenGenerateRequest oauthTokenGenerateRequest) throws ApiException { @@ -116,6 +119,7 @@ public ApiResponse oauthTokenGenerateWithHttpInfo(OAuthToken +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenRefreshRequest) throws ApiException { @@ -133,6 +137,7 @@ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenR +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public ApiResponse oauthTokenRefreshWithHttpInfo(OAuthTokenRefreshRequest oauthTokenRefreshRequest) throws ApiException { diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java index 28eb1cdfb..fafe689fc 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java @@ -34,7 +34,9 @@ */ @JsonPropertyOrder({ OAuthTokenRefreshRequest.JSON_PROPERTY_GRANT_TYPE, - OAuthTokenRefreshRequest.JSON_PROPERTY_REFRESH_TOKEN + OAuthTokenRefreshRequest.JSON_PROPERTY_REFRESH_TOKEN, + OAuthTokenRefreshRequest.JSON_PROPERTY_CLIENT_ID, + OAuthTokenRefreshRequest.JSON_PROPERTY_CLIENT_SECRET }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -45,6 +47,12 @@ public class OAuthTokenRefreshRequest { public static final String JSON_PROPERTY_REFRESH_TOKEN = "refresh_token"; private String refreshToken; + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + private String clientId; + + public static final String JSON_PROPERTY_CLIENT_SECRET = "client_secret"; + private String clientSecret; + public OAuthTokenRefreshRequest() { } @@ -113,6 +121,56 @@ public void setRefreshToken(String refreshToken) { } + public OAuthTokenRefreshRequest clientId(String clientId) { + this.clientId = clientId; + return this; + } + + /** + * The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + * @return clientId + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getClientId() { + return clientId; + } + + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setClientId(String clientId) { + this.clientId = clientId; + } + + + public OAuthTokenRefreshRequest clientSecret(String clientSecret) { + this.clientSecret = clientSecret; + return this; + } + + /** + * The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + * @return clientSecret + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getClientSecret() { + return clientSecret; + } + + + @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setClientSecret(String clientSecret) { + this.clientSecret = clientSecret; + } + + /** * Return true if this OAuthTokenRefreshRequest object is equal to o. */ @@ -126,12 +184,14 @@ public boolean equals(Object o) { } OAuthTokenRefreshRequest oauthTokenRefreshRequest = (OAuthTokenRefreshRequest) o; return Objects.equals(this.grantType, oauthTokenRefreshRequest.grantType) && - Objects.equals(this.refreshToken, oauthTokenRefreshRequest.refreshToken); + Objects.equals(this.refreshToken, oauthTokenRefreshRequest.refreshToken) && + Objects.equals(this.clientId, oauthTokenRefreshRequest.clientId) && + Objects.equals(this.clientSecret, oauthTokenRefreshRequest.clientSecret); } @Override public int hashCode() { - return Objects.hash(grantType, refreshToken); + return Objects.hash(grantType, refreshToken, clientId, clientSecret); } @Override @@ -140,6 +200,8 @@ public String toString() { sb.append("class OAuthTokenRefreshRequest {\n"); sb.append(" grantType: ").append(toIndentedString(grantType)).append("\n"); sb.append(" refreshToken: ").append(toIndentedString(refreshToken)).append("\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" clientSecret: ").append(toIndentedString(clientSecret)).append("\n"); sb.append("}"); return sb.toString(); } @@ -186,6 +248,44 @@ public Map createFormData() throws ApiException { map.put("refresh_token", JSON.getDefault().getMapper().writeValueAsString(refreshToken)); } } + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) || + clientId.getClass().equals(Integer.class) || + clientId.getClass().equals(String.class) || + clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for(int i = 0; i< getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } + else { + map.put("client_id", JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (clientSecret != null) { + if (isFileTypeOrListOfFiles(clientSecret)) { + fileTypeFound = true; + } + + if (clientSecret.getClass().equals(java.io.File.class) || + clientSecret.getClass().equals(Integer.class) || + clientSecret.getClass().equals(String.class) || + clientSecret.getClass().isEnum()) { + map.put("client_secret", clientSecret); + } else if (isListOfFile(clientSecret)) { + for(int i = 0; i< getListSize(clientSecret); i++) { + map.put("client_secret[" + i + "]", getFromList(clientSecret, i)); + } + } + else { + map.put("client_secret", JSON.getDefault().getMapper().writeValueAsString(clientSecret)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/node/api/oAuthApi.ts b/sdks/node/api/oAuthApi.ts index c1b080359..1478d53e0 100644 --- a/sdks/node/api/oAuthApi.ts +++ b/sdks/node/api/oAuthApi.ts @@ -236,6 +236,17 @@ export class OAuthApi { return; } + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + reject(error); } ); @@ -361,6 +372,17 @@ export class OAuthApi { return; } + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + reject(error); } ); diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 94fc0d284..d95c19e31 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -18331,6 +18331,16 @@ OAuthTokenRefreshRequest.attributeTypeMap = [ name: "refreshToken", baseName: "refresh_token", type: "string" + }, + { + name: "clientId", + baseName: "client_id", + type: "string" + }, + { + name: "clientSecret", + baseName: "client_secret", + type: "string" } ]; @@ -27300,6 +27310,14 @@ var OAuthApi = class { )) { return; } + if (handleErrorRangeResponse6( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } reject(error); } ); @@ -27395,6 +27413,14 @@ var OAuthApi = class { )) { return; } + if (handleErrorRangeResponse6( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } reject(error); } ); @@ -27428,6 +27454,16 @@ function handleErrorCodeResponse6(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } +function handleErrorRangeResponse6(reject, response, code, returnType) { + let rangeCodeLeft = Number(code[0] + "00"); + let rangeCodeRight = Number(code[0] + "99"); + if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { + const body = ObjectSerializer.deserialize(response.data, returnType); + reject(new HttpError(response, body, response.status)); + return true; + } + return false; +} // api/reportApi.ts var defaultBasePath7 = "https://api.hellosign.com/v3"; @@ -27573,7 +27609,7 @@ var ReportApi = class { )) { return; } - if (handleErrorRangeResponse6( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -27615,7 +27651,7 @@ function handleErrorCodeResponse7(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse6(reject, response, code, returnType) { +function handleErrorRangeResponse7(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -27770,7 +27806,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -27885,7 +27921,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -27968,7 +28004,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28082,7 +28118,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28197,7 +28233,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28299,7 +28335,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28395,7 +28431,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28497,7 +28533,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28593,7 +28629,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28706,7 +28742,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28803,7 +28839,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28926,7 +28962,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -29004,7 +29040,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -29118,7 +29154,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -29233,7 +29269,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -29356,7 +29392,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -29398,7 +29434,7 @@ function handleErrorCodeResponse8(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse7(reject, response, code, returnType) { +function handleErrorRangeResponse8(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -29563,7 +29599,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29673,7 +29709,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29747,7 +29783,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29834,7 +29870,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29928,7 +29964,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -30023,7 +30059,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -30132,7 +30168,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -30246,7 +30282,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -30354,7 +30390,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -30465,7 +30501,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -30506,7 +30542,7 @@ function handleErrorCodeResponse9(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse8(reject, response, code, returnType) { +function handleErrorRangeResponse9(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -30674,7 +30710,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30789,7 +30825,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30904,7 +30940,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30987,7 +31023,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31088,7 +31124,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31184,7 +31220,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31286,7 +31322,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31382,7 +31418,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31495,7 +31531,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31618,7 +31654,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31741,7 +31777,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31783,7 +31819,7 @@ function handleErrorCodeResponse10(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse9(reject, response, code, returnType) { +function handleErrorRangeResponse10(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -31943,7 +31979,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -32058,7 +32094,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -32173,7 +32209,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -32296,7 +32332,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -32338,7 +32374,7 @@ function handleErrorCodeResponse11(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse10(reject, response, code, returnType) { +function handleErrorRangeResponse11(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { diff --git a/sdks/node/docs/model/OAuthTokenRefreshRequest.md b/sdks/node/docs/model/OAuthTokenRefreshRequest.md index d5dc06d1b..8a24bdc15 100644 --- a/sdks/node/docs/model/OAuthTokenRefreshRequest.md +++ b/sdks/node/docs/model/OAuthTokenRefreshRequest.md @@ -8,5 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `grantType`*_required_ | ```string``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | | `refreshToken`*_required_ | ```string``` | The token provided when you got the expired access token. | | +| `clientId` | ```string``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `clientSecret` | ```string``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | [[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/oAuthTokenRefreshRequest.ts b/sdks/node/model/oAuthTokenRefreshRequest.ts index e6c6848b6..2f8971dd5 100644 --- a/sdks/node/model/oAuthTokenRefreshRequest.ts +++ b/sdks/node/model/oAuthTokenRefreshRequest.ts @@ -33,6 +33,14 @@ export class OAuthTokenRefreshRequest { * The token provided when you got the expired access token. */ "refreshToken": string; + /** + * The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + */ + "clientId"?: string; + /** + * The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + */ + "clientSecret"?: string; static discriminator: string | undefined = undefined; @@ -47,6 +55,16 @@ export class OAuthTokenRefreshRequest { baseName: "refresh_token", type: "string", }, + { + name: "clientId", + baseName: "client_id", + type: "string", + }, + { + name: "clientSecret", + baseName: "client_secret", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/types/model/oAuthTokenRefreshRequest.d.ts b/sdks/node/types/model/oAuthTokenRefreshRequest.d.ts index 53211884e..71f3d108f 100644 --- a/sdks/node/types/model/oAuthTokenRefreshRequest.d.ts +++ b/sdks/node/types/model/oAuthTokenRefreshRequest.d.ts @@ -2,6 +2,8 @@ import { AttributeTypeMap } from "./"; export declare class OAuthTokenRefreshRequest { "grantType": string; "refreshToken": string; + "clientId"?: string; + "clientSecret"?: string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/php/docs/Model/OAuthTokenRefreshRequest.md b/sdks/php/docs/Model/OAuthTokenRefreshRequest.md index c9525386c..9ba09db42 100644 --- a/sdks/php/docs/Model/OAuthTokenRefreshRequest.md +++ b/sdks/php/docs/Model/OAuthTokenRefreshRequest.md @@ -8,5 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `grant_type`*_required_ | ```string``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | | `refresh_token`*_required_ | ```string``` | The token provided when you got the expired access token. | | +| `client_id` | ```string``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `client_secret` | ```string``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | [[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/OAuthApi.php b/sdks/php/src/Api/OAuthApi.php index 6fa77398a..81468626d 100644 --- a/sdks/php/src/Api/OAuthApi.php +++ b/sdks/php/src/Api/OAuthApi.php @@ -211,6 +211,15 @@ public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $ ); } + $result = $this->handleRangeCodeResponse( + $response, + '4XX', + '\Dropbox\Sign\Model\ErrorResponse' + ); + if ($result) { + return $result; + } + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\OAuthTokenResponse' === '\SplFileObject') { @@ -269,6 +278,9 @@ public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $ $response->getHeaders(), ]; } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { + throw $e; + } switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( @@ -582,6 +594,15 @@ public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_ ); } + $result = $this->handleRangeCodeResponse( + $response, + '4XX', + '\Dropbox\Sign\Model\ErrorResponse' + ); + if ($result) { + return $result; + } + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\OAuthTokenResponse' === '\SplFileObject') { @@ -640,6 +661,9 @@ public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_ $response->getHeaders(), ]; } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { + throw $e; + } switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( diff --git a/sdks/php/src/Model/OAuthTokenRefreshRequest.php b/sdks/php/src/Model/OAuthTokenRefreshRequest.php index c4c7f93be..11cf05a3b 100644 --- a/sdks/php/src/Model/OAuthTokenRefreshRequest.php +++ b/sdks/php/src/Model/OAuthTokenRefreshRequest.php @@ -59,6 +59,8 @@ class OAuthTokenRefreshRequest implements ModelInterface, ArrayAccess, JsonSeria protected static $openAPITypes = [ 'grant_type' => 'string', 'refresh_token' => 'string', + 'client_id' => 'string', + 'client_secret' => 'string', ]; /** @@ -71,6 +73,8 @@ class OAuthTokenRefreshRequest implements ModelInterface, ArrayAccess, JsonSeria protected static $openAPIFormats = [ 'grant_type' => null, 'refresh_token' => null, + 'client_id' => null, + 'client_secret' => null, ]; /** @@ -81,6 +85,8 @@ class OAuthTokenRefreshRequest implements ModelInterface, ArrayAccess, JsonSeria protected static array $openAPINullables = [ 'grant_type' => false, 'refresh_token' => false, + 'client_id' => false, + 'client_secret' => false, ]; /** @@ -163,6 +169,8 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'grant_type' => 'grant_type', 'refresh_token' => 'refresh_token', + 'client_id' => 'client_id', + 'client_secret' => 'client_secret', ]; /** @@ -173,6 +181,8 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'grant_type' => 'setGrantType', 'refresh_token' => 'setRefreshToken', + 'client_id' => 'setClientId', + 'client_secret' => 'setClientSecret', ]; /** @@ -183,6 +193,8 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'grant_type' => 'getGrantType', 'refresh_token' => 'getRefreshToken', + 'client_id' => 'getClientId', + 'client_secret' => 'getClientSecret', ]; /** @@ -243,6 +255,8 @@ public function __construct(array $data = null) { $this->setIfExists('grant_type', $data ?? [], 'refresh_token'); $this->setIfExists('refresh_token', $data ?? [], null); + $this->setIfExists('client_id', $data ?? [], null); + $this->setIfExists('client_secret', $data ?? [], null); } /** @@ -364,6 +378,60 @@ public function setRefreshToken(string $refresh_token) return $this; } + /** + * Gets client_id + * + * @return string|null + */ + public function getClientId() + { + return $this->container['client_id']; + } + + /** + * Sets client_id + * + * @param string|null $client_id The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + * + * @return self + */ + public function setClientId(?string $client_id) + { + if (is_null($client_id)) { + throw new InvalidArgumentException('non-nullable client_id cannot be null'); + } + $this->container['client_id'] = $client_id; + + return $this; + } + + /** + * Gets client_secret + * + * @return string|null + */ + public function getClientSecret() + { + return $this->container['client_secret']; + } + + /** + * Sets client_secret + * + * @param string|null $client_secret The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + * + * @return self + */ + public function setClientSecret(?string $client_secret) + { + if (is_null($client_secret)) { + throw new InvalidArgumentException('non-nullable client_secret cannot be null'); + } + $this->container['client_secret'] = $client_secret; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/python/docs/OAuthApi.md b/sdks/python/docs/OAuthApi.md index 969109c45..b26775683 100644 --- a/sdks/python/docs/OAuthApi.md +++ b/sdks/python/docs/OAuthApi.md @@ -67,6 +67,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +**4XX** | failed_operation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -126,6 +127,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +**4XX** | failed_operation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/sdks/python/docs/OAuthTokenRefreshRequest.md b/sdks/python/docs/OAuthTokenRefreshRequest.md index 9322c48d6..87662c9e1 100644 --- a/sdks/python/docs/OAuthTokenRefreshRequest.md +++ b/sdks/python/docs/OAuthTokenRefreshRequest.md @@ -7,6 +7,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `grant_type`*_required_ | ```str``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | | `refresh_token`*_required_ | ```str``` | The token provided when you got the expired access token. | | +| `client_id` | ```str``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `client_secret` | ```str``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | [[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/api/o_auth_api.py b/sdks/python/dropbox_sign/api/o_auth_api.py index d5035a186..bedd1bfff 100644 --- a/sdks/python/dropbox_sign/api/o_auth_api.py +++ b/sdks/python/dropbox_sign/api/o_auth_api.py @@ -93,6 +93,7 @@ def oauth_token_generate( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", + "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -157,6 +158,7 @@ def oauth_token_generate_with_http_info( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", + "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -221,6 +223,7 @@ def oauth_token_generate_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", + "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -366,6 +369,7 @@ def oauth_token_refresh( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", + "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -430,6 +434,7 @@ def oauth_token_refresh_with_http_info( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", + "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -494,6 +499,7 @@ def oauth_token_refresh_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", + "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout diff --git a/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py b/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py index 09535d939..573036386 100644 --- a/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py +++ b/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -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 @@ -38,7 +38,20 @@ class OAuthTokenRefreshRequest(BaseModel): refresh_token: StrictStr = Field( description="The token provided when you got the expired access token." ) - __properties: ClassVar[List[str]] = ["grant_type", "refresh_token"] + client_id: Optional[StrictStr] = Field( + default=None, + description='The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.', + ) + client_secret: Optional[StrictStr] = Field( + default=None, + description='The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.', + ) + __properties: ClassVar[List[str]] = [ + "grant_type", + "refresh_token", + "client_id", + "client_secret", + ] model_config = ConfigDict( populate_by_name=True, @@ -109,6 +122,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: else "refresh_token" ), "refresh_token": obj.get("refresh_token"), + "client_id": obj.get("client_id"), + "client_secret": obj.get("client_secret"), } ) return _obj @@ -128,6 +143,8 @@ def openapi_types(cls) -> Dict[str, str]: return { "grant_type": "(str,)", "refresh_token": "(str,)", + "client_id": "(str,)", + "client_secret": "(str,)", } @classmethod diff --git a/sdks/ruby/docs/OAuthTokenRefreshRequest.md b/sdks/ruby/docs/OAuthTokenRefreshRequest.md index fe729fe82..4bd1757c8 100644 --- a/sdks/ruby/docs/OAuthTokenRefreshRequest.md +++ b/sdks/ruby/docs/OAuthTokenRefreshRequest.md @@ -8,4 +8,6 @@ | ---- | ---- | ----------- | ----- | | `grant_type`*_required_ | ```String``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | | `refresh_token`*_required_ | ```String``` | The token provided when you got the expired access token. | | +| `client_id` | ```String``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `client_secret` | ```String``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | diff --git a/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb b/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb index eb0c67745..6e9d748e8 100644 --- a/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb @@ -108,6 +108,20 @@ def oauth_token_generate_with_http_info(o_auth_token_generate_request, opts = {} e.message end + range_code = "4XX".split('').first + range_code_left = "#{range_code}00".to_i + range_code_right = "#{range_code}99".to_i + if e.code >= range_code_left && e.code <= range_code_right + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end end @@ -203,6 +217,20 @@ def oauth_token_refresh_with_http_info(o_auth_token_refresh_request, opts = {}) e.message end + range_code = "4XX".split('').first + range_code_left = "#{range_code}00".to_i + range_code_right = "#{range_code}99".to_i + if e.code >= range_code_left && e.code <= range_code_right + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end end diff --git a/sdks/ruby/lib/dropbox-sign/models/o_auth_token_refresh_request.rb b/sdks/ruby/lib/dropbox-sign/models/o_auth_token_refresh_request.rb index 7628e0b2e..3ac73212e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/o_auth_token_refresh_request.rb @@ -26,11 +26,21 @@ class OAuthTokenRefreshRequest # @return [String] attr_accessor :refresh_token + # The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + # @return [String] + attr_accessor :client_id + + # The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + # @return [String] + attr_accessor :client_secret + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'grant_type' => :'grant_type', - :'refresh_token' => :'refresh_token' + :'refresh_token' => :'refresh_token', + :'client_id' => :'client_id', + :'client_secret' => :'client_secret' } end @@ -43,7 +53,9 @@ def self.acceptable_attributes def self.openapi_types { :'grant_type' => :'String', - :'refresh_token' => :'String' + :'refresh_token' => :'String', + :'client_id' => :'String', + :'client_secret' => :'String' } end @@ -102,6 +114,14 @@ def initialize(attributes = {}) if attributes.key?(:'refresh_token') self.refresh_token = attributes[:'refresh_token'] end + + if attributes.key?(:'client_id') + self.client_id = attributes[:'client_id'] + end + + if attributes.key?(:'client_secret') + self.client_secret = attributes[:'client_secret'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -133,7 +153,9 @@ def ==(o) return true if self.equal?(o) self.class == o.class && grant_type == o.grant_type && - refresh_token == o.refresh_token + refresh_token == o.refresh_token && + client_id == o.client_id && + client_secret == o.client_secret end # @see the `==` method @@ -145,7 +167,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [grant_type, refresh_token].hash + [grant_type, refresh_token, client_id, client_secret].hash end # Builds the object from hash diff --git a/translations/en.yaml b/translations/en.yaml index 5cbf3ca41..74340f9bb 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -183,6 +183,8 @@ "OAuthTokenRefresh::DESCRIPTION": Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. "OAuthTokenRefresh::GRANT_TYPE": When refreshing an existing token use `refresh_token`. "OAuthTokenRefresh::REFRESH_TOKEN": The token provided when you got the expired access token. +"OAuthTokenRefresh::CLIENT_ID": The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. +"OAuthTokenRefresh::CLIENT_SECRET": The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. "ReportCreate::SUMMARY": Create Report "ReportCreate::DESCRIPTION": |- From e7d5a1516668ec0146d2cb8bbce5f84b9705c7e3 Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Thu, 17 Oct 2024 11:22:10 -0500 Subject: [PATCH 09/16] Improvements to Template response; reduces nullability (#440) --- openapi-raw.yaml | 165 ++++-- openapi-sdk.yaml | 167 ++++-- openapi.yaml | 167 ++++-- ...lateCreateEmbeddedDraftResponseTemplate.md | 2 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/dotnet/docs/TemplateResponse.md | 2 +- sdks/dotnet/docs/TemplateResponseAccount.md | 2 +- .../docs/TemplateResponseAccountQuota.md | 2 +- sdks/dotnet/docs/TemplateResponseCCRole.md | 2 +- sdks/dotnet/docs/TemplateResponseDocument.md | 2 +- ...TemplateResponseDocumentCustomFieldBase.md | 2 +- ...lateResponseDocumentCustomFieldCheckbox.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 16 +- .../TemplateResponseDocumentFieldGroup.md | 2 +- .../TemplateResponseDocumentFieldGroupRule.md | 2 +- .../TemplateResponseDocumentFormFieldBase.md | 2 +- ...mplateResponseDocumentFormFieldCheckbox.md | 19 +- ...lateResponseDocumentFormFieldDateSigned.md | 19 +- ...mplateResponseDocumentFormFieldDropdown.md | 19 +- ...plateResponseDocumentFormFieldHyperlink.md | 19 +- ...mplateResponseDocumentFormFieldInitials.md | 19 +- .../TemplateResponseDocumentFormFieldRadio.md | 19 +- ...plateResponseDocumentFormFieldSignature.md | 19 +- .../TemplateResponseDocumentFormFieldText.md | 19 +- ...TemplateResponseDocumentStaticFieldBase.md | 2 +- ...lateResponseDocumentStaticFieldCheckbox.md | 16 +- ...teResponseDocumentStaticFieldDateSigned.md | 16 +- ...lateResponseDocumentStaticFieldDropdown.md | 16 +- ...ateResponseDocumentStaticFieldHyperlink.md | 16 +- ...lateResponseDocumentStaticFieldInitials.md | 16 +- ...emplateResponseDocumentStaticFieldRadio.md | 16 +- ...ateResponseDocumentStaticFieldSignature.md | 16 +- ...TemplateResponseDocumentStaticFieldText.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 2 +- .../dotnet/docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- ...lateCreateEmbeddedDraftResponseTemplate.cs | 22 +- .../Model/TemplateCreateResponseTemplate.cs | 9 +- .../Dropbox.Sign/Model/TemplateResponse.cs | 298 ++++++----- .../Model/TemplateResponseAccount.cs | 80 +-- .../Model/TemplateResponseAccountQuota.cs | 16 +- .../Model/TemplateResponseCCRole.cs | 9 +- .../Model/TemplateResponseDocument.cs | 87 +-- ...TemplateResponseDocumentCustomFieldBase.cs | 126 +++-- ...lateResponseDocumentCustomFieldCheckbox.cs | 16 +- ...TemplateResponseDocumentCustomFieldText.cs | 42 +- .../TemplateResponseDocumentFieldGroup.cs | 18 +- .../TemplateResponseDocumentFieldGroupRule.cs | 18 +- .../TemplateResponseDocumentFormFieldBase.cs | 125 ++--- ...mplateResponseDocumentFormFieldCheckbox.cs | 44 +- ...lateResponseDocumentFormFieldDateSigned.cs | 44 +- ...mplateResponseDocumentFormFieldDropdown.cs | 44 +- ...plateResponseDocumentFormFieldHyperlink.cs | 70 ++- ...mplateResponseDocumentFormFieldInitials.cs | 44 +- .../TemplateResponseDocumentFormFieldRadio.cs | 49 +- ...plateResponseDocumentFormFieldSignature.cs | 44 +- .../TemplateResponseDocumentFormFieldText.cs | 70 ++- ...TemplateResponseDocumentStaticFieldBase.cs | 100 ++-- ...lateResponseDocumentStaticFieldCheckbox.cs | 16 +- ...teResponseDocumentStaticFieldDateSigned.cs | 16 +- ...lateResponseDocumentStaticFieldDropdown.cs | 16 +- ...ateResponseDocumentStaticFieldHyperlink.cs | 16 +- ...lateResponseDocumentStaticFieldInitials.cs | 16 +- ...emplateResponseDocumentStaticFieldRadio.cs | 16 +- ...ateResponseDocumentStaticFieldSignature.cs | 16 +- ...TemplateResponseDocumentStaticFieldText.cs | 16 +- .../TemplateResponseFieldAvgTextLength.cs | 8 +- .../Model/TemplateResponseSignerRole.cs | 9 +- .../TemplateUpdateFilesResponseTemplate.cs | 9 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/java-v1/docs/TemplateResponse.md | 25 +- sdks/java-v1/docs/TemplateResponseAccount.md | 10 +- .../docs/TemplateResponseAccountQuota.md | 8 +- sdks/java-v1/docs/TemplateResponseCCRole.md | 2 +- sdks/java-v1/docs/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 17 +- ...mplateResponseDocumentFormFieldCheckbox.md | 1 + ...lateResponseDocumentFormFieldDateSigned.md | 1 + ...mplateResponseDocumentFormFieldDropdown.md | 1 + ...plateResponseDocumentFormFieldHyperlink.md | 9 +- ...mplateResponseDocumentFormFieldInitials.md | 1 + .../TemplateResponseDocumentFormFieldRadio.md | 1 + ...plateResponseDocumentFormFieldSignature.md | 1 + .../TemplateResponseDocumentFormFieldText.md | 9 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- ...teCreateEmbeddedDraftResponseTemplate.java | 21 +- .../model/TemplateCreateResponseTemplate.java | 7 +- .../dropbox/sign/model/TemplateResponse.java | 450 +++++++++------- .../sign/model/TemplateResponseAccount.java | 137 ++--- .../model/TemplateResponseAccountQuota.java | 28 +- .../sign/model/TemplateResponseCCRole.java | 7 +- .../sign/model/TemplateResponseDocument.java | 143 ++--- ...mplateResponseDocumentCustomFieldBase.java | 223 ++++---- ...mplateResponseDocumentCustomFieldText.java | 28 +- .../TemplateResponseDocumentFieldGroup.java | 14 +- ...emplateResponseDocumentFieldGroupRule.java | 14 +- ...TemplateResponseDocumentFormFieldBase.java | 205 +++---- ...lateResponseDocumentFormFieldCheckbox.java | 53 +- ...teResponseDocumentFormFieldDateSigned.java | 53 +- ...lateResponseDocumentFormFieldDropdown.java | 53 +- ...ateResponseDocumentFormFieldHyperlink.java | 85 ++- ...lateResponseDocumentFormFieldInitials.java | 53 +- ...emplateResponseDocumentFormFieldRadio.java | 54 +- ...ateResponseDocumentFormFieldSignature.java | 53 +- ...TemplateResponseDocumentFormFieldText.java | 78 ++- ...mplateResponseDocumentStaticFieldBase.java | 154 +++--- .../TemplateResponseFieldAvgTextLength.java | 14 +- .../model/TemplateResponseSignerRole.java | 7 +- .../TemplateUpdateFilesResponseTemplate.java | 7 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/java-v2/docs/TemplateResponse.md | 25 +- sdks/java-v2/docs/TemplateResponseAccount.md | 10 +- .../docs/TemplateResponseAccountQuota.md | 8 +- sdks/java-v2/docs/TemplateResponseCCRole.md | 2 +- sdks/java-v2/docs/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 17 +- ...mplateResponseDocumentFormFieldCheckbox.md | 1 + ...lateResponseDocumentFormFieldDateSigned.md | 1 + ...mplateResponseDocumentFormFieldDropdown.md | 1 + ...plateResponseDocumentFormFieldHyperlink.md | 9 +- ...mplateResponseDocumentFormFieldInitials.md | 1 + .../TemplateResponseDocumentFormFieldRadio.md | 1 + ...plateResponseDocumentFormFieldSignature.md | 1 + .../TemplateResponseDocumentFormFieldText.md | 9 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- ...teCreateEmbeddedDraftResponseTemplate.java | 18 +- .../model/TemplateCreateResponseTemplate.java | 6 +- .../dropbox/sign/model/TemplateResponse.java | 447 +++++++++------- .../sign/model/TemplateResponseAccount.java | 136 ++--- .../model/TemplateResponseAccountQuota.java | 24 +- .../sign/model/TemplateResponseCCRole.java | 6 +- .../sign/model/TemplateResponseDocument.java | 144 ++--- ...mplateResponseDocumentCustomFieldBase.java | 220 ++++---- ...mplateResponseDocumentCustomFieldText.java | 24 +- .../TemplateResponseDocumentFieldGroup.java | 12 +- ...emplateResponseDocumentFieldGroupRule.java | 12 +- ...TemplateResponseDocumentFormFieldBase.java | 206 +++---- ...lateResponseDocumentFormFieldCheckbox.java | 54 +- ...teResponseDocumentFormFieldDateSigned.java | 54 +- ...lateResponseDocumentFormFieldDropdown.java | 54 +- ...ateResponseDocumentFormFieldHyperlink.java | 78 ++- ...lateResponseDocumentFormFieldInitials.java | 54 +- ...emplateResponseDocumentFormFieldRadio.java | 54 +- ...ateResponseDocumentFormFieldSignature.java | 54 +- ...TemplateResponseDocumentFormFieldText.java | 78 ++- ...mplateResponseDocumentStaticFieldBase.java | 152 +++--- .../TemplateResponseFieldAvgTextLength.java | 12 +- .../model/TemplateResponseSignerRole.java | 6 +- .../TemplateUpdateFilesResponseTemplate.java | 6 +- sdks/node/dist/api.js | 134 +++-- ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../model/TemplateCreateResponseTemplate.md | 2 +- sdks/node/docs/model/TemplateResponse.md | 25 +- .../docs/model/TemplateResponseAccount.md | 10 +- .../model/TemplateResponseAccountQuota.md | 8 +- .../node/docs/model/TemplateResponseCCRole.md | 2 +- .../docs/model/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 17 +- ...mplateResponseDocumentFormFieldCheckbox.md | 1 + ...lateResponseDocumentFormFieldDateSigned.md | 1 + ...mplateResponseDocumentFormFieldDropdown.md | 1 + ...plateResponseDocumentFormFieldHyperlink.md | 9 +- ...mplateResponseDocumentFormFieldInitials.md | 1 + .../TemplateResponseDocumentFormFieldRadio.md | 1 + ...plateResponseDocumentFormFieldSignature.md | 1 + .../TemplateResponseDocumentFormFieldText.md | 9 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../docs/model/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- ...lateCreateEmbeddedDraftResponseTemplate.ts | 6 +- .../model/templateCreateResponseTemplate.ts | 2 +- sdks/node/model/templateResponse.ts | 84 +-- sdks/node/model/templateResponseAccount.ts | 28 +- .../model/templateResponseAccountQuota.ts | 8 +- sdks/node/model/templateResponseCCRole.ts | 2 +- sdks/node/model/templateResponseDocument.ts | 28 +- ...templateResponseDocumentCustomFieldBase.ts | 38 +- ...templateResponseDocumentCustomFieldText.ts | 8 +- .../templateResponseDocumentFieldGroup.ts | 4 +- .../templateResponseDocumentFieldGroupRule.ts | 4 +- .../templateResponseDocumentFormFieldBase.ts | 37 +- ...mplateResponseDocumentFormFieldCheckbox.ts | 9 + ...lateResponseDocumentFormFieldDateSigned.ts | 9 + ...mplateResponseDocumentFormFieldDropdown.ts | 9 + ...plateResponseDocumentFormFieldHyperlink.ts | 17 +- ...mplateResponseDocumentFormFieldInitials.ts | 9 + .../templateResponseDocumentFormFieldRadio.ts | 9 + ...plateResponseDocumentFormFieldSignature.ts | 9 + .../templateResponseDocumentFormFieldText.ts | 17 +- ...templateResponseDocumentStaticFieldBase.ts | 28 +- .../templateResponseFieldAvgTextLength.ts | 4 +- sdks/node/model/templateResponseSignerRole.ts | 2 +- .../templateUpdateFilesResponseTemplate.ts | 2 +- ...teCreateEmbeddedDraftResponseTemplate.d.ts | 6 +- .../model/templateCreateResponseTemplate.d.ts | 2 +- sdks/node/types/model/templateResponse.d.ts | 24 +- .../types/model/templateResponseAccount.d.ts | 10 +- .../model/templateResponseAccountQuota.d.ts | 8 +- .../types/model/templateResponseCCRole.d.ts | 2 +- .../types/model/templateResponseDocument.d.ts | 10 +- ...mplateResponseDocumentCustomFieldBase.d.ts | 14 +- ...mplateResponseDocumentCustomFieldText.d.ts | 8 +- .../templateResponseDocumentFieldGroup.d.ts | 4 +- ...emplateResponseDocumentFieldGroupRule.d.ts | 4 +- ...templateResponseDocumentFormFieldBase.d.ts | 17 +- ...lateResponseDocumentFormFieldCheckbox.d.ts | 1 + ...teResponseDocumentFormFieldDateSigned.d.ts | 1 + ...lateResponseDocumentFormFieldDropdown.d.ts | 1 + ...ateResponseDocumentFormFieldHyperlink.d.ts | 9 +- ...lateResponseDocumentFormFieldInitials.d.ts | 1 + ...emplateResponseDocumentFormFieldRadio.d.ts | 1 + ...ateResponseDocumentFormFieldSignature.d.ts | 1 + ...templateResponseDocumentFormFieldText.d.ts | 9 +- ...mplateResponseDocumentStaticFieldBase.d.ts | 16 +- .../templateResponseFieldAvgTextLength.d.ts | 4 +- .../model/templateResponseSignerRole.d.ts | 2 +- .../templateUpdateFilesResponseTemplate.d.ts | 2 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../Model/TemplateCreateResponseTemplate.md | 2 +- sdks/php/docs/Model/TemplateResponse.md | 25 +- .../php/docs/Model/TemplateResponseAccount.md | 10 +- .../Model/TemplateResponseAccountQuota.md | 8 +- sdks/php/docs/Model/TemplateResponseCCRole.md | 2 +- .../docs/Model/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 17 +- ...mplateResponseDocumentFormFieldCheckbox.md | 1 + ...lateResponseDocumentFormFieldDateSigned.md | 1 + ...mplateResponseDocumentFormFieldDropdown.md | 1 + ...plateResponseDocumentFormFieldHyperlink.md | 9 +- ...mplateResponseDocumentFormFieldInitials.md | 1 + .../TemplateResponseDocumentFormFieldRadio.md | 1 + ...plateResponseDocumentFormFieldSignature.md | 1 + .../TemplateResponseDocumentFormFieldText.md | 9 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../docs/Model/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- ...ateCreateEmbeddedDraftResponseTemplate.php | 31 +- .../Model/TemplateCreateResponseTemplate.php | 13 +- sdks/php/src/Model/TemplateResponse.php | 392 ++++++++------ .../php/src/Model/TemplateResponseAccount.php | 117 ++-- .../Model/TemplateResponseAccountQuota.php | 40 +- sdks/php/src/Model/TemplateResponseCCRole.php | 13 +- .../src/Model/TemplateResponseDocument.php | 128 +++-- ...emplateResponseDocumentCustomFieldBase.php | 179 ++++--- ...emplateResponseDocumentCustomFieldText.php | 36 +- .../TemplateResponseDocumentFieldGroup.php | 22 +- ...TemplateResponseDocumentFieldGroupRule.php | 22 +- .../TemplateResponseDocumentFormFieldBase.php | 173 +++--- ...plateResponseDocumentFormFieldCheckbox.php | 41 ++ ...ateResponseDocumentFormFieldDateSigned.php | 41 ++ ...plateResponseDocumentFormFieldDropdown.php | 41 ++ ...lateResponseDocumentFormFieldHyperlink.php | 77 ++- ...plateResponseDocumentFormFieldInitials.php | 41 ++ ...TemplateResponseDocumentFormFieldRadio.php | 37 ++ ...lateResponseDocumentFormFieldSignature.php | 41 ++ .../TemplateResponseDocumentFormFieldText.php | 77 ++- ...emplateResponseDocumentStaticFieldBase.php | 132 +++-- .../TemplateResponseFieldAvgTextLength.php | 22 +- .../src/Model/TemplateResponseSignerRole.php | 13 +- .../TemplateUpdateFilesResponseTemplate.php | 13 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/python/docs/TemplateResponse.md | 25 +- sdks/python/docs/TemplateResponseAccount.md | 10 +- .../docs/TemplateResponseAccountQuota.md | 8 +- sdks/python/docs/TemplateResponseCCRole.md | 2 +- sdks/python/docs/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 17 +- ...mplateResponseDocumentFormFieldCheckbox.md | 1 + ...lateResponseDocumentFormFieldDateSigned.md | 1 + ...mplateResponseDocumentFormFieldDropdown.md | 1 + ...plateResponseDocumentFormFieldHyperlink.md | 9 +- ...mplateResponseDocumentFormFieldInitials.md | 1 + .../TemplateResponseDocumentFormFieldRadio.md | 1 + ...plateResponseDocumentFormFieldSignature.md | 1 + .../TemplateResponseDocumentFormFieldText.md | 9 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../python/docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- ...create_embedded_draft_response_template.py | 12 +- .../template_create_response_template.py | 6 +- .../dropbox_sign/models/template_response.py | 132 +++-- .../models/template_response_account.py | 31 +- .../models/template_response_account_quota.py | 18 +- .../models/template_response_cc_role.py | 4 +- .../models/template_response_document.py | 33 +- ...ate_response_document_custom_field_base.py | 39 +- ...response_document_custom_field_checkbox.py | 10 +- ...ate_response_document_custom_field_text.py | 33 +- .../template_response_document_field_group.py | 8 +- ...late_response_document_field_group_rule.py | 11 +- ...plate_response_document_form_field_base.py | 41 +- ...e_response_document_form_field_checkbox.py | 10 +- ...esponse_document_form_field_date_signed.py | 12 +- ...e_response_document_form_field_dropdown.py | 10 +- ..._response_document_form_field_hyperlink.py | 27 +- ...e_response_document_form_field_initials.py | 10 +- ...late_response_document_form_field_radio.py | 11 +- ..._response_document_form_field_signature.py | 10 +- ...plate_response_document_form_field_text.py | 31 +- ...ate_response_document_static_field_base.py | 38 +- ...response_document_static_field_checkbox.py | 4 +- ...ponse_document_static_field_date_signed.py | 6 +- ...response_document_static_field_dropdown.py | 4 +- ...esponse_document_static_field_hyperlink.py | 4 +- ...response_document_static_field_initials.py | 4 +- ...te_response_document_static_field_radio.py | 4 +- ...esponse_document_static_field_signature.py | 4 +- ...ate_response_document_static_field_text.py | 4 +- ...template_response_field_avg_text_length.py | 8 +- .../models/template_response_signer_role.py | 2 +- ...template_update_files_response_template.py | 4 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/ruby/docs/TemplateResponse.md | 25 +- sdks/ruby/docs/TemplateResponseAccount.md | 10 +- .../ruby/docs/TemplateResponseAccountQuota.md | 8 +- sdks/ruby/docs/TemplateResponseCCRole.md | 2 +- sdks/ruby/docs/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 17 +- ...mplateResponseDocumentFormFieldCheckbox.md | 1 + ...lateResponseDocumentFormFieldDateSigned.md | 1 + ...mplateResponseDocumentFormFieldDropdown.md | 1 + ...plateResponseDocumentFormFieldHyperlink.md | 9 +- ...mplateResponseDocumentFormFieldInitials.md | 1 + .../TemplateResponseDocumentFormFieldRadio.md | 1 + ...plateResponseDocumentFormFieldSignature.md | 1 + .../TemplateResponseDocumentFormFieldText.md | 9 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- sdks/ruby/docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- ...create_embedded_draft_response_template.rb | 15 + .../template_create_response_template.rb | 5 + .../dropbox-sign/models/template_response.rb | 163 ++++-- .../models/template_response_account.rb | 55 +- .../models/template_response_account_quota.rb | 20 + .../models/template_response_cc_role.rb | 5 + .../models/template_response_document.rb | 58 +- ...ate_response_document_custom_field_base.rb | 73 ++- ...ate_response_document_custom_field_text.rb | 20 + .../template_response_document_field_group.rb | 10 + ...late_response_document_field_group_rule.rb | 10 + ...plate_response_document_form_field_base.rb | 80 ++- ...e_response_document_form_field_checkbox.rb | 20 +- ...esponse_document_form_field_date_signed.rb | 20 +- ...e_response_document_form_field_dropdown.rb | 20 +- ..._response_document_form_field_hyperlink.rb | 40 +- ...e_response_document_form_field_initials.rb | 20 +- ...late_response_document_form_field_radio.rb | 24 +- ..._response_document_form_field_signature.rb | 20 +- ...plate_response_document_form_field_text.rb | 42 +- ...ate_response_document_static_field_base.rb | 62 ++- ...template_response_field_avg_text_length.rb | 10 + .../models/template_response_signer_role.rb | 5 + ...template_update_files_response_template.rb | 5 + test_fixtures/TemplateGetResponse.json | 503 +----------------- test_fixtures/TemplateListResponse.json | 39 +- translations/en.yaml | 2 +- 394 files changed, 6862 insertions(+), 4643 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 5889894a4..e0d57e123 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -10674,6 +10674,19 @@ components: x-internal-class: true TemplateResponse: description: '_t__TemplateResponse::DESCRIPTION' + required: + - accounts + - attachments + - can_edit + - cc_roles + - documents + - is_creator + - is_locked + - message + - metadata + - signer_roles + - template_id + - title properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' @@ -10694,15 +10707,12 @@ components: is_creator: description: '_t__TemplateResponse::IS_CREATOR' type: boolean - nullable: true can_edit: description: '_t__TemplateResponse::CAN_EDIT' type: boolean - nullable: true is_locked: description: '_t__TemplateResponse::IS_LOCKED' type: boolean - nullable: true metadata: description: '_t__TemplateResponse::METADATA' type: object @@ -10740,10 +10750,20 @@ components: type: array items: $ref: '#/components/schemas/TemplateResponseAccount' - nullable: true + attachments: + description: '_t__SignatureRequestResponseAttachment::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SignatureRequestResponseAttachment' type: object x-internal-class: true TemplateResponseAccount: + required: + - account_id + - is_locked + - is_paid_hf + - is_paid_hs + - quotas properties: account_id: description: '_t__TemplateResponseAccount::ACCOUNT_ID' @@ -10766,6 +10786,11 @@ components: x-internal-class: true TemplateResponseAccountQuota: description: '_t__TemplateResponseAccountQuota::DESCRIPTION' + required: + - templates_left + - api_signature_requests_left + - documents_left + - sms_verifications_left properties: templates_left: description: '_t__TemplateResponseAccountQuota::TEMPLATES_LEFT' @@ -10782,6 +10807,8 @@ components: type: object x-internal-class: true TemplateResponseCCRole: + required: + - name properties: name: description: '_t__TemplateResponseCCRole::NAME' @@ -10790,6 +10817,10 @@ components: x-internal-class: true TemplateCreateEmbeddedDraftResponseTemplate: description: '_t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION' + required: + - edit_url + - expires_at + - template_id properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' @@ -10810,6 +10841,8 @@ components: x-internal-class: true TemplateCreateResponseTemplate: description: '_t__TemplateCreateResponseTemplate::DESCRIPTION' + required: + - template_id properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' @@ -10817,6 +10850,12 @@ components: type: object x-internal-class: true TemplateResponseDocument: + required: + - custom_fields + - field_groups + - form_fields + - name + - static_fields properties: name: description: '_t__TemplateResponseDocument::NAME' @@ -10844,13 +10883,19 @@ components: type: array items: $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - nullable: true type: object x-internal-class: true TemplateResponseDocumentCustomFieldBase: description: '_t__TemplateResponseDocumentCustomField::DESCRIPTION' required: + - api_id + - height + - name + - required - type + - width + - x + - 'y' properties: api_id: description: '_t__TemplateResponseDocumentCustomField::API_ID' @@ -10909,6 +10954,10 @@ components: TemplateResponseDocumentCustomFieldText: description: '_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - @@ -10932,6 +10981,9 @@ components: type: string type: object TemplateResponseDocumentFieldGroup: + required: + - name + - rule properties: name: description: '_t__TemplateResponseDocumentFieldGroup::NAME' @@ -10942,6 +10994,9 @@ components: x-internal-class: true TemplateResponseDocumentFieldGroupRule: description: '_t__TemplateResponseDocumentFieldGroup::RULE' + required: + - groupLabel + - requirement properties: requirement: description: '_t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT' @@ -10954,7 +11009,15 @@ components: TemplateResponseDocumentFormFieldBase: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION' required: + - api_id + - height + - name + - required + - signer - type + - width + - x + - 'y' properties: api_id: description: '_t__TemplateResponseDocumentFormField::API_ID' @@ -10983,10 +11046,6 @@ components: required: description: '_t__TemplateResponseDocumentFormField::REQUIRED' type: boolean - group: - description: '_t__TemplateResponseDocumentFormField::GROUP' - type: string - nullable: true type: object discriminator: propertyName: type @@ -11003,17 +11062,21 @@ components: x-base-class: true TemplateResponseDocumentFormFieldCheckbox: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' + required: + - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: checkbox + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldDateSigned: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' @@ -11023,13 +11086,15 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: date_signed + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldDropdown: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' @@ -11039,24 +11104,28 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: dropdown + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldHyperlink: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' @@ -11073,6 +11142,10 @@ components: fontFamily: description: '_t__TemplateResponseDocumentFormField::FONT_FAMILY' type: string + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldInitials: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' @@ -11082,13 +11155,15 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: initials + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldRadio: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' @@ -11099,13 +11174,14 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: radio + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string type: object TemplateResponseDocumentFormFieldSignature: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' @@ -11115,24 +11191,28 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: signature + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldText: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' @@ -11164,11 +11244,23 @@ components: - employer_identification_number - custom_regex nullable: true + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string + nullable: true type: object TemplateResponseDocumentStaticFieldBase: description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION' required: + - api_id + - height + - name + - required + - signer - type + - width + - x + - 'y' properties: api_id: description: '_t__TemplateResponseDocumentStaticField::API_ID' @@ -11223,8 +11315,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11239,8 +11329,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11255,8 +11343,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11271,8 +11357,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11287,8 +11371,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11303,8 +11385,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11319,8 +11399,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11335,8 +11413,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11345,6 +11421,9 @@ components: type: object TemplateResponseFieldAvgTextLength: description: '_t__TemplateResponseFieldAvgTextLength::DESCRIPTION' + required: + - num_lines + - num_chars_per_line properties: num_lines: description: '_t__TemplateResponseFieldAvgTextLength::NUM_LINES' @@ -11355,6 +11434,8 @@ components: type: object x-internal-class: true TemplateResponseSignerRole: + required: + - name properties: name: description: '_t__TemplateResponseSignerRole::NAME' @@ -11366,6 +11447,8 @@ components: x-internal-class: true TemplateUpdateFilesResponseTemplate: description: '_t__TemplateUpdateFilesResponseTemplate::DESCRIPTION' + required: + - template_id properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 17a5b7f81..f24937c67 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -11290,6 +11290,19 @@ components: x-internal-class: true TemplateResponse: description: 'Contains information about the templates you and your team have created.' + required: + - accounts + - attachments + - can_edit + - cc_roles + - documents + - is_creator + - is_locked + - message + - metadata + - signer_roles + - template_id + - title properties: template_id: description: 'The id of the Template.' @@ -11304,24 +11317,21 @@ components: description: 'Time the template was last updated.' type: integer is_embedded: - description: '`true` if this template was created using an embedded flow, `false` if it was created on our website.' + description: '`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.' type: boolean nullable: true is_creator: description: '`true` if you are the owner of this template, `false` if it''s been shared with you by a team member.' type: boolean - nullable: true can_edit: description: 'Indicates whether edit rights have been granted to you by the owner (always `true` if that''s you).' type: boolean - nullable: true is_locked: description: |- Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. type: boolean - nullable: true metadata: description: 'The metadata attached to the template.' type: object @@ -11359,10 +11369,20 @@ components: type: array items: $ref: '#/components/schemas/TemplateResponseAccount' - nullable: true + attachments: + description: 'Signer attachments.' + type: array + items: + $ref: '#/components/schemas/SignatureRequestResponseAttachment' type: object x-internal-class: true TemplateResponseAccount: + required: + - account_id + - is_locked + - is_paid_hf + - is_paid_hs + - quotas properties: account_id: description: 'The id of the Account.' @@ -11385,6 +11405,11 @@ components: x-internal-class: true TemplateResponseAccountQuota: description: 'An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.' + required: + - templates_left + - api_signature_requests_left + - documents_left + - sms_verifications_left properties: templates_left: description: 'API templates remaining.' @@ -11401,6 +11426,8 @@ components: type: object x-internal-class: true TemplateResponseCCRole: + required: + - name properties: name: description: 'The name of the Role.' @@ -11409,6 +11436,10 @@ components: x-internal-class: true TemplateCreateEmbeddedDraftResponseTemplate: description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.' + required: + - edit_url + - expires_at + - template_id properties: template_id: description: 'The id of the Template.' @@ -11429,6 +11460,8 @@ components: x-internal-class: true TemplateCreateResponseTemplate: description: 'Template object with parameters: `template_id`.' + required: + - template_id properties: template_id: description: 'The id of the Template.' @@ -11436,6 +11469,12 @@ components: type: object x-internal-class: true TemplateResponseDocument: + required: + - custom_fields + - field_groups + - form_fields + - name + - static_fields properties: name: description: 'Name of the associated file.' @@ -11463,13 +11502,19 @@ components: type: array items: $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - nullable: true type: object x-internal-class: true TemplateResponseDocumentCustomFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: + - api_id + - height + - name + - required - type + - width + - x + - 'y' properties: api_id: description: 'The unique ID for this field.' @@ -11532,6 +11577,10 @@ components: TemplateResponseDocumentCustomFieldText: description: 'This class extends `TemplateResponseDocumentCustomFieldBase`' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - @@ -11559,6 +11608,9 @@ components: type: string type: object TemplateResponseDocumentFieldGroup: + required: + - name + - rule properties: name: description: 'The name of the form field group.' @@ -11569,6 +11621,9 @@ components: x-internal-class: true TemplateResponseDocumentFieldGroupRule: description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).' + required: + - groupLabel + - requirement properties: requirement: description: |- @@ -11586,7 +11641,15 @@ components: TemplateResponseDocumentFormFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: + - api_id + - height + - name + - required + - signer - type + - width + - x + - 'y' properties: api_id: description: 'A unique id for the form field.' @@ -11615,10 +11678,6 @@ components: required: description: 'Boolean showing whether or not this field is required.' type: boolean - group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' - type: string - nullable: true type: object discriminator: propertyName: type @@ -11635,12 +11694,12 @@ components: x-base-class: true TemplateResponseDocumentFormFieldCheckbox: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + required: + - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11656,6 +11715,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: checkbox + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldDateSigned: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11665,8 +11728,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11682,6 +11743,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: date_signed + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldDropdown: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11691,8 +11756,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11708,17 +11771,23 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: dropdown + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldHyperlink: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11745,6 +11814,10 @@ components: fontFamily: description: 'Font family used in this form field''s text.' type: string + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldInitials: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11754,8 +11827,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11771,6 +11842,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: initials + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldRadio: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11781,8 +11856,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11798,6 +11871,9 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: radio + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string type: object TemplateResponseDocumentFormFieldSignature: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11807,8 +11883,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11824,17 +11898,23 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: signature + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldText: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11876,11 +11956,23 @@ components: - employer_identification_number - custom_regex nullable: true + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentStaticFieldBase: description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' required: + - api_id + - height + - name + - required + - signer - type + - width + - x + - 'y' properties: api_id: description: 'A unique id for the static field.' @@ -11935,8 +12027,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11961,8 +12051,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11987,8 +12075,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12013,8 +12099,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12039,8 +12123,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12065,8 +12147,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12091,8 +12171,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12117,8 +12195,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12137,6 +12213,9 @@ components: type: object TemplateResponseFieldAvgTextLength: description: 'Average text length in this field.' + required: + - num_lines + - num_chars_per_line properties: num_lines: description: 'Number of lines.' @@ -12147,6 +12226,8 @@ components: type: object x-internal-class: true TemplateResponseSignerRole: + required: + - name properties: name: description: 'The name of the Role.' @@ -12158,6 +12239,8 @@ components: x-internal-class: true TemplateUpdateFilesResponseTemplate: description: 'Contains template id' + required: + - template_id properties: template_id: description: 'The id of the Template.' diff --git a/openapi.yaml b/openapi.yaml index 4b14bfca4..56be94ebe 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -11268,6 +11268,19 @@ components: x-internal-class: true TemplateResponse: description: 'Contains information about the templates you and your team have created.' + required: + - accounts + - attachments + - can_edit + - cc_roles + - documents + - is_creator + - is_locked + - message + - metadata + - signer_roles + - template_id + - title properties: template_id: description: 'The id of the Template.' @@ -11282,24 +11295,21 @@ components: description: 'Time the template was last updated.' type: integer is_embedded: - description: '`true` if this template was created using an embedded flow, `false` if it was created on our website.' + description: '`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.' type: boolean nullable: true is_creator: description: '`true` if you are the owner of this template, `false` if it''s been shared with you by a team member.' type: boolean - nullable: true can_edit: description: 'Indicates whether edit rights have been granted to you by the owner (always `true` if that''s you).' type: boolean - nullable: true is_locked: description: |- Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. type: boolean - nullable: true metadata: description: 'The metadata attached to the template.' type: object @@ -11337,10 +11347,20 @@ components: type: array items: $ref: '#/components/schemas/TemplateResponseAccount' - nullable: true + attachments: + description: 'Signer attachments.' + type: array + items: + $ref: '#/components/schemas/SignatureRequestResponseAttachment' type: object x-internal-class: true TemplateResponseAccount: + required: + - account_id + - is_locked + - is_paid_hf + - is_paid_hs + - quotas properties: account_id: description: 'The id of the Account.' @@ -11363,6 +11383,11 @@ components: x-internal-class: true TemplateResponseAccountQuota: description: 'An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.' + required: + - templates_left + - api_signature_requests_left + - documents_left + - sms_verifications_left properties: templates_left: description: 'API templates remaining.' @@ -11379,6 +11404,8 @@ components: type: object x-internal-class: true TemplateResponseCCRole: + required: + - name properties: name: description: 'The name of the Role.' @@ -11387,6 +11414,10 @@ components: x-internal-class: true TemplateCreateEmbeddedDraftResponseTemplate: description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.' + required: + - edit_url + - expires_at + - template_id properties: template_id: description: 'The id of the Template.' @@ -11407,6 +11438,8 @@ components: x-internal-class: true TemplateCreateResponseTemplate: description: 'Template object with parameters: `template_id`.' + required: + - template_id properties: template_id: description: 'The id of the Template.' @@ -11414,6 +11447,12 @@ components: type: object x-internal-class: true TemplateResponseDocument: + required: + - custom_fields + - field_groups + - form_fields + - name + - static_fields properties: name: description: 'Name of the associated file.' @@ -11441,13 +11480,19 @@ components: type: array items: $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - nullable: true type: object x-internal-class: true TemplateResponseDocumentCustomFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: + - api_id + - height + - name + - required - type + - width + - x + - 'y' properties: api_id: description: 'The unique ID for this field.' @@ -11510,6 +11555,10 @@ components: TemplateResponseDocumentCustomFieldText: description: 'This class extends `TemplateResponseDocumentCustomFieldBase`' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - @@ -11537,6 +11586,9 @@ components: type: string type: object TemplateResponseDocumentFieldGroup: + required: + - name + - rule properties: name: description: 'The name of the form field group.' @@ -11547,6 +11599,9 @@ components: x-internal-class: true TemplateResponseDocumentFieldGroupRule: description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).' + required: + - groupLabel + - requirement properties: requirement: description: |- @@ -11564,7 +11619,15 @@ components: TemplateResponseDocumentFormFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: + - api_id + - height + - name + - required + - signer - type + - width + - x + - 'y' properties: api_id: description: 'A unique id for the form field.' @@ -11593,10 +11656,6 @@ components: required: description: 'Boolean showing whether or not this field is required.' type: boolean - group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' - type: string - nullable: true type: object discriminator: propertyName: type @@ -11613,12 +11672,12 @@ components: x-base-class: true TemplateResponseDocumentFormFieldCheckbox: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + required: + - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11634,6 +11693,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: checkbox + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldDateSigned: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11643,8 +11706,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11660,6 +11721,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: date_signed + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldDropdown: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11669,8 +11734,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11686,17 +11749,23 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: dropdown + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldHyperlink: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11723,6 +11792,10 @@ components: fontFamily: description: 'Font family used in this form field''s text.' type: string + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldInitials: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11732,8 +11805,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11749,6 +11820,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: initials + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldRadio: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11759,8 +11834,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11776,6 +11849,9 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: radio + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string type: object TemplateResponseDocumentFormFieldSignature: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11785,8 +11861,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11802,17 +11876,23 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: signature + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldText: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11854,11 +11934,23 @@ components: - employer_identification_number - custom_regex nullable: true + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentStaticFieldBase: description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' required: + - api_id + - height + - name + - required + - signer - type + - width + - x + - 'y' properties: api_id: description: 'A unique id for the static field.' @@ -11913,8 +12005,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11939,8 +12029,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11965,8 +12053,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11991,8 +12077,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12017,8 +12101,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12043,8 +12125,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12069,8 +12149,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12095,8 +12173,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12115,6 +12191,9 @@ components: type: object TemplateResponseFieldAvgTextLength: description: 'Average text length in this field.' + required: + - num_lines + - num_chars_per_line properties: num_lines: description: 'Number of lines.' @@ -12125,6 +12204,8 @@ components: type: object x-internal-class: true TemplateResponseSignerRole: + required: + - name properties: name: description: 'The name of the Role.' @@ -12136,6 +12217,8 @@ components: x-internal-class: true TemplateUpdateFilesResponseTemplate: description: 'Contains template id' + required: + - template_id properties: template_id: description: 'The id of the Template.' diff --git a/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index d23893dd3..14e94249e 100644 --- a/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -5,7 +5,7 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | [optional] **EditUrl** | **string** | Link to edit the template. | [optional] **ExpiresAt** | **int** | When the link expires. | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**TemplateId** | **string** | The id of the Template. | **EditUrl** | **string** | Link to edit the template. | **ExpiresAt** | **int** | When the link expires. | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateCreateResponseTemplate.md b/sdks/dotnet/docs/TemplateCreateResponseTemplate.md index 85941fc4e..e8b10cc5e 100644 --- a/sdks/dotnet/docs/TemplateCreateResponseTemplate.md +++ b/sdks/dotnet/docs/TemplateCreateResponseTemplate.md @@ -5,7 +5,7 @@ Template object with parameters: `template_id`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | [optional] +**TemplateId** | **string** | The id of the Template. | [[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/TemplateResponse.md b/sdks/dotnet/docs/TemplateResponse.md index ce17e3777..5e8b837b9 100644 --- a/sdks/dotnet/docs/TemplateResponse.md +++ b/sdks/dotnet/docs/TemplateResponse.md @@ -5,7 +5,7 @@ Contains information about the templates you and your team have created. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | [optional] **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. | [optional] **IsCreator** | **bool?** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | [optional] **CanEdit** | **bool?** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | [optional] **IsLocked** | **bool?** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | [optional] **Metadata** | **Object** | The metadata attached to the template. | [optional] **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | [optional] **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | [optional] +**TemplateId** | **string** | The id of the Template. | **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | **Metadata** | **Object** | The metadata attached to the template. | **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [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/TemplateResponseAccount.md b/sdks/dotnet/docs/TemplateResponseAccount.md index b69b4ebaa..297e5209a 100644 --- a/sdks/dotnet/docs/TemplateResponseAccount.md +++ b/sdks/dotnet/docs/TemplateResponseAccount.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** | [**TemplateResponseAccountQuota**](TemplateResponseAccountQuota.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** | [**TemplateResponseAccountQuota**](TemplateResponseAccountQuota.md) | | **EmailAddress** | **string** | The email address associated with the Account. | [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/TemplateResponseAccountQuota.md b/sdks/dotnet/docs/TemplateResponseAccountQuota.md index 5051dc54f..9b51ccf96 100644 --- a/sdks/dotnet/docs/TemplateResponseAccountQuota.md +++ b/sdks/dotnet/docs/TemplateResponseAccountQuota.md @@ -5,7 +5,7 @@ An array of the designated CC roles that must be specified when sending a Signat Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplatesLeft** | **int** | API templates remaining. | [optional] **ApiSignatureRequestsLeft** | **int** | API signature requests remaining. | [optional] **DocumentsLeft** | **int** | Signature requests remaining. | [optional] **SmsVerificationsLeft** | **int** | SMS verifications remaining. | [optional] +**TemplatesLeft** | **int** | API templates remaining. | **ApiSignatureRequestsLeft** | **int** | API signature requests remaining. | **DocumentsLeft** | **int** | Signature requests remaining. | **SmsVerificationsLeft** | **int** | SMS verifications remaining. | [[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/TemplateResponseCCRole.md b/sdks/dotnet/docs/TemplateResponseCCRole.md index 1e8067443..fbb67b662 100644 --- a/sdks/dotnet/docs/TemplateResponseCCRole.md +++ b/sdks/dotnet/docs/TemplateResponseCCRole.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the Role. | [optional] +**Name** | **string** | The name of the Role. | [[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/TemplateResponseDocument.md b/sdks/dotnet/docs/TemplateResponseDocument.md index 6847d7b3c..2d475d964 100644 --- a/sdks/dotnet/docs/TemplateResponseDocument.md +++ b/sdks/dotnet/docs/TemplateResponseDocument.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | Name of the associated file. | [optional] **Index** | **int** | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | [optional] **FieldGroups** | [**List<TemplateResponseDocumentFieldGroup>**](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | [optional] **FormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | [optional] **StaticFields** | [**List<TemplateResponseDocumentStaticFieldBase>**](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | [optional] +**Name** | **string** | Name of the associated file. | **FieldGroups** | [**List<TemplateResponseDocumentFieldGroup>**](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | **FormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | **StaticFields** | [**List<TemplateResponseDocumentStaticFieldBase>**](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | **Index** | **int** | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | [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/TemplateResponseDocumentCustomFieldBase.md b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldBase.md index 9f349a7ab..11b988b67 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldBase.md @@ -5,7 +5,7 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | | **ApiId** | **string** | The unique ID for this field. | [optional] **Name** | **string** | The name of the Custom Field. | [optional] **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] **X** | **int** | The horizontal offset in pixels for this form field. | [optional] **Y** | **int** | The vertical offset in pixels for this form field. | [optional] **Width** | **int** | The width in pixels of this form field. | [optional] **Height** | **int** | The height in pixels of this form field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] +**ApiId** | **string** | The unique ID for this field. | **Name** | **string** | The name of the Custom Field. | **Type** | **string** | | **X** | **int** | The horizontal offset in pixels for this form field. | **Y** | **int** | The vertical offset in pixels for this form field. | **Width** | **int** | The width in pixels of this form field. | **Height** | **int** | The height in pixels of this form field. | **Required** | **bool** | Boolean showing whether or not this field is required. | **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [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/TemplateResponseDocumentCustomFieldCheckbox.md b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldCheckbox.md index 11a948265..83b4c54aa 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldCheckbox.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldCheckbox.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**Name** | **string** | The name of the Custom Field. | [optional] +**ApiId** | **string** | The unique ID for this field. | +**Name** | **string** | The name of the Custom Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to "checkbox"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md index 8db16365b..4e2fb5a19 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md @@ -5,16 +5,16 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**Name** | **string** | The name of the Custom Field. | [optional] +**ApiId** | **string** | The unique ID for this field. | +**Name** | **string** | The name of the Custom Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] -**Type** | **string** | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional] +**Type** | **string** | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | **IsMultiline** | **bool** | Whether this form field is multiline text. | **OriginalFontSize** | **int** | Original font size used in this form field's text. | **FontFamily** | **string** | Font family used in this form field's text. | [[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/TemplateResponseDocumentFieldGroup.md b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroup.md index 0dfac711c..8d3113005 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroup.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the form field group. | [optional] **Rule** | [**TemplateResponseDocumentFieldGroupRule**](TemplateResponseDocumentFieldGroupRule.md) | | [optional] +**Name** | **string** | The name of the form field group. | **Rule** | [**TemplateResponseDocumentFieldGroupRule**](TemplateResponseDocumentFieldGroupRule.md) | | [[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/TemplateResponseDocumentFieldGroupRule.md b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroupRule.md index 44dd2eb4a..bf5970a2d 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroupRule.md @@ -5,7 +5,7 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Requirement** | **string** | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | [optional] **GroupLabel** | **string** | Name of the group | [optional] +**Requirement** | **string** | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | **GroupLabel** | **string** | Name of the group | [[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/TemplateResponseDocumentFormFieldBase.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldBase.md index 0e941c7ec..3d29f4f62 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldBase.md @@ -5,7 +5,7 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | | **ApiId** | **string** | A unique id for the form field. | [optional] **Name** | **string** | The name of the form field. | [optional] **Signer** | **string** | The signer of the Form Field. | [optional] **X** | **int** | The horizontal offset in pixels for this form field. | [optional] **Y** | **int** | The vertical offset in pixels for this form field. | [optional] **Width** | **int** | The width in pixels of this form field. | [optional] **Height** | **int** | The height in pixels of this form field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] +**ApiId** | **string** | A unique id for the form field. | **Name** | **string** | The name of the form field. | **Type** | **string** | | **Signer** | **string** | The signer of the Form Field. | **X** | **int** | The horizontal offset in pixels for this form field. | **Y** | **int** | The vertical offset in pixels for this form field. | **Width** | **int** | The width in pixels of this form field. | **Height** | **int** | The height in pixels of this form field. | **Required** | **bool** | Boolean showing whether or not this field is required. | [[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/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldCheckbox.md index 45636fa5a..add6e9a18 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "checkbox"] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "checkbox"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDateSigned.md index 6bf5b02b3..0c08c5ab2 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "date_signed"] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "date_signed"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldDropdown.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDropdown.md index fa94587f3..cde089bc9 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "dropdown"] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "dropdown"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldHyperlink.md index c5dc34e1f..481e7f478 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "hyperlink"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "hyperlink"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | **IsMultiline** | **bool** | Whether this form field is multiline text. | **OriginalFontSize** | **int** | Original font size used in this form field's text. | **FontFamily** | **string** | Font family used in this form field's text. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldInitials.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldInitials.md index ada79ecb1..86905a63f 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldInitials.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "initials"] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "initials"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldRadio.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldRadio.md index abc332ce9..217c5357c 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldRadio.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "radio"] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "radio"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [[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/TemplateResponseDocumentFormFieldSignature.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldSignature.md index 429769c02..08452c6cb 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldSignature.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "signature"] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "signature"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldText.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldText.md index 9bcc4780e..030296903 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldText.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional] **ValidationType** | **string** | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | [optional] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | **IsMultiline** | **bool** | Whether this form field is multiline text. | **OriginalFontSize** | **int** | Original font size used in this form field's text. | **FontFamily** | **string** | Font family used in this form field's text. | **ValidationType** | **string** | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentStaticFieldBase.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldBase.md index b147460c8..368bc5d06 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldBase.md @@ -5,7 +5,7 @@ An array describing static overlay fields. **NOTE:** Only available for certain Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | | **ApiId** | **string** | A unique id for the static field. | [optional] **Name** | **string** | The name of the static field. | [optional] **Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"]**X** | **int** | The horizontal offset in pixels for this static field. | [optional] **Y** | **int** | The vertical offset in pixels for this static field. | [optional] **Width** | **int** | The width in pixels of this static field. | [optional] **Height** | **int** | The height in pixels of this static field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] +**ApiId** | **string** | A unique id for the static field. | **Name** | **string** | The name of the static field. | **Type** | **string** | | **Signer** | **string** | The signer of the Static Field. | [default to "me_now"]**X** | **int** | The horizontal offset in pixels for this static field. | **Y** | **int** | The vertical offset in pixels for this static field. | **Width** | **int** | The width in pixels of this static field. | **Height** | **int** | The height in pixels of this static field. | **Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [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/TemplateResponseDocumentStaticFieldCheckbox.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldCheckbox.md index cfa9ccb8c..b70eab4c5 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldCheckbox.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldCheckbox.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "checkbox"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md index bae7b8ab4..935ac5748 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "date_signed"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md index 7815923f9..327d1ccb1 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "dropdown"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md index 81b419793..f2a3de8a4 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "hyperlink"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md index a9dae476b..0cc875be7 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "initials"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md index a13dc60d2..e73fa66a8 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "radio"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md index 7d2481d97..6900f646f 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "signature"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md index b44f3f3e4..8ec627f04 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "text"] diff --git a/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md b/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md index a2773f068..58559eab7 100644 --- a/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md @@ -5,7 +5,7 @@ Average text length in this field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**NumLines** | **int** | Number of lines. | [optional] **NumCharsPerLine** | **int** | Number of characters per line. | [optional] +**NumLines** | **int** | Number of lines. | **NumCharsPerLine** | **int** | Number of characters per line. | [[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/TemplateResponseSignerRole.md b/sdks/dotnet/docs/TemplateResponseSignerRole.md index ddead2a48..8a1fe3d5e 100644 --- a/sdks/dotnet/docs/TemplateResponseSignerRole.md +++ b/sdks/dotnet/docs/TemplateResponseSignerRole.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the Role. | [optional] **Order** | **int** | If signer order is assigned this is the 0-based index for this role. | [optional] +**Name** | **string** | The name of the Role. | **Order** | **int** | If signer order is assigned this is the 0-based index for this role. | [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/TemplateUpdateFilesResponseTemplate.md b/sdks/dotnet/docs/TemplateUpdateFilesResponseTemplate.md index 390961e68..c057d7d3a 100644 --- a/sdks/dotnet/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/dotnet/docs/TemplateUpdateFilesResponseTemplate.md @@ -5,7 +5,7 @@ Contains template id Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**TemplateId** | **string** | The id of the Template. | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs index fb8ca4762..db713a0e3 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs @@ -41,14 +41,24 @@ protected TemplateCreateEmbeddedDraftResponseTemplate() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template.. - /// Link to edit the template.. - /// When the link expires.. + /// The id of the Template. (required). + /// Link to edit the template. (required). + /// When the link expires. (required). /// A list of warnings.. public TemplateCreateEmbeddedDraftResponseTemplate(string templateId = default(string), string editUrl = default(string), int expiresAt = default(int), List warnings = default(List)) { + // to ensure "templateId" is required (not null) + if (templateId == null) + { + throw new ArgumentNullException("templateId is a required property for TemplateCreateEmbeddedDraftResponseTemplate and cannot be null"); + } this.TemplateId = templateId; + // to ensure "editUrl" is required (not null) + if (editUrl == null) + { + throw new ArgumentNullException("editUrl is a required property for TemplateCreateEmbeddedDraftResponseTemplate and cannot be null"); + } this.EditUrl = editUrl; this.ExpiresAt = expiresAt; this.Warnings = warnings; @@ -74,21 +84,21 @@ public static TemplateCreateEmbeddedDraftResponseTemplate Init(string jsonData) /// The id of the Template. /// /// The id of the Template. - [DataMember(Name = "template_id", EmitDefaultValue = true)] + [DataMember(Name = "template_id", IsRequired = true, EmitDefaultValue = true)] public string TemplateId { get; set; } /// /// Link to edit the template. /// /// Link to edit the template. - [DataMember(Name = "edit_url", EmitDefaultValue = true)] + [DataMember(Name = "edit_url", IsRequired = true, EmitDefaultValue = true)] public string EditUrl { get; set; } /// /// When the link expires. /// /// When the link expires. - [DataMember(Name = "expires_at", EmitDefaultValue = true)] + [DataMember(Name = "expires_at", IsRequired = true, EmitDefaultValue = true)] public int ExpiresAt { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs index 1c362dd91..1ad97711a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs @@ -41,10 +41,15 @@ protected TemplateCreateResponseTemplate() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template.. + /// The id of the Template. (required). public TemplateCreateResponseTemplate(string templateId = default(string)) { + // to ensure "templateId" is required (not null) + if (templateId == null) + { + throw new ArgumentNullException("templateId is a required property for TemplateCreateResponseTemplate and cannot be null"); + } this.TemplateId = templateId; } @@ -68,7 +73,7 @@ public static TemplateCreateResponseTemplate Init(string jsonData) /// The id of the Template. /// /// The id of the Template. - [DataMember(Name = "template_id", EmitDefaultValue = true)] + [DataMember(Name = "template_id", IsRequired = true, EmitDefaultValue = true)] public string TemplateId { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs index 6ec3587f8..9a96d947e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs @@ -41,39 +41,86 @@ protected TemplateResponse() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template.. - /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.. - /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.. + /// The id of the Template. (required). + /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. (required). + /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. (required). /// Time the template was last updated.. - /// `true` if this template was created using an embedded flow, `false` if it was created on our website.. - /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member.. - /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).. - /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.. - /// The metadata attached to the template.. - /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.. - /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.. - /// An array describing each document associated with this Template. Includes form field data for each document.. + /// `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.. + /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member. (required). + /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). (required). + /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. (required). + /// The metadata attached to the template. (required). + /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. (required). + /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. (required). + /// An array describing each document associated with this Template. Includes form field data for each document. (required). /// Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.. /// Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.. - /// An array of the Accounts that can use this Template.. - public TemplateResponse(string templateId = default(string), string title = default(string), string message = default(string), int updatedAt = default(int), bool? isEmbedded = default(bool?), bool? isCreator = default(bool?), bool? canEdit = default(bool?), bool? isLocked = default(bool?), Object metadata = default(Object), List signerRoles = default(List), List ccRoles = default(List), List documents = default(List), List customFields = default(List), List namedFormFields = default(List), List accounts = default(List)) + /// An array of the Accounts that can use this Template. (required). + /// Signer attachments. (required). + public TemplateResponse(string templateId = default(string), string title = default(string), string message = default(string), int updatedAt = default(int), bool? isEmbedded = default(bool?), bool isCreator = default(bool), bool canEdit = default(bool), bool isLocked = default(bool), Object metadata = default(Object), List signerRoles = default(List), List ccRoles = default(List), List documents = default(List), List customFields = default(List), List namedFormFields = default(List), List accounts = default(List), List attachments = default(List)) { + // to ensure "templateId" is required (not null) + if (templateId == null) + { + throw new ArgumentNullException("templateId is a required property for TemplateResponse and cannot be null"); + } this.TemplateId = templateId; + // to ensure "title" is required (not null) + if (title == null) + { + throw new ArgumentNullException("title is a required property for TemplateResponse and cannot be null"); + } this.Title = title; + // to ensure "message" is required (not null) + if (message == null) + { + throw new ArgumentNullException("message is a required property for TemplateResponse and cannot be null"); + } this.Message = message; - this.UpdatedAt = updatedAt; - this.IsEmbedded = isEmbedded; this.IsCreator = isCreator; this.CanEdit = canEdit; this.IsLocked = isLocked; + // to ensure "metadata" is required (not null) + if (metadata == null) + { + throw new ArgumentNullException("metadata is a required property for TemplateResponse and cannot be null"); + } this.Metadata = metadata; + // to ensure "signerRoles" is required (not null) + if (signerRoles == null) + { + throw new ArgumentNullException("signerRoles is a required property for TemplateResponse and cannot be null"); + } this.SignerRoles = signerRoles; + // to ensure "ccRoles" is required (not null) + if (ccRoles == null) + { + throw new ArgumentNullException("ccRoles is a required property for TemplateResponse and cannot be null"); + } this.CcRoles = ccRoles; + // to ensure "documents" is required (not null) + if (documents == null) + { + throw new ArgumentNullException("documents is a required property for TemplateResponse and cannot be null"); + } this.Documents = documents; + // to ensure "accounts" is required (not null) + if (accounts == null) + { + throw new ArgumentNullException("accounts is a required property for TemplateResponse and cannot be null"); + } + this.Accounts = accounts; + // to ensure "attachments" is required (not null) + if (attachments == null) + { + throw new ArgumentNullException("attachments is a required property for TemplateResponse and cannot be null"); + } + this.Attachments = attachments; + this.UpdatedAt = updatedAt; + this.IsEmbedded = isEmbedded; this.CustomFields = customFields; this.NamedFormFields = namedFormFields; - this.Accounts = accounts; } /// @@ -96,86 +143,100 @@ public static TemplateResponse Init(string jsonData) /// The id of the Template. /// /// The id of the Template. - [DataMember(Name = "template_id", EmitDefaultValue = true)] + [DataMember(Name = "template_id", IsRequired = true, EmitDefaultValue = true)] public string TemplateId { get; set; } /// /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. /// /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. - [DataMember(Name = "title", EmitDefaultValue = true)] + [DataMember(Name = "title", IsRequired = true, EmitDefaultValue = true)] public string Title { get; set; } /// /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. /// /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. - [DataMember(Name = "message", EmitDefaultValue = true)] + [DataMember(Name = "message", IsRequired = true, EmitDefaultValue = true)] public string Message { get; set; } - /// - /// Time the template was last updated. - /// - /// Time the template was last updated. - [DataMember(Name = "updated_at", EmitDefaultValue = true)] - public int UpdatedAt { get; set; } - - /// - /// `true` if this template was created using an embedded flow, `false` if it was created on our website. - /// - /// `true` if this template was created using an embedded flow, `false` if it was created on our website. - [DataMember(Name = "is_embedded", EmitDefaultValue = true)] - public bool? IsEmbedded { get; set; } - /// /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member. /// /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member. - [DataMember(Name = "is_creator", EmitDefaultValue = true)] - public bool? IsCreator { get; set; } + [DataMember(Name = "is_creator", IsRequired = true, EmitDefaultValue = true)] + public bool IsCreator { get; set; } /// /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). /// /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). - [DataMember(Name = "can_edit", EmitDefaultValue = true)] - public bool? CanEdit { get; set; } + [DataMember(Name = "can_edit", IsRequired = true, EmitDefaultValue = true)] + public bool CanEdit { get; set; } /// /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. /// /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. - [DataMember(Name = "is_locked", EmitDefaultValue = true)] - public bool? IsLocked { get; set; } + [DataMember(Name = "is_locked", IsRequired = true, EmitDefaultValue = true)] + public bool IsLocked { get; set; } /// /// The metadata attached to the template. /// /// The metadata attached to the template. - [DataMember(Name = "metadata", EmitDefaultValue = true)] + [DataMember(Name = "metadata", IsRequired = true, EmitDefaultValue = true)] public Object Metadata { get; set; } /// /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. /// /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. - [DataMember(Name = "signer_roles", EmitDefaultValue = true)] + [DataMember(Name = "signer_roles", IsRequired = true, EmitDefaultValue = true)] public List SignerRoles { get; set; } /// /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. /// /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. - [DataMember(Name = "cc_roles", EmitDefaultValue = true)] + [DataMember(Name = "cc_roles", IsRequired = true, EmitDefaultValue = true)] public List CcRoles { get; set; } /// /// An array describing each document associated with this Template. Includes form field data for each document. /// /// An array describing each document associated with this Template. Includes form field data for each document. - [DataMember(Name = "documents", EmitDefaultValue = true)] + [DataMember(Name = "documents", IsRequired = true, EmitDefaultValue = true)] public List Documents { get; set; } + /// + /// An array of the Accounts that can use this Template. + /// + /// An array of the Accounts that can use this Template. + [DataMember(Name = "accounts", IsRequired = true, EmitDefaultValue = true)] + public List Accounts { get; set; } + + /// + /// Signer attachments. + /// + /// Signer attachments. + [DataMember(Name = "attachments", IsRequired = true, EmitDefaultValue = true)] + public List Attachments { get; set; } + + /// + /// Time the template was last updated. + /// + /// Time the template was last updated. + [DataMember(Name = "updated_at", EmitDefaultValue = true)] + public int UpdatedAt { get; set; } + + /// + /// `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + /// + /// `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + [DataMember(Name = "is_embedded", EmitDefaultValue = true)] + public bool? IsEmbedded { get; set; } + /// /// Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. /// @@ -192,13 +253,6 @@ public static TemplateResponse Init(string jsonData) [Obsolete] public List NamedFormFields { get; set; } - /// - /// An array of the Accounts that can use this Template. - /// - /// An array of the Accounts that can use this Template. - [DataMember(Name = "accounts", EmitDefaultValue = true)] - public List Accounts { get; set; } - /// /// Returns the string presentation of the object /// @@ -210,8 +264,6 @@ public override string ToString() sb.Append(" TemplateId: ").Append(TemplateId).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" Message: ").Append(Message).Append("\n"); - sb.Append(" UpdatedAt: ").Append(UpdatedAt).Append("\n"); - sb.Append(" IsEmbedded: ").Append(IsEmbedded).Append("\n"); sb.Append(" IsCreator: ").Append(IsCreator).Append("\n"); sb.Append(" CanEdit: ").Append(CanEdit).Append("\n"); sb.Append(" IsLocked: ").Append(IsLocked).Append("\n"); @@ -219,9 +271,12 @@ public override string ToString() sb.Append(" SignerRoles: ").Append(SignerRoles).Append("\n"); sb.Append(" CcRoles: ").Append(CcRoles).Append("\n"); sb.Append(" Documents: ").Append(Documents).Append("\n"); + sb.Append(" Accounts: ").Append(Accounts).Append("\n"); + sb.Append(" Attachments: ").Append(Attachments).Append("\n"); + sb.Append(" UpdatedAt: ").Append(UpdatedAt).Append("\n"); + sb.Append(" IsEmbedded: ").Append(IsEmbedded).Append("\n"); sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); sb.Append(" NamedFormFields: ").Append(NamedFormFields).Append("\n"); - sb.Append(" Accounts: ").Append(Accounts).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -272,29 +327,17 @@ public bool Equals(TemplateResponse input) (this.Message != null && this.Message.Equals(input.Message)) ) && - ( - this.UpdatedAt == input.UpdatedAt || - this.UpdatedAt.Equals(input.UpdatedAt) - ) && - ( - this.IsEmbedded == input.IsEmbedded || - (this.IsEmbedded != null && - this.IsEmbedded.Equals(input.IsEmbedded)) - ) && ( this.IsCreator == input.IsCreator || - (this.IsCreator != null && - this.IsCreator.Equals(input.IsCreator)) + this.IsCreator.Equals(input.IsCreator) ) && ( this.CanEdit == input.CanEdit || - (this.CanEdit != null && - this.CanEdit.Equals(input.CanEdit)) + this.CanEdit.Equals(input.CanEdit) ) && ( this.IsLocked == input.IsLocked || - (this.IsLocked != null && - this.IsLocked.Equals(input.IsLocked)) + this.IsLocked.Equals(input.IsLocked) ) && ( this.Metadata == input.Metadata || @@ -319,6 +362,27 @@ public bool Equals(TemplateResponse input) input.Documents != null && this.Documents.SequenceEqual(input.Documents) ) && + ( + this.Accounts == input.Accounts || + this.Accounts != null && + input.Accounts != null && + this.Accounts.SequenceEqual(input.Accounts) + ) && + ( + this.Attachments == input.Attachments || + this.Attachments != null && + input.Attachments != null && + this.Attachments.SequenceEqual(input.Attachments) + ) && + ( + this.UpdatedAt == input.UpdatedAt || + this.UpdatedAt.Equals(input.UpdatedAt) + ) && + ( + this.IsEmbedded == input.IsEmbedded || + (this.IsEmbedded != null && + this.IsEmbedded.Equals(input.IsEmbedded)) + ) && ( this.CustomFields == input.CustomFields || this.CustomFields != null && @@ -330,12 +394,6 @@ public bool Equals(TemplateResponse input) this.NamedFormFields != null && input.NamedFormFields != null && this.NamedFormFields.SequenceEqual(input.NamedFormFields) - ) && - ( - this.Accounts == input.Accounts || - this.Accounts != null && - input.Accounts != null && - this.Accounts.SequenceEqual(input.Accounts) ); } @@ -360,23 +418,9 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Message.GetHashCode(); } - hashCode = (hashCode * 59) + this.UpdatedAt.GetHashCode(); - if (this.IsEmbedded != null) - { - hashCode = (hashCode * 59) + this.IsEmbedded.GetHashCode(); - } - if (this.IsCreator != null) - { - hashCode = (hashCode * 59) + this.IsCreator.GetHashCode(); - } - if (this.CanEdit != null) - { - hashCode = (hashCode * 59) + this.CanEdit.GetHashCode(); - } - if (this.IsLocked != null) - { - hashCode = (hashCode * 59) + this.IsLocked.GetHashCode(); - } + hashCode = (hashCode * 59) + this.IsCreator.GetHashCode(); + hashCode = (hashCode * 59) + this.CanEdit.GetHashCode(); + hashCode = (hashCode * 59) + this.IsLocked.GetHashCode(); if (this.Metadata != null) { hashCode = (hashCode * 59) + this.Metadata.GetHashCode(); @@ -393,6 +437,19 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Documents.GetHashCode(); } + if (this.Accounts != null) + { + hashCode = (hashCode * 59) + this.Accounts.GetHashCode(); + } + if (this.Attachments != null) + { + hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); + } + hashCode = (hashCode * 59) + this.UpdatedAt.GetHashCode(); + if (this.IsEmbedded != null) + { + hashCode = (hashCode * 59) + this.IsEmbedded.GetHashCode(); + } if (this.CustomFields != null) { hashCode = (hashCode * 59) + this.CustomFields.GetHashCode(); @@ -401,10 +458,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.NamedFormFields.GetHashCode(); } - if (this.Accounts != null) - { - hashCode = (hashCode * 59) + this.Accounts.GetHashCode(); - } return hashCode; } } @@ -443,38 +496,24 @@ public List GetOpenApiTypes() Value = Message, }); types.Add(new OpenApiType() - { - Name = "updated_at", - Property = "UpdatedAt", - Type = "int", - Value = UpdatedAt, - }); - types.Add(new OpenApiType() - { - Name = "is_embedded", - Property = "IsEmbedded", - Type = "bool?", - Value = IsEmbedded, - }); - types.Add(new OpenApiType() { Name = "is_creator", Property = "IsCreator", - Type = "bool?", + Type = "bool", Value = IsCreator, }); types.Add(new OpenApiType() { Name = "can_edit", Property = "CanEdit", - Type = "bool?", + Type = "bool", Value = CanEdit, }); types.Add(new OpenApiType() { Name = "is_locked", Property = "IsLocked", - Type = "bool?", + Type = "bool", Value = IsLocked, }); types.Add(new OpenApiType() @@ -506,6 +545,34 @@ public List GetOpenApiTypes() Value = Documents, }); types.Add(new OpenApiType() + { + Name = "accounts", + Property = "Accounts", + Type = "List", + Value = Accounts, + }); + types.Add(new OpenApiType() + { + Name = "attachments", + Property = "Attachments", + Type = "List", + Value = Attachments, + }); + types.Add(new OpenApiType() + { + Name = "updated_at", + Property = "UpdatedAt", + Type = "int", + Value = UpdatedAt, + }); + types.Add(new OpenApiType() + { + Name = "is_embedded", + Property = "IsEmbedded", + Type = "bool?", + Value = IsEmbedded, + }); + types.Add(new OpenApiType() { Name = "custom_fields", Property = "CustomFields", @@ -519,13 +586,6 @@ public List GetOpenApiTypes() Type = "List", Value = NamedFormFields, }); - types.Add(new OpenApiType() - { - Name = "accounts", - Property = "Accounts", - Type = "List", - Value = Accounts, - }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs index 0a40c5548..ef4030d8f 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs @@ -41,21 +41,31 @@ protected TemplateResponseAccount() { } /// /// 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). public TemplateResponseAccount(string accountId = default(string), string emailAddress = default(string), bool isLocked = default(bool), bool isPaidHs = default(bool), bool isPaidHf = default(bool), TemplateResponseAccountQuota quotas = default(TemplateResponseAccountQuota)) { + // to ensure "accountId" is required (not null) + if (accountId == null) + { + throw new ArgumentNullException("accountId is a required property for TemplateResponseAccount 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 TemplateResponseAccount and cannot be null"); + } this.Quotas = quotas; + this.EmailAddress = emailAddress; } /// @@ -78,43 +88,43 @@ public static TemplateResponseAccount 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 TemplateResponseAccountQuota 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; } + /// /// Returns the string presentation of the object /// @@ -124,11 +134,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseAccount {\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("}\n"); return sb.ToString(); } @@ -169,11 +179,6 @@ public bool Equals(TemplateResponseAccount 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) @@ -190,6 +195,11 @@ public bool Equals(TemplateResponseAccount input) this.Quotas == input.Quotas || (this.Quotas != null && this.Quotas.Equals(input.Quotas)) + ) && + ( + this.EmailAddress == input.EmailAddress || + (this.EmailAddress != null && + this.EmailAddress.Equals(input.EmailAddress)) ); } @@ -206,10 +216,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(); @@ -217,6 +223,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Quotas.GetHashCode(); } + if (this.EmailAddress != null) + { + hashCode = (hashCode * 59) + this.EmailAddress.GetHashCode(); + } return hashCode; } } @@ -241,13 +251,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", @@ -275,6 +278,13 @@ public List GetOpenApiTypes() Type = "TemplateResponseAccountQuota", Value = Quotas, }); + types.Add(new OpenApiType() + { + Name = "email_address", + Property = "EmailAddress", + Type = "string", + Value = EmailAddress, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs index 5a67d889c..cc5c7177a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs @@ -41,10 +41,10 @@ protected TemplateResponseAccountQuota() { } /// /// Initializes a new instance of the class. /// - /// API templates remaining.. - /// API signature requests remaining.. - /// Signature requests remaining.. - /// SMS verifications remaining.. + /// API templates remaining. (required). + /// API signature requests remaining. (required). + /// Signature requests remaining. (required). + /// SMS verifications remaining. (required). public TemplateResponseAccountQuota(int templatesLeft = default(int), int apiSignatureRequestsLeft = default(int), int documentsLeft = default(int), int smsVerificationsLeft = default(int)) { @@ -74,28 +74,28 @@ public static TemplateResponseAccountQuota Init(string jsonData) /// API templates remaining. /// /// API templates remaining. - [DataMember(Name = "templates_left", EmitDefaultValue = true)] + [DataMember(Name = "templates_left", IsRequired = true, EmitDefaultValue = true)] public int TemplatesLeft { get; set; } /// /// API signature requests remaining. /// /// API signature requests remaining. - [DataMember(Name = "api_signature_requests_left", EmitDefaultValue = true)] + [DataMember(Name = "api_signature_requests_left", IsRequired = true, EmitDefaultValue = true)] public int ApiSignatureRequestsLeft { get; set; } /// /// Signature requests remaining. /// /// Signature requests remaining. - [DataMember(Name = "documents_left", EmitDefaultValue = true)] + [DataMember(Name = "documents_left", IsRequired = true, EmitDefaultValue = true)] public int DocumentsLeft { get; set; } /// /// SMS verifications remaining. /// /// SMS verifications remaining. - [DataMember(Name = "sms_verifications_left", EmitDefaultValue = true)] + [DataMember(Name = "sms_verifications_left", IsRequired = true, EmitDefaultValue = true)] public int SmsVerificationsLeft { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs index e153a6836..444000308 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs @@ -41,10 +41,15 @@ protected TemplateResponseCCRole() { } /// /// Initializes a new instance of the class. /// - /// The name of the Role.. + /// The name of the Role. (required). public TemplateResponseCCRole(string name = default(string)) { + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TemplateResponseCCRole and cannot be null"); + } this.Name = name; } @@ -68,7 +73,7 @@ public static TemplateResponseCCRole Init(string jsonData) /// The name of the Role. /// /// The name of the Role. - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs index 461b2f2fa..8a1b856c7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs @@ -41,21 +41,46 @@ protected TemplateResponseDocument() { } /// /// Initializes a new instance of the class. /// - /// Name of the associated file.. + /// Name of the associated file. (required). /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing).. - /// An array of Form Field Group objects.. - /// An array of Form Field objects containing the name and type of each named field.. - /// An array of Form Field objects containing the name and type of each named field.. - /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.. + /// An array of Form Field Group objects. (required). + /// An array of Form Field objects containing the name and type of each named field. (required). + /// An array of Form Field objects containing the name and type of each named field. (required). + /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. (required). public TemplateResponseDocument(string name = default(string), int index = default(int), List fieldGroups = default(List), List formFields = default(List), List customFields = default(List), List staticFields = default(List)) { + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TemplateResponseDocument and cannot be null"); + } this.Name = name; - this.Index = index; + // to ensure "fieldGroups" is required (not null) + if (fieldGroups == null) + { + throw new ArgumentNullException("fieldGroups is a required property for TemplateResponseDocument and cannot be null"); + } this.FieldGroups = fieldGroups; + // to ensure "formFields" is required (not null) + if (formFields == null) + { + throw new ArgumentNullException("formFields is a required property for TemplateResponseDocument and cannot be null"); + } this.FormFields = formFields; + // to ensure "customFields" is required (not null) + if (customFields == null) + { + throw new ArgumentNullException("customFields is a required property for TemplateResponseDocument and cannot be null"); + } this.CustomFields = customFields; + // to ensure "staticFields" is required (not null) + if (staticFields == null) + { + throw new ArgumentNullException("staticFields is a required property for TemplateResponseDocument and cannot be null"); + } this.StaticFields = staticFields; + this.Index = index; } /// @@ -78,44 +103,44 @@ public static TemplateResponseDocument Init(string jsonData) /// Name of the associated file. /// /// Name of the associated file. - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } - /// - /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - /// - /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - [DataMember(Name = "index", EmitDefaultValue = true)] - public int Index { get; set; } - /// /// An array of Form Field Group objects. /// /// An array of Form Field Group objects. - [DataMember(Name = "field_groups", EmitDefaultValue = true)] + [DataMember(Name = "field_groups", IsRequired = true, EmitDefaultValue = true)] public List FieldGroups { get; set; } /// /// An array of Form Field objects containing the name and type of each named field. /// /// An array of Form Field objects containing the name and type of each named field. - [DataMember(Name = "form_fields", EmitDefaultValue = true)] + [DataMember(Name = "form_fields", IsRequired = true, EmitDefaultValue = true)] public List FormFields { get; set; } /// /// An array of Form Field objects containing the name and type of each named field. /// /// An array of Form Field objects containing the name and type of each named field. - [DataMember(Name = "custom_fields", EmitDefaultValue = true)] + [DataMember(Name = "custom_fields", IsRequired = true, EmitDefaultValue = true)] public List CustomFields { get; set; } /// /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. /// /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. - [DataMember(Name = "static_fields", EmitDefaultValue = true)] + [DataMember(Name = "static_fields", IsRequired = true, EmitDefaultValue = true)] public List StaticFields { get; set; } + /// + /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + /// + /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + [DataMember(Name = "index", EmitDefaultValue = true)] + public int Index { get; set; } + /// /// Returns the string presentation of the object /// @@ -125,11 +150,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseDocument {\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Index: ").Append(Index).Append("\n"); sb.Append(" FieldGroups: ").Append(FieldGroups).Append("\n"); sb.Append(" FormFields: ").Append(FormFields).Append("\n"); sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); sb.Append(" StaticFields: ").Append(StaticFields).Append("\n"); + sb.Append(" Index: ").Append(Index).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -170,10 +195,6 @@ public bool Equals(TemplateResponseDocument input) (this.Name != null && this.Name.Equals(input.Name)) ) && - ( - this.Index == input.Index || - this.Index.Equals(input.Index) - ) && ( this.FieldGroups == input.FieldGroups || this.FieldGroups != null && @@ -197,6 +218,10 @@ public bool Equals(TemplateResponseDocument input) this.StaticFields != null && input.StaticFields != null && this.StaticFields.SequenceEqual(input.StaticFields) + ) && + ( + this.Index == input.Index || + this.Index.Equals(input.Index) ); } @@ -213,7 +238,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Name.GetHashCode(); } - hashCode = (hashCode * 59) + this.Index.GetHashCode(); if (this.FieldGroups != null) { hashCode = (hashCode * 59) + this.FieldGroups.GetHashCode(); @@ -230,6 +254,7 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.StaticFields.GetHashCode(); } + hashCode = (hashCode * 59) + this.Index.GetHashCode(); return hashCode; } } @@ -254,13 +279,6 @@ public List GetOpenApiTypes() Value = Name, }); types.Add(new OpenApiType() - { - Name = "index", - Property = "Index", - Type = "int", - Value = Index, - }); - types.Add(new OpenApiType() { Name = "field_groups", Property = "FieldGroups", @@ -288,6 +306,13 @@ public List GetOpenApiTypes() Type = "List", Value = StaticFields, }); + types.Add(new OpenApiType() + { + Name = "index", + Property = "Index", + Type = "int", + Value = Index, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs index de66ae6db..2e6953d02 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs @@ -45,33 +45,43 @@ protected TemplateResponseDocumentCustomFieldBase() { } /// /// Initializes a new instance of the class. /// - /// The unique ID for this field.. - /// The name of the Custom Field.. + /// The unique ID for this field. (required). + /// The name of the Custom Field. (required). /// type (required). /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentCustomFieldBase(string apiId = default(string), string name = default(string), string type = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { + // to ensure "apiId" is required (not null) + if (apiId == null) + { + throw new ArgumentNullException("apiId is a required property for TemplateResponseDocumentCustomFieldBase and cannot be null"); + } + this.ApiId = apiId; + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TemplateResponseDocumentCustomFieldBase and cannot be null"); + } + this.Name = name; // to ensure "type" is required (not null) if (type == null) { throw new ArgumentNullException("type is a required property for TemplateResponseDocumentCustomFieldBase and cannot be null"); } this.Type = type; - this.ApiId = apiId; - this.Name = name; - this.Signer = Convert.ToString(signer); this.X = x; this.Y = y; this.Width = width; this.Height = height; this.Required = required; + this.Signer = Convert.ToString(signer); this.Group = group; } @@ -91,73 +101,73 @@ public static TemplateResponseDocumentCustomFieldBase Init(string jsonData) return obj; } - /// - /// Gets or Sets Type - /// - [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] - public string Type { get; set; } - /// /// The unique ID for this field. /// /// The unique ID for this field. - [DataMember(Name = "api_id", EmitDefaultValue = true)] + [DataMember(Name = "api_id", IsRequired = true, EmitDefaultValue = true)] public string ApiId { get; set; } /// /// The name of the Custom Field. /// /// The name of the Custom Field. - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// - /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + /// Gets or Sets Type /// - /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). - [DataMember(Name = "signer", EmitDefaultValue = true)] - public object Signer - { - get => this._signer; - set => this._signer = Convert.ToString(value); - } + [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] + public string Type { get; set; } - private string _signer; /// /// The horizontal offset in pixels for this form field. /// /// The horizontal offset in pixels for this form field. - [DataMember(Name = "x", EmitDefaultValue = true)] + [DataMember(Name = "x", IsRequired = true, EmitDefaultValue = true)] public int X { get; set; } /// /// The vertical offset in pixels for this form field. /// /// The vertical offset in pixels for this form field. - [DataMember(Name = "y", EmitDefaultValue = true)] + [DataMember(Name = "y", IsRequired = true, EmitDefaultValue = true)] public int Y { get; set; } /// /// The width in pixels of this form field. /// /// The width in pixels of this form field. - [DataMember(Name = "width", EmitDefaultValue = true)] + [DataMember(Name = "width", IsRequired = true, EmitDefaultValue = true)] public int Width { get; set; } /// /// The height in pixels of this form field. /// /// The height in pixels of this form field. - [DataMember(Name = "height", EmitDefaultValue = true)] + [DataMember(Name = "height", IsRequired = true, EmitDefaultValue = true)] public int Height { get; set; } /// /// Boolean showing whether or not this field is required. /// /// Boolean showing whether or not this field is required. - [DataMember(Name = "required", EmitDefaultValue = true)] + [DataMember(Name = "required", IsRequired = true, EmitDefaultValue = true)] public bool Required { get; set; } + /// + /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + /// + /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + [DataMember(Name = "signer", EmitDefaultValue = true)] + public object Signer + { + get => this._signer; + set => this._signer = Convert.ToString(value); + } + + private string _signer; /// /// The name of the group this field is in. If this field is not a group, this defaults to `null`. /// @@ -173,15 +183,15 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseDocumentCustomFieldBase {\n"); - sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" ApiId: ").Append(ApiId).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Signer: ").Append(Signer).Append("\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" X: ").Append(X).Append("\n"); sb.Append(" Y: ").Append(Y).Append("\n"); sb.Append(" Width: ").Append(Width).Append("\n"); sb.Append(" Height: ").Append(Height).Append("\n"); sb.Append(" Required: ").Append(Required).Append("\n"); + sb.Append(" Signer: ").Append(Signer).Append("\n"); sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); @@ -218,11 +228,6 @@ public bool Equals(TemplateResponseDocumentCustomFieldBase input) return false; } return - ( - this.Type == input.Type || - (this.Type != null && - this.Type.Equals(input.Type)) - ) && ( this.ApiId == input.ApiId || (this.ApiId != null && @@ -234,9 +239,9 @@ public bool Equals(TemplateResponseDocumentCustomFieldBase input) this.Name.Equals(input.Name)) ) && ( - this.Signer == input.Signer || - (this.Signer != null && - this.Signer.Equals(input.Signer)) + this.Type == input.Type || + (this.Type != null && + this.Type.Equals(input.Type)) ) && ( this.X == input.X || @@ -258,6 +263,11 @@ public bool Equals(TemplateResponseDocumentCustomFieldBase input) this.Required == input.Required || this.Required.Equals(input.Required) ) && + ( + this.Signer == input.Signer || + (this.Signer != null && + this.Signer.Equals(input.Signer)) + ) && ( this.Group == input.Group || (this.Group != null && @@ -274,10 +284,6 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; - if (this.Type != null) - { - hashCode = (hashCode * 59) + this.Type.GetHashCode(); - } if (this.ApiId != null) { hashCode = (hashCode * 59) + this.ApiId.GetHashCode(); @@ -286,15 +292,19 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Name.GetHashCode(); } - if (this.Signer != null) + if (this.Type != null) { - hashCode = (hashCode * 59) + this.Signer.GetHashCode(); + hashCode = (hashCode * 59) + this.Type.GetHashCode(); } hashCode = (hashCode * 59) + this.X.GetHashCode(); hashCode = (hashCode * 59) + this.Y.GetHashCode(); hashCode = (hashCode * 59) + this.Width.GetHashCode(); hashCode = (hashCode * 59) + this.Height.GetHashCode(); hashCode = (hashCode * 59) + this.Required.GetHashCode(); + if (this.Signer != null) + { + hashCode = (hashCode * 59) + this.Signer.GetHashCode(); + } if (this.Group != null) { hashCode = (hashCode * 59) + this.Group.GetHashCode(); @@ -326,13 +336,6 @@ public List GetOpenApiTypes() { var types = new List(); types.Add(new OpenApiType() - { - Name = "type", - Property = "Type", - Type = "string", - Value = Type, - }); - types.Add(new OpenApiType() { Name = "api_id", Property = "ApiId", @@ -348,10 +351,10 @@ public List GetOpenApiTypes() }); types.Add(new OpenApiType() { - Name = "signer", - Property = "Signer", + Name = "type", + Property = "Type", Type = "string", - Value = Signer, + Value = Type, }); types.Add(new OpenApiType() { @@ -389,6 +392,13 @@ public List GetOpenApiTypes() Value = Required, }); types.Add(new OpenApiType() + { + Name = "signer", + Property = "Signer", + Type = "string", + Value = Signer, + }); + types.Add(new OpenApiType() { Name = "group", Property = "Group", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs index dde2bef21..7f0e4909d 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs @@ -42,25 +42,25 @@ protected TemplateResponseDocumentCustomFieldCheckbox() { } /// Initializes a new instance of the class. /// /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` (required) (default to "checkbox"). - /// The unique ID for this field.. - /// The name of the Custom Field.. + /// The unique ID for this field. (required). + /// The name of the Custom Field. (required). /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentCustomFieldCheckbox(string type = @"checkbox", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; this.Name = name; - this.Signer = Convert.ToString(signer); this.X = x; this.Y = y; this.Width = width; this.Height = height; this.Required = required; + this.Signer = Convert.ToString(signer); this.Group = group; // to ensure "type" is required (not null) diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs index 1e850816f..d7966950a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs @@ -42,29 +42,29 @@ protected TemplateResponseDocumentCustomFieldText() { } /// Initializes a new instance of the class. /// /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` (required) (default to "text"). - /// avgTextLength. - /// Whether this form field is multiline text.. - /// Original font size used in this form field's text.. - /// Font family used in this form field's text.. - /// The unique ID for this field.. - /// The name of the Custom Field.. + /// avgTextLength (required). + /// Whether this form field is multiline text. (required). + /// Original font size used in this form field's text. (required). + /// Font family used in this form field's text. (required). + /// The unique ID for this field. (required). + /// The name of the Custom Field. (required). /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentCustomFieldText(string type = @"text", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; this.Name = name; - this.Signer = Convert.ToString(signer); this.X = x; this.Y = y; this.Width = width; this.Height = height; this.Required = required; + this.Signer = Convert.ToString(signer); this.Group = group; // to ensure "type" is required (not null) @@ -73,9 +73,19 @@ protected TemplateResponseDocumentCustomFieldText() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentCustomFieldText and cannot be null"); } this.Type = type; + // to ensure "avgTextLength" is required (not null) + if (avgTextLength == null) + { + throw new ArgumentNullException("avgTextLength is a required property for TemplateResponseDocumentCustomFieldText and cannot be null"); + } this.AvgTextLength = avgTextLength; this.IsMultiline = isMultiline; this.OriginalFontSize = originalFontSize; + // to ensure "fontFamily" is required (not null) + if (fontFamily == null) + { + throw new ArgumentNullException("fontFamily is a required property for TemplateResponseDocumentCustomFieldText and cannot be null"); + } this.FontFamily = fontFamily; } @@ -105,28 +115,28 @@ public static TemplateResponseDocumentCustomFieldText Init(string jsonData) /// /// Gets or Sets AvgTextLength /// - [DataMember(Name = "avg_text_length", EmitDefaultValue = true)] + [DataMember(Name = "avg_text_length", IsRequired = true, EmitDefaultValue = true)] public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } /// /// Whether this form field is multiline text. /// /// Whether this form field is multiline text. - [DataMember(Name = "isMultiline", EmitDefaultValue = true)] + [DataMember(Name = "isMultiline", IsRequired = true, EmitDefaultValue = true)] public bool IsMultiline { get; set; } /// /// Original font size used in this form field's text. /// /// Original font size used in this form field's text. - [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] + [DataMember(Name = "originalFontSize", IsRequired = true, EmitDefaultValue = true)] public int OriginalFontSize { get; set; } /// /// Font family used in this form field's text. /// /// Font family used in this form field's text. - [DataMember(Name = "fontFamily", EmitDefaultValue = true)] + [DataMember(Name = "fontFamily", IsRequired = true, EmitDefaultValue = true)] public string FontFamily { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs index 019491e26..1e27c0f38 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs @@ -41,12 +41,22 @@ protected TemplateResponseDocumentFieldGroup() { } /// /// Initializes a new instance of the class. /// - /// The name of the form field group.. - /// rule. + /// The name of the form field group. (required). + /// rule (required). public TemplateResponseDocumentFieldGroup(string name = default(string), TemplateResponseDocumentFieldGroupRule rule = default(TemplateResponseDocumentFieldGroupRule)) { + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TemplateResponseDocumentFieldGroup and cannot be null"); + } this.Name = name; + // to ensure "rule" is required (not null) + if (rule == null) + { + throw new ArgumentNullException("rule is a required property for TemplateResponseDocumentFieldGroup and cannot be null"); + } this.Rule = rule; } @@ -70,13 +80,13 @@ public static TemplateResponseDocumentFieldGroup Init(string jsonData) /// The name of the form field group. /// /// The name of the form field group. - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// /// Gets or Sets Rule /// - [DataMember(Name = "rule", EmitDefaultValue = true)] + [DataMember(Name = "rule", IsRequired = true, EmitDefaultValue = true)] public TemplateResponseDocumentFieldGroupRule Rule { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs index ad19e0e20..8f690dccc 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs @@ -41,12 +41,22 @@ protected TemplateResponseDocumentFieldGroupRule() { } /// /// Initializes a new instance of the class. /// - /// Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group.. - /// Name of the group. + /// Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. (required). + /// Name of the group (required). public TemplateResponseDocumentFieldGroupRule(string requirement = default(string), string groupLabel = default(string)) { + // to ensure "requirement" is required (not null) + if (requirement == null) + { + throw new ArgumentNullException("requirement is a required property for TemplateResponseDocumentFieldGroupRule and cannot be null"); + } this.Requirement = requirement; + // to ensure "groupLabel" is required (not null) + if (groupLabel == null) + { + throw new ArgumentNullException("groupLabel is a required property for TemplateResponseDocumentFieldGroupRule and cannot be null"); + } this.GroupLabel = groupLabel; } @@ -70,14 +80,14 @@ public static TemplateResponseDocumentFieldGroupRule Init(string jsonData) /// Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. /// /// Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. - [DataMember(Name = "requirement", EmitDefaultValue = true)] + [DataMember(Name = "requirement", IsRequired = true, EmitDefaultValue = true)] public string Requirement { get; set; } /// /// Name of the group /// /// Name of the group - [DataMember(Name = "groupLabel", EmitDefaultValue = true)] + [DataMember(Name = "groupLabel", IsRequired = true, EmitDefaultValue = true)] public string GroupLabel { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs index 45f1eefac..4e55daa18 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs @@ -51,34 +51,47 @@ protected TemplateResponseDocumentFormFieldBase() { } /// /// Initializes a new instance of the class. /// - /// A unique id for the form field.. - /// The name of the form field.. + /// A unique id for the form field. (required). + /// The name of the form field. (required). /// type (required). - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldBase(string apiId = default(string), string name = default(string), string type = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldBase(string apiId = default(string), string name = default(string), string type = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { + // to ensure "apiId" is required (not null) + if (apiId == null) + { + throw new ArgumentNullException("apiId is a required property for TemplateResponseDocumentFormFieldBase and cannot be null"); + } + this.ApiId = apiId; + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TemplateResponseDocumentFormFieldBase and cannot be null"); + } + this.Name = name; // to ensure "type" is required (not null) if (type == null) { throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldBase and cannot be null"); } this.Type = type; - this.ApiId = apiId; - this.Name = name; + // to ensure "signer" is required (not null) + if (signer == null) + { + throw new ArgumentNullException("signer is a required property for TemplateResponseDocumentFormFieldBase and cannot be null"); + } this.Signer = Convert.ToString(signer); this.X = x; this.Y = y; this.Width = width; this.Height = height; this.Required = required; - this.Group = group; } /// @@ -97,31 +110,31 @@ public static TemplateResponseDocumentFormFieldBase Init(string jsonData) return obj; } - /// - /// Gets or Sets Type - /// - [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] - public string Type { get; set; } - /// /// A unique id for the form field. /// /// A unique id for the form field. - [DataMember(Name = "api_id", EmitDefaultValue = true)] + [DataMember(Name = "api_id", IsRequired = true, EmitDefaultValue = true)] public string ApiId { get; set; } /// /// The name of the form field. /// /// The name of the form field. - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } + /// + /// Gets or Sets Type + /// + [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] + public string Type { get; set; } + /// /// The signer of the Form Field. /// /// The signer of the Form Field. - [DataMember(Name = "signer", EmitDefaultValue = true)] + [DataMember(Name = "signer", IsRequired = true, EmitDefaultValue = true)] public object Signer { get => this._signer; @@ -133,44 +146,37 @@ public object Signer /// The horizontal offset in pixels for this form field. /// /// The horizontal offset in pixels for this form field. - [DataMember(Name = "x", EmitDefaultValue = true)] + [DataMember(Name = "x", IsRequired = true, EmitDefaultValue = true)] public int X { get; set; } /// /// The vertical offset in pixels for this form field. /// /// The vertical offset in pixels for this form field. - [DataMember(Name = "y", EmitDefaultValue = true)] + [DataMember(Name = "y", IsRequired = true, EmitDefaultValue = true)] public int Y { get; set; } /// /// The width in pixels of this form field. /// /// The width in pixels of this form field. - [DataMember(Name = "width", EmitDefaultValue = true)] + [DataMember(Name = "width", IsRequired = true, EmitDefaultValue = true)] public int Width { get; set; } /// /// The height in pixels of this form field. /// /// The height in pixels of this form field. - [DataMember(Name = "height", EmitDefaultValue = true)] + [DataMember(Name = "height", IsRequired = true, EmitDefaultValue = true)] public int Height { get; set; } /// /// Boolean showing whether or not this field is required. /// /// Boolean showing whether or not this field is required. - [DataMember(Name = "required", EmitDefaultValue = true)] + [DataMember(Name = "required", IsRequired = true, EmitDefaultValue = true)] public bool Required { get; set; } - /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. - /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. - [DataMember(Name = "group", EmitDefaultValue = true)] - public string Group { get; set; } - /// /// Returns the string presentation of the object /// @@ -179,16 +185,15 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseDocumentFormFieldBase {\n"); - sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" ApiId: ").Append(ApiId).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" Signer: ").Append(Signer).Append("\n"); sb.Append(" X: ").Append(X).Append("\n"); sb.Append(" Y: ").Append(Y).Append("\n"); sb.Append(" Width: ").Append(Width).Append("\n"); sb.Append(" Height: ").Append(Height).Append("\n"); sb.Append(" Required: ").Append(Required).Append("\n"); - sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -224,11 +229,6 @@ public bool Equals(TemplateResponseDocumentFormFieldBase input) return false; } return - ( - this.Type == input.Type || - (this.Type != null && - this.Type.Equals(input.Type)) - ) && ( this.ApiId == input.ApiId || (this.ApiId != null && @@ -239,6 +239,11 @@ public bool Equals(TemplateResponseDocumentFormFieldBase input) (this.Name != null && this.Name.Equals(input.Name)) ) && + ( + this.Type == input.Type || + (this.Type != null && + this.Type.Equals(input.Type)) + ) && ( this.Signer == input.Signer || (this.Signer != null && @@ -263,11 +268,6 @@ public bool Equals(TemplateResponseDocumentFormFieldBase input) ( this.Required == input.Required || this.Required.Equals(input.Required) - ) && - ( - this.Group == input.Group || - (this.Group != null && - this.Group.Equals(input.Group)) ); } @@ -280,10 +280,6 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; - if (this.Type != null) - { - hashCode = (hashCode * 59) + this.Type.GetHashCode(); - } if (this.ApiId != null) { hashCode = (hashCode * 59) + this.ApiId.GetHashCode(); @@ -292,6 +288,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Name.GetHashCode(); } + if (this.Type != null) + { + hashCode = (hashCode * 59) + this.Type.GetHashCode(); + } if (this.Signer != null) { hashCode = (hashCode * 59) + this.Signer.GetHashCode(); @@ -301,10 +301,6 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Width.GetHashCode(); hashCode = (hashCode * 59) + this.Height.GetHashCode(); hashCode = (hashCode * 59) + this.Required.GetHashCode(); - if (this.Group != null) - { - hashCode = (hashCode * 59) + this.Group.GetHashCode(); - } return hashCode; } } @@ -332,13 +328,6 @@ public List GetOpenApiTypes() { var types = new List(); types.Add(new OpenApiType() - { - Name = "type", - Property = "Type", - Type = "string", - Value = Type, - }); - types.Add(new OpenApiType() { Name = "api_id", Property = "ApiId", @@ -353,6 +342,13 @@ public List GetOpenApiTypes() Value = Name, }); types.Add(new OpenApiType() + { + Name = "type", + Property = "Type", + Type = "string", + Value = Type, + }); + types.Add(new OpenApiType() { Name = "signer", Property = "Signer", @@ -394,13 +390,6 @@ public List GetOpenApiTypes() Type = "bool", Value = Required, }); - types.Add(new OpenApiType() - { - Name = "group", - Property = "Group", - Type = "string", - Value = Group, - }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs index 81107edb4..98508a633 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs @@ -42,16 +42,16 @@ protected TemplateResponseDocumentFormFieldCheckbox() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "checkbox"). - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldCheckbox(string type = @"checkbox", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldCheckbox(string type = @"checkbox", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -61,7 +61,6 @@ protected TemplateResponseDocumentFormFieldCheckbox() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -69,6 +68,7 @@ protected TemplateResponseDocumentFormFieldCheckbox() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldCheckbox and cannot be null"); } this.Type = type; + this.Group = group; } /// @@ -94,6 +94,13 @@ public static TemplateResponseDocumentFormFieldCheckbox Init(string jsonData) [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -104,6 +111,7 @@ public override string ToString() sb.Append("class TemplateResponseDocumentFormFieldCheckbox {\n"); sb.Append(" ").Append(base.ToString().Replace("\n", "\n ")).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -143,6 +151,11 @@ public bool Equals(TemplateResponseDocumentFormFieldCheckbox input) this.Type == input.Type || (this.Type != null && this.Type.Equals(input.Type)) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -159,6 +172,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Type.GetHashCode(); } + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -196,6 +213,13 @@ public List GetOpenApiTypes() Type = "string", Value = Type, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs index 617886762..96cba8647 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs @@ -42,16 +42,16 @@ protected TemplateResponseDocumentFormFieldDateSigned() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "date_signed"). - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldDateSigned(string type = @"date_signed", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldDateSigned(string type = @"date_signed", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -61,7 +61,6 @@ protected TemplateResponseDocumentFormFieldDateSigned() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -69,6 +68,7 @@ protected TemplateResponseDocumentFormFieldDateSigned() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldDateSigned and cannot be null"); } this.Type = type; + this.Group = group; } /// @@ -94,6 +94,13 @@ public static TemplateResponseDocumentFormFieldDateSigned Init(string jsonData) [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -104,6 +111,7 @@ public override string ToString() sb.Append("class TemplateResponseDocumentFormFieldDateSigned {\n"); sb.Append(" ").Append(base.ToString().Replace("\n", "\n ")).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -143,6 +151,11 @@ public bool Equals(TemplateResponseDocumentFormFieldDateSigned input) this.Type == input.Type || (this.Type != null && this.Type.Equals(input.Type)) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -159,6 +172,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Type.GetHashCode(); } + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -196,6 +213,13 @@ public List GetOpenApiTypes() Type = "string", Value = Type, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs index e402f7f74..a100c7984 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs @@ -42,16 +42,16 @@ protected TemplateResponseDocumentFormFieldDropdown() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "dropdown"). - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldDropdown(string type = @"dropdown", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldDropdown(string type = @"dropdown", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -61,7 +61,6 @@ protected TemplateResponseDocumentFormFieldDropdown() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -69,6 +68,7 @@ protected TemplateResponseDocumentFormFieldDropdown() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldDropdown and cannot be null"); } this.Type = type; + this.Group = group; } /// @@ -94,6 +94,13 @@ public static TemplateResponseDocumentFormFieldDropdown Init(string jsonData) [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -104,6 +111,7 @@ public override string ToString() sb.Append("class TemplateResponseDocumentFormFieldDropdown {\n"); sb.Append(" ").Append(base.ToString().Replace("\n", "\n ")).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -143,6 +151,11 @@ public bool Equals(TemplateResponseDocumentFormFieldDropdown input) this.Type == input.Type || (this.Type != null && this.Type.Equals(input.Type)) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -159,6 +172,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Type.GetHashCode(); } + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -196,6 +213,13 @@ public List GetOpenApiTypes() Type = "string", Value = Type, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs index 5f874e63a..7138491b7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs @@ -42,20 +42,20 @@ protected TemplateResponseDocumentFormFieldHyperlink() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "hyperlink"). - /// avgTextLength. - /// Whether this form field is multiline text.. - /// Original font size used in this form field's text.. - /// Font family used in this form field's text.. - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// avgTextLength (required). + /// Whether this form field is multiline text. (required). + /// Original font size used in this form field's text. (required). + /// Font family used in this form field's text. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldHyperlink(string type = @"hyperlink", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldHyperlink(string type = @"hyperlink", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -65,7 +65,6 @@ protected TemplateResponseDocumentFormFieldHyperlink() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -73,10 +72,21 @@ protected TemplateResponseDocumentFormFieldHyperlink() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldHyperlink and cannot be null"); } this.Type = type; + // to ensure "avgTextLength" is required (not null) + if (avgTextLength == null) + { + throw new ArgumentNullException("avgTextLength is a required property for TemplateResponseDocumentFormFieldHyperlink and cannot be null"); + } this.AvgTextLength = avgTextLength; this.IsMultiline = isMultiline; this.OriginalFontSize = originalFontSize; + // to ensure "fontFamily" is required (not null) + if (fontFamily == null) + { + throw new ArgumentNullException("fontFamily is a required property for TemplateResponseDocumentFormFieldHyperlink and cannot be null"); + } this.FontFamily = fontFamily; + this.Group = group; } /// @@ -105,30 +115,37 @@ public static TemplateResponseDocumentFormFieldHyperlink Init(string jsonData) /// /// Gets or Sets AvgTextLength /// - [DataMember(Name = "avg_text_length", EmitDefaultValue = true)] + [DataMember(Name = "avg_text_length", IsRequired = true, EmitDefaultValue = true)] public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } /// /// Whether this form field is multiline text. /// /// Whether this form field is multiline text. - [DataMember(Name = "isMultiline", EmitDefaultValue = true)] + [DataMember(Name = "isMultiline", IsRequired = true, EmitDefaultValue = true)] public bool IsMultiline { get; set; } /// /// Original font size used in this form field's text. /// /// Original font size used in this form field's text. - [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] + [DataMember(Name = "originalFontSize", IsRequired = true, EmitDefaultValue = true)] public int OriginalFontSize { get; set; } /// /// Font family used in this form field's text. /// /// Font family used in this form field's text. - [DataMember(Name = "fontFamily", EmitDefaultValue = true)] + [DataMember(Name = "fontFamily", IsRequired = true, EmitDefaultValue = true)] public string FontFamily { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -143,6 +160,7 @@ public override string ToString() sb.Append(" IsMultiline: ").Append(IsMultiline).Append("\n"); sb.Append(" OriginalFontSize: ").Append(OriginalFontSize).Append("\n"); sb.Append(" FontFamily: ").Append(FontFamily).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -200,6 +218,11 @@ public bool Equals(TemplateResponseDocumentFormFieldHyperlink input) this.FontFamily == input.FontFamily || (this.FontFamily != null && this.FontFamily.Equals(input.FontFamily)) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -226,6 +249,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.FontFamily.GetHashCode(); } + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -291,6 +318,13 @@ public List GetOpenApiTypes() Type = "string", Value = FontFamily, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs index 3eb9296b0..cff4fe342 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs @@ -42,16 +42,16 @@ protected TemplateResponseDocumentFormFieldInitials() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "initials"). - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldInitials(string type = @"initials", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldInitials(string type = @"initials", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -61,7 +61,6 @@ protected TemplateResponseDocumentFormFieldInitials() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -69,6 +68,7 @@ protected TemplateResponseDocumentFormFieldInitials() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldInitials and cannot be null"); } this.Type = type; + this.Group = group; } /// @@ -94,6 +94,13 @@ public static TemplateResponseDocumentFormFieldInitials Init(string jsonData) [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -104,6 +111,7 @@ public override string ToString() sb.Append("class TemplateResponseDocumentFormFieldInitials {\n"); sb.Append(" ").Append(base.ToString().Replace("\n", "\n ")).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -143,6 +151,11 @@ public bool Equals(TemplateResponseDocumentFormFieldInitials input) this.Type == input.Type || (this.Type != null && this.Type.Equals(input.Type)) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -159,6 +172,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Type.GetHashCode(); } + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -196,6 +213,13 @@ public List GetOpenApiTypes() Type = "string", Value = Type, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs index 2bf695e4d..0d1eec061 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs @@ -42,16 +42,16 @@ protected TemplateResponseDocumentFormFieldRadio() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "radio"). - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. (required). - public TemplateResponseDocumentFormFieldRadio(string type = @"radio", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldRadio(string type = @"radio", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -61,7 +61,6 @@ protected TemplateResponseDocumentFormFieldRadio() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -69,6 +68,12 @@ protected TemplateResponseDocumentFormFieldRadio() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldRadio and cannot be null"); } this.Type = type; + // to ensure "group" is required (not null) + if (group == null) + { + throw new ArgumentNullException("group is a required property for TemplateResponseDocumentFormFieldRadio and cannot be null"); + } + this.Group = group; } /// @@ -94,6 +99,13 @@ public static TemplateResponseDocumentFormFieldRadio Init(string jsonData) [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", IsRequired = true, EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -104,6 +116,7 @@ public override string ToString() sb.Append("class TemplateResponseDocumentFormFieldRadio {\n"); sb.Append(" ").Append(base.ToString().Replace("\n", "\n ")).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -143,6 +156,11 @@ public bool Equals(TemplateResponseDocumentFormFieldRadio input) this.Type == input.Type || (this.Type != null && this.Type.Equals(input.Type)) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -159,6 +177,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Type.GetHashCode(); } + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -196,6 +218,13 @@ public List GetOpenApiTypes() Type = "string", Value = Type, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs index 79119e439..f5301dd13 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs @@ -42,16 +42,16 @@ protected TemplateResponseDocumentFormFieldSignature() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "signature"). - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldSignature(string type = @"signature", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldSignature(string type = @"signature", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -61,7 +61,6 @@ protected TemplateResponseDocumentFormFieldSignature() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -69,6 +68,7 @@ protected TemplateResponseDocumentFormFieldSignature() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldSignature and cannot be null"); } this.Type = type; + this.Group = group; } /// @@ -94,6 +94,13 @@ public static TemplateResponseDocumentFormFieldSignature Init(string jsonData) [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -104,6 +111,7 @@ public override string ToString() sb.Append("class TemplateResponseDocumentFormFieldSignature {\n"); sb.Append(" ").Append(base.ToString().Replace("\n", "\n ")).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -143,6 +151,11 @@ public bool Equals(TemplateResponseDocumentFormFieldSignature input) this.Type == input.Type || (this.Type != null && this.Type.Equals(input.Type)) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -159,6 +172,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Type.GetHashCode(); } + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -196,6 +213,13 @@ public List GetOpenApiTypes() Type = "string", Value = Type, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs index ee0686bcb..0d9bbbe31 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs @@ -117,21 +117,21 @@ protected TemplateResponseDocumentFormFieldText() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "text"). - /// avgTextLength. - /// Whether this form field is multiline text.. - /// Original font size used in this form field's text.. - /// Font family used in this form field's text.. + /// avgTextLength (required). + /// Whether this form field is multiline text. (required). + /// Original font size used in this form field's text. (required). + /// Font family used in this form field's text. (required). /// Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.. - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldText(string type = @"text", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), ValidationTypeEnum? validationType = default(ValidationTypeEnum?), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldText(string type = @"text", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), ValidationTypeEnum? validationType = default(ValidationTypeEnum?), string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -141,7 +141,6 @@ protected TemplateResponseDocumentFormFieldText() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -149,11 +148,22 @@ protected TemplateResponseDocumentFormFieldText() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldText and cannot be null"); } this.Type = type; + // to ensure "avgTextLength" is required (not null) + if (avgTextLength == null) + { + throw new ArgumentNullException("avgTextLength is a required property for TemplateResponseDocumentFormFieldText and cannot be null"); + } this.AvgTextLength = avgTextLength; this.IsMultiline = isMultiline; this.OriginalFontSize = originalFontSize; + // to ensure "fontFamily" is required (not null) + if (fontFamily == null) + { + throw new ArgumentNullException("fontFamily is a required property for TemplateResponseDocumentFormFieldText and cannot be null"); + } this.FontFamily = fontFamily; this.ValidationType = validationType; + this.Group = group; } /// @@ -182,30 +192,37 @@ public static TemplateResponseDocumentFormFieldText Init(string jsonData) /// /// Gets or Sets AvgTextLength /// - [DataMember(Name = "avg_text_length", EmitDefaultValue = true)] + [DataMember(Name = "avg_text_length", IsRequired = true, EmitDefaultValue = true)] public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } /// /// Whether this form field is multiline text. /// /// Whether this form field is multiline text. - [DataMember(Name = "isMultiline", EmitDefaultValue = true)] + [DataMember(Name = "isMultiline", IsRequired = true, EmitDefaultValue = true)] public bool IsMultiline { get; set; } /// /// Original font size used in this form field's text. /// /// Original font size used in this form field's text. - [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] + [DataMember(Name = "originalFontSize", IsRequired = true, EmitDefaultValue = true)] public int OriginalFontSize { get; set; } /// /// Font family used in this form field's text. /// /// Font family used in this form field's text. - [DataMember(Name = "fontFamily", EmitDefaultValue = true)] + [DataMember(Name = "fontFamily", IsRequired = true, EmitDefaultValue = true)] public string FontFamily { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -221,6 +238,7 @@ public override string ToString() sb.Append(" OriginalFontSize: ").Append(OriginalFontSize).Append("\n"); sb.Append(" FontFamily: ").Append(FontFamily).Append("\n"); sb.Append(" ValidationType: ").Append(ValidationType).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -282,6 +300,11 @@ public bool Equals(TemplateResponseDocumentFormFieldText input) ( this.ValidationType == input.ValidationType || this.ValidationType.Equals(input.ValidationType) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -309,6 +332,10 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.FontFamily.GetHashCode(); } hashCode = (hashCode * 59) + this.ValidationType.GetHashCode(); + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -381,6 +408,13 @@ public List GetOpenApiTypes() Type = "string", Value = ValidationType, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs index 69281b328..cac470d89 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs @@ -51,29 +51,43 @@ protected TemplateResponseDocumentStaticFieldBase() { } /// /// Initializes a new instance of the class. /// - /// A unique id for the static field.. - /// The name of the static field.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). /// type (required). - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldBase(string apiId = default(string), string name = default(string), string type = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { + // to ensure "apiId" is required (not null) + if (apiId == null) + { + throw new ArgumentNullException("apiId is a required property for TemplateResponseDocumentStaticFieldBase and cannot be null"); + } + this.ApiId = apiId; + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TemplateResponseDocumentStaticFieldBase and cannot be null"); + } + this.Name = name; // to ensure "type" is required (not null) if (type == null) { throw new ArgumentNullException("type is a required property for TemplateResponseDocumentStaticFieldBase and cannot be null"); } this.Type = type; - this.ApiId = apiId; - this.Name = name; - // use default value if no "signer" provided - this.Signer = signer ?? "me_now"; + // to ensure "signer" is required (not null) + if (signer == null) + { + throw new ArgumentNullException("signer is a required property for TemplateResponseDocumentStaticFieldBase and cannot be null"); + } + this.Signer = signer; this.X = x; this.Y = y; this.Width = width; @@ -98,66 +112,66 @@ public static TemplateResponseDocumentStaticFieldBase Init(string jsonData) return obj; } - /// - /// Gets or Sets Type - /// - [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] - public string Type { get; set; } - /// /// A unique id for the static field. /// /// A unique id for the static field. - [DataMember(Name = "api_id", EmitDefaultValue = true)] + [DataMember(Name = "api_id", IsRequired = true, EmitDefaultValue = true)] public string ApiId { get; set; } /// /// The name of the static field. /// /// The name of the static field. - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } + /// + /// Gets or Sets Type + /// + [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] + public string Type { get; set; } + /// /// The signer of the Static Field. /// /// The signer of the Static Field. - [DataMember(Name = "signer", EmitDefaultValue = true)] + [DataMember(Name = "signer", IsRequired = true, EmitDefaultValue = true)] public string Signer { get; set; } /// /// The horizontal offset in pixels for this static field. /// /// The horizontal offset in pixels for this static field. - [DataMember(Name = "x", EmitDefaultValue = true)] + [DataMember(Name = "x", IsRequired = true, EmitDefaultValue = true)] public int X { get; set; } /// /// The vertical offset in pixels for this static field. /// /// The vertical offset in pixels for this static field. - [DataMember(Name = "y", EmitDefaultValue = true)] + [DataMember(Name = "y", IsRequired = true, EmitDefaultValue = true)] public int Y { get; set; } /// /// The width in pixels of this static field. /// /// The width in pixels of this static field. - [DataMember(Name = "width", EmitDefaultValue = true)] + [DataMember(Name = "width", IsRequired = true, EmitDefaultValue = true)] public int Width { get; set; } /// /// The height in pixels of this static field. /// /// The height in pixels of this static field. - [DataMember(Name = "height", EmitDefaultValue = true)] + [DataMember(Name = "height", IsRequired = true, EmitDefaultValue = true)] public int Height { get; set; } /// /// Boolean showing whether or not this field is required. /// /// Boolean showing whether or not this field is required. - [DataMember(Name = "required", EmitDefaultValue = true)] + [DataMember(Name = "required", IsRequired = true, EmitDefaultValue = true)] public bool Required { get; set; } /// @@ -175,9 +189,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseDocumentStaticFieldBase {\n"); - sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" ApiId: ").Append(ApiId).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" Signer: ").Append(Signer).Append("\n"); sb.Append(" X: ").Append(X).Append("\n"); sb.Append(" Y: ").Append(Y).Append("\n"); @@ -220,11 +234,6 @@ public bool Equals(TemplateResponseDocumentStaticFieldBase input) return false; } return - ( - this.Type == input.Type || - (this.Type != null && - this.Type.Equals(input.Type)) - ) && ( this.ApiId == input.ApiId || (this.ApiId != null && @@ -235,6 +244,11 @@ public bool Equals(TemplateResponseDocumentStaticFieldBase input) (this.Name != null && this.Name.Equals(input.Name)) ) && + ( + this.Type == input.Type || + (this.Type != null && + this.Type.Equals(input.Type)) + ) && ( this.Signer == input.Signer || (this.Signer != null && @@ -276,10 +290,6 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; - if (this.Type != null) - { - hashCode = (hashCode * 59) + this.Type.GetHashCode(); - } if (this.ApiId != null) { hashCode = (hashCode * 59) + this.ApiId.GetHashCode(); @@ -288,6 +298,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Name.GetHashCode(); } + if (this.Type != null) + { + hashCode = (hashCode * 59) + this.Type.GetHashCode(); + } if (this.Signer != null) { hashCode = (hashCode * 59) + this.Signer.GetHashCode(); @@ -328,13 +342,6 @@ public List GetOpenApiTypes() { var types = new List(); types.Add(new OpenApiType() - { - Name = "type", - Property = "Type", - Type = "string", - Value = Type, - }); - types.Add(new OpenApiType() { Name = "api_id", Property = "ApiId", @@ -349,6 +356,13 @@ public List GetOpenApiTypes() Value = Name, }); types.Add(new OpenApiType() + { + Name = "type", + Property = "Type", + Type = "string", + Value = Type, + }); + types.Add(new OpenApiType() { Name = "signer", Property = "Signer", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs index 0d5fce147..ecc2a11d8 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldCheckbox() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "checkbox"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldCheckbox(string type = @"checkbox", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs index 4d30a2038..af09f33ac 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldDateSigned() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "date_signed"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldDateSigned(string type = @"date_signed", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs index 423e983f4..381e2eed8 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldDropdown() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "dropdown"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldDropdown(string type = @"dropdown", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs index 78b8bd087..4d3426e92 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldHyperlink() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "hyperlink"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldHyperlink(string type = @"hyperlink", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs index cc5526323..0d07e78f2 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldInitials() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "initials"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldInitials(string type = @"initials", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs index 24f09b8c1..c25fd9db6 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldRadio() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "radio"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldRadio(string type = @"radio", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs index 0d7ea03a6..f4f5b70e2 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldSignature() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "signature"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldSignature(string type = @"signature", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs index 48c59ea75..ba2930e53 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldText() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "text"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldText(string type = @"text", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs index 3d3ae1df2..6ed7b426c 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs @@ -41,8 +41,8 @@ protected TemplateResponseFieldAvgTextLength() { } /// /// Initializes a new instance of the class. /// - /// Number of lines.. - /// Number of characters per line.. + /// Number of lines. (required). + /// Number of characters per line. (required). public TemplateResponseFieldAvgTextLength(int numLines = default(int), int numCharsPerLine = default(int)) { @@ -70,14 +70,14 @@ public static TemplateResponseFieldAvgTextLength Init(string jsonData) /// Number of lines. /// /// Number of lines. - [DataMember(Name = "num_lines", EmitDefaultValue = true)] + [DataMember(Name = "num_lines", IsRequired = true, EmitDefaultValue = true)] public int NumLines { get; set; } /// /// Number of characters per line. /// /// Number of characters per line. - [DataMember(Name = "num_chars_per_line", EmitDefaultValue = true)] + [DataMember(Name = "num_chars_per_line", IsRequired = true, EmitDefaultValue = true)] public int NumCharsPerLine { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs index db464fd46..f11de6735 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs @@ -41,11 +41,16 @@ protected TemplateResponseSignerRole() { } /// /// Initializes a new instance of the class. /// - /// The name of the Role.. + /// The name of the Role. (required). /// If signer order is assigned this is the 0-based index for this role.. public TemplateResponseSignerRole(string name = default(string), int order = default(int)) { + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TemplateResponseSignerRole and cannot be null"); + } this.Name = name; this.Order = order; } @@ -70,7 +75,7 @@ public static TemplateResponseSignerRole Init(string jsonData) /// The name of the Role. /// /// The name of the Role. - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs index 4a8863338..d82c11047 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs @@ -41,11 +41,16 @@ protected TemplateUpdateFilesResponseTemplate() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template.. + /// The id of the Template. (required). /// A list of warnings.. public TemplateUpdateFilesResponseTemplate(string templateId = default(string), List warnings = default(List)) { + // to ensure "templateId" is required (not null) + if (templateId == null) + { + throw new ArgumentNullException("templateId is a required property for TemplateUpdateFilesResponseTemplate and cannot be null"); + } this.TemplateId = templateId; this.Warnings = warnings; } @@ -70,7 +75,7 @@ public static TemplateUpdateFilesResponseTemplate Init(string jsonData) /// The id of the Template. /// /// The id of the Template. - [DataMember(Name = "template_id", EmitDefaultValue = true)] + [DataMember(Name = "template_id", IsRequired = true, EmitDefaultValue = true)] public string TemplateId { get; set; } /// diff --git a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 770cce434..224ec6c71 100644 --- a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -8,9 +8,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | -| `editUrl` | ```String``` | Link to edit the template. | | -| `expiresAt` | ```Integer``` | When the link expires. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | +| `editUrl`*_required_ | ```String``` | Link to edit the template. | | +| `expiresAt`*_required_ | ```Integer``` | When the link expires. | | | `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/java-v1/docs/TemplateCreateResponseTemplate.md b/sdks/java-v1/docs/TemplateCreateResponseTemplate.md index 1dcd4bd79..79801d898 100644 --- a/sdks/java-v1/docs/TemplateCreateResponseTemplate.md +++ b/sdks/java-v1/docs/TemplateCreateResponseTemplate.md @@ -8,7 +8,7 @@ Template object with parameters: `template_id`. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | diff --git a/sdks/java-v1/docs/TemplateResponse.md b/sdks/java-v1/docs/TemplateResponse.md index 078685ff1..87d844276 100644 --- a/sdks/java-v1/docs/TemplateResponse.md +++ b/sdks/java-v1/docs/TemplateResponse.md @@ -8,21 +8,22 @@ Contains information about the templates you and your team have created. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | -| `title` | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | +| `title`*_required_ | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message`*_required_ | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `isCreator`*_required_ | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `canEdit`*_required_ | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `isLocked`*_required_ | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata`*_required_ | ```Object``` | The metadata attached to the template. | | +| `signerRoles`*_required_ | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `ccRoles`*_required_ | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | +| `documents`*_required_ | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `accounts`*_required_ | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments`*_required_ | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updatedAt` | ```Integer``` | Time the template was last updated. | | -| `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `isCreator` | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `canEdit` | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `isLocked` | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata` | ```Object``` | The metadata attached to the template. | | -| `signerRoles` | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `ccRoles` | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | | `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | diff --git a/sdks/java-v1/docs/TemplateResponseAccount.md b/sdks/java-v1/docs/TemplateResponseAccount.md index 10c996408..dd8ebce7f 100644 --- a/sdks/java-v1/docs/TemplateResponseAccount.md +++ b/sdks/java-v1/docs/TemplateResponseAccount.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_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.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` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | diff --git a/sdks/java-v1/docs/TemplateResponseAccountQuota.md b/sdks/java-v1/docs/TemplateResponseAccountQuota.md index ad94c2493..72160ca8f 100644 --- a/sdks/java-v1/docs/TemplateResponseAccountQuota.md +++ b/sdks/java-v1/docs/TemplateResponseAccountQuota.md @@ -8,10 +8,10 @@ An array of the designated CC roles that must be specified when sending a Signat | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templatesLeft` | ```Integer``` | API templates remaining. | | -| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | | -| `documentsLeft` | ```Integer``` | Signature requests remaining. | | -| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | +| `templatesLeft`*_required_ | ```Integer``` | API templates remaining. | | +| `apiSignatureRequestsLeft`*_required_ | ```Integer``` | API signature requests remaining. | | +| `documentsLeft`*_required_ | ```Integer``` | Signature requests remaining. | | +| `smsVerificationsLeft`*_required_ | ```Integer``` | SMS verifications remaining. | | diff --git a/sdks/java-v1/docs/TemplateResponseCCRole.md b/sdks/java-v1/docs/TemplateResponseCCRole.md index 64069b826..06e61bff4 100644 --- a/sdks/java-v1/docs/TemplateResponseCCRole.md +++ b/sdks/java-v1/docs/TemplateResponseCCRole.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the Role. | | +| `name`*_required_ | ```String``` | The name of the Role. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocument.md b/sdks/java-v1/docs/TemplateResponseDocument.md index 65da85d42..cb69a481f 100644 --- a/sdks/java-v1/docs/TemplateResponseDocument.md +++ b/sdks/java-v1/docs/TemplateResponseDocument.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | Name of the associated file. | | +| `name`*_required_ | ```String``` | Name of the associated file. | | +| `fieldGroups`*_required_ | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `formFields`*_required_ | [```List```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `customFields`*_required_ | [```List```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `staticFields`*_required_ | [```List```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | | `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `fieldGroups` | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `formFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `staticFields` | [```List```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md index edd461727..c7c7f8264 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md @@ -8,15 +8,15 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| `apiId`*_required_ | ```String``` | The unique ID for this field. | | +| `name`*_required_ | ```String``` | The name of the Custom Field. | | | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | The unique ID for this field. | | -| `name` | ```String``` | The name of the Custom Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | | `signer` | ```String``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md index ccaf19394..70c991777 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md @@ -9,10 +9,10 @@ This class extends `TemplateResponseDocumentCustomFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md index 03b5ffbb8..7dd066f54 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the form field group. | | -| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name`*_required_ | ```String``` | The name of the form field group. | | +| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md index e0f4dcc8a..59d4e5e06 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md @@ -8,8 +8,8 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `requirement` | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `groupLabel` | ```String``` | Name of the group | | +| `requirement`*_required_ | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `groupLabel`*_required_ | ```String``` | Name of the group | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md index 656070ad4..8d8766339 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md @@ -8,16 +8,15 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| `apiId`*_required_ | ```String``` | A unique id for the form field. | | +| `name`*_required_ | ```String``` | The name of the form field. | | | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | A unique id for the form field. | | -| `name` | ```String``` | The name of the form field. | | -| `signer` | ```String``` | The signer of the Form Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `signer`*_required_ | ```String``` | The signer of the Form Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldCheckbox.md index 83d36e0f1..a7f2cadeb 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDateSigned.md index 5ba66eff9..09b45eec7 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDropdown.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDropdown.md index b4f2030fc..70e5da455 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md index 0cf89df5e..104029730 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -9,10 +9,11 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldInitials.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldInitials.md index 707d67ee2..f1fe1f5b5 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldInitials.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldRadio.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldRadio.md index b83d96d53..877b842a2 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldRadio.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group`*_required_ | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldSignature.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldSignature.md index 8be298793..366aaa9b4 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldSignature.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md index 3581d3855..31520bd6f 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md @@ -9,11 +9,12 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | | `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md index 4be3cf070..f52329b04 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md @@ -8,15 +8,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| `apiId`*_required_ | ```String``` | A unique id for the static field. | | +| `name`*_required_ | ```String``` | The name of the static field. | | | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | A unique id for the static field. | | -| `name` | ```String``` | The name of the static field. | | -| `signer` | ```String``` | The signer of the Static Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this static field. | | -| `width` | ```Integer``` | The width in pixels of this static field. | | -| `height` | ```Integer``` | The height in pixels of this static field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `signer`*_required_ | ```String``` | The signer of the Static Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this static field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this static field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this static field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this static field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md b/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md index bb66f3057..f0d2106b0 100644 --- a/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md @@ -8,8 +8,8 @@ Average text length in this field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `numLines` | ```Integer``` | Number of lines. | | -| `numCharsPerLine` | ```Integer``` | Number of characters per line. | | +| `numLines`*_required_ | ```Integer``` | Number of lines. | | +| `numCharsPerLine`*_required_ | ```Integer``` | Number of characters per line. | | diff --git a/sdks/java-v1/docs/TemplateResponseSignerRole.md b/sdks/java-v1/docs/TemplateResponseSignerRole.md index 15b48cf17..08458f4e0 100644 --- a/sdks/java-v1/docs/TemplateResponseSignerRole.md +++ b/sdks/java-v1/docs/TemplateResponseSignerRole.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the Role. | | +| `name`*_required_ | ```String``` | The name of the Role. | | | `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this role. | | diff --git a/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md index 6289a9953..7acdbb340 100644 --- a/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md @@ -8,7 +8,7 @@ Contains template id | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | | `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java index 7e2fc0bc4..e82d6aa72 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java @@ -82,14 +82,15 @@ public TemplateCreateEmbeddedDraftResponseTemplate templateId(String templateId) * * @return templateId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; } @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } @@ -104,14 +105,15 @@ public TemplateCreateEmbeddedDraftResponseTemplate editUrl(String editUrl) { * * @return editUrl */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EDIT_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_EDIT_URL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getEditUrl() { return editUrl; } @JsonProperty(JSON_PROPERTY_EDIT_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setEditUrl(String editUrl) { this.editUrl = editUrl; } @@ -126,14 +128,15 @@ public TemplateCreateEmbeddedDraftResponseTemplate expiresAt(Integer expiresAt) * * @return expiresAt */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EXPIRES_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getExpiresAt() { return expiresAt; } @JsonProperty(JSON_PROPERTY_EXPIRES_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setExpiresAt(Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java index 017ed6e40..cd3964ffb 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java @@ -61,14 +61,15 @@ public TemplateCreateResponseTemplate templateId(String templateId) { * * @return templateId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; } @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java index 3a0e14a2f..59f31e8af 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -30,8 +30,6 @@ TemplateResponse.JSON_PROPERTY_TEMPLATE_ID, TemplateResponse.JSON_PROPERTY_TITLE, TemplateResponse.JSON_PROPERTY_MESSAGE, - TemplateResponse.JSON_PROPERTY_UPDATED_AT, - TemplateResponse.JSON_PROPERTY_IS_EMBEDDED, TemplateResponse.JSON_PROPERTY_IS_CREATOR, TemplateResponse.JSON_PROPERTY_CAN_EDIT, TemplateResponse.JSON_PROPERTY_IS_LOCKED, @@ -39,9 +37,12 @@ TemplateResponse.JSON_PROPERTY_SIGNER_ROLES, TemplateResponse.JSON_PROPERTY_CC_ROLES, TemplateResponse.JSON_PROPERTY_DOCUMENTS, + TemplateResponse.JSON_PROPERTY_ACCOUNTS, + TemplateResponse.JSON_PROPERTY_ATTACHMENTS, + TemplateResponse.JSON_PROPERTY_UPDATED_AT, + TemplateResponse.JSON_PROPERTY_IS_EMBEDDED, TemplateResponse.JSON_PROPERTY_CUSTOM_FIELDS, - TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS, - TemplateResponse.JSON_PROPERTY_ACCOUNTS + TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -57,12 +58,6 @@ public class TemplateResponse { public static final String JSON_PROPERTY_MESSAGE = "message"; private String message; - public static final String JSON_PROPERTY_UPDATED_AT = "updated_at"; - private Integer updatedAt; - - public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; - private Boolean isEmbedded; - public static final String JSON_PROPERTY_IS_CREATOR = "is_creator"; private Boolean isCreator; @@ -76,13 +71,25 @@ public class TemplateResponse { private Object metadata; public static final String JSON_PROPERTY_SIGNER_ROLES = "signer_roles"; - private List signerRoles = null; + private List signerRoles = new ArrayList<>(); public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; - private List ccRoles = null; + private List ccRoles = new ArrayList<>(); public static final String JSON_PROPERTY_DOCUMENTS = "documents"; - private List documents = null; + private List documents = new ArrayList<>(); + + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private List accounts = new ArrayList<>(); + + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + private List attachments = new ArrayList<>(); + + public static final String JSON_PROPERTY_UPDATED_AT = "updated_at"; + private Integer updatedAt; + + public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; + private Boolean isEmbedded; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; @Deprecated private List customFields = null; @@ -90,9 +97,6 @@ public class TemplateResponse { public static final String JSON_PROPERTY_NAMED_FORM_FIELDS = "named_form_fields"; @Deprecated private List namedFormFields = null; - public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private List accounts = null; - public TemplateResponse() {} /** @@ -119,14 +123,15 @@ public TemplateResponse templateId(String templateId) { * * @return templateId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; } @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } @@ -143,14 +148,15 @@ public TemplateResponse title(String title) { * * @return title */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TITLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTitle() { return title; } @JsonProperty(JSON_PROPERTY_TITLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTitle(String title) { this.title = title; } @@ -166,63 +172,19 @@ public TemplateResponse message(String message) { * * @return message */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_MESSAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getMessage() { return message; } @JsonProperty(JSON_PROPERTY_MESSAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setMessage(String message) { this.message = message; } - public TemplateResponse updatedAt(Integer updatedAt) { - this.updatedAt = updatedAt; - return this; - } - - /** - * Time the template was last updated. - * - * @return updatedAt - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Integer getUpdatedAt() { - return updatedAt; - } - - @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUpdatedAt(Integer updatedAt) { - this.updatedAt = updatedAt; - } - - public TemplateResponse isEmbedded(Boolean isEmbedded) { - this.isEmbedded = isEmbedded; - return this; - } - - /** - * `true` if this template was created using an embedded flow, `false` if it - * was created on our website. - * - * @return isEmbedded - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getIsEmbedded() { - return isEmbedded; - } - - @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsEmbedded(Boolean isEmbedded) { - this.isEmbedded = isEmbedded; - } - public TemplateResponse isCreator(Boolean isCreator) { this.isCreator = isCreator; return this; @@ -234,14 +196,15 @@ public TemplateResponse isCreator(Boolean isCreator) { * * @return isCreator */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_CREATOR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsCreator() { return isCreator; } @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsCreator(Boolean isCreator) { this.isCreator = isCreator; } @@ -257,14 +220,15 @@ public TemplateResponse canEdit(Boolean canEdit) { * * @return canEdit */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CAN_EDIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CAN_EDIT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getCanEdit() { return canEdit; } @JsonProperty(JSON_PROPERTY_CAN_EDIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCanEdit(Boolean canEdit) { this.canEdit = canEdit; } @@ -281,14 +245,15 @@ public TemplateResponse 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; } @@ -303,14 +268,15 @@ public TemplateResponse metadata(Object metadata) { * * @return metadata */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_METADATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Object getMetadata() { return metadata; } @JsonProperty(JSON_PROPERTY_METADATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setMetadata(Object metadata) { this.metadata = metadata; } @@ -334,14 +300,15 @@ public TemplateResponse addSignerRolesItem(TemplateResponseSignerRole signerRole * * @return signerRoles */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getSignerRoles() { return signerRoles; } @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSignerRoles(List signerRoles) { this.signerRoles = signerRoles; } @@ -365,14 +332,15 @@ public TemplateResponse addCcRolesItem(TemplateResponseCCRole ccRolesItem) { * * @return ccRoles */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CC_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CC_ROLES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getCcRoles() { return ccRoles; } @JsonProperty(JSON_PROPERTY_CC_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCcRoles(List ccRoles) { this.ccRoles = ccRoles; } @@ -396,18 +364,127 @@ public TemplateResponse addDocumentsItem(TemplateResponseDocument documentsItem) * * @return documents */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_DOCUMENTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DOCUMENTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getDocuments() { return documents; } @JsonProperty(JSON_PROPERTY_DOCUMENTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setDocuments(List documents) { this.documents = documents; } + public TemplateResponse accounts(List accounts) { + this.accounts = accounts; + return this; + } + + public TemplateResponse addAccountsItem(TemplateResponseAccount accountsItem) { + if (this.accounts == null) { + this.accounts = new ArrayList<>(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * An array of the Accounts that can use this Template. + * + * @return accounts + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getAccounts() { + return accounts; + } + + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setAccounts(List accounts) { + this.accounts = accounts; + } + + public TemplateResponse attachments(List attachments) { + this.attachments = attachments; + return this; + } + + public TemplateResponse addAttachmentsItem(SignatureRequestResponseAttachment attachmentsItem) { + if (this.attachments == null) { + this.attachments = new ArrayList<>(); + } + this.attachments.add(attachmentsItem); + return this; + } + + /** + * Signer attachments. + * + * @return attachments + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getAttachments() { + return attachments; + } + + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setAttachments(List attachments) { + this.attachments = attachments; + } + + public TemplateResponse updatedAt(Integer updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + * Time the template was last updated. + * + * @return updatedAt + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Integer getUpdatedAt() { + return updatedAt; + } + + @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setUpdatedAt(Integer updatedAt) { + this.updatedAt = updatedAt; + } + + public TemplateResponse isEmbedded(Boolean isEmbedded) { + this.isEmbedded = isEmbedded; + return this; + } + + /** + * `true` if this template was created using an embedded flow, `false` if it + * was created on our website. Will be `null` when you are not the creator of the + * Template. + * + * @return isEmbedded + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIsEmbedded() { + return isEmbedded; + } + + @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIsEmbedded(Boolean isEmbedded) { + this.isEmbedded = isEmbedded; + } + @Deprecated public TemplateResponse customFields( List customFields) { @@ -484,36 +561,6 @@ public void setNamedFormFields(List named this.namedFormFields = namedFormFields; } - public TemplateResponse accounts(List accounts) { - this.accounts = accounts; - return this; - } - - public TemplateResponse addAccountsItem(TemplateResponseAccount accountsItem) { - if (this.accounts == null) { - this.accounts = new ArrayList<>(); - } - this.accounts.add(accountsItem); - return this; - } - - /** - * An array of the Accounts that can use this Template. - * - * @return accounts - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public List getAccounts() { - return accounts; - } - - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccounts(List accounts) { - this.accounts = accounts; - } - /** Return true if this TemplateResponse object is equal to o. */ @Override public boolean equals(Object o) { @@ -527,8 +574,6 @@ public boolean equals(Object o) { return Objects.equals(this.templateId, templateResponse.templateId) && Objects.equals(this.title, templateResponse.title) && Objects.equals(this.message, templateResponse.message) - && Objects.equals(this.updatedAt, templateResponse.updatedAt) - && Objects.equals(this.isEmbedded, templateResponse.isEmbedded) && Objects.equals(this.isCreator, templateResponse.isCreator) && Objects.equals(this.canEdit, templateResponse.canEdit) && Objects.equals(this.isLocked, templateResponse.isLocked) @@ -536,9 +581,12 @@ public boolean equals(Object o) { && Objects.equals(this.signerRoles, templateResponse.signerRoles) && Objects.equals(this.ccRoles, templateResponse.ccRoles) && Objects.equals(this.documents, templateResponse.documents) + && Objects.equals(this.accounts, templateResponse.accounts) + && Objects.equals(this.attachments, templateResponse.attachments) + && Objects.equals(this.updatedAt, templateResponse.updatedAt) + && Objects.equals(this.isEmbedded, templateResponse.isEmbedded) && Objects.equals(this.customFields, templateResponse.customFields) - && Objects.equals(this.namedFormFields, templateResponse.namedFormFields) - && Objects.equals(this.accounts, templateResponse.accounts); + && Objects.equals(this.namedFormFields, templateResponse.namedFormFields); } @Override @@ -547,8 +595,6 @@ public int hashCode() { templateId, title, message, - updatedAt, - isEmbedded, isCreator, canEdit, isLocked, @@ -556,9 +602,12 @@ public int hashCode() { signerRoles, ccRoles, documents, + accounts, + attachments, + updatedAt, + isEmbedded, customFields, - namedFormFields, - accounts); + namedFormFields); } @Override @@ -568,8 +617,6 @@ public String toString() { sb.append(" templateId: ").append(toIndentedString(templateId)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); - sb.append(" isEmbedded: ").append(toIndentedString(isEmbedded)).append("\n"); sb.append(" isCreator: ").append(toIndentedString(isCreator)).append("\n"); sb.append(" canEdit: ").append(toIndentedString(canEdit)).append("\n"); sb.append(" isLocked: ").append(toIndentedString(isLocked)).append("\n"); @@ -577,9 +624,12 @@ public String toString() { sb.append(" signerRoles: ").append(toIndentedString(signerRoles)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" documents: ").append(toIndentedString(documents)).append("\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); + sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); + sb.append(" isEmbedded: ").append(toIndentedString(isEmbedded)).append("\n"); sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); sb.append(" namedFormFields: ").append(toIndentedString(namedFormFields)).append("\n"); - sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); sb.append("}"); return sb.toString(); } @@ -644,46 +694,6 @@ public Map createFormData() throws ApiException { map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); } } - if (updatedAt != null) { - if (isFileTypeOrListOfFiles(updatedAt)) { - fileTypeFound = true; - } - - if (updatedAt.getClass().equals(java.io.File.class) - || updatedAt.getClass().equals(Integer.class) - || updatedAt.getClass().equals(String.class) - || updatedAt.getClass().isEnum()) { - map.put("updated_at", updatedAt); - } else if (isListOfFile(updatedAt)) { - for (int i = 0; i < getListSize(updatedAt); i++) { - map.put("updated_at[" + i + "]", getFromList(updatedAt, i)); - } - } else { - map.put( - "updated_at", - JSON.getDefault().getMapper().writeValueAsString(updatedAt)); - } - } - if (isEmbedded != null) { - if (isFileTypeOrListOfFiles(isEmbedded)) { - fileTypeFound = true; - } - - if (isEmbedded.getClass().equals(java.io.File.class) - || isEmbedded.getClass().equals(Integer.class) - || isEmbedded.getClass().equals(String.class) - || isEmbedded.getClass().isEnum()) { - map.put("is_embedded", isEmbedded); - } else if (isListOfFile(isEmbedded)) { - for (int i = 0; i < getListSize(isEmbedded); i++) { - map.put("is_embedded[" + i + "]", getFromList(isEmbedded, i)); - } - } else { - map.put( - "is_embedded", - JSON.getDefault().getMapper().writeValueAsString(isEmbedded)); - } - } if (isCreator != null) { if (isFileTypeOrListOfFiles(isCreator)) { fileTypeFound = true; @@ -818,6 +828,84 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(documents)); } } + if (accounts != null) { + if (isFileTypeOrListOfFiles(accounts)) { + fileTypeFound = true; + } + + if (accounts.getClass().equals(java.io.File.class) + || accounts.getClass().equals(Integer.class) + || accounts.getClass().equals(String.class) + || accounts.getClass().isEnum()) { + map.put("accounts", accounts); + } else if (isListOfFile(accounts)) { + for (int i = 0; i < getListSize(accounts); i++) { + map.put("accounts[" + i + "]", getFromList(accounts, i)); + } + } else { + map.put("accounts", JSON.getDefault().getMapper().writeValueAsString(accounts)); + } + } + if (attachments != null) { + if (isFileTypeOrListOfFiles(attachments)) { + fileTypeFound = true; + } + + if (attachments.getClass().equals(java.io.File.class) + || attachments.getClass().equals(Integer.class) + || attachments.getClass().equals(String.class) + || attachments.getClass().isEnum()) { + map.put("attachments", attachments); + } else if (isListOfFile(attachments)) { + for (int i = 0; i < getListSize(attachments); i++) { + map.put("attachments[" + i + "]", getFromList(attachments, i)); + } + } else { + map.put( + "attachments", + JSON.getDefault().getMapper().writeValueAsString(attachments)); + } + } + if (updatedAt != null) { + if (isFileTypeOrListOfFiles(updatedAt)) { + fileTypeFound = true; + } + + if (updatedAt.getClass().equals(java.io.File.class) + || updatedAt.getClass().equals(Integer.class) + || updatedAt.getClass().equals(String.class) + || updatedAt.getClass().isEnum()) { + map.put("updated_at", updatedAt); + } else if (isListOfFile(updatedAt)) { + for (int i = 0; i < getListSize(updatedAt); i++) { + map.put("updated_at[" + i + "]", getFromList(updatedAt, i)); + } + } else { + map.put( + "updated_at", + JSON.getDefault().getMapper().writeValueAsString(updatedAt)); + } + } + if (isEmbedded != null) { + if (isFileTypeOrListOfFiles(isEmbedded)) { + fileTypeFound = true; + } + + if (isEmbedded.getClass().equals(java.io.File.class) + || isEmbedded.getClass().equals(Integer.class) + || isEmbedded.getClass().equals(String.class) + || isEmbedded.getClass().isEnum()) { + map.put("is_embedded", isEmbedded); + } else if (isListOfFile(isEmbedded)) { + for (int i = 0; i < getListSize(isEmbedded); i++) { + map.put("is_embedded[" + i + "]", getFromList(isEmbedded, i)); + } + } else { + map.put( + "is_embedded", + JSON.getDefault().getMapper().writeValueAsString(isEmbedded)); + } + } if (customFields != null) { if (isFileTypeOrListOfFiles(customFields)) { fileTypeFound = true; @@ -858,24 +946,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(namedFormFields)); } } - if (accounts != null) { - if (isFileTypeOrListOfFiles(accounts)) { - fileTypeFound = true; - } - - if (accounts.getClass().equals(java.io.File.class) - || accounts.getClass().equals(Integer.class) - || accounts.getClass().equals(String.class) - || accounts.getClass().isEnum()) { - map.put("accounts", accounts); - } else if (isListOfFile(accounts)) { - for (int i = 0; i < getListSize(accounts); i++) { - map.put("accounts[" + i + "]", getFromList(accounts, i)); - } - } else { - map.put("accounts", JSON.getDefault().getMapper().writeValueAsString(accounts)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java index 901e4be34..8397c2dc6 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java @@ -26,11 +26,11 @@ /** TemplateResponseAccount */ @JsonPropertyOrder({ TemplateResponseAccount.JSON_PROPERTY_ACCOUNT_ID, - TemplateResponseAccount.JSON_PROPERTY_EMAIL_ADDRESS, TemplateResponseAccount.JSON_PROPERTY_IS_LOCKED, TemplateResponseAccount.JSON_PROPERTY_IS_PAID_HS, TemplateResponseAccount.JSON_PROPERTY_IS_PAID_HF, - TemplateResponseAccount.JSON_PROPERTY_QUOTAS + TemplateResponseAccount.JSON_PROPERTY_QUOTAS, + TemplateResponseAccount.JSON_PROPERTY_EMAIL_ADDRESS }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -40,9 +40,6 @@ public class TemplateResponseAccount { 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; @@ -55,6 +52,9 @@ public class TemplateResponseAccount { public static final String JSON_PROPERTY_QUOTAS = "quotas"; private TemplateResponseAccountQuota quotas; + public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + private String emailAddress; + public TemplateResponseAccount() {} /** @@ -82,40 +82,19 @@ public TemplateResponseAccount 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 TemplateResponseAccount 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 TemplateResponseAccount isLocked(Boolean isLocked) { this.isLocked = isLocked; return this; @@ -126,14 +105,15 @@ public TemplateResponseAccount 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; } @@ -148,14 +128,15 @@ public TemplateResponseAccount 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; } @@ -170,14 +151,15 @@ public TemplateResponseAccount 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; } @@ -192,18 +174,41 @@ public TemplateResponseAccount quotas(TemplateResponseAccountQuota 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 TemplateResponseAccountQuota getQuotas() { return quotas; } @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setQuotas(TemplateResponseAccountQuota quotas) { this.quotas = quotas; } + public TemplateResponseAccount 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; + } + /** Return true if this TemplateResponseAccount object is equal to o. */ @Override public boolean equals(Object o) { @@ -215,16 +220,16 @@ public boolean equals(Object o) { } TemplateResponseAccount templateResponseAccount = (TemplateResponseAccount) o; return Objects.equals(this.accountId, templateResponseAccount.accountId) - && Objects.equals(this.emailAddress, templateResponseAccount.emailAddress) && Objects.equals(this.isLocked, templateResponseAccount.isLocked) && Objects.equals(this.isPaidHs, templateResponseAccount.isPaidHs) && Objects.equals(this.isPaidHf, templateResponseAccount.isPaidHf) - && Objects.equals(this.quotas, templateResponseAccount.quotas); + && Objects.equals(this.quotas, templateResponseAccount.quotas) + && Objects.equals(this.emailAddress, templateResponseAccount.emailAddress); } @Override public int hashCode() { - return Objects.hash(accountId, emailAddress, isLocked, isPaidHs, isPaidHf, quotas); + return Objects.hash(accountId, isLocked, isPaidHs, isPaidHf, quotas, emailAddress); } @Override @@ -232,11 +237,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseAccount {\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("}"); return sb.toString(); } @@ -265,26 +270,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; @@ -363,6 +348,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)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java index 0ebdbe2a4..37e680526 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java @@ -79,14 +79,15 @@ public TemplateResponseAccountQuota templatesLeft(Integer templatesLeft) { * * @return templatesLeft */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getTemplatesLeft() { return templatesLeft; } @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplatesLeft(Integer templatesLeft) { this.templatesLeft = templatesLeft; } @@ -101,14 +102,15 @@ public TemplateResponseAccountQuota apiSignatureRequestsLeft(Integer apiSignatur * * @return apiSignatureRequestsLeft */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getApiSignatureRequestsLeft() { return apiSignatureRequestsLeft; } @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiSignatureRequestsLeft(Integer apiSignatureRequestsLeft) { this.apiSignatureRequestsLeft = apiSignatureRequestsLeft; } @@ -123,14 +125,15 @@ public TemplateResponseAccountQuota documentsLeft(Integer documentsLeft) { * * @return documentsLeft */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getDocumentsLeft() { return documentsLeft; } @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setDocumentsLeft(Integer documentsLeft) { this.documentsLeft = documentsLeft; } @@ -145,14 +148,15 @@ public TemplateResponseAccountQuota smsVerificationsLeft(Integer smsVerification * * @return smsVerificationsLeft */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getSmsVerificationsLeft() { return smsVerificationsLeft; } @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSmsVerificationsLeft(Integer smsVerificationsLeft) { this.smsVerificationsLeft = smsVerificationsLeft; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java index e4a7d7377..d360b16dc 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java @@ -60,14 +60,15 @@ public TemplateResponseCCRole name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java index de32fb5ac..a76ceca5d 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java @@ -28,11 +28,11 @@ /** TemplateResponseDocument */ @JsonPropertyOrder({ TemplateResponseDocument.JSON_PROPERTY_NAME, - TemplateResponseDocument.JSON_PROPERTY_INDEX, TemplateResponseDocument.JSON_PROPERTY_FIELD_GROUPS, TemplateResponseDocument.JSON_PROPERTY_FORM_FIELDS, TemplateResponseDocument.JSON_PROPERTY_CUSTOM_FIELDS, - TemplateResponseDocument.JSON_PROPERTY_STATIC_FIELDS + TemplateResponseDocument.JSON_PROPERTY_STATIC_FIELDS, + TemplateResponseDocument.JSON_PROPERTY_INDEX }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -42,20 +42,20 @@ public class TemplateResponseDocument { public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_INDEX = "index"; - private Integer index; - public static final String JSON_PROPERTY_FIELD_GROUPS = "field_groups"; - private List fieldGroups = null; + private List fieldGroups = new ArrayList<>(); public static final String JSON_PROPERTY_FORM_FIELDS = "form_fields"; - private List formFields = null; + private List formFields = new ArrayList<>(); public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; - private List customFields = null; + private List customFields = new ArrayList<>(); public static final String JSON_PROPERTY_STATIC_FIELDS = "static_fields"; - private List staticFields = null; + private List staticFields = new ArrayList<>(); + + public static final String JSON_PROPERTY_INDEX = "index"; + private Integer index; public TemplateResponseDocument() {} @@ -85,41 +85,19 @@ public TemplateResponseDocument name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } - public TemplateResponseDocument index(Integer index) { - this.index = index; - return this; - } - - /** - * Document ordering, the lowest index is displayed first and the highest last (0-based - * indexing). - * - * @return index - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_INDEX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Integer getIndex() { - return index; - } - - @JsonProperty(JSON_PROPERTY_INDEX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIndex(Integer index) { - this.index = index; - } - public TemplateResponseDocument fieldGroups( List fieldGroups) { this.fieldGroups = fieldGroups; @@ -140,14 +118,15 @@ public TemplateResponseDocument addFieldGroupsItem( * * @return fieldGroups */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getFieldGroups() { return fieldGroups; } @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFieldGroups(List fieldGroups) { this.fieldGroups = fieldGroups; } @@ -172,14 +151,15 @@ public TemplateResponseDocument addFormFieldsItem( * * @return formFields */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FORM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FORM_FIELDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getFormFields() { return formFields; } @JsonProperty(JSON_PROPERTY_FORM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFormFields(List formFields) { this.formFields = formFields; } @@ -204,14 +184,15 @@ public TemplateResponseDocument addCustomFieldsItem( * * @return customFields */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getCustomFields() { return customFields; } @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCustomFields(List customFields) { this.customFields = customFields; } @@ -237,18 +218,42 @@ public TemplateResponseDocument addStaticFieldsItem( * * @return staticFields */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getStaticFields() { return staticFields; } @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setStaticFields(List staticFields) { this.staticFields = staticFields; } + public TemplateResponseDocument index(Integer index) { + this.index = index; + return this; + } + + /** + * Document ordering, the lowest index is displayed first and the highest last (0-based + * indexing). + * + * @return index + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_INDEX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Integer getIndex() { + return index; + } + + @JsonProperty(JSON_PROPERTY_INDEX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIndex(Integer index) { + this.index = index; + } + /** Return true if this TemplateResponseDocument object is equal to o. */ @Override public boolean equals(Object o) { @@ -260,16 +265,16 @@ public boolean equals(Object o) { } TemplateResponseDocument templateResponseDocument = (TemplateResponseDocument) o; return Objects.equals(this.name, templateResponseDocument.name) - && Objects.equals(this.index, templateResponseDocument.index) && Objects.equals(this.fieldGroups, templateResponseDocument.fieldGroups) && Objects.equals(this.formFields, templateResponseDocument.formFields) && Objects.equals(this.customFields, templateResponseDocument.customFields) - && Objects.equals(this.staticFields, templateResponseDocument.staticFields); + && Objects.equals(this.staticFields, templateResponseDocument.staticFields) + && Objects.equals(this.index, templateResponseDocument.index); } @Override public int hashCode() { - return Objects.hash(name, index, fieldGroups, formFields, customFields, staticFields); + return Objects.hash(name, fieldGroups, formFields, customFields, staticFields, index); } @Override @@ -277,11 +282,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocument {\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" index: ").append(toIndentedString(index)).append("\n"); sb.append(" fieldGroups: ").append(toIndentedString(fieldGroups)).append("\n"); sb.append(" formFields: ").append(toIndentedString(formFields)).append("\n"); sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); sb.append(" staticFields: ").append(toIndentedString(staticFields)).append("\n"); + sb.append(" index: ").append(toIndentedString(index)).append("\n"); sb.append("}"); return sb.toString(); } @@ -308,24 +313,6 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } - if (index != null) { - if (isFileTypeOrListOfFiles(index)) { - fileTypeFound = true; - } - - if (index.getClass().equals(java.io.File.class) - || index.getClass().equals(Integer.class) - || index.getClass().equals(String.class) - || index.getClass().isEnum()) { - map.put("index", index); - } else if (isListOfFile(index)) { - for (int i = 0; i < getListSize(index); i++) { - map.put("index[" + i + "]", getFromList(index, i)); - } - } else { - map.put("index", JSON.getDefault().getMapper().writeValueAsString(index)); - } - } if (fieldGroups != null) { if (isFileTypeOrListOfFiles(fieldGroups)) { fileTypeFound = true; @@ -406,6 +393,24 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(staticFields)); } } + if (index != null) { + if (isFileTypeOrListOfFiles(index)) { + fileTypeFound = true; + } + + if (index.getClass().equals(java.io.File.class) + || index.getClass().equals(Integer.class) + || index.getClass().equals(String.class) + || index.getClass().isEnum()) { + map.put("index", index); + } else if (isListOfFile(index)) { + for (int i = 0; i < getListSize(index); i++) { + map.put("index[" + i + "]", getFromList(index, i)); + } + } else { + map.put("index", JSON.getDefault().getMapper().writeValueAsString(index)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java index d6c0d010c..1458076c7 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java @@ -27,15 +27,15 @@ /** An array of Form Field objects containing the name and type of each named field. */ @JsonPropertyOrder({ - TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_NAME, - TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_SIGNER, + TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_Y, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_WIDTH, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_HEIGHT, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_REQUIRED, + TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_GROUP }) @javax.annotation.Generated( @@ -56,17 +56,14 @@ @JsonSubTypes.Type(value = TemplateResponseDocumentCustomFieldText.class, name = "text"), }) public class TemplateResponseDocumentCustomFieldBase { - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_SIGNER = "signer"; - private String signer; + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; public static final String JSON_PROPERTY_X = "x"; private Integer x; @@ -83,6 +80,9 @@ public class TemplateResponseDocumentCustomFieldBase { public static final String JSON_PROPERTY_REQUIRED = "required"; private Boolean required; + public static final String JSON_PROPERTY_SIGNER = "signer"; + private String signer; + public static final String JSON_PROPERTY_GROUP = "group"; private String group; @@ -105,29 +105,6 @@ public static TemplateResponseDocumentCustomFieldBase init(HashMap data) throws TemplateResponseDocumentCustomFieldBase.class); } - public TemplateResponseDocumentCustomFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * - * @return type - */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public String getType() { - return type; - } - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - public TemplateResponseDocumentCustomFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -138,14 +115,15 @@ public TemplateResponseDocumentCustomFieldBase apiId(String apiId) { * * @return apiId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_API_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getApiId() { return apiId; } @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -160,48 +138,40 @@ public TemplateResponseDocumentCustomFieldBase name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } - public TemplateResponseDocumentCustomFieldBase signer(String signer) { - this.signer = signer; - return this; - } - - public TemplateResponseDocumentCustomFieldBase signer(Integer signer) { - this.signer = String.valueOf(signer); + public TemplateResponseDocumentCustomFieldBase type(String type) { + this.type = type; return this; } /** - * The signer of the Custom Field. Can be `null` if field is a merge field (assigned - * to Sender). + * Get type * - * @return signer + * @return type */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getSigner() { - return signer; - } - - @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigner(String signer) { - this.signer = signer; + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getType() { + return type; } - public void setSigner(Integer signer) { - this.signer = String.valueOf(signer); + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; } public TemplateResponseDocumentCustomFieldBase x(Integer x) { @@ -214,14 +184,15 @@ public TemplateResponseDocumentCustomFieldBase x(Integer x) { * * @return x */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_X) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getX() { return x; } @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setX(Integer x) { this.x = x; } @@ -236,14 +207,15 @@ public TemplateResponseDocumentCustomFieldBase y(Integer y) { * * @return y */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_Y) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getY() { return y; } @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setY(Integer y) { this.y = y; } @@ -258,14 +230,15 @@ public TemplateResponseDocumentCustomFieldBase width(Integer width) { * * @return width */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_WIDTH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getWidth() { return width; } @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setWidth(Integer width) { this.width = width; } @@ -280,14 +253,15 @@ public TemplateResponseDocumentCustomFieldBase height(Integer height) { * * @return height */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_HEIGHT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getHeight() { return height; } @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setHeight(Integer height) { this.height = height; } @@ -302,18 +276,51 @@ public TemplateResponseDocumentCustomFieldBase required(Boolean required) { * * @return required */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_REQUIRED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getRequired() { return required; } @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequired(Boolean required) { this.required = required; } + public TemplateResponseDocumentCustomFieldBase signer(String signer) { + this.signer = signer; + return this; + } + + public TemplateResponseDocumentCustomFieldBase signer(Integer signer) { + this.signer = String.valueOf(signer); + return this; + } + + /** + * The signer of the Custom Field. Can be `null` if field is a merge field (assigned + * to Sender). + * + * @return signer + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getSigner() { + return signer; + } + + @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigner(String signer) { + this.signer = signer; + } + + public void setSigner(Integer signer) { + this.signer = String.valueOf(signer); + } + public TemplateResponseDocumentCustomFieldBase group(String group) { this.group = group; return this; @@ -348,36 +355,36 @@ public boolean equals(Object o) { } TemplateResponseDocumentCustomFieldBase templateResponseDocumentCustomFieldBase = (TemplateResponseDocumentCustomFieldBase) o; - return Objects.equals(this.type, templateResponseDocumentCustomFieldBase.type) - && Objects.equals(this.apiId, templateResponseDocumentCustomFieldBase.apiId) + return Objects.equals(this.apiId, templateResponseDocumentCustomFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentCustomFieldBase.name) - && Objects.equals(this.signer, templateResponseDocumentCustomFieldBase.signer) + && Objects.equals(this.type, templateResponseDocumentCustomFieldBase.type) && Objects.equals(this.x, templateResponseDocumentCustomFieldBase.x) && Objects.equals(this.y, templateResponseDocumentCustomFieldBase.y) && Objects.equals(this.width, templateResponseDocumentCustomFieldBase.width) && Objects.equals(this.height, templateResponseDocumentCustomFieldBase.height) && Objects.equals(this.required, templateResponseDocumentCustomFieldBase.required) + && Objects.equals(this.signer, templateResponseDocumentCustomFieldBase.signer) && Objects.equals(this.group, templateResponseDocumentCustomFieldBase.group); } @Override public int hashCode() { - return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); + return Objects.hash(apiId, name, type, x, y, width, height, required, signer, group); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentCustomFieldBase {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); sb.append(" width: ").append(toIndentedString(width)).append("\n"); sb.append(" height: ").append(toIndentedString(height)).append("\n"); sb.append(" required: ").append(toIndentedString(required)).append("\n"); + sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); @@ -387,24 +394,6 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) - || type.getClass().equals(Integer.class) - || type.getClass().equals(String.class) - || type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for (int i = 0; i < getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -441,22 +430,22 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } - if (signer != null) { - if (isFileTypeOrListOfFiles(signer)) { + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { fileTypeFound = true; } - if (signer.getClass().equals(java.io.File.class) - || signer.getClass().equals(Integer.class) - || signer.getClass().equals(String.class) - || signer.getClass().isEnum()) { - map.put("signer", signer); - } else if (isListOfFile(signer)) { - for (int i = 0; i < getListSize(signer); i++) { - map.put("signer[" + i + "]", getFromList(signer, i)); + if (type.getClass().equals(java.io.File.class) + || type.getClass().equals(Integer.class) + || type.getClass().equals(String.class) + || type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for (int i = 0; i < getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); } } else { - map.put("signer", JSON.getDefault().getMapper().writeValueAsString(signer)); + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } if (x != null) { @@ -549,6 +538,24 @@ public Map createFormData() throws ApiException { map.put("required", JSON.getDefault().getMapper().writeValueAsString(required)); } } + if (signer != null) { + if (isFileTypeOrListOfFiles(signer)) { + fileTypeFound = true; + } + + if (signer.getClass().equals(java.io.File.class) + || signer.getClass().equals(Integer.class) + || signer.getClass().equals(String.class) + || signer.getClass().isEnum()) { + map.put("signer", signer); + } else if (isListOfFile(signer)) { + for (int i = 0; i < getListSize(signer); i++) { + map.put("signer[" + i + "]", getFromList(signer, i)); + } + } else { + map.put("signer", JSON.getDefault().getMapper().writeValueAsString(signer)); + } + } if (group != null) { if (isFileTypeOrListOfFiles(group)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java index e915dc017..7fdf99be8 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java @@ -115,14 +115,15 @@ public TemplateResponseDocumentCustomFieldText avgTextLength( * * @return avgTextLength */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; } @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -137,14 +138,15 @@ public TemplateResponseDocumentCustomFieldText isMultiline(Boolean isMultiline) * * @return isMultiline */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_MULTILINE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsMultiline() { return isMultiline; } @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -159,14 +161,15 @@ public TemplateResponseDocumentCustomFieldText originalFontSize(Integer original * * @return originalFontSize */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getOriginalFontSize() { return originalFontSize; } @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -181,14 +184,15 @@ public TemplateResponseDocumentCustomFieldText fontFamily(String fontFamily) { * * @return fontFamily */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FONT_FAMILY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getFontFamily() { return fontFamily; } @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java index 27dd50e83..b362998bf 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java @@ -67,14 +67,15 @@ public TemplateResponseDocumentFieldGroup name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } @@ -89,14 +90,15 @@ public TemplateResponseDocumentFieldGroup rule(TemplateResponseDocumentFieldGrou * * @return rule */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_RULE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_RULE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseDocumentFieldGroupRule getRule() { return rule; } @JsonProperty(JSON_PROPERTY_RULE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRule(TemplateResponseDocumentFieldGroupRule rule) { this.rule = rule; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java index 0fa796c46..fd8e15836 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java @@ -75,14 +75,15 @@ public TemplateResponseDocumentFieldGroupRule requirement(String requirement) { * * @return requirement */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIREMENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_REQUIREMENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getRequirement() { return requirement; } @JsonProperty(JSON_PROPERTY_REQUIREMENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequirement(String requirement) { this.requirement = requirement; } @@ -97,14 +98,15 @@ public TemplateResponseDocumentFieldGroupRule groupLabel(String groupLabel) { * * @return groupLabel */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP_LABEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_GROUP_LABEL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getGroupLabel() { return groupLabel; } @JsonProperty(JSON_PROPERTY_GROUP_LABEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setGroupLabel(String groupLabel) { this.groupLabel = groupLabel; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java index 86b997464..56639bb69 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java @@ -27,16 +27,15 @@ /** An array of Form Field objects containing the name and type of each named field. */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_NAME, + TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_Y, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_WIDTH, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_HEIGHT, - TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_REQUIRED, - TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_GROUP + TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_REQUIRED }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -66,15 +65,15 @@ @JsonSubTypes.Type(value = TemplateResponseDocumentFormFieldText.class, name = "text"), }) public class TemplateResponseDocumentFormFieldBase { - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + public static final String JSON_PROPERTY_SIGNER = "signer"; private String signer; @@ -93,9 +92,6 @@ public class TemplateResponseDocumentFormFieldBase { public static final String JSON_PROPERTY_REQUIRED = "required"; private Boolean required; - public static final String JSON_PROPERTY_GROUP = "group"; - private String group; - public TemplateResponseDocumentFormFieldBase() {} /** @@ -114,29 +110,6 @@ public static TemplateResponseDocumentFormFieldBase init(HashMap data) throws Ex TemplateResponseDocumentFormFieldBase.class); } - public TemplateResponseDocumentFormFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * - * @return type - */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public String getType() { - return type; - } - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - public TemplateResponseDocumentFormFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -147,14 +120,15 @@ public TemplateResponseDocumentFormFieldBase apiId(String apiId) { * * @return apiId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_API_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getApiId() { return apiId; } @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -169,18 +143,42 @@ public TemplateResponseDocumentFormFieldBase name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } + public TemplateResponseDocumentFormFieldBase type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * + * @return type + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getType() { + return type; + } + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; + } + public TemplateResponseDocumentFormFieldBase signer(String signer) { this.signer = signer; return this; @@ -196,14 +194,15 @@ public TemplateResponseDocumentFormFieldBase signer(Integer signer) { * * @return signer */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSigner() { return signer; } @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSigner(String signer) { this.signer = signer; } @@ -222,14 +221,15 @@ public TemplateResponseDocumentFormFieldBase x(Integer x) { * * @return x */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_X) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getX() { return x; } @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setX(Integer x) { this.x = x; } @@ -244,14 +244,15 @@ public TemplateResponseDocumentFormFieldBase y(Integer y) { * * @return y */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_Y) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getY() { return y; } @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setY(Integer y) { this.y = y; } @@ -266,14 +267,15 @@ public TemplateResponseDocumentFormFieldBase width(Integer width) { * * @return width */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_WIDTH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getWidth() { return width; } @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setWidth(Integer width) { this.width = width; } @@ -288,14 +290,15 @@ public TemplateResponseDocumentFormFieldBase height(Integer height) { * * @return height */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_HEIGHT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getHeight() { return height; } @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setHeight(Integer height) { this.height = height; } @@ -310,41 +313,19 @@ public TemplateResponseDocumentFormFieldBase required(Boolean required) { * * @return required */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_REQUIRED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getRequired() { return required; } @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequired(Boolean required) { this.required = required; } - public TemplateResponseDocumentFormFieldBase group(String group) { - this.group = group; - return this; - } - - /** - * The name of the group this field is in. If this field is not a group, this defaults to - * `null` except for Radio fields. - * - * @return group - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getGroup() { - return group; - } - - @JsonProperty(JSON_PROPERTY_GROUP) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroup(String group) { - this.group = group; - } - /** Return true if this TemplateResponseDocumentFormFieldBase object is equal to o. */ @Override public boolean equals(Object o) { @@ -356,37 +337,35 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldBase templateResponseDocumentFormFieldBase = (TemplateResponseDocumentFormFieldBase) o; - return Objects.equals(this.type, templateResponseDocumentFormFieldBase.type) - && Objects.equals(this.apiId, templateResponseDocumentFormFieldBase.apiId) + return Objects.equals(this.apiId, templateResponseDocumentFormFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentFormFieldBase.name) + && Objects.equals(this.type, templateResponseDocumentFormFieldBase.type) && Objects.equals(this.signer, templateResponseDocumentFormFieldBase.signer) && Objects.equals(this.x, templateResponseDocumentFormFieldBase.x) && Objects.equals(this.y, templateResponseDocumentFormFieldBase.y) && Objects.equals(this.width, templateResponseDocumentFormFieldBase.width) && Objects.equals(this.height, templateResponseDocumentFormFieldBase.height) - && Objects.equals(this.required, templateResponseDocumentFormFieldBase.required) - && Objects.equals(this.group, templateResponseDocumentFormFieldBase.group); + && Objects.equals(this.required, templateResponseDocumentFormFieldBase.required); } @Override public int hashCode() { - return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); + return Objects.hash(apiId, name, type, signer, x, y, width, height, required); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentFormFieldBase {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); sb.append(" width: ").append(toIndentedString(width)).append("\n"); sb.append(" height: ").append(toIndentedString(height)).append("\n"); sb.append(" required: ").append(toIndentedString(required)).append("\n"); - sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -395,24 +374,6 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) - || type.getClass().equals(Integer.class) - || type.getClass().equals(String.class) - || type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for (int i = 0; i < getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -449,6 +410,24 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { + fileTypeFound = true; + } + + if (type.getClass().equals(java.io.File.class) + || type.getClass().equals(Integer.class) + || type.getClass().equals(String.class) + || type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for (int i = 0; i < getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); + } + } else { + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + } + } if (signer != null) { if (isFileTypeOrListOfFiles(signer)) { fileTypeFound = true; @@ -557,24 +536,6 @@ public Map createFormData() throws ApiException { map.put("required", JSON.getDefault().getMapper().writeValueAsString(required)); } } - if (group != null) { - if (isFileTypeOrListOfFiles(group)) { - fileTypeFound = true; - } - - if (group.getClass().equals(java.io.File.class) - || group.getClass().equals(Integer.class) - || group.getClass().equals(String.class) - || group.getClass().isEnum()) { - map.put("group", group); - } else if (isListOfFile(group)) { - for (int i = 0; i < getListSize(group); i++) { - map.put("group[" + i + "]", getFromList(group, i)); - } - } else { - map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java index e7469c5a5..b291ffdd8 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java @@ -25,7 +25,10 @@ import java.util.Objects; /** This class extends `TemplateResponseDocumentFormFieldBase` */ -@JsonPropertyOrder({TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_TYPE}) +@JsonPropertyOrder({ + TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_GROUP +}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -42,6 +45,9 @@ public class TemplateResponseDocumentFormFieldCheckbox public static final String JSON_PROPERTY_TYPE = "type"; private String type = "checkbox"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldCheckbox() {} /** @@ -92,6 +98,29 @@ public void setType(String type) { this.type = type; } + public TemplateResponseDocumentFormFieldCheckbox group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldCheckbox object is equal to o. */ @Override public boolean equals(Object o) { @@ -104,12 +133,13 @@ public boolean equals(Object o) { TemplateResponseDocumentFormFieldCheckbox templateResponseDocumentFormFieldCheckbox = (TemplateResponseDocumentFormFieldCheckbox) o; return Objects.equals(this.type, templateResponseDocumentFormFieldCheckbox.type) + && Objects.equals(this.group, templateResponseDocumentFormFieldCheckbox.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -118,6 +148,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldCheckbox {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -145,6 +176,24 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java index 47a664adb..b43906f05 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java @@ -25,7 +25,10 @@ import java.util.Objects; /** This class extends `TemplateResponseDocumentFormFieldBase` */ -@JsonPropertyOrder({TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_TYPE}) +@JsonPropertyOrder({ + TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_GROUP +}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -42,6 +45,9 @@ public class TemplateResponseDocumentFormFieldDateSigned public static final String JSON_PROPERTY_TYPE = "type"; private String type = "date_signed"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldDateSigned() {} /** @@ -93,6 +99,29 @@ public void setType(String type) { this.type = type; } + public TemplateResponseDocumentFormFieldDateSigned group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldDateSigned object is equal to o. */ @Override public boolean equals(Object o) { @@ -105,12 +134,13 @@ public boolean equals(Object o) { TemplateResponseDocumentFormFieldDateSigned templateResponseDocumentFormFieldDateSigned = (TemplateResponseDocumentFormFieldDateSigned) o; return Objects.equals(this.type, templateResponseDocumentFormFieldDateSigned.type) + && Objects.equals(this.group, templateResponseDocumentFormFieldDateSigned.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -119,6 +149,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldDateSigned {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -146,6 +177,24 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java index 548aebe5a..1c6289c42 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java @@ -25,7 +25,10 @@ import java.util.Objects; /** This class extends `TemplateResponseDocumentFormFieldBase` */ -@JsonPropertyOrder({TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_TYPE}) +@JsonPropertyOrder({ + TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_GROUP +}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -42,6 +45,9 @@ public class TemplateResponseDocumentFormFieldDropdown public static final String JSON_PROPERTY_TYPE = "type"; private String type = "dropdown"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldDropdown() {} /** @@ -92,6 +98,29 @@ public void setType(String type) { this.type = type; } + public TemplateResponseDocumentFormFieldDropdown group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldDropdown object is equal to o. */ @Override public boolean equals(Object o) { @@ -104,12 +133,13 @@ public boolean equals(Object o) { TemplateResponseDocumentFormFieldDropdown templateResponseDocumentFormFieldDropdown = (TemplateResponseDocumentFormFieldDropdown) o; return Objects.equals(this.type, templateResponseDocumentFormFieldDropdown.type) + && Objects.equals(this.group, templateResponseDocumentFormFieldDropdown.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -118,6 +148,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldDropdown {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -145,6 +176,24 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java index 71ed8a6b1..c42b580b3 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java @@ -30,7 +30,8 @@ TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_AVG_TEXT_LENGTH, TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_IS_MULTILINE, TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_ORIGINAL_FONT_SIZE, - TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_FONT_FAMILY + TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_FONT_FAMILY, + TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_GROUP }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -60,6 +61,9 @@ public class TemplateResponseDocumentFormFieldHyperlink public static final String JSON_PROPERTY_FONT_FAMILY = "fontFamily"; private String fontFamily; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldHyperlink() {} /** @@ -122,14 +126,15 @@ public TemplateResponseDocumentFormFieldHyperlink avgTextLength( * * @return avgTextLength */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; } @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -144,14 +149,15 @@ public TemplateResponseDocumentFormFieldHyperlink isMultiline(Boolean isMultilin * * @return isMultiline */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_MULTILINE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsMultiline() { return isMultiline; } @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -166,14 +172,15 @@ public TemplateResponseDocumentFormFieldHyperlink originalFontSize(Integer origi * * @return originalFontSize */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getOriginalFontSize() { return originalFontSize; } @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -188,18 +195,42 @@ public TemplateResponseDocumentFormFieldHyperlink fontFamily(String fontFamily) * * @return fontFamily */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FONT_FAMILY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getFontFamily() { return fontFamily; } @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } + public TemplateResponseDocumentFormFieldHyperlink group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldHyperlink object is equal to o. */ @Override public boolean equals(Object o) { @@ -222,13 +253,20 @@ public boolean equals(Object o) { templateResponseDocumentFormFieldHyperlink.originalFontSize) && Objects.equals( this.fontFamily, templateResponseDocumentFormFieldHyperlink.fontFamily) + && Objects.equals(this.group, templateResponseDocumentFormFieldHyperlink.group) && super.equals(o); } @Override public int hashCode() { return Objects.hash( - type, avgTextLength, isMultiline, originalFontSize, fontFamily, super.hashCode()); + type, + avgTextLength, + isMultiline, + originalFontSize, + fontFamily, + group, + super.hashCode()); } @Override @@ -241,6 +279,7 @@ public String toString() { sb.append(" isMultiline: ").append(toIndentedString(isMultiline)).append("\n"); sb.append(" originalFontSize: ").append(toIndentedString(originalFontSize)).append("\n"); sb.append(" fontFamily: ").append(toIndentedString(fontFamily)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -348,6 +387,24 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(fontFamily)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java index b2a1c740b..17bc3553e 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java @@ -25,7 +25,10 @@ import java.util.Objects; /** This class extends `TemplateResponseDocumentFormFieldBase` */ -@JsonPropertyOrder({TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_TYPE}) +@JsonPropertyOrder({ + TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_GROUP +}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -42,6 +45,9 @@ public class TemplateResponseDocumentFormFieldInitials public static final String JSON_PROPERTY_TYPE = "type"; private String type = "initials"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldInitials() {} /** @@ -92,6 +98,29 @@ public void setType(String type) { this.type = type; } + public TemplateResponseDocumentFormFieldInitials group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldInitials object is equal to o. */ @Override public boolean equals(Object o) { @@ -104,12 +133,13 @@ public boolean equals(Object o) { TemplateResponseDocumentFormFieldInitials templateResponseDocumentFormFieldInitials = (TemplateResponseDocumentFormFieldInitials) o; return Objects.equals(this.type, templateResponseDocumentFormFieldInitials.type) + && Objects.equals(this.group, templateResponseDocumentFormFieldInitials.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -118,6 +148,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldInitials {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -145,6 +176,24 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java index a9f10772c..75b7a72ad 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java @@ -25,7 +25,10 @@ import java.util.Objects; /** This class extends `TemplateResponseDocumentFormFieldBase` */ -@JsonPropertyOrder({TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_TYPE}) +@JsonPropertyOrder({ + TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_GROUP +}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -41,6 +44,9 @@ public class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocu public static final String JSON_PROPERTY_TYPE = "type"; private String type = "radio"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldRadio() {} /** @@ -90,6 +96,30 @@ public void setType(String type) { this.type = type; } + public TemplateResponseDocumentFormFieldRadio group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldRadio object is equal to o. */ @Override public boolean equals(Object o) { @@ -102,12 +132,13 @@ public boolean equals(Object o) { TemplateResponseDocumentFormFieldRadio templateResponseDocumentFormFieldRadio = (TemplateResponseDocumentFormFieldRadio) o; return Objects.equals(this.type, templateResponseDocumentFormFieldRadio.type) + && Objects.equals(this.group, templateResponseDocumentFormFieldRadio.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -116,6 +147,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldRadio {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -143,6 +175,24 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java index 4155ba402..15630a485 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java @@ -25,7 +25,10 @@ import java.util.Objects; /** This class extends `TemplateResponseDocumentFormFieldBase` */ -@JsonPropertyOrder({TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_TYPE}) +@JsonPropertyOrder({ + TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_GROUP +}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -42,6 +45,9 @@ public class TemplateResponseDocumentFormFieldSignature public static final String JSON_PROPERTY_TYPE = "type"; private String type = "signature"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldSignature() {} /** @@ -93,6 +99,29 @@ public void setType(String type) { this.type = type; } + public TemplateResponseDocumentFormFieldSignature group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldSignature object is equal to o. */ @Override public boolean equals(Object o) { @@ -105,12 +134,13 @@ public boolean equals(Object o) { TemplateResponseDocumentFormFieldSignature templateResponseDocumentFormFieldSignature = (TemplateResponseDocumentFormFieldSignature) o; return Objects.equals(this.type, templateResponseDocumentFormFieldSignature.type) + && Objects.equals(this.group, templateResponseDocumentFormFieldSignature.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -119,6 +149,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldSignature {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -146,6 +177,24 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java index 070454b47..e7176f5ea 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java @@ -33,7 +33,8 @@ TemplateResponseDocumentFormFieldText.JSON_PROPERTY_IS_MULTILINE, TemplateResponseDocumentFormFieldText.JSON_PROPERTY_ORIGINAL_FONT_SIZE, TemplateResponseDocumentFormFieldText.JSON_PROPERTY_FONT_FAMILY, - TemplateResponseDocumentFormFieldText.JSON_PROPERTY_VALIDATION_TYPE + TemplateResponseDocumentFormFieldText.JSON_PROPERTY_VALIDATION_TYPE, + TemplateResponseDocumentFormFieldText.JSON_PROPERTY_GROUP }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -118,6 +119,9 @@ public static ValidationTypeEnum fromValue(String value) { public static final String JSON_PROPERTY_VALIDATION_TYPE = "validation_type"; private ValidationTypeEnum validationType; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldText() {} /** @@ -178,14 +182,15 @@ public TemplateResponseDocumentFormFieldText avgTextLength( * * @return avgTextLength */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; } @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -200,14 +205,15 @@ public TemplateResponseDocumentFormFieldText isMultiline(Boolean isMultiline) { * * @return isMultiline */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_MULTILINE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsMultiline() { return isMultiline; } @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -222,14 +228,15 @@ public TemplateResponseDocumentFormFieldText originalFontSize(Integer originalFo * * @return originalFontSize */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getOriginalFontSize() { return originalFontSize; } @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -244,14 +251,15 @@ public TemplateResponseDocumentFormFieldText fontFamily(String fontFamily) { * * @return fontFamily */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FONT_FAMILY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getFontFamily() { return fontFamily; } @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } @@ -280,6 +288,29 @@ public void setValidationType(ValidationTypeEnum validationType) { this.validationType = validationType; } + public TemplateResponseDocumentFormFieldText group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldText object is equal to o. */ @Override public boolean equals(Object o) { @@ -302,6 +333,7 @@ public boolean equals(Object o) { && Objects.equals(this.fontFamily, templateResponseDocumentFormFieldText.fontFamily) && Objects.equals( this.validationType, templateResponseDocumentFormFieldText.validationType) + && Objects.equals(this.group, templateResponseDocumentFormFieldText.group) && super.equals(o); } @@ -314,6 +346,7 @@ public int hashCode() { originalFontSize, fontFamily, validationType, + group, super.hashCode()); } @@ -328,6 +361,7 @@ public String toString() { sb.append(" originalFontSize: ").append(toIndentedString(originalFontSize)).append("\n"); sb.append(" fontFamily: ").append(toIndentedString(fontFamily)).append("\n"); sb.append(" validationType: ").append(toIndentedString(validationType)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -455,6 +489,24 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(validationType)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java index 164ee218b..6595dccd8 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java @@ -29,9 +29,9 @@ * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. */ @JsonPropertyOrder({ - TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_NAME, + TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_Y, @@ -74,15 +74,15 @@ @JsonSubTypes.Type(value = TemplateResponseDocumentStaticFieldText.class, name = "text"), }) public class TemplateResponseDocumentStaticFieldBase { - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + public static final String JSON_PROPERTY_SIGNER = "signer"; private String signer = "me_now"; @@ -123,29 +123,6 @@ public static TemplateResponseDocumentStaticFieldBase init(HashMap data) throws TemplateResponseDocumentStaticFieldBase.class); } - public TemplateResponseDocumentStaticFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * - * @return type - */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public String getType() { - return type; - } - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - public TemplateResponseDocumentStaticFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -156,14 +133,15 @@ public TemplateResponseDocumentStaticFieldBase apiId(String apiId) { * * @return apiId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_API_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getApiId() { return apiId; } @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -178,18 +156,42 @@ public TemplateResponseDocumentStaticFieldBase name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } + public TemplateResponseDocumentStaticFieldBase type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * + * @return type + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getType() { + return type; + } + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; + } + public TemplateResponseDocumentStaticFieldBase signer(String signer) { this.signer = signer; return this; @@ -200,14 +202,15 @@ public TemplateResponseDocumentStaticFieldBase signer(String signer) { * * @return signer */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSigner() { return signer; } @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSigner(String signer) { this.signer = signer; } @@ -222,14 +225,15 @@ public TemplateResponseDocumentStaticFieldBase x(Integer x) { * * @return x */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_X) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getX() { return x; } @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setX(Integer x) { this.x = x; } @@ -244,14 +248,15 @@ public TemplateResponseDocumentStaticFieldBase y(Integer y) { * * @return y */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_Y) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getY() { return y; } @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setY(Integer y) { this.y = y; } @@ -266,14 +271,15 @@ public TemplateResponseDocumentStaticFieldBase width(Integer width) { * * @return width */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_WIDTH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getWidth() { return width; } @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setWidth(Integer width) { this.width = width; } @@ -288,14 +294,15 @@ public TemplateResponseDocumentStaticFieldBase height(Integer height) { * * @return height */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_HEIGHT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getHeight() { return height; } @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setHeight(Integer height) { this.height = height; } @@ -310,14 +317,15 @@ public TemplateResponseDocumentStaticFieldBase required(Boolean required) { * * @return required */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_REQUIRED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getRequired() { return required; } @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequired(Boolean required) { this.required = required; } @@ -356,9 +364,9 @@ public boolean equals(Object o) { } TemplateResponseDocumentStaticFieldBase templateResponseDocumentStaticFieldBase = (TemplateResponseDocumentStaticFieldBase) o; - return Objects.equals(this.type, templateResponseDocumentStaticFieldBase.type) - && Objects.equals(this.apiId, templateResponseDocumentStaticFieldBase.apiId) + return Objects.equals(this.apiId, templateResponseDocumentStaticFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentStaticFieldBase.name) + && Objects.equals(this.type, templateResponseDocumentStaticFieldBase.type) && Objects.equals(this.signer, templateResponseDocumentStaticFieldBase.signer) && Objects.equals(this.x, templateResponseDocumentStaticFieldBase.x) && Objects.equals(this.y, templateResponseDocumentStaticFieldBase.y) @@ -370,16 +378,16 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); + return Objects.hash(apiId, name, type, signer, x, y, width, height, required, group); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentStaticFieldBase {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); @@ -395,24 +403,6 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) - || type.getClass().equals(Integer.class) - || type.getClass().equals(String.class) - || type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for (int i = 0; i < getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -449,6 +439,24 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { + fileTypeFound = true; + } + + if (type.getClass().equals(java.io.File.class) + || type.getClass().equals(Integer.class) + || type.getClass().equals(String.class) + || type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for (int i = 0; i < getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); + } + } else { + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + } + } if (signer != null) { if (isFileTypeOrListOfFiles(signer)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java index b5a9afb52..375fc0737 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java @@ -67,14 +67,15 @@ public TemplateResponseFieldAvgTextLength numLines(Integer numLines) { * * @return numLines */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NUM_LINES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NUM_LINES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getNumLines() { return numLines; } @JsonProperty(JSON_PROPERTY_NUM_LINES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setNumLines(Integer numLines) { this.numLines = numLines; } @@ -89,14 +90,15 @@ public TemplateResponseFieldAvgTextLength numCharsPerLine(Integer numCharsPerLin * * @return numCharsPerLine */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getNumCharsPerLine() { return numCharsPerLine; } @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setNumCharsPerLine(Integer numCharsPerLine) { this.numCharsPerLine = numCharsPerLine; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java index 4724f47e5..d6697fef8 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java @@ -67,14 +67,15 @@ public TemplateResponseSignerRole name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java index 08f0784e7..66a058873 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java @@ -69,14 +69,15 @@ public TemplateUpdateFilesResponseTemplate templateId(String templateId) { * * @return templateId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; } @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } diff --git a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 770cce434..224ec6c71 100644 --- a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -8,9 +8,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | -| `editUrl` | ```String``` | Link to edit the template. | | -| `expiresAt` | ```Integer``` | When the link expires. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | +| `editUrl`*_required_ | ```String``` | Link to edit the template. | | +| `expiresAt`*_required_ | ```Integer``` | When the link expires. | | | `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/java-v2/docs/TemplateCreateResponseTemplate.md b/sdks/java-v2/docs/TemplateCreateResponseTemplate.md index 1dcd4bd79..79801d898 100644 --- a/sdks/java-v2/docs/TemplateCreateResponseTemplate.md +++ b/sdks/java-v2/docs/TemplateCreateResponseTemplate.md @@ -8,7 +8,7 @@ Template object with parameters: `template_id`. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | diff --git a/sdks/java-v2/docs/TemplateResponse.md b/sdks/java-v2/docs/TemplateResponse.md index 078685ff1..87d844276 100644 --- a/sdks/java-v2/docs/TemplateResponse.md +++ b/sdks/java-v2/docs/TemplateResponse.md @@ -8,21 +8,22 @@ Contains information about the templates you and your team have created. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | -| `title` | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | +| `title`*_required_ | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message`*_required_ | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `isCreator`*_required_ | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `canEdit`*_required_ | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `isLocked`*_required_ | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata`*_required_ | ```Object``` | The metadata attached to the template. | | +| `signerRoles`*_required_ | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `ccRoles`*_required_ | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | +| `documents`*_required_ | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `accounts`*_required_ | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments`*_required_ | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updatedAt` | ```Integer``` | Time the template was last updated. | | -| `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `isCreator` | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `canEdit` | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `isLocked` | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata` | ```Object``` | The metadata attached to the template. | | -| `signerRoles` | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `ccRoles` | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | | `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | diff --git a/sdks/java-v2/docs/TemplateResponseAccount.md b/sdks/java-v2/docs/TemplateResponseAccount.md index 10c996408..dd8ebce7f 100644 --- a/sdks/java-v2/docs/TemplateResponseAccount.md +++ b/sdks/java-v2/docs/TemplateResponseAccount.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_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.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` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | diff --git a/sdks/java-v2/docs/TemplateResponseAccountQuota.md b/sdks/java-v2/docs/TemplateResponseAccountQuota.md index ad94c2493..72160ca8f 100644 --- a/sdks/java-v2/docs/TemplateResponseAccountQuota.md +++ b/sdks/java-v2/docs/TemplateResponseAccountQuota.md @@ -8,10 +8,10 @@ An array of the designated CC roles that must be specified when sending a Signat | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templatesLeft` | ```Integer``` | API templates remaining. | | -| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | | -| `documentsLeft` | ```Integer``` | Signature requests remaining. | | -| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | +| `templatesLeft`*_required_ | ```Integer``` | API templates remaining. | | +| `apiSignatureRequestsLeft`*_required_ | ```Integer``` | API signature requests remaining. | | +| `documentsLeft`*_required_ | ```Integer``` | Signature requests remaining. | | +| `smsVerificationsLeft`*_required_ | ```Integer``` | SMS verifications remaining. | | diff --git a/sdks/java-v2/docs/TemplateResponseCCRole.md b/sdks/java-v2/docs/TemplateResponseCCRole.md index 64069b826..06e61bff4 100644 --- a/sdks/java-v2/docs/TemplateResponseCCRole.md +++ b/sdks/java-v2/docs/TemplateResponseCCRole.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the Role. | | +| `name`*_required_ | ```String``` | The name of the Role. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocument.md b/sdks/java-v2/docs/TemplateResponseDocument.md index 65da85d42..cb69a481f 100644 --- a/sdks/java-v2/docs/TemplateResponseDocument.md +++ b/sdks/java-v2/docs/TemplateResponseDocument.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | Name of the associated file. | | +| `name`*_required_ | ```String``` | Name of the associated file. | | +| `fieldGroups`*_required_ | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `formFields`*_required_ | [```List```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `customFields`*_required_ | [```List```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `staticFields`*_required_ | [```List```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | | `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `fieldGroups` | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `formFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `staticFields` | [```List```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md index edd461727..c7c7f8264 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md @@ -8,15 +8,15 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| `apiId`*_required_ | ```String``` | The unique ID for this field. | | +| `name`*_required_ | ```String``` | The name of the Custom Field. | | | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | The unique ID for this field. | | -| `name` | ```String``` | The name of the Custom Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | | `signer` | ```String``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md index ccaf19394..70c991777 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md @@ -9,10 +9,10 @@ This class extends `TemplateResponseDocumentCustomFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md index 03b5ffbb8..7dd066f54 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the form field group. | | -| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name`*_required_ | ```String``` | The name of the form field group. | | +| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md index e0f4dcc8a..59d4e5e06 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md @@ -8,8 +8,8 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `requirement` | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `groupLabel` | ```String``` | Name of the group | | +| `requirement`*_required_ | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `groupLabel`*_required_ | ```String``` | Name of the group | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md index 656070ad4..8d8766339 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md @@ -8,16 +8,15 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| `apiId`*_required_ | ```String``` | A unique id for the form field. | | +| `name`*_required_ | ```String``` | The name of the form field. | | | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | A unique id for the form field. | | -| `name` | ```String``` | The name of the form field. | | -| `signer` | ```String``` | The signer of the Form Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `signer`*_required_ | ```String``` | The signer of the Form Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldCheckbox.md index 83d36e0f1..a7f2cadeb 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDateSigned.md index 5ba66eff9..09b45eec7 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDropdown.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDropdown.md index b4f2030fc..70e5da455 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md index 0cf89df5e..104029730 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -9,10 +9,11 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldInitials.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldInitials.md index 707d67ee2..f1fe1f5b5 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldInitials.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldRadio.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldRadio.md index b83d96d53..877b842a2 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldRadio.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group`*_required_ | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldSignature.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldSignature.md index 8be298793..366aaa9b4 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldSignature.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md index 3581d3855..31520bd6f 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md @@ -9,11 +9,12 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | | `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md index 4be3cf070..f52329b04 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md @@ -8,15 +8,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| `apiId`*_required_ | ```String``` | A unique id for the static field. | | +| `name`*_required_ | ```String``` | The name of the static field. | | | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | A unique id for the static field. | | -| `name` | ```String``` | The name of the static field. | | -| `signer` | ```String``` | The signer of the Static Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this static field. | | -| `width` | ```Integer``` | The width in pixels of this static field. | | -| `height` | ```Integer``` | The height in pixels of this static field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `signer`*_required_ | ```String``` | The signer of the Static Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this static field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this static field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this static field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this static field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md b/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md index bb66f3057..f0d2106b0 100644 --- a/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md @@ -8,8 +8,8 @@ Average text length in this field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `numLines` | ```Integer``` | Number of lines. | | -| `numCharsPerLine` | ```Integer``` | Number of characters per line. | | +| `numLines`*_required_ | ```Integer``` | Number of lines. | | +| `numCharsPerLine`*_required_ | ```Integer``` | Number of characters per line. | | diff --git a/sdks/java-v2/docs/TemplateResponseSignerRole.md b/sdks/java-v2/docs/TemplateResponseSignerRole.md index 15b48cf17..08458f4e0 100644 --- a/sdks/java-v2/docs/TemplateResponseSignerRole.md +++ b/sdks/java-v2/docs/TemplateResponseSignerRole.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the Role. | | +| `name`*_required_ | ```String``` | The name of the Role. | | | `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this role. | | diff --git a/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md index 6289a9953..7acdbb340 100644 --- a/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md @@ -8,7 +8,7 @@ Contains template id | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | | `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java index f9c0286ac..d0d6ca141 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java @@ -84,9 +84,9 @@ public TemplateCreateEmbeddedDraftResponseTemplate templateId(String templateId) * The id of the Template. * @return templateId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; @@ -94,7 +94,7 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } @@ -109,9 +109,9 @@ public TemplateCreateEmbeddedDraftResponseTemplate editUrl(String editUrl) { * Link to edit the template. * @return editUrl */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_EDIT_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getEditUrl() { return editUrl; @@ -119,7 +119,7 @@ public String getEditUrl() { @JsonProperty(JSON_PROPERTY_EDIT_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setEditUrl(String editUrl) { this.editUrl = editUrl; } @@ -134,9 +134,9 @@ public TemplateCreateEmbeddedDraftResponseTemplate expiresAt(Integer expiresAt) * When the link expires. * @return expiresAt */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_EXPIRES_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getExpiresAt() { return expiresAt; @@ -144,7 +144,7 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setExpiresAt(Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java index 6d668fd69..d070cfa45 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java @@ -68,9 +68,9 @@ public TemplateCreateResponseTemplate templateId(String templateId) { * The id of the Template. * @return templateId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; @@ -78,7 +78,7 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java index 577975bea..7f664e0d1 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -16,6 +16,7 @@ import java.util.Objects; import java.util.Map; import java.util.HashMap; +import com.dropbox.sign.model.SignatureRequestResponseAttachment; import com.dropbox.sign.model.TemplateResponseAccount; import com.dropbox.sign.model.TemplateResponseCCRole; import com.dropbox.sign.model.TemplateResponseDocument; @@ -44,8 +45,6 @@ TemplateResponse.JSON_PROPERTY_TEMPLATE_ID, TemplateResponse.JSON_PROPERTY_TITLE, TemplateResponse.JSON_PROPERTY_MESSAGE, - TemplateResponse.JSON_PROPERTY_UPDATED_AT, - TemplateResponse.JSON_PROPERTY_IS_EMBEDDED, TemplateResponse.JSON_PROPERTY_IS_CREATOR, TemplateResponse.JSON_PROPERTY_CAN_EDIT, TemplateResponse.JSON_PROPERTY_IS_LOCKED, @@ -53,9 +52,12 @@ TemplateResponse.JSON_PROPERTY_SIGNER_ROLES, TemplateResponse.JSON_PROPERTY_CC_ROLES, TemplateResponse.JSON_PROPERTY_DOCUMENTS, + TemplateResponse.JSON_PROPERTY_ACCOUNTS, + TemplateResponse.JSON_PROPERTY_ATTACHMENTS, + TemplateResponse.JSON_PROPERTY_UPDATED_AT, + TemplateResponse.JSON_PROPERTY_IS_EMBEDDED, TemplateResponse.JSON_PROPERTY_CUSTOM_FIELDS, - TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS, - TemplateResponse.JSON_PROPERTY_ACCOUNTS + TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -69,12 +71,6 @@ public class TemplateResponse { public static final String JSON_PROPERTY_MESSAGE = "message"; private String message; - public static final String JSON_PROPERTY_UPDATED_AT = "updated_at"; - private Integer updatedAt; - - public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; - private Boolean isEmbedded; - public static final String JSON_PROPERTY_IS_CREATOR = "is_creator"; private Boolean isCreator; @@ -88,13 +84,25 @@ public class TemplateResponse { private Object metadata; public static final String JSON_PROPERTY_SIGNER_ROLES = "signer_roles"; - private List signerRoles = null; + private List signerRoles = new ArrayList<>(); public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; - private List ccRoles = null; + private List ccRoles = new ArrayList<>(); public static final String JSON_PROPERTY_DOCUMENTS = "documents"; - private List documents = null; + private List documents = new ArrayList<>(); + + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private List accounts = new ArrayList<>(); + + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + private List attachments = new ArrayList<>(); + + public static final String JSON_PROPERTY_UPDATED_AT = "updated_at"; + private Integer updatedAt; + + public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; + private Boolean isEmbedded; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; @Deprecated @@ -104,9 +112,6 @@ public class TemplateResponse { @Deprecated private List namedFormFields = null; - public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private List accounts = null; - public TemplateResponse() { } @@ -134,9 +139,9 @@ public TemplateResponse templateId(String templateId) { * The id of the Template. * @return templateId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; @@ -144,7 +149,7 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } @@ -159,9 +164,9 @@ public TemplateResponse title(String title) { * The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. * @return title */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TITLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTitle() { return title; @@ -169,7 +174,7 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTitle(String title) { this.title = title; } @@ -184,9 +189,9 @@ public TemplateResponse message(String message) { * The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. * @return message */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_MESSAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getMessage() { return message; @@ -194,62 +199,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setMessage(String message) { this.message = message; } - public TemplateResponse updatedAt(Integer updatedAt) { - this.updatedAt = updatedAt; - return this; - } - - /** - * Time the template was last updated. - * @return updatedAt - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getUpdatedAt() { - return updatedAt; - } - - - @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUpdatedAt(Integer updatedAt) { - this.updatedAt = updatedAt; - } - - - public TemplateResponse isEmbedded(Boolean isEmbedded) { - this.isEmbedded = isEmbedded; - return this; - } - - /** - * `true` if this template was created using an embedded flow, `false` if it was created on our website. - * @return isEmbedded - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getIsEmbedded() { - return isEmbedded; - } - - - @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsEmbedded(Boolean isEmbedded) { - this.isEmbedded = isEmbedded; - } - - public TemplateResponse isCreator(Boolean isCreator) { this.isCreator = isCreator; return this; @@ -259,9 +214,9 @@ public TemplateResponse isCreator(Boolean isCreator) { * `true` if you are the owner of this template, `false` if it's been shared with you by a team member. * @return isCreator */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsCreator() { return isCreator; @@ -269,7 +224,7 @@ public Boolean getIsCreator() { @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsCreator(Boolean isCreator) { this.isCreator = isCreator; } @@ -284,9 +239,9 @@ public TemplateResponse canEdit(Boolean canEdit) { * Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). * @return canEdit */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_CAN_EDIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getCanEdit() { return canEdit; @@ -294,7 +249,7 @@ public Boolean getCanEdit() { @JsonProperty(JSON_PROPERTY_CAN_EDIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCanEdit(Boolean canEdit) { this.canEdit = canEdit; } @@ -309,9 +264,9 @@ public TemplateResponse isLocked(Boolean isLocked) { * Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. * @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; @@ -319,7 +274,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; } @@ -334,9 +289,9 @@ public TemplateResponse metadata(Object metadata) { * The metadata attached to the template. * @return metadata */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_METADATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Object getMetadata() { return metadata; @@ -344,7 +299,7 @@ public Object getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setMetadata(Object metadata) { this.metadata = metadata; } @@ -367,9 +322,9 @@ public TemplateResponse addSignerRolesItem(TemplateResponseSignerRole signerRole * An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. * @return signerRoles */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getSignerRoles() { return signerRoles; @@ -377,7 +332,7 @@ public List getSignerRoles() { @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSignerRoles(List signerRoles) { this.signerRoles = signerRoles; } @@ -400,9 +355,9 @@ public TemplateResponse addCcRolesItem(TemplateResponseCCRole ccRolesItem) { * An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. * @return ccRoles */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_CC_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getCcRoles() { return ccRoles; @@ -410,7 +365,7 @@ public List getCcRoles() { @JsonProperty(JSON_PROPERTY_CC_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCcRoles(List ccRoles) { this.ccRoles = ccRoles; } @@ -433,9 +388,9 @@ public TemplateResponse addDocumentsItem(TemplateResponseDocument documentsItem) * An array describing each document associated with this Template. Includes form field data for each document. * @return documents */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_DOCUMENTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getDocuments() { return documents; @@ -443,12 +398,128 @@ public List getDocuments() { @JsonProperty(JSON_PROPERTY_DOCUMENTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setDocuments(List documents) { this.documents = documents; } + public TemplateResponse accounts(List accounts) { + this.accounts = accounts; + return this; + } + + public TemplateResponse addAccountsItem(TemplateResponseAccount accountsItem) { + if (this.accounts == null) { + this.accounts = new ArrayList<>(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * An array of the Accounts that can use this Template. + * @return accounts + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getAccounts() { + return accounts; + } + + + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setAccounts(List accounts) { + this.accounts = accounts; + } + + + public TemplateResponse attachments(List attachments) { + this.attachments = attachments; + return this; + } + + public TemplateResponse addAttachmentsItem(SignatureRequestResponseAttachment attachmentsItem) { + if (this.attachments == null) { + this.attachments = new ArrayList<>(); + } + this.attachments.add(attachmentsItem); + return this; + } + + /** + * Signer attachments. + * @return attachments + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getAttachments() { + return attachments; + } + + + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setAttachments(List attachments) { + this.attachments = attachments; + } + + + public TemplateResponse updatedAt(Integer updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + * Time the template was last updated. + * @return updatedAt + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getUpdatedAt() { + return updatedAt; + } + + + @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setUpdatedAt(Integer updatedAt) { + this.updatedAt = updatedAt; + } + + + public TemplateResponse isEmbedded(Boolean isEmbedded) { + this.isEmbedded = isEmbedded; + return this; + } + + /** + * `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + * @return isEmbedded + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIsEmbedded() { + return isEmbedded; + } + + + @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIsEmbedded(Boolean isEmbedded) { + this.isEmbedded = isEmbedded; + } + + @Deprecated public TemplateResponse customFields(List customFields) { this.customFields = customFields; @@ -523,39 +594,6 @@ public void setNamedFormFields(List named } - public TemplateResponse accounts(List accounts) { - this.accounts = accounts; - return this; - } - - public TemplateResponse addAccountsItem(TemplateResponseAccount accountsItem) { - if (this.accounts == null) { - this.accounts = new ArrayList<>(); - } - this.accounts.add(accountsItem); - return this; - } - - /** - * An array of the Accounts that can use this Template. - * @return accounts - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getAccounts() { - return accounts; - } - - - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccounts(List accounts) { - this.accounts = accounts; - } - - /** * Return true if this TemplateResponse object is equal to o. */ @@ -571,8 +609,6 @@ public boolean equals(Object o) { return Objects.equals(this.templateId, templateResponse.templateId) && Objects.equals(this.title, templateResponse.title) && Objects.equals(this.message, templateResponse.message) && - Objects.equals(this.updatedAt, templateResponse.updatedAt) && - Objects.equals(this.isEmbedded, templateResponse.isEmbedded) && Objects.equals(this.isCreator, templateResponse.isCreator) && Objects.equals(this.canEdit, templateResponse.canEdit) && Objects.equals(this.isLocked, templateResponse.isLocked) && @@ -580,14 +616,17 @@ public boolean equals(Object o) { Objects.equals(this.signerRoles, templateResponse.signerRoles) && Objects.equals(this.ccRoles, templateResponse.ccRoles) && Objects.equals(this.documents, templateResponse.documents) && + Objects.equals(this.accounts, templateResponse.accounts) && + Objects.equals(this.attachments, templateResponse.attachments) && + Objects.equals(this.updatedAt, templateResponse.updatedAt) && + Objects.equals(this.isEmbedded, templateResponse.isEmbedded) && Objects.equals(this.customFields, templateResponse.customFields) && - Objects.equals(this.namedFormFields, templateResponse.namedFormFields) && - Objects.equals(this.accounts, templateResponse.accounts); + Objects.equals(this.namedFormFields, templateResponse.namedFormFields); } @Override public int hashCode() { - return Objects.hash(templateId, title, message, updatedAt, isEmbedded, isCreator, canEdit, isLocked, metadata, signerRoles, ccRoles, documents, customFields, namedFormFields, accounts); + return Objects.hash(templateId, title, message, isCreator, canEdit, isLocked, metadata, signerRoles, ccRoles, documents, accounts, attachments, updatedAt, isEmbedded, customFields, namedFormFields); } @Override @@ -597,8 +636,6 @@ public String toString() { sb.append(" templateId: ").append(toIndentedString(templateId)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); - sb.append(" isEmbedded: ").append(toIndentedString(isEmbedded)).append("\n"); sb.append(" isCreator: ").append(toIndentedString(isCreator)).append("\n"); sb.append(" canEdit: ").append(toIndentedString(canEdit)).append("\n"); sb.append(" isLocked: ").append(toIndentedString(isLocked)).append("\n"); @@ -606,9 +643,12 @@ public String toString() { sb.append(" signerRoles: ").append(toIndentedString(signerRoles)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" documents: ").append(toIndentedString(documents)).append("\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); + sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); + sb.append(" isEmbedded: ").append(toIndentedString(isEmbedded)).append("\n"); sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); sb.append(" namedFormFields: ").append(toIndentedString(namedFormFields)).append("\n"); - sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); sb.append("}"); return sb.toString(); } @@ -674,44 +714,6 @@ public Map createFormData() throws ApiException { map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); } } - if (updatedAt != null) { - if (isFileTypeOrListOfFiles(updatedAt)) { - fileTypeFound = true; - } - - if (updatedAt.getClass().equals(java.io.File.class) || - updatedAt.getClass().equals(Integer.class) || - updatedAt.getClass().equals(String.class) || - updatedAt.getClass().isEnum()) { - map.put("updated_at", updatedAt); - } else if (isListOfFile(updatedAt)) { - for(int i = 0; i< getListSize(updatedAt); i++) { - map.put("updated_at[" + i + "]", getFromList(updatedAt, i)); - } - } - else { - map.put("updated_at", JSON.getDefault().getMapper().writeValueAsString(updatedAt)); - } - } - if (isEmbedded != null) { - if (isFileTypeOrListOfFiles(isEmbedded)) { - fileTypeFound = true; - } - - if (isEmbedded.getClass().equals(java.io.File.class) || - isEmbedded.getClass().equals(Integer.class) || - isEmbedded.getClass().equals(String.class) || - isEmbedded.getClass().isEnum()) { - map.put("is_embedded", isEmbedded); - } else if (isListOfFile(isEmbedded)) { - for(int i = 0; i< getListSize(isEmbedded); i++) { - map.put("is_embedded[" + i + "]", getFromList(isEmbedded, i)); - } - } - else { - map.put("is_embedded", JSON.getDefault().getMapper().writeValueAsString(isEmbedded)); - } - } if (isCreator != null) { if (isFileTypeOrListOfFiles(isCreator)) { fileTypeFound = true; @@ -845,6 +847,82 @@ public Map createFormData() throws ApiException { map.put("documents", JSON.getDefault().getMapper().writeValueAsString(documents)); } } + if (accounts != null) { + if (isFileTypeOrListOfFiles(accounts)) { + fileTypeFound = true; + } + + if (accounts.getClass().equals(java.io.File.class) || + accounts.getClass().equals(Integer.class) || + accounts.getClass().equals(String.class) || + accounts.getClass().isEnum()) { + map.put("accounts", accounts); + } else if (isListOfFile(accounts)) { + for(int i = 0; i< getListSize(accounts); i++) { + map.put("accounts[" + i + "]", getFromList(accounts, i)); + } + } + else { + map.put("accounts", JSON.getDefault().getMapper().writeValueAsString(accounts)); + } + } + if (attachments != null) { + if (isFileTypeOrListOfFiles(attachments)) { + fileTypeFound = true; + } + + if (attachments.getClass().equals(java.io.File.class) || + attachments.getClass().equals(Integer.class) || + attachments.getClass().equals(String.class) || + attachments.getClass().isEnum()) { + map.put("attachments", attachments); + } else if (isListOfFile(attachments)) { + for(int i = 0; i< getListSize(attachments); i++) { + map.put("attachments[" + i + "]", getFromList(attachments, i)); + } + } + else { + map.put("attachments", JSON.getDefault().getMapper().writeValueAsString(attachments)); + } + } + if (updatedAt != null) { + if (isFileTypeOrListOfFiles(updatedAt)) { + fileTypeFound = true; + } + + if (updatedAt.getClass().equals(java.io.File.class) || + updatedAt.getClass().equals(Integer.class) || + updatedAt.getClass().equals(String.class) || + updatedAt.getClass().isEnum()) { + map.put("updated_at", updatedAt); + } else if (isListOfFile(updatedAt)) { + for(int i = 0; i< getListSize(updatedAt); i++) { + map.put("updated_at[" + i + "]", getFromList(updatedAt, i)); + } + } + else { + map.put("updated_at", JSON.getDefault().getMapper().writeValueAsString(updatedAt)); + } + } + if (isEmbedded != null) { + if (isFileTypeOrListOfFiles(isEmbedded)) { + fileTypeFound = true; + } + + if (isEmbedded.getClass().equals(java.io.File.class) || + isEmbedded.getClass().equals(Integer.class) || + isEmbedded.getClass().equals(String.class) || + isEmbedded.getClass().isEnum()) { + map.put("is_embedded", isEmbedded); + } else if (isListOfFile(isEmbedded)) { + for(int i = 0; i< getListSize(isEmbedded); i++) { + map.put("is_embedded[" + i + "]", getFromList(isEmbedded, i)); + } + } + else { + map.put("is_embedded", JSON.getDefault().getMapper().writeValueAsString(isEmbedded)); + } + } if (customFields != null) { if (isFileTypeOrListOfFiles(customFields)) { fileTypeFound = true; @@ -883,25 +961,6 @@ public Map createFormData() throws ApiException { map.put("named_form_fields", JSON.getDefault().getMapper().writeValueAsString(namedFormFields)); } } - if (accounts != null) { - if (isFileTypeOrListOfFiles(accounts)) { - fileTypeFound = true; - } - - if (accounts.getClass().equals(java.io.File.class) || - accounts.getClass().equals(Integer.class) || - accounts.getClass().equals(String.class) || - accounts.getClass().isEnum()) { - map.put("accounts", accounts); - } else if (isListOfFile(accounts)) { - for(int i = 0; i< getListSize(accounts); i++) { - map.put("accounts[" + i + "]", getFromList(accounts, i)); - } - } - else { - map.put("accounts", JSON.getDefault().getMapper().writeValueAsString(accounts)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java index 53f50dd8a..ae6b9cdc6 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java @@ -35,11 +35,11 @@ */ @JsonPropertyOrder({ TemplateResponseAccount.JSON_PROPERTY_ACCOUNT_ID, - TemplateResponseAccount.JSON_PROPERTY_EMAIL_ADDRESS, TemplateResponseAccount.JSON_PROPERTY_IS_LOCKED, TemplateResponseAccount.JSON_PROPERTY_IS_PAID_HS, TemplateResponseAccount.JSON_PROPERTY_IS_PAID_HF, - TemplateResponseAccount.JSON_PROPERTY_QUOTAS + TemplateResponseAccount.JSON_PROPERTY_QUOTAS, + TemplateResponseAccount.JSON_PROPERTY_EMAIL_ADDRESS }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -47,9 +47,6 @@ public class TemplateResponseAccount { 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; @@ -62,6 +59,9 @@ public class TemplateResponseAccount { public static final String JSON_PROPERTY_QUOTAS = "quotas"; private TemplateResponseAccountQuota quotas; + public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + private String emailAddress; + public TemplateResponseAccount() { } @@ -89,9 +89,9 @@ public TemplateResponseAccount 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; @@ -99,37 +99,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 TemplateResponseAccount 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 TemplateResponseAccount isLocked(Boolean isLocked) { this.isLocked = isLocked; return this; @@ -139,9 +114,9 @@ public TemplateResponseAccount 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; @@ -149,7 +124,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; } @@ -164,9 +139,9 @@ public TemplateResponseAccount 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; @@ -174,7 +149,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; } @@ -189,9 +164,9 @@ public TemplateResponseAccount 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; @@ -199,7 +174,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; } @@ -214,9 +189,9 @@ public TemplateResponseAccount quotas(TemplateResponseAccountQuota 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 TemplateResponseAccountQuota getQuotas() { return quotas; @@ -224,12 +199,37 @@ public TemplateResponseAccountQuota getQuotas() { @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setQuotas(TemplateResponseAccountQuota quotas) { this.quotas = quotas; } + public TemplateResponseAccount 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; + } + + /** * Return true if this TemplateResponseAccount object is equal to o. */ @@ -243,16 +243,16 @@ public boolean equals(Object o) { } TemplateResponseAccount templateResponseAccount = (TemplateResponseAccount) o; return Objects.equals(this.accountId, templateResponseAccount.accountId) && - Objects.equals(this.emailAddress, templateResponseAccount.emailAddress) && Objects.equals(this.isLocked, templateResponseAccount.isLocked) && Objects.equals(this.isPaidHs, templateResponseAccount.isPaidHs) && Objects.equals(this.isPaidHf, templateResponseAccount.isPaidHf) && - Objects.equals(this.quotas, templateResponseAccount.quotas); + Objects.equals(this.quotas, templateResponseAccount.quotas) && + Objects.equals(this.emailAddress, templateResponseAccount.emailAddress); } @Override public int hashCode() { - return Objects.hash(accountId, emailAddress, isLocked, isPaidHs, isPaidHf, quotas); + return Objects.hash(accountId, isLocked, isPaidHs, isPaidHf, quotas, emailAddress); } @Override @@ -260,11 +260,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseAccount {\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("}"); return sb.toString(); } @@ -292,25 +292,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; @@ -387,6 +368,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)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java index 78b1f583d..0b1e7e66f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java @@ -80,9 +80,9 @@ public TemplateResponseAccountQuota templatesLeft(Integer templatesLeft) { * API templates remaining. * @return templatesLeft */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getTemplatesLeft() { return templatesLeft; @@ -90,7 +90,7 @@ public Integer getTemplatesLeft() { @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplatesLeft(Integer templatesLeft) { this.templatesLeft = templatesLeft; } @@ -105,9 +105,9 @@ public TemplateResponseAccountQuota apiSignatureRequestsLeft(Integer apiSignatur * API signature requests remaining. * @return apiSignatureRequestsLeft */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getApiSignatureRequestsLeft() { return apiSignatureRequestsLeft; @@ -115,7 +115,7 @@ public Integer getApiSignatureRequestsLeft() { @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiSignatureRequestsLeft(Integer apiSignatureRequestsLeft) { this.apiSignatureRequestsLeft = apiSignatureRequestsLeft; } @@ -130,9 +130,9 @@ public TemplateResponseAccountQuota documentsLeft(Integer documentsLeft) { * Signature requests remaining. * @return documentsLeft */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getDocumentsLeft() { return documentsLeft; @@ -140,7 +140,7 @@ public Integer getDocumentsLeft() { @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setDocumentsLeft(Integer documentsLeft) { this.documentsLeft = documentsLeft; } @@ -155,9 +155,9 @@ public TemplateResponseAccountQuota smsVerificationsLeft(Integer smsVerification * SMS verifications remaining. * @return smsVerificationsLeft */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getSmsVerificationsLeft() { return smsVerificationsLeft; @@ -165,7 +165,7 @@ public Integer getSmsVerificationsLeft() { @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSmsVerificationsLeft(Integer smsVerificationsLeft) { this.smsVerificationsLeft = smsVerificationsLeft; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java index 4ed3eb946..5a9461f44 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java @@ -68,9 +68,9 @@ public TemplateResponseCCRole name(String name) { * The name of the Role. * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -78,7 +78,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java index 040c68ccc..2dbcbfee0 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java @@ -40,11 +40,11 @@ */ @JsonPropertyOrder({ TemplateResponseDocument.JSON_PROPERTY_NAME, - TemplateResponseDocument.JSON_PROPERTY_INDEX, TemplateResponseDocument.JSON_PROPERTY_FIELD_GROUPS, TemplateResponseDocument.JSON_PROPERTY_FORM_FIELDS, TemplateResponseDocument.JSON_PROPERTY_CUSTOM_FIELDS, - TemplateResponseDocument.JSON_PROPERTY_STATIC_FIELDS + TemplateResponseDocument.JSON_PROPERTY_STATIC_FIELDS, + TemplateResponseDocument.JSON_PROPERTY_INDEX }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -52,20 +52,20 @@ public class TemplateResponseDocument { public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_INDEX = "index"; - private Integer index; - public static final String JSON_PROPERTY_FIELD_GROUPS = "field_groups"; - private List fieldGroups = null; + private List fieldGroups = new ArrayList<>(); public static final String JSON_PROPERTY_FORM_FIELDS = "form_fields"; - private List formFields = null; + private List formFields = new ArrayList<>(); public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; - private List customFields = null; + private List customFields = new ArrayList<>(); public static final String JSON_PROPERTY_STATIC_FIELDS = "static_fields"; - private List staticFields = null; + private List staticFields = new ArrayList<>(); + + public static final String JSON_PROPERTY_INDEX = "index"; + private Integer index; public TemplateResponseDocument() { } @@ -94,9 +94,9 @@ public TemplateResponseDocument name(String name) { * Name of the associated file. * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -104,37 +104,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } - public TemplateResponseDocument index(Integer index) { - this.index = index; - return this; - } - - /** - * Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - * @return index - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_INDEX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getIndex() { - return index; - } - - - @JsonProperty(JSON_PROPERTY_INDEX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIndex(Integer index) { - this.index = index; - } - - public TemplateResponseDocument fieldGroups(List fieldGroups) { this.fieldGroups = fieldGroups; return this; @@ -152,9 +127,9 @@ public TemplateResponseDocument addFieldGroupsItem(TemplateResponseDocumentField * An array of Form Field Group objects. * @return fieldGroups */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getFieldGroups() { return fieldGroups; @@ -162,7 +137,7 @@ public List getFieldGroups() { @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFieldGroups(List fieldGroups) { this.fieldGroups = fieldGroups; } @@ -185,9 +160,9 @@ public TemplateResponseDocument addFormFieldsItem(TemplateResponseDocumentFormFi * An array of Form Field objects containing the name and type of each named field. * @return formFields */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_FORM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getFormFields() { return formFields; @@ -195,7 +170,7 @@ public List getFormFields() { @JsonProperty(JSON_PROPERTY_FORM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFormFields(List formFields) { this.formFields = formFields; } @@ -218,9 +193,9 @@ public TemplateResponseDocument addCustomFieldsItem(TemplateResponseDocumentCust * An array of Form Field objects containing the name and type of each named field. * @return customFields */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getCustomFields() { return customFields; @@ -228,7 +203,7 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCustomFields(List customFields) { this.customFields = customFields; } @@ -251,9 +226,9 @@ public TemplateResponseDocument addStaticFieldsItem(TemplateResponseDocumentStat * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. * @return staticFields */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getStaticFields() { return staticFields; @@ -261,12 +236,37 @@ public List getStaticFields() { @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setStaticFields(List staticFields) { this.staticFields = staticFields; } + public TemplateResponseDocument index(Integer index) { + this.index = index; + return this; + } + + /** + * Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + * @return index + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_INDEX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getIndex() { + return index; + } + + + @JsonProperty(JSON_PROPERTY_INDEX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIndex(Integer index) { + this.index = index; + } + + /** * Return true if this TemplateResponseDocument object is equal to o. */ @@ -280,16 +280,16 @@ public boolean equals(Object o) { } TemplateResponseDocument templateResponseDocument = (TemplateResponseDocument) o; return Objects.equals(this.name, templateResponseDocument.name) && - Objects.equals(this.index, templateResponseDocument.index) && Objects.equals(this.fieldGroups, templateResponseDocument.fieldGroups) && Objects.equals(this.formFields, templateResponseDocument.formFields) && Objects.equals(this.customFields, templateResponseDocument.customFields) && - Objects.equals(this.staticFields, templateResponseDocument.staticFields); + Objects.equals(this.staticFields, templateResponseDocument.staticFields) && + Objects.equals(this.index, templateResponseDocument.index); } @Override public int hashCode() { - return Objects.hash(name, index, fieldGroups, formFields, customFields, staticFields); + return Objects.hash(name, fieldGroups, formFields, customFields, staticFields, index); } @Override @@ -297,11 +297,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocument {\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" index: ").append(toIndentedString(index)).append("\n"); sb.append(" fieldGroups: ").append(toIndentedString(fieldGroups)).append("\n"); sb.append(" formFields: ").append(toIndentedString(formFields)).append("\n"); sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); sb.append(" staticFields: ").append(toIndentedString(staticFields)).append("\n"); + sb.append(" index: ").append(toIndentedString(index)).append("\n"); sb.append("}"); return sb.toString(); } @@ -329,25 +329,6 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } - if (index != null) { - if (isFileTypeOrListOfFiles(index)) { - fileTypeFound = true; - } - - if (index.getClass().equals(java.io.File.class) || - index.getClass().equals(Integer.class) || - index.getClass().equals(String.class) || - index.getClass().isEnum()) { - map.put("index", index); - } else if (isListOfFile(index)) { - for(int i = 0; i< getListSize(index); i++) { - map.put("index[" + i + "]", getFromList(index, i)); - } - } - else { - map.put("index", JSON.getDefault().getMapper().writeValueAsString(index)); - } - } if (fieldGroups != null) { if (isFileTypeOrListOfFiles(fieldGroups)) { fileTypeFound = true; @@ -424,6 +405,25 @@ public Map createFormData() throws ApiException { map.put("static_fields", JSON.getDefault().getMapper().writeValueAsString(staticFields)); } } + if (index != null) { + if (isFileTypeOrListOfFiles(index)) { + fileTypeFound = true; + } + + if (index.getClass().equals(java.io.File.class) || + index.getClass().equals(Integer.class) || + index.getClass().equals(String.class) || + index.getClass().isEnum()) { + map.put("index", index); + } else if (isListOfFile(index)) { + for(int i = 0; i< getListSize(index); i++) { + map.put("index[" + i + "]", getFromList(index, i)); + } + } + else { + map.put("index", JSON.getDefault().getMapper().writeValueAsString(index)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java index 4797afd91..e5cf7fa77 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java @@ -36,15 +36,15 @@ * An array of Form Field objects containing the name and type of each named field. */ @JsonPropertyOrder({ - TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_NAME, - TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_SIGNER, + TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_Y, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_WIDTH, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_HEIGHT, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_REQUIRED, + TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -59,17 +59,14 @@ }) public class TemplateResponseDocumentCustomFieldBase { - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_SIGNER = "signer"; - private String signer; + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; public static final String JSON_PROPERTY_X = "x"; private Integer x; @@ -86,6 +83,9 @@ public class TemplateResponseDocumentCustomFieldBase { public static final String JSON_PROPERTY_REQUIRED = "required"; private Boolean required; + public static final String JSON_PROPERTY_SIGNER = "signer"; + private String signer; + public static final String JSON_PROPERTY_GROUP = "group"; private String group; @@ -107,31 +107,6 @@ static public TemplateResponseDocumentCustomFieldBase init(HashMap data) throws ); } - public TemplateResponseDocumentCustomFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * @return type - */ - @jakarta.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getType() { - return type; - } - - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - - public TemplateResponseDocumentCustomFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -141,9 +116,9 @@ public TemplateResponseDocumentCustomFieldBase apiId(String apiId) { * The unique ID for this field. * @return apiId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getApiId() { return apiId; @@ -151,7 +126,7 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -166,9 +141,9 @@ public TemplateResponseDocumentCustomFieldBase name(String name) { * The name of the Custom Field. * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -176,42 +151,34 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } - public TemplateResponseDocumentCustomFieldBase signer(String signer) { - this.signer = signer; - return this; - } - public TemplateResponseDocumentCustomFieldBase signer(Integer signer) { - this.signer = String.valueOf(signer); + public TemplateResponseDocumentCustomFieldBase type(String type) { + this.type = type; return this; } /** - * The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). - * @return signer + * Get type + * @return type */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) - public String getSigner() { - return signer; + public String getType() { + return type; } - @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigner(String signer) { - this.signer = signer; - } - - public void setSigner(Integer signer) { - this.signer = String.valueOf(signer); + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; } @@ -224,9 +191,9 @@ public TemplateResponseDocumentCustomFieldBase x(Integer x) { * The horizontal offset in pixels for this form field. * @return x */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getX() { return x; @@ -234,7 +201,7 @@ public Integer getX() { @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setX(Integer x) { this.x = x; } @@ -249,9 +216,9 @@ public TemplateResponseDocumentCustomFieldBase y(Integer y) { * The vertical offset in pixels for this form field. * @return y */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getY() { return y; @@ -259,7 +226,7 @@ public Integer getY() { @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setY(Integer y) { this.y = y; } @@ -274,9 +241,9 @@ public TemplateResponseDocumentCustomFieldBase width(Integer width) { * The width in pixels of this form field. * @return width */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getWidth() { return width; @@ -284,7 +251,7 @@ public Integer getWidth() { @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setWidth(Integer width) { this.width = width; } @@ -299,9 +266,9 @@ public TemplateResponseDocumentCustomFieldBase height(Integer height) { * The height in pixels of this form field. * @return height */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getHeight() { return height; @@ -309,7 +276,7 @@ public Integer getHeight() { @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setHeight(Integer height) { this.height = height; } @@ -324,9 +291,9 @@ public TemplateResponseDocumentCustomFieldBase required(Boolean required) { * Boolean showing whether or not this field is required. * @return required */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getRequired() { return required; @@ -334,12 +301,45 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequired(Boolean required) { this.required = required; } + public TemplateResponseDocumentCustomFieldBase signer(String signer) { + this.signer = signer; + return this; + } + public TemplateResponseDocumentCustomFieldBase signer(Integer signer) { + this.signer = String.valueOf(signer); + return this; + } + + /** + * The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + * @return signer + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSigner() { + return signer; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigner(String signer) { + this.signer = signer; + } + + public void setSigner(Integer signer) { + this.signer = String.valueOf(signer); + } + + public TemplateResponseDocumentCustomFieldBase group(String group) { this.group = group; return this; @@ -377,36 +377,36 @@ public boolean equals(Object o) { return false; } TemplateResponseDocumentCustomFieldBase templateResponseDocumentCustomFieldBase = (TemplateResponseDocumentCustomFieldBase) o; - return Objects.equals(this.type, templateResponseDocumentCustomFieldBase.type) && - Objects.equals(this.apiId, templateResponseDocumentCustomFieldBase.apiId) && + return Objects.equals(this.apiId, templateResponseDocumentCustomFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentCustomFieldBase.name) && - Objects.equals(this.signer, templateResponseDocumentCustomFieldBase.signer) && + Objects.equals(this.type, templateResponseDocumentCustomFieldBase.type) && Objects.equals(this.x, templateResponseDocumentCustomFieldBase.x) && Objects.equals(this.y, templateResponseDocumentCustomFieldBase.y) && Objects.equals(this.width, templateResponseDocumentCustomFieldBase.width) && Objects.equals(this.height, templateResponseDocumentCustomFieldBase.height) && Objects.equals(this.required, templateResponseDocumentCustomFieldBase.required) && + Objects.equals(this.signer, templateResponseDocumentCustomFieldBase.signer) && Objects.equals(this.group, templateResponseDocumentCustomFieldBase.group); } @Override public int hashCode() { - return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); + return Objects.hash(apiId, name, type, x, y, width, height, required, signer, group); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentCustomFieldBase {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); sb.append(" width: ").append(toIndentedString(width)).append("\n"); sb.append(" height: ").append(toIndentedString(height)).append("\n"); sb.append(" required: ").append(toIndentedString(required)).append("\n"); + sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); @@ -416,25 +416,6 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) || - type.getClass().equals(Integer.class) || - type.getClass().equals(String.class) || - type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for(int i = 0; i< getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } - else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -473,23 +454,23 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } - if (signer != null) { - if (isFileTypeOrListOfFiles(signer)) { + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { fileTypeFound = true; } - if (signer.getClass().equals(java.io.File.class) || - signer.getClass().equals(Integer.class) || - signer.getClass().equals(String.class) || - signer.getClass().isEnum()) { - map.put("signer", signer); - } else if (isListOfFile(signer)) { - for(int i = 0; i< getListSize(signer); i++) { - map.put("signer[" + i + "]", getFromList(signer, i)); + if (type.getClass().equals(java.io.File.class) || + type.getClass().equals(Integer.class) || + type.getClass().equals(String.class) || + type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for(int i = 0; i< getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); } } else { - map.put("signer", JSON.getDefault().getMapper().writeValueAsString(signer)); + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } if (x != null) { @@ -587,6 +568,25 @@ public Map createFormData() throws ApiException { map.put("required", JSON.getDefault().getMapper().writeValueAsString(required)); } } + if (signer != null) { + if (isFileTypeOrListOfFiles(signer)) { + fileTypeFound = true; + } + + if (signer.getClass().equals(java.io.File.class) || + signer.getClass().equals(Integer.class) || + signer.getClass().equals(String.class) || + signer.getClass().isEnum()) { + map.put("signer", signer); + } else if (isListOfFile(signer)) { + for(int i = 0; i< getListSize(signer); i++) { + map.put("signer[" + i + "]", getFromList(signer, i)); + } + } + else { + map.put("signer", JSON.getDefault().getMapper().writeValueAsString(signer)); + } + } if (group != null) { if (isFileTypeOrListOfFiles(group)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java index e9c2932d6..5aba1a567 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java @@ -119,9 +119,9 @@ public TemplateResponseDocumentCustomFieldText avgTextLength(TemplateResponseFie * Get avgTextLength * @return avgTextLength */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; @@ -129,7 +129,7 @@ public TemplateResponseFieldAvgTextLength getAvgTextLength() { @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -144,9 +144,9 @@ public TemplateResponseDocumentCustomFieldText isMultiline(Boolean isMultiline) * Whether this form field is multiline text. * @return isMultiline */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsMultiline() { return isMultiline; @@ -154,7 +154,7 @@ public Boolean getIsMultiline() { @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -169,9 +169,9 @@ public TemplateResponseDocumentCustomFieldText originalFontSize(Integer original * Original font size used in this form field's text. * @return originalFontSize */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getOriginalFontSize() { return originalFontSize; @@ -179,7 +179,7 @@ public Integer getOriginalFontSize() { @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -194,9 +194,9 @@ public TemplateResponseDocumentCustomFieldText fontFamily(String fontFamily) { * Font family used in this form field's text. * @return fontFamily */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getFontFamily() { return fontFamily; @@ -204,7 +204,7 @@ public String getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java index 3e724af45..d02f5f5ec 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java @@ -73,9 +73,9 @@ public TemplateResponseDocumentFieldGroup name(String name) { * The name of the form field group. * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -83,7 +83,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } @@ -98,9 +98,9 @@ public TemplateResponseDocumentFieldGroup rule(TemplateResponseDocumentFieldGrou * Get rule * @return rule */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_RULE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseDocumentFieldGroupRule getRule() { return rule; @@ -108,7 +108,7 @@ public TemplateResponseDocumentFieldGroupRule getRule() { @JsonProperty(JSON_PROPERTY_RULE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRule(TemplateResponseDocumentFieldGroupRule rule) { this.rule = rule; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java index 65aa63b0f..d92998793 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java @@ -72,9 +72,9 @@ public TemplateResponseDocumentFieldGroupRule requirement(String requirement) { * Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. * @return requirement */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_REQUIREMENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getRequirement() { return requirement; @@ -82,7 +82,7 @@ public String getRequirement() { @JsonProperty(JSON_PROPERTY_REQUIREMENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequirement(String requirement) { this.requirement = requirement; } @@ -97,9 +97,9 @@ public TemplateResponseDocumentFieldGroupRule groupLabel(String groupLabel) { * Name of the group * @return groupLabel */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_GROUP_LABEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getGroupLabel() { return groupLabel; @@ -107,7 +107,7 @@ public String getGroupLabel() { @JsonProperty(JSON_PROPERTY_GROUP_LABEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setGroupLabel(String groupLabel) { this.groupLabel = groupLabel; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java index cbef92e0f..5a62be6c8 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java @@ -36,16 +36,15 @@ * An array of Form Field objects containing the name and type of each named field. */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_NAME, + TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_Y, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_WIDTH, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_HEIGHT, - TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_REQUIRED, - TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_GROUP + TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_REQUIRED }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -65,15 +64,15 @@ }) public class TemplateResponseDocumentFormFieldBase { - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + public static final String JSON_PROPERTY_SIGNER = "signer"; private String signer; @@ -92,9 +91,6 @@ public class TemplateResponseDocumentFormFieldBase { public static final String JSON_PROPERTY_REQUIRED = "required"; private Boolean required; - public static final String JSON_PROPERTY_GROUP = "group"; - private String group; - public TemplateResponseDocumentFormFieldBase() { } @@ -113,31 +109,6 @@ static public TemplateResponseDocumentFormFieldBase init(HashMap data) throws Ex ); } - public TemplateResponseDocumentFormFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * @return type - */ - @jakarta.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getType() { - return type; - } - - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - - public TemplateResponseDocumentFormFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -147,9 +118,9 @@ public TemplateResponseDocumentFormFieldBase apiId(String apiId) { * A unique id for the form field. * @return apiId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getApiId() { return apiId; @@ -157,7 +128,7 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -172,9 +143,9 @@ public TemplateResponseDocumentFormFieldBase name(String name) { * The name of the form field. * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -182,12 +153,37 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } + public TemplateResponseDocumentFormFieldBase type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getType() { + return type; + } + + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; + } + + public TemplateResponseDocumentFormFieldBase signer(String signer) { this.signer = signer; return this; @@ -201,9 +197,9 @@ public TemplateResponseDocumentFormFieldBase signer(Integer signer) { * The signer of the Form Field. * @return signer */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSigner() { return signer; @@ -211,7 +207,7 @@ public String getSigner() { @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSigner(String signer) { this.signer = signer; } @@ -230,9 +226,9 @@ public TemplateResponseDocumentFormFieldBase x(Integer x) { * The horizontal offset in pixels for this form field. * @return x */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getX() { return x; @@ -240,7 +236,7 @@ public Integer getX() { @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setX(Integer x) { this.x = x; } @@ -255,9 +251,9 @@ public TemplateResponseDocumentFormFieldBase y(Integer y) { * The vertical offset in pixels for this form field. * @return y */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getY() { return y; @@ -265,7 +261,7 @@ public Integer getY() { @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setY(Integer y) { this.y = y; } @@ -280,9 +276,9 @@ public TemplateResponseDocumentFormFieldBase width(Integer width) { * The width in pixels of this form field. * @return width */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getWidth() { return width; @@ -290,7 +286,7 @@ public Integer getWidth() { @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setWidth(Integer width) { this.width = width; } @@ -305,9 +301,9 @@ public TemplateResponseDocumentFormFieldBase height(Integer height) { * The height in pixels of this form field. * @return height */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getHeight() { return height; @@ -315,7 +311,7 @@ public Integer getHeight() { @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setHeight(Integer height) { this.height = height; } @@ -330,9 +326,9 @@ public TemplateResponseDocumentFormFieldBase required(Boolean required) { * Boolean showing whether or not this field is required. * @return required */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getRequired() { return required; @@ -340,37 +336,12 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequired(Boolean required) { this.required = required; } - public TemplateResponseDocumentFormFieldBase group(String group) { - this.group = group; - return this; - } - - /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. - * @return group - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GROUP) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getGroup() { - return group; - } - - - @JsonProperty(JSON_PROPERTY_GROUP) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroup(String group) { - this.group = group; - } - - /** * Return true if this TemplateResponseDocumentFormFieldBase object is equal to o. */ @@ -383,37 +354,35 @@ public boolean equals(Object o) { return false; } TemplateResponseDocumentFormFieldBase templateResponseDocumentFormFieldBase = (TemplateResponseDocumentFormFieldBase) o; - return Objects.equals(this.type, templateResponseDocumentFormFieldBase.type) && - Objects.equals(this.apiId, templateResponseDocumentFormFieldBase.apiId) && + return Objects.equals(this.apiId, templateResponseDocumentFormFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentFormFieldBase.name) && + Objects.equals(this.type, templateResponseDocumentFormFieldBase.type) && Objects.equals(this.signer, templateResponseDocumentFormFieldBase.signer) && Objects.equals(this.x, templateResponseDocumentFormFieldBase.x) && Objects.equals(this.y, templateResponseDocumentFormFieldBase.y) && Objects.equals(this.width, templateResponseDocumentFormFieldBase.width) && Objects.equals(this.height, templateResponseDocumentFormFieldBase.height) && - Objects.equals(this.required, templateResponseDocumentFormFieldBase.required) && - Objects.equals(this.group, templateResponseDocumentFormFieldBase.group); + Objects.equals(this.required, templateResponseDocumentFormFieldBase.required); } @Override public int hashCode() { - return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); + return Objects.hash(apiId, name, type, signer, x, y, width, height, required); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentFormFieldBase {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); sb.append(" width: ").append(toIndentedString(width)).append("\n"); sb.append(" height: ").append(toIndentedString(height)).append("\n"); sb.append(" required: ").append(toIndentedString(required)).append("\n"); - sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -422,25 +391,6 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) || - type.getClass().equals(Integer.class) || - type.getClass().equals(String.class) || - type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for(int i = 0; i< getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } - else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -479,6 +429,25 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { + fileTypeFound = true; + } + + if (type.getClass().equals(java.io.File.class) || + type.getClass().equals(Integer.class) || + type.getClass().equals(String.class) || + type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for(int i = 0; i< getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); + } + } + else { + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + } + } if (signer != null) { if (isFileTypeOrListOfFiles(signer)) { fileTypeFound = true; @@ -593,25 +562,6 @@ public Map createFormData() throws ApiException { map.put("required", JSON.getDefault().getMapper().writeValueAsString(required)); } } - if (group != null) { - if (isFileTypeOrListOfFiles(group)) { - fileTypeFound = true; - } - - if (group.getClass().equals(java.io.File.class) || - group.getClass().equals(Integer.class) || - group.getClass().equals(String.class) || - group.getClass().isEnum()) { - map.put("group", group); - } else if (isListOfFile(group)) { - for(int i = 0; i< getListSize(group); i++) { - map.put("group[" + i + "]", getFromList(group, i)); - } - } - else { - map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java index 8354a7a23..110468a28 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java @@ -37,7 +37,8 @@ * This class extends `TemplateResponseDocumentFormFieldBase` */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_TYPE + TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -50,6 +51,9 @@ public class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseD public static final String JSON_PROPERTY_TYPE = "type"; private String type = "checkbox"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldCheckbox() { } @@ -93,6 +97,31 @@ public void setType(String type) { } + public TemplateResponseDocumentFormFieldCheckbox group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldCheckbox object is equal to o. */ @@ -106,12 +135,13 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldCheckbox templateResponseDocumentFormFieldCheckbox = (TemplateResponseDocumentFormFieldCheckbox) o; return Objects.equals(this.type, templateResponseDocumentFormFieldCheckbox.type) && + Objects.equals(this.group, templateResponseDocumentFormFieldCheckbox.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -120,6 +150,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldCheckbox {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -148,6 +179,25 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java index 202991168..67ec89a5c 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java @@ -37,7 +37,8 @@ * This class extends `TemplateResponseDocumentFormFieldBase` */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_TYPE + TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -50,6 +51,9 @@ public class TemplateResponseDocumentFormFieldDateSigned extends TemplateRespons public static final String JSON_PROPERTY_TYPE = "type"; private String type = "date_signed"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldDateSigned() { } @@ -93,6 +97,31 @@ public void setType(String type) { } + public TemplateResponseDocumentFormFieldDateSigned group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldDateSigned object is equal to o. */ @@ -106,12 +135,13 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldDateSigned templateResponseDocumentFormFieldDateSigned = (TemplateResponseDocumentFormFieldDateSigned) o; return Objects.equals(this.type, templateResponseDocumentFormFieldDateSigned.type) && + Objects.equals(this.group, templateResponseDocumentFormFieldDateSigned.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -120,6 +150,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldDateSigned {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -148,6 +179,25 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java index ca033ad09..8003f4c05 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java @@ -37,7 +37,8 @@ * This class extends `TemplateResponseDocumentFormFieldBase` */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_TYPE + TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -50,6 +51,9 @@ public class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseD public static final String JSON_PROPERTY_TYPE = "type"; private String type = "dropdown"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldDropdown() { } @@ -93,6 +97,31 @@ public void setType(String type) { } + public TemplateResponseDocumentFormFieldDropdown group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldDropdown object is equal to o. */ @@ -106,12 +135,13 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldDropdown templateResponseDocumentFormFieldDropdown = (TemplateResponseDocumentFormFieldDropdown) o; return Objects.equals(this.type, templateResponseDocumentFormFieldDropdown.type) && + Objects.equals(this.group, templateResponseDocumentFormFieldDropdown.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -120,6 +150,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldDropdown {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -148,6 +179,25 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java index acaa254b4..3db1348fb 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java @@ -42,7 +42,8 @@ TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_AVG_TEXT_LENGTH, TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_IS_MULTILINE, TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_ORIGINAL_FONT_SIZE, - TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_FONT_FAMILY + TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_FONT_FAMILY, + TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -67,6 +68,9 @@ public class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponse public static final String JSON_PROPERTY_FONT_FAMILY = "fontFamily"; private String fontFamily; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldHyperlink() { } @@ -119,9 +123,9 @@ public TemplateResponseDocumentFormFieldHyperlink avgTextLength(TemplateResponse * Get avgTextLength * @return avgTextLength */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; @@ -129,7 +133,7 @@ public TemplateResponseFieldAvgTextLength getAvgTextLength() { @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -144,9 +148,9 @@ public TemplateResponseDocumentFormFieldHyperlink isMultiline(Boolean isMultilin * Whether this form field is multiline text. * @return isMultiline */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsMultiline() { return isMultiline; @@ -154,7 +158,7 @@ public Boolean getIsMultiline() { @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -169,9 +173,9 @@ public TemplateResponseDocumentFormFieldHyperlink originalFontSize(Integer origi * Original font size used in this form field's text. * @return originalFontSize */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getOriginalFontSize() { return originalFontSize; @@ -179,7 +183,7 @@ public Integer getOriginalFontSize() { @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -194,9 +198,9 @@ public TemplateResponseDocumentFormFieldHyperlink fontFamily(String fontFamily) * Font family used in this form field's text. * @return fontFamily */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getFontFamily() { return fontFamily; @@ -204,12 +208,37 @@ public String getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } + public TemplateResponseDocumentFormFieldHyperlink group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldHyperlink object is equal to o. */ @@ -227,12 +256,13 @@ public boolean equals(Object o) { Objects.equals(this.isMultiline, templateResponseDocumentFormFieldHyperlink.isMultiline) && Objects.equals(this.originalFontSize, templateResponseDocumentFormFieldHyperlink.originalFontSize) && Objects.equals(this.fontFamily, templateResponseDocumentFormFieldHyperlink.fontFamily) && + Objects.equals(this.group, templateResponseDocumentFormFieldHyperlink.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, avgTextLength, isMultiline, originalFontSize, fontFamily, super.hashCode()); + return Objects.hash(type, avgTextLength, isMultiline, originalFontSize, fontFamily, group, super.hashCode()); } @Override @@ -245,6 +275,7 @@ public String toString() { sb.append(" isMultiline: ").append(toIndentedString(isMultiline)).append("\n"); sb.append(" originalFontSize: ").append(toIndentedString(originalFontSize)).append("\n"); sb.append(" fontFamily: ").append(toIndentedString(fontFamily)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -349,6 +380,25 @@ public Map createFormData() throws ApiException { map.put("fontFamily", JSON.getDefault().getMapper().writeValueAsString(fontFamily)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java index 749d70157..7aa96f533 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java @@ -37,7 +37,8 @@ * This class extends `TemplateResponseDocumentFormFieldBase` */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_TYPE + TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -50,6 +51,9 @@ public class TemplateResponseDocumentFormFieldInitials extends TemplateResponseD public static final String JSON_PROPERTY_TYPE = "type"; private String type = "initials"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldInitials() { } @@ -93,6 +97,31 @@ public void setType(String type) { } + public TemplateResponseDocumentFormFieldInitials group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldInitials object is equal to o. */ @@ -106,12 +135,13 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldInitials templateResponseDocumentFormFieldInitials = (TemplateResponseDocumentFormFieldInitials) o; return Objects.equals(this.type, templateResponseDocumentFormFieldInitials.type) && + Objects.equals(this.group, templateResponseDocumentFormFieldInitials.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -120,6 +150,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldInitials {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -148,6 +179,25 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java index aa71ef521..5e9365793 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java @@ -37,7 +37,8 @@ * This class extends `TemplateResponseDocumentFormFieldBase` */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_TYPE + TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -50,6 +51,9 @@ public class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocu public static final String JSON_PROPERTY_TYPE = "type"; private String type = "radio"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldRadio() { } @@ -93,6 +97,31 @@ public void setType(String type) { } + public TemplateResponseDocumentFormFieldRadio group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldRadio object is equal to o. */ @@ -106,12 +135,13 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldRadio templateResponseDocumentFormFieldRadio = (TemplateResponseDocumentFormFieldRadio) o; return Objects.equals(this.type, templateResponseDocumentFormFieldRadio.type) && + Objects.equals(this.group, templateResponseDocumentFormFieldRadio.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -120,6 +150,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldRadio {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -148,6 +179,25 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java index 9ff154afe..ac0a0c321 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java @@ -37,7 +37,8 @@ * This class extends `TemplateResponseDocumentFormFieldBase` */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_TYPE + TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -50,6 +51,9 @@ public class TemplateResponseDocumentFormFieldSignature extends TemplateResponse public static final String JSON_PROPERTY_TYPE = "type"; private String type = "signature"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldSignature() { } @@ -93,6 +97,31 @@ public void setType(String type) { } + public TemplateResponseDocumentFormFieldSignature group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldSignature object is equal to o. */ @@ -106,12 +135,13 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldSignature templateResponseDocumentFormFieldSignature = (TemplateResponseDocumentFormFieldSignature) o; return Objects.equals(this.type, templateResponseDocumentFormFieldSignature.type) && + Objects.equals(this.group, templateResponseDocumentFormFieldSignature.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -120,6 +150,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldSignature {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -148,6 +179,25 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java index db2192813..2474e5298 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java @@ -43,7 +43,8 @@ TemplateResponseDocumentFormFieldText.JSON_PROPERTY_IS_MULTILINE, TemplateResponseDocumentFormFieldText.JSON_PROPERTY_ORIGINAL_FONT_SIZE, TemplateResponseDocumentFormFieldText.JSON_PROPERTY_FONT_FAMILY, - TemplateResponseDocumentFormFieldText.JSON_PROPERTY_VALIDATION_TYPE + TemplateResponseDocumentFormFieldText.JSON_PROPERTY_VALIDATION_TYPE, + TemplateResponseDocumentFormFieldText.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -122,6 +123,9 @@ public static ValidationTypeEnum fromValue(String value) { public static final String JSON_PROPERTY_VALIDATION_TYPE = "validation_type"; private ValidationTypeEnum validationType; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldText() { } @@ -174,9 +178,9 @@ public TemplateResponseDocumentFormFieldText avgTextLength(TemplateResponseField * Get avgTextLength * @return avgTextLength */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; @@ -184,7 +188,7 @@ public TemplateResponseFieldAvgTextLength getAvgTextLength() { @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -199,9 +203,9 @@ public TemplateResponseDocumentFormFieldText isMultiline(Boolean isMultiline) { * Whether this form field is multiline text. * @return isMultiline */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsMultiline() { return isMultiline; @@ -209,7 +213,7 @@ public Boolean getIsMultiline() { @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -224,9 +228,9 @@ public TemplateResponseDocumentFormFieldText originalFontSize(Integer originalFo * Original font size used in this form field's text. * @return originalFontSize */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getOriginalFontSize() { return originalFontSize; @@ -234,7 +238,7 @@ public Integer getOriginalFontSize() { @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -249,9 +253,9 @@ public TemplateResponseDocumentFormFieldText fontFamily(String fontFamily) { * Font family used in this form field's text. * @return fontFamily */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getFontFamily() { return fontFamily; @@ -259,7 +263,7 @@ public String getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } @@ -290,6 +294,31 @@ public void setValidationType(ValidationTypeEnum validationType) { } + public TemplateResponseDocumentFormFieldText group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldText object is equal to o. */ @@ -308,12 +337,13 @@ public boolean equals(Object o) { Objects.equals(this.originalFontSize, templateResponseDocumentFormFieldText.originalFontSize) && Objects.equals(this.fontFamily, templateResponseDocumentFormFieldText.fontFamily) && Objects.equals(this.validationType, templateResponseDocumentFormFieldText.validationType) && + Objects.equals(this.group, templateResponseDocumentFormFieldText.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, avgTextLength, isMultiline, originalFontSize, fontFamily, validationType, super.hashCode()); + return Objects.hash(type, avgTextLength, isMultiline, originalFontSize, fontFamily, validationType, group, super.hashCode()); } @Override @@ -327,6 +357,7 @@ public String toString() { sb.append(" originalFontSize: ").append(toIndentedString(originalFontSize)).append("\n"); sb.append(" fontFamily: ").append(toIndentedString(fontFamily)).append("\n"); sb.append(" validationType: ").append(toIndentedString(validationType)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -450,6 +481,25 @@ public Map createFormData() throws ApiException { map.put("validation_type", JSON.getDefault().getMapper().writeValueAsString(validationType)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java index 4e1e98229..96a4e8d85 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java @@ -36,9 +36,9 @@ * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. */ @JsonPropertyOrder({ - TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_NAME, + TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_Y, @@ -65,15 +65,15 @@ }) public class TemplateResponseDocumentStaticFieldBase { - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + public static final String JSON_PROPERTY_SIGNER = "signer"; private String signer = "me_now"; @@ -113,31 +113,6 @@ static public TemplateResponseDocumentStaticFieldBase init(HashMap data) throws ); } - public TemplateResponseDocumentStaticFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * @return type - */ - @jakarta.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getType() { - return type; - } - - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - - public TemplateResponseDocumentStaticFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -147,9 +122,9 @@ public TemplateResponseDocumentStaticFieldBase apiId(String apiId) { * A unique id for the static field. * @return apiId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getApiId() { return apiId; @@ -157,7 +132,7 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -172,9 +147,9 @@ public TemplateResponseDocumentStaticFieldBase name(String name) { * The name of the static field. * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -182,12 +157,37 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } + public TemplateResponseDocumentStaticFieldBase type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getType() { + return type; + } + + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; + } + + public TemplateResponseDocumentStaticFieldBase signer(String signer) { this.signer = signer; return this; @@ -197,9 +197,9 @@ public TemplateResponseDocumentStaticFieldBase signer(String signer) { * The signer of the Static Field. * @return signer */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSigner() { return signer; @@ -207,7 +207,7 @@ public String getSigner() { @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSigner(String signer) { this.signer = signer; } @@ -222,9 +222,9 @@ public TemplateResponseDocumentStaticFieldBase x(Integer x) { * The horizontal offset in pixels for this static field. * @return x */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getX() { return x; @@ -232,7 +232,7 @@ public Integer getX() { @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setX(Integer x) { this.x = x; } @@ -247,9 +247,9 @@ public TemplateResponseDocumentStaticFieldBase y(Integer y) { * The vertical offset in pixels for this static field. * @return y */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getY() { return y; @@ -257,7 +257,7 @@ public Integer getY() { @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setY(Integer y) { this.y = y; } @@ -272,9 +272,9 @@ public TemplateResponseDocumentStaticFieldBase width(Integer width) { * The width in pixels of this static field. * @return width */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getWidth() { return width; @@ -282,7 +282,7 @@ public Integer getWidth() { @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setWidth(Integer width) { this.width = width; } @@ -297,9 +297,9 @@ public TemplateResponseDocumentStaticFieldBase height(Integer height) { * The height in pixels of this static field. * @return height */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getHeight() { return height; @@ -307,7 +307,7 @@ public Integer getHeight() { @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setHeight(Integer height) { this.height = height; } @@ -322,9 +322,9 @@ public TemplateResponseDocumentStaticFieldBase required(Boolean required) { * Boolean showing whether or not this field is required. * @return required */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getRequired() { return required; @@ -332,7 +332,7 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequired(Boolean required) { this.required = required; } @@ -375,9 +375,9 @@ public boolean equals(Object o) { return false; } TemplateResponseDocumentStaticFieldBase templateResponseDocumentStaticFieldBase = (TemplateResponseDocumentStaticFieldBase) o; - return Objects.equals(this.type, templateResponseDocumentStaticFieldBase.type) && - Objects.equals(this.apiId, templateResponseDocumentStaticFieldBase.apiId) && + return Objects.equals(this.apiId, templateResponseDocumentStaticFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentStaticFieldBase.name) && + Objects.equals(this.type, templateResponseDocumentStaticFieldBase.type) && Objects.equals(this.signer, templateResponseDocumentStaticFieldBase.signer) && Objects.equals(this.x, templateResponseDocumentStaticFieldBase.x) && Objects.equals(this.y, templateResponseDocumentStaticFieldBase.y) && @@ -389,16 +389,16 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); + return Objects.hash(apiId, name, type, signer, x, y, width, height, required, group); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentStaticFieldBase {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); @@ -414,25 +414,6 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) || - type.getClass().equals(Integer.class) || - type.getClass().equals(String.class) || - type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for(int i = 0; i< getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } - else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -471,6 +452,25 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { + fileTypeFound = true; + } + + if (type.getClass().equals(java.io.File.class) || + type.getClass().equals(Integer.class) || + type.getClass().equals(String.class) || + type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for(int i = 0; i< getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); + } + } + else { + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + } + } if (signer != null) { if (isFileTypeOrListOfFiles(signer)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java index 38f5acd25..fc46699ac 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java @@ -72,9 +72,9 @@ public TemplateResponseFieldAvgTextLength numLines(Integer numLines) { * Number of lines. * @return numLines */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NUM_LINES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getNumLines() { return numLines; @@ -82,7 +82,7 @@ public Integer getNumLines() { @JsonProperty(JSON_PROPERTY_NUM_LINES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setNumLines(Integer numLines) { this.numLines = numLines; } @@ -97,9 +97,9 @@ public TemplateResponseFieldAvgTextLength numCharsPerLine(Integer numCharsPerLin * Number of characters per line. * @return numCharsPerLine */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getNumCharsPerLine() { return numCharsPerLine; @@ -107,7 +107,7 @@ public Integer getNumCharsPerLine() { @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setNumCharsPerLine(Integer numCharsPerLine) { this.numCharsPerLine = numCharsPerLine; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java index 45d786a89..d1463cbd8 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java @@ -72,9 +72,9 @@ public TemplateResponseSignerRole name(String name) { * The name of the Role. * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -82,7 +82,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java index 19dea91bd..fb4c17ded 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java @@ -76,9 +76,9 @@ public TemplateUpdateFilesResponseTemplate templateId(String templateId) { * The id of the Template. * @return templateId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; @@ -86,7 +86,7 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index d95c19e31..27094d35b 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -22503,16 +22503,6 @@ TemplateResponse.attributeTypeMap = [ baseName: "message", type: "string" }, - { - name: "updatedAt", - baseName: "updated_at", - type: "number" - }, - { - name: "isEmbedded", - baseName: "is_embedded", - type: "boolean" - }, { name: "isCreator", baseName: "is_creator", @@ -22548,6 +22538,26 @@ TemplateResponse.attributeTypeMap = [ baseName: "documents", type: "Array" }, + { + name: "accounts", + baseName: "accounts", + type: "Array" + }, + { + name: "attachments", + baseName: "attachments", + type: "Array" + }, + { + name: "updatedAt", + baseName: "updated_at", + type: "number" + }, + { + name: "isEmbedded", + baseName: "is_embedded", + type: "boolean" + }, { name: "customFields", baseName: "custom_fields", @@ -22557,11 +22567,6 @@ TemplateResponse.attributeTypeMap = [ name: "namedFormFields", baseName: "named_form_fields", type: "Array" - }, - { - name: "accounts", - baseName: "accounts", - type: "Array" } ]; @@ -22582,11 +22587,6 @@ TemplateResponseAccount.attributeTypeMap = [ baseName: "account_id", type: "string" }, - { - name: "emailAddress", - baseName: "email_address", - type: "string" - }, { name: "isLocked", baseName: "is_locked", @@ -22606,6 +22606,11 @@ TemplateResponseAccount.attributeTypeMap = [ name: "quotas", baseName: "quotas", type: "TemplateResponseAccountQuota" + }, + { + name: "emailAddress", + baseName: "email_address", + type: "string" } ]; @@ -22679,11 +22684,6 @@ TemplateResponseDocument.attributeTypeMap = [ baseName: "name", type: "string" }, - { - name: "index", - baseName: "index", - type: "number" - }, { name: "fieldGroups", baseName: "field_groups", @@ -22703,6 +22703,11 @@ TemplateResponseDocument.attributeTypeMap = [ name: "staticFields", baseName: "static_fields", type: "Array" + }, + { + name: "index", + baseName: "index", + type: "number" } ]; @@ -22727,11 +22732,6 @@ var _TemplateResponseDocumentCustomFieldBase = class { var TemplateResponseDocumentCustomFieldBase = _TemplateResponseDocumentCustomFieldBase; TemplateResponseDocumentCustomFieldBase.discriminator = "type"; TemplateResponseDocumentCustomFieldBase.attributeTypeMap = [ - { - name: "type", - baseName: "type", - type: "string" - }, { name: "apiId", baseName: "api_id", @@ -22743,8 +22743,8 @@ TemplateResponseDocumentCustomFieldBase.attributeTypeMap = [ type: "string" }, { - name: "signer", - baseName: "signer", + name: "type", + baseName: "type", type: "string" }, { @@ -22772,6 +22772,11 @@ TemplateResponseDocumentCustomFieldBase.attributeTypeMap = [ baseName: "required", type: "boolean" }, + { + name: "signer", + baseName: "signer", + type: "string" + }, { name: "group", baseName: "group", @@ -22944,11 +22949,6 @@ var _TemplateResponseDocumentFormFieldBase = class { var TemplateResponseDocumentFormFieldBase = _TemplateResponseDocumentFormFieldBase; TemplateResponseDocumentFormFieldBase.discriminator = "type"; TemplateResponseDocumentFormFieldBase.attributeTypeMap = [ - { - name: "type", - baseName: "type", - type: "string" - }, { name: "apiId", baseName: "api_id", @@ -22959,6 +22959,11 @@ TemplateResponseDocumentFormFieldBase.attributeTypeMap = [ baseName: "name", type: "string" }, + { + name: "type", + baseName: "type", + type: "string" + }, { name: "signer", baseName: "signer", @@ -22988,11 +22993,6 @@ TemplateResponseDocumentFormFieldBase.attributeTypeMap = [ name: "required", baseName: "required", type: "boolean" - }, - { - name: "group", - baseName: "group", - type: "string" } ]; @@ -23019,6 +23019,11 @@ TemplateResponseDocumentFormFieldCheckbox.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23045,6 +23050,11 @@ TemplateResponseDocumentFormFieldDateSigned.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23071,6 +23081,11 @@ TemplateResponseDocumentFormFieldDropdown.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23117,6 +23132,11 @@ TemplateResponseDocumentFormFieldHyperlink.attributeTypeMap = [ name: "fontFamily", baseName: "fontFamily", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23143,6 +23163,11 @@ TemplateResponseDocumentFormFieldInitials.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23169,6 +23194,11 @@ TemplateResponseDocumentFormFieldRadio.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23195,6 +23225,11 @@ TemplateResponseDocumentFormFieldSignature.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23246,6 +23281,11 @@ TemplateResponseDocumentFormFieldText.attributeTypeMap = [ name: "validationType", baseName: "validation_type", type: "TemplateResponseDocumentFormFieldText.ValidationTypeEnum" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; ((TemplateResponseDocumentFormFieldText2) => { @@ -23306,11 +23346,6 @@ var _TemplateResponseDocumentStaticFieldBase = class { var TemplateResponseDocumentStaticFieldBase = _TemplateResponseDocumentStaticFieldBase; TemplateResponseDocumentStaticFieldBase.discriminator = "type"; TemplateResponseDocumentStaticFieldBase.attributeTypeMap = [ - { - name: "type", - baseName: "type", - type: "string" - }, { name: "apiId", baseName: "api_id", @@ -23321,6 +23356,11 @@ TemplateResponseDocumentStaticFieldBase.attributeTypeMap = [ baseName: "name", type: "string" }, + { + name: "type", + baseName: "type", + type: "string" + }, { name: "signer", baseName: "signer", diff --git a/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md index 05c82cd71..0a13c1f8e 100644 --- a/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -6,9 +6,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId` | ```string``` | The id of the Template. | | -| `editUrl` | ```string``` | Link to edit the template. | | -| `expiresAt` | ```number``` | When the link expires. | | +| `templateId`*_required_ | ```string``` | The id of the Template. | | +| `editUrl`*_required_ | ```string``` | Link to edit the template. | | +| `expiresAt`*_required_ | ```number``` | When the link expires. | | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | [[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/TemplateCreateResponseTemplate.md b/sdks/node/docs/model/TemplateCreateResponseTemplate.md index 3b4e62005..f96ba4cd2 100644 --- a/sdks/node/docs/model/TemplateCreateResponseTemplate.md +++ b/sdks/node/docs/model/TemplateCreateResponseTemplate.md @@ -6,6 +6,6 @@ Template object with parameters: `template_id`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId` | ```string``` | The id of the Template. | | +| `templateId`*_required_ | ```string``` | The id of the Template. | | [[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/TemplateResponse.md b/sdks/node/docs/model/TemplateResponse.md index e82af4305..868e86155 100644 --- a/sdks/node/docs/model/TemplateResponse.md +++ b/sdks/node/docs/model/TemplateResponse.md @@ -6,20 +6,21 @@ Contains information about the templates you and your team have created. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId` | ```string``` | The id of the Template. | | -| `title` | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `templateId`*_required_ | ```string``` | The id of the Template. | | +| `title`*_required_ | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message`*_required_ | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `isCreator`*_required_ | ```boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `canEdit`*_required_ | ```boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `isLocked`*_required_ | ```boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata`*_required_ | ```object``` | The metadata attached to the template. | | +| `signerRoles`*_required_ | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `ccRoles`*_required_ | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | +| `documents`*_required_ | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `accounts`*_required_ | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments`*_required_ | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updatedAt` | ```number``` | Time the template was last updated. | | -| `isEmbedded` | ```boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `isCreator` | ```boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `canEdit` | ```boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `isLocked` | ```boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata` | ```object``` | The metadata attached to the template. | | -| `signerRoles` | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `ccRoles` | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `isEmbedded` | ```boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | | `customFields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | [[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/TemplateResponseAccount.md b/sdks/node/docs/model/TemplateResponseAccount.md index 524109d96..eb890053e 100644 --- a/sdks/node/docs/model/TemplateResponseAccount.md +++ b/sdks/node/docs/model/TemplateResponseAccount.md @@ -6,11 +6,11 @@ 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_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.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` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | [[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/TemplateResponseAccountQuota.md b/sdks/node/docs/model/TemplateResponseAccountQuota.md index 587c6dab3..ff782d764 100644 --- a/sdks/node/docs/model/TemplateResponseAccountQuota.md +++ b/sdks/node/docs/model/TemplateResponseAccountQuota.md @@ -6,9 +6,9 @@ An array of the designated CC roles that must be specified when sending a Signat Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templatesLeft` | ```number``` | API templates remaining. | | -| `apiSignatureRequestsLeft` | ```number``` | API signature requests remaining. | | -| `documentsLeft` | ```number``` | Signature requests remaining. | | -| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | | +| `templatesLeft`*_required_ | ```number``` | API templates remaining. | | +| `apiSignatureRequestsLeft`*_required_ | ```number``` | API signature requests remaining. | | +| `documentsLeft`*_required_ | ```number``` | Signature requests remaining. | | +| `smsVerificationsLeft`*_required_ | ```number``` | SMS verifications remaining. | | [[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/TemplateResponseCCRole.md b/sdks/node/docs/model/TemplateResponseCCRole.md index 32ad82ef9..74c81b18d 100644 --- a/sdks/node/docs/model/TemplateResponseCCRole.md +++ b/sdks/node/docs/model/TemplateResponseCCRole.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the Role. | | +| `name`*_required_ | ```string``` | The name of the Role. | | [[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/TemplateResponseDocument.md b/sdks/node/docs/model/TemplateResponseDocument.md index 5f3f0d214..50fa698f4 100644 --- a/sdks/node/docs/model/TemplateResponseDocument.md +++ b/sdks/node/docs/model/TemplateResponseDocument.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | Name of the associated file. | | +| `name`*_required_ | ```string``` | Name of the associated file. | | +| `fieldGroups`*_required_ | [```Array```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `formFields`*_required_ | [```Array```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `customFields`*_required_ | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `staticFields`*_required_ | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | | `index` | ```number``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `fieldGroups` | [```Array```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `formFields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `customFields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `staticFields` | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | [[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/TemplateResponseDocumentCustomFieldBase.md b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldBase.md index 81418366f..4a9b70f2a 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldBase.md @@ -6,15 +6,15 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `apiId`*_required_ | ```string``` | The unique ID for this field. | | +| `name`*_required_ | ```string``` | The name of the Custom Field. | | | `type`*_required_ | ```string``` | | | -| `apiId` | ```string``` | The unique ID for this field. | | -| `name` | ```string``` | The name of the Custom Field. | | +| `x`*_required_ | ```number``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```number``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```number``` | The width in pixels of this form field. | | +| `height`*_required_ | ```number``` | The height in pixels of this form field. | | +| `required`*_required_ | ```boolean``` | Boolean showing whether or not this field is required. | | | `signer` | ```string``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```number``` | The horizontal offset in pixels for this form field. | | -| `y` | ```number``` | The vertical offset in pixels for this form field. | | -| `width` | ```number``` | The width in pixels of this form field. | | -| `height` | ```number``` | The height in pixels of this form field. | | -| `required` | ```boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseDocumentCustomFieldText.md b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldText.md index 035c69583..84a007361 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldText.md @@ -7,9 +7,9 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```number``` | Original font size used in this form field's text. | | -| `fontFamily` | ```string``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```number``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```string``` | Font family used in this form field's text. | | [[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/TemplateResponseDocumentFieldGroup.md b/sdks/node/docs/model/TemplateResponseDocumentFieldGroup.md index 51f7c3369..b60f4eb75 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFieldGroup.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFieldGroup.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the form field group. | | -| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name`*_required_ | ```string``` | The name of the form field group. | | +| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | [[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/TemplateResponseDocumentFieldGroupRule.md b/sdks/node/docs/model/TemplateResponseDocumentFieldGroupRule.md index 95e4fa470..965bc8c08 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFieldGroupRule.md @@ -6,7 +6,7 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `requirement` | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `groupLabel` | ```string``` | Name of the group | | +| `requirement`*_required_ | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `groupLabel`*_required_ | ```string``` | Name of the group | | [[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/TemplateResponseDocumentFormFieldBase.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldBase.md index 859662984..bdae5de92 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldBase.md @@ -6,15 +6,14 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `apiId`*_required_ | ```string``` | A unique id for the form field. | | +| `name`*_required_ | ```string``` | The name of the form field. | | | `type`*_required_ | ```string``` | | | -| `apiId` | ```string``` | A unique id for the form field. | | -| `name` | ```string``` | The name of the form field. | | -| `signer` | ```string``` | The signer of the Form Field. | | -| `x` | ```number``` | The horizontal offset in pixels for this form field. | | -| `y` | ```number``` | The vertical offset in pixels for this form field. | | -| `width` | ```number``` | The width in pixels of this form field. | | -| `height` | ```number``` | The height in pixels of this form field. | | -| `required` | ```boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `signer`*_required_ | ```string``` | The signer of the Form Field. | | +| `x`*_required_ | ```number``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```number``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```number``` | The width in pixels of this form field. | | +| `height`*_required_ | ```number``` | The height in pixels of this form field. | | +| `required`*_required_ | ```boolean``` | Boolean showing whether or not this field is required. | | [[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/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldCheckbox.md index f2153cbc1..2ee1b9e5e 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldCheckbox.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldDateSigned.md index ada92f315..8996ce7a3 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldDateSigned.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldDropdown.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldDropdown.md index c868840bd..35cadabb5 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldDropdown.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldHyperlink.md index fadb22b4f..ec72f7901 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldHyperlink.md @@ -7,9 +7,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```number``` | Original font size used in this form field's text. | | -| `fontFamily` | ```string``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```number``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```string``` | Font family used in this form field's text. | | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldInitials.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldInitials.md index 9040699a9..ab0ccda06 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldInitials.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldRadio.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldRadio.md index 409352e50..3b888caf7 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldRadio.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | +| `group`*_required_ | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldSignature.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldSignature.md index 3336b5b0d..b46f1d963 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldSignature.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldText.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldText.md index c335bce0a..c2769f4fc 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldText.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldText.md @@ -7,10 +7,11 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```number``` | Original font size used in this form field's text. | | -| `fontFamily` | ```string``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```number``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```string``` | Font family used in this form field's text. | | | `validationType` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentStaticFieldBase.md b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldBase.md index 243c1d108..a5fe1b0f6 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldBase.md @@ -6,15 +6,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `apiId`*_required_ | ```string``` | A unique id for the static field. | | +| `name`*_required_ | ```string``` | The name of the static field. | | | `type`*_required_ | ```string``` | | | -| `apiId` | ```string``` | A unique id for the static field. | | -| `name` | ```string``` | The name of the static field. | | -| `signer` | ```string``` | The signer of the Static Field. | [default to 'me_now'] | -| `x` | ```number``` | The horizontal offset in pixels for this static field. | | -| `y` | ```number``` | The vertical offset in pixels for this static field. | | -| `width` | ```number``` | The width in pixels of this static field. | | -| `height` | ```number``` | The height in pixels of this static field. | | -| `required` | ```boolean``` | Boolean showing whether or not this field is required. | | +| `signer`*_required_ | ```string``` | The signer of the Static Field. | [default to 'me_now'] | +| `x`*_required_ | ```number``` | The horizontal offset in pixels for this static field. | | +| `y`*_required_ | ```number``` | The vertical offset in pixels for this static field. | | +| `width`*_required_ | ```number``` | The width in pixels of this static field. | | +| `height`*_required_ | ```number``` | The height in pixels of this static field. | | +| `required`*_required_ | ```boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseFieldAvgTextLength.md b/sdks/node/docs/model/TemplateResponseFieldAvgTextLength.md index 45daf9dae..585551694 100644 --- a/sdks/node/docs/model/TemplateResponseFieldAvgTextLength.md +++ b/sdks/node/docs/model/TemplateResponseFieldAvgTextLength.md @@ -6,7 +6,7 @@ Average text length in this field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `numLines` | ```number``` | Number of lines. | | -| `numCharsPerLine` | ```number``` | Number of characters per line. | | +| `numLines`*_required_ | ```number``` | Number of lines. | | +| `numCharsPerLine`*_required_ | ```number``` | Number of characters per line. | | [[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/TemplateResponseSignerRole.md b/sdks/node/docs/model/TemplateResponseSignerRole.md index e33fced3c..d3456d9cf 100644 --- a/sdks/node/docs/model/TemplateResponseSignerRole.md +++ b/sdks/node/docs/model/TemplateResponseSignerRole.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the Role. | | +| `name`*_required_ | ```string``` | The name of the Role. | | | `order` | ```number``` | If signer order is assigned this is the 0-based index for this role. | | [[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/TemplateUpdateFilesResponseTemplate.md b/sdks/node/docs/model/TemplateUpdateFilesResponseTemplate.md index aea14ab0c..90feb3f29 100644 --- a/sdks/node/docs/model/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/node/docs/model/TemplateUpdateFilesResponseTemplate.md @@ -6,7 +6,7 @@ Contains template id Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId` | ```string``` | The id of the Template. | | +| `templateId`*_required_ | ```string``` | The id of the Template. | | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | [[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/templateCreateEmbeddedDraftResponseTemplate.ts b/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts index af7f9a71b..259954445 100644 --- a/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts +++ b/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts @@ -32,15 +32,15 @@ export class TemplateCreateEmbeddedDraftResponseTemplate { /** * The id of the Template. */ - "templateId"?: string; + "templateId": string; /** * Link to edit the template. */ - "editUrl"?: string; + "editUrl": string; /** * When the link expires. */ - "expiresAt"?: number; + "expiresAt": number; /** * A list of warnings. */ diff --git a/sdks/node/model/templateCreateResponseTemplate.ts b/sdks/node/model/templateCreateResponseTemplate.ts index cdcd61167..e6e8a7ea6 100644 --- a/sdks/node/model/templateCreateResponseTemplate.ts +++ b/sdks/node/model/templateCreateResponseTemplate.ts @@ -31,7 +31,7 @@ export class TemplateCreateResponseTemplate { /** * The id of the Template. */ - "templateId"?: string; + "templateId": string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponse.ts b/sdks/node/model/templateResponse.ts index 88df4c09b..c115a359c 100644 --- a/sdks/node/model/templateResponse.ts +++ b/sdks/node/model/templateResponse.ts @@ -23,6 +23,7 @@ */ import { AttributeTypeMap, ObjectSerializer } from "./"; +import { SignatureRequestResponseAttachment } from "./signatureRequestResponseAttachment"; import { TemplateResponseAccount } from "./templateResponseAccount"; import { TemplateResponseCCRole } from "./templateResponseCCRole"; import { TemplateResponseDocument } from "./templateResponseDocument"; @@ -37,51 +38,59 @@ export class TemplateResponse { /** * The id of the Template. */ - "templateId"?: string; + "templateId": string; /** * The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. */ - "title"?: string; + "title": string; /** * The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. */ - "message"?: string; - /** - * Time the template was last updated. - */ - "updatedAt"?: number; - /** - * `true` if this template was created using an embedded flow, `false` if it was created on our website. - */ - "isEmbedded"?: boolean | null; + "message": string; /** * `true` if you are the owner of this template, `false` if it\'s been shared with you by a team member. */ - "isCreator"?: boolean | null; + "isCreator": boolean; /** * Indicates whether edit rights have been granted to you by the owner (always `true` if that\'s you). */ - "canEdit"?: boolean | null; + "canEdit": boolean; /** * Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. */ - "isLocked"?: boolean | null; + "isLocked": boolean; /** * The metadata attached to the template. */ - "metadata"?: object; + "metadata": object; /** * An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. */ - "signerRoles"?: Array; + "signerRoles": Array; /** * An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. */ - "ccRoles"?: Array; + "ccRoles": Array; /** * An array describing each document associated with this Template. Includes form field data for each document. */ - "documents"?: Array; + "documents": Array; + /** + * An array of the Accounts that can use this Template. + */ + "accounts": Array; + /** + * Signer attachments. + */ + "attachments": Array; + /** + * Time the template was last updated. + */ + "updatedAt"?: number; + /** + * `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + */ + "isEmbedded"?: boolean | null; /** * Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. */ @@ -90,10 +99,6 @@ export class TemplateResponse { * Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. */ "namedFormFields"?: Array | null; - /** - * An array of the Accounts that can use this Template. - */ - "accounts"?: Array | null; static discriminator: string | undefined = undefined; @@ -113,16 +118,6 @@ export class TemplateResponse { baseName: "message", type: "string", }, - { - name: "updatedAt", - baseName: "updated_at", - type: "number", - }, - { - name: "isEmbedded", - baseName: "is_embedded", - type: "boolean", - }, { name: "isCreator", baseName: "is_creator", @@ -158,6 +153,26 @@ export class TemplateResponse { baseName: "documents", type: "Array", }, + { + name: "accounts", + baseName: "accounts", + type: "Array", + }, + { + name: "attachments", + baseName: "attachments", + type: "Array", + }, + { + name: "updatedAt", + baseName: "updated_at", + type: "number", + }, + { + name: "isEmbedded", + baseName: "is_embedded", + type: "boolean", + }, { name: "customFields", baseName: "custom_fields", @@ -168,11 +183,6 @@ export class TemplateResponse { baseName: "named_form_fields", type: "Array", }, - { - name: "accounts", - baseName: "accounts", - type: "Array", - }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseAccount.ts b/sdks/node/model/templateResponseAccount.ts index 3b43d9351..86f230130 100644 --- a/sdks/node/model/templateResponseAccount.ts +++ b/sdks/node/model/templateResponseAccount.ts @@ -29,24 +29,24 @@ export class TemplateResponseAccount { /** * 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"?: TemplateResponseAccountQuota; + "isPaidHf": boolean; + "quotas": TemplateResponseAccountQuota; + /** + * The email address associated with the Account. + */ + "emailAddress"?: string; static discriminator: string | undefined = undefined; @@ -56,11 +56,6 @@ export class TemplateResponseAccount { baseName: "account_id", type: "string", }, - { - name: "emailAddress", - baseName: "email_address", - type: "string", - }, { name: "isLocked", baseName: "is_locked", @@ -81,6 +76,11 @@ export class TemplateResponseAccount { baseName: "quotas", type: "TemplateResponseAccountQuota", }, + { + name: "emailAddress", + baseName: "email_address", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseAccountQuota.ts b/sdks/node/model/templateResponseAccountQuota.ts index e2d6669b6..fbb4547ac 100644 --- a/sdks/node/model/templateResponseAccountQuota.ts +++ b/sdks/node/model/templateResponseAccountQuota.ts @@ -31,19 +31,19 @@ export class TemplateResponseAccountQuota { /** * API templates remaining. */ - "templatesLeft"?: number; + "templatesLeft": number; /** * API signature requests remaining. */ - "apiSignatureRequestsLeft"?: number; + "apiSignatureRequestsLeft": number; /** * Signature requests remaining. */ - "documentsLeft"?: number; + "documentsLeft": number; /** * SMS verifications remaining. */ - "smsVerificationsLeft"?: number; + "smsVerificationsLeft": number; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseCCRole.ts b/sdks/node/model/templateResponseCCRole.ts index b3b7a2fd7..442fe1f89 100644 --- a/sdks/node/model/templateResponseCCRole.ts +++ b/sdks/node/model/templateResponseCCRole.ts @@ -28,7 +28,7 @@ export class TemplateResponseCCRole { /** * The name of the Role. */ - "name"?: string; + "name": string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseDocument.ts b/sdks/node/model/templateResponseDocument.ts index 0c7a19e02..4b55dfe81 100644 --- a/sdks/node/model/templateResponseDocument.ts +++ b/sdks/node/model/templateResponseDocument.ts @@ -32,27 +32,27 @@ export class TemplateResponseDocument { /** * Name of the associated file. */ - "name"?: string; - /** - * Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - */ - "index"?: number; + "name": string; /** * An array of Form Field Group objects. */ - "fieldGroups"?: Array; + "fieldGroups": Array; /** * An array of Form Field objects containing the name and type of each named field. */ - "formFields"?: Array; + "formFields": Array; /** * An array of Form Field objects containing the name and type of each named field. */ - "customFields"?: Array; + "customFields": Array; /** * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. */ - "staticFields"?: Array | null; + "staticFields": Array; + /** + * Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + */ + "index"?: number; static discriminator: string | undefined = undefined; @@ -62,11 +62,6 @@ export class TemplateResponseDocument { baseName: "name", type: "string", }, - { - name: "index", - baseName: "index", - type: "number", - }, { name: "fieldGroups", baseName: "field_groups", @@ -87,6 +82,11 @@ export class TemplateResponseDocument { baseName: "static_fields", type: "Array", }, + { + name: "index", + baseName: "index", + type: "number", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentCustomFieldBase.ts b/sdks/node/model/templateResponseDocumentCustomFieldBase.ts index a0ed43965..340f9200d 100644 --- a/sdks/node/model/templateResponseDocumentCustomFieldBase.ts +++ b/sdks/node/model/templateResponseDocumentCustomFieldBase.ts @@ -28,39 +28,39 @@ import { AttributeTypeMap } from "./"; * An array of Form Field objects containing the name and type of each named field. */ export abstract class TemplateResponseDocumentCustomFieldBase { - "type": string; /** * The unique ID for this field. */ - "apiId"?: string; + "apiId": string; /** * The name of the Custom Field. */ - "name"?: string; - /** - * The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). - */ - "signer"?: number | string | null; + "name": string; + "type": string; /** * The horizontal offset in pixels for this form field. */ - "x"?: number; + "x": number; /** * The vertical offset in pixels for this form field. */ - "y"?: number; + "y": number; /** * The width in pixels of this form field. */ - "width"?: number; + "width": number; /** * The height in pixels of this form field. */ - "height"?: number; + "height": number; /** * Boolean showing whether or not this field is required. */ - "required"?: boolean; + "required": boolean; + /** + * The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + */ + "signer"?: number | string | null; /** * The name of the group this field is in. If this field is not a group, this defaults to `null`. */ @@ -69,11 +69,6 @@ export abstract class TemplateResponseDocumentCustomFieldBase { static discriminator: string | undefined = "type"; static attributeTypeMap: AttributeTypeMap = [ - { - name: "type", - baseName: "type", - type: "string", - }, { name: "apiId", baseName: "api_id", @@ -85,8 +80,8 @@ export abstract class TemplateResponseDocumentCustomFieldBase { type: "string", }, { - name: "signer", - baseName: "signer", + name: "type", + baseName: "type", type: "string", }, { @@ -114,6 +109,11 @@ export abstract class TemplateResponseDocumentCustomFieldBase { baseName: "required", type: "boolean", }, + { + name: "signer", + baseName: "signer", + type: "string", + }, { name: "group", baseName: "group", diff --git a/sdks/node/model/templateResponseDocumentCustomFieldText.ts b/sdks/node/model/templateResponseDocumentCustomFieldText.ts index 3f59efc19..f07ba6b45 100644 --- a/sdks/node/model/templateResponseDocumentCustomFieldText.ts +++ b/sdks/node/model/templateResponseDocumentCustomFieldText.ts @@ -34,19 +34,19 @@ export class TemplateResponseDocumentCustomFieldText extends TemplateResponseDoc * The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` */ "type": string = "text"; - "avgTextLength"?: TemplateResponseFieldAvgTextLength; + "avgTextLength": TemplateResponseFieldAvgTextLength; /** * Whether this form field is multiline text. */ - "isMultiline"?: boolean; + "isMultiline": boolean; /** * Original font size used in this form field\'s text. */ - "originalFontSize"?: number; + "originalFontSize": number; /** * Font family used in this form field\'s text. */ - "fontFamily"?: string; + "fontFamily": string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseDocumentFieldGroup.ts b/sdks/node/model/templateResponseDocumentFieldGroup.ts index 4d2f9c695..820863174 100644 --- a/sdks/node/model/templateResponseDocumentFieldGroup.ts +++ b/sdks/node/model/templateResponseDocumentFieldGroup.ts @@ -29,8 +29,8 @@ export class TemplateResponseDocumentFieldGroup { /** * The name of the form field group. */ - "name"?: string; - "rule"?: TemplateResponseDocumentFieldGroupRule; + "name": string; + "rule": TemplateResponseDocumentFieldGroupRule; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseDocumentFieldGroupRule.ts b/sdks/node/model/templateResponseDocumentFieldGroupRule.ts index f5ad93cf4..4e8f93b10 100644 --- a/sdks/node/model/templateResponseDocumentFieldGroupRule.ts +++ b/sdks/node/model/templateResponseDocumentFieldGroupRule.ts @@ -31,11 +31,11 @@ export class TemplateResponseDocumentFieldGroupRule { /** * Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. */ - "requirement"?: string; + "requirement": string; /** * Name of the group */ - "groupLabel"?: string; + "groupLabel": string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseDocumentFormFieldBase.ts b/sdks/node/model/templateResponseDocumentFormFieldBase.ts index 94242a4a9..e7aa32f85 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldBase.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldBase.ts @@ -28,52 +28,43 @@ import { AttributeTypeMap } from "./"; * An array of Form Field objects containing the name and type of each named field. */ export abstract class TemplateResponseDocumentFormFieldBase { - "type": string; /** * A unique id for the form field. */ - "apiId"?: string; + "apiId": string; /** * The name of the form field. */ - "name"?: string; + "name": string; + "type": string; /** * The signer of the Form Field. */ - "signer"?: number | string; + "signer": number | string; /** * The horizontal offset in pixels for this form field. */ - "x"?: number; + "x": number; /** * The vertical offset in pixels for this form field. */ - "y"?: number; + "y": number; /** * The width in pixels of this form field. */ - "width"?: number; + "width": number; /** * The height in pixels of this form field. */ - "height"?: number; + "height": number; /** * Boolean showing whether or not this field is required. */ - "required"?: boolean; - /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. - */ - "group"?: string | null; + "required": boolean; static discriminator: string | undefined = "type"; static attributeTypeMap: AttributeTypeMap = [ - { - name: "type", - baseName: "type", - type: "string", - }, { name: "apiId", baseName: "api_id", @@ -84,6 +75,11 @@ export abstract class TemplateResponseDocumentFormFieldBase { baseName: "name", type: "string", }, + { + name: "type", + baseName: "type", + type: "string", + }, { name: "signer", baseName: "signer", @@ -114,11 +110,6 @@ export abstract class TemplateResponseDocumentFormFieldBase { baseName: "required", type: "boolean", }, - { - name: "group", - baseName: "group", - type: "string", - }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldCheckbox.ts b/sdks/node/model/templateResponseDocumentFormFieldCheckbox.ts index 5e0b6d88b..e27a9fd0a 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldCheckbox.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldCheckbox.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseD * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "checkbox"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseD baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldDateSigned.ts b/sdks/node/model/templateResponseDocumentFormFieldDateSigned.ts index b510aa57f..08ce11026 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldDateSigned.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldDateSigned.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldDateSigned extends TemplateRespons * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "date_signed"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldDateSigned extends TemplateRespons baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldDropdown.ts b/sdks/node/model/templateResponseDocumentFormFieldDropdown.ts index e2878febc..0aeb3e4e0 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldDropdown.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldDropdown.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseD * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "dropdown"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseD baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts b/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts index 4a5998959..2c2113493 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts @@ -34,19 +34,23 @@ export class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponse * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "hyperlink"; - "avgTextLength"?: TemplateResponseFieldAvgTextLength; + "avgTextLength": TemplateResponseFieldAvgTextLength; /** * Whether this form field is multiline text. */ - "isMultiline"?: boolean; + "isMultiline": boolean; /** * Original font size used in this form field\'s text. */ - "originalFontSize"?: number; + "originalFontSize": number; /** * Font family used in this form field\'s text. */ - "fontFamily"?: string; + "fontFamily": string; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -76,6 +80,11 @@ export class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponse baseName: "fontFamily", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldInitials.ts b/sdks/node/model/templateResponseDocumentFormFieldInitials.ts index 1b14087a4..02f89a99e 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldInitials.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldInitials.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldInitials extends TemplateResponseD * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "initials"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldInitials extends TemplateResponseD baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldRadio.ts b/sdks/node/model/templateResponseDocumentFormFieldRadio.ts index 3a20f95a0..0841c0d5a 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldRadio.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldRadio.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocu * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "radio"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group": string; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocu baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldSignature.ts b/sdks/node/model/templateResponseDocumentFormFieldSignature.ts index c069e00aa..8467c9103 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldSignature.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldSignature.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldSignature extends TemplateResponse * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "signature"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldSignature extends TemplateResponse baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldText.ts b/sdks/node/model/templateResponseDocumentFormFieldText.ts index 2c320d342..9f8ebcc91 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldText.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldText.ts @@ -34,23 +34,27 @@ export class TemplateResponseDocumentFormFieldText extends TemplateResponseDocum * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "text"; - "avgTextLength"?: TemplateResponseFieldAvgTextLength; + "avgTextLength": TemplateResponseFieldAvgTextLength; /** * Whether this form field is multiline text. */ - "isMultiline"?: boolean; + "isMultiline": boolean; /** * Original font size used in this form field\'s text. */ - "originalFontSize"?: number; + "originalFontSize": number; /** * Font family used in this form field\'s text. */ - "fontFamily"?: string; + "fontFamily": string; /** * Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. */ "validationType"?: TemplateResponseDocumentFormFieldText.ValidationTypeEnum; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -85,6 +89,11 @@ export class TemplateResponseDocumentFormFieldText extends TemplateResponseDocum baseName: "validation_type", type: "TemplateResponseDocumentFormFieldText.ValidationTypeEnum", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentStaticFieldBase.ts b/sdks/node/model/templateResponseDocumentStaticFieldBase.ts index 04d3275ef..6640046d7 100644 --- a/sdks/node/model/templateResponseDocumentStaticFieldBase.ts +++ b/sdks/node/model/templateResponseDocumentStaticFieldBase.ts @@ -28,39 +28,39 @@ import { AttributeTypeMap } from "./"; * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. */ export abstract class TemplateResponseDocumentStaticFieldBase { - "type": string; /** * A unique id for the static field. */ - "apiId"?: string; + "apiId": string; /** * The name of the static field. */ - "name"?: string; + "name": string; + "type": string; /** * The signer of the Static Field. */ - "signer"?: string = "me_now"; + "signer": string = "me_now"; /** * The horizontal offset in pixels for this static field. */ - "x"?: number; + "x": number; /** * The vertical offset in pixels for this static field. */ - "y"?: number; + "y": number; /** * The width in pixels of this static field. */ - "width"?: number; + "width": number; /** * The height in pixels of this static field. */ - "height"?: number; + "height": number; /** * Boolean showing whether or not this field is required. */ - "required"?: boolean; + "required": boolean; /** * The name of the group this field is in. If this field is not a group, this defaults to `null`. */ @@ -69,11 +69,6 @@ export abstract class TemplateResponseDocumentStaticFieldBase { static discriminator: string | undefined = "type"; static attributeTypeMap: AttributeTypeMap = [ - { - name: "type", - baseName: "type", - type: "string", - }, { name: "apiId", baseName: "api_id", @@ -84,6 +79,11 @@ export abstract class TemplateResponseDocumentStaticFieldBase { baseName: "name", type: "string", }, + { + name: "type", + baseName: "type", + type: "string", + }, { name: "signer", baseName: "signer", diff --git a/sdks/node/model/templateResponseFieldAvgTextLength.ts b/sdks/node/model/templateResponseFieldAvgTextLength.ts index d0a4fc396..c95ebfbdd 100644 --- a/sdks/node/model/templateResponseFieldAvgTextLength.ts +++ b/sdks/node/model/templateResponseFieldAvgTextLength.ts @@ -31,11 +31,11 @@ export class TemplateResponseFieldAvgTextLength { /** * Number of lines. */ - "numLines"?: number; + "numLines": number; /** * Number of characters per line. */ - "numCharsPerLine"?: number; + "numCharsPerLine": number; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseSignerRole.ts b/sdks/node/model/templateResponseSignerRole.ts index 9bebd958f..a4950641a 100644 --- a/sdks/node/model/templateResponseSignerRole.ts +++ b/sdks/node/model/templateResponseSignerRole.ts @@ -28,7 +28,7 @@ export class TemplateResponseSignerRole { /** * The name of the Role. */ - "name"?: string; + "name": string; /** * If signer order is assigned this is the 0-based index for this role. */ diff --git a/sdks/node/model/templateUpdateFilesResponseTemplate.ts b/sdks/node/model/templateUpdateFilesResponseTemplate.ts index 98e18dabc..8d49e2d1b 100644 --- a/sdks/node/model/templateUpdateFilesResponseTemplate.ts +++ b/sdks/node/model/templateUpdateFilesResponseTemplate.ts @@ -32,7 +32,7 @@ export class TemplateUpdateFilesResponseTemplate { /** * The id of the Template. */ - "templateId"?: string; + "templateId": string; /** * A list of warnings. */ diff --git a/sdks/node/types/model/templateCreateEmbeddedDraftResponseTemplate.d.ts b/sdks/node/types/model/templateCreateEmbeddedDraftResponseTemplate.d.ts index 7287dbec2..124051aa9 100644 --- a/sdks/node/types/model/templateCreateEmbeddedDraftResponseTemplate.d.ts +++ b/sdks/node/types/model/templateCreateEmbeddedDraftResponseTemplate.d.ts @@ -1,9 +1,9 @@ import { AttributeTypeMap } from "./"; import { WarningResponse } from "./warningResponse"; export declare class TemplateCreateEmbeddedDraftResponseTemplate { - "templateId"?: string; - "editUrl"?: string; - "expiresAt"?: number; + "templateId": string; + "editUrl": string; + "expiresAt": number; "warnings"?: Array; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/templateCreateResponseTemplate.d.ts b/sdks/node/types/model/templateCreateResponseTemplate.d.ts index cc5c4e9a6..272ddeec1 100644 --- a/sdks/node/types/model/templateCreateResponseTemplate.d.ts +++ b/sdks/node/types/model/templateCreateResponseTemplate.d.ts @@ -1,6 +1,6 @@ import { AttributeTypeMap } from "./"; export declare class TemplateCreateResponseTemplate { - "templateId"?: string; + "templateId": string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponse.d.ts b/sdks/node/types/model/templateResponse.d.ts index 8ac333e50..a53df471b 100644 --- a/sdks/node/types/model/templateResponse.d.ts +++ b/sdks/node/types/model/templateResponse.d.ts @@ -1,4 +1,5 @@ import { AttributeTypeMap } from "./"; +import { SignatureRequestResponseAttachment } from "./signatureRequestResponseAttachment"; import { TemplateResponseAccount } from "./templateResponseAccount"; import { TemplateResponseCCRole } from "./templateResponseCCRole"; import { TemplateResponseDocument } from "./templateResponseDocument"; @@ -6,21 +7,22 @@ import { TemplateResponseDocumentCustomFieldBase } from "./templateResponseDocum import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; import { TemplateResponseSignerRole } from "./templateResponseSignerRole"; export declare class TemplateResponse { - "templateId"?: string; - "title"?: string; - "message"?: string; + "templateId": string; + "title": string; + "message": string; + "isCreator": boolean; + "canEdit": boolean; + "isLocked": boolean; + "metadata": object; + "signerRoles": Array; + "ccRoles": Array; + "documents": Array; + "accounts": Array; + "attachments": Array; "updatedAt"?: number; "isEmbedded"?: boolean | null; - "isCreator"?: boolean | null; - "canEdit"?: boolean | null; - "isLocked"?: boolean | null; - "metadata"?: object; - "signerRoles"?: Array; - "ccRoles"?: Array; - "documents"?: Array; "customFields"?: Array | null; "namedFormFields"?: Array | null; - "accounts"?: Array | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseAccount.d.ts b/sdks/node/types/model/templateResponseAccount.d.ts index 514cb2550..e8995a23f 100644 --- a/sdks/node/types/model/templateResponseAccount.d.ts +++ b/sdks/node/types/model/templateResponseAccount.d.ts @@ -1,12 +1,12 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseAccountQuota } from "./templateResponseAccountQuota"; export declare class TemplateResponseAccount { - "accountId"?: string; + "accountId": string; + "isLocked": boolean; + "isPaidHs": boolean; + "isPaidHf": boolean; + "quotas": TemplateResponseAccountQuota; "emailAddress"?: string; - "isLocked"?: boolean; - "isPaidHs"?: boolean; - "isPaidHf"?: boolean; - "quotas"?: TemplateResponseAccountQuota; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseAccountQuota.d.ts b/sdks/node/types/model/templateResponseAccountQuota.d.ts index e8ef0162f..c5ae8ac28 100644 --- a/sdks/node/types/model/templateResponseAccountQuota.d.ts +++ b/sdks/node/types/model/templateResponseAccountQuota.d.ts @@ -1,9 +1,9 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseAccountQuota { - "templatesLeft"?: number; - "apiSignatureRequestsLeft"?: number; - "documentsLeft"?: number; - "smsVerificationsLeft"?: number; + "templatesLeft": number; + "apiSignatureRequestsLeft": number; + "documentsLeft": number; + "smsVerificationsLeft": number; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseCCRole.d.ts b/sdks/node/types/model/templateResponseCCRole.d.ts index ebb6cd371..a96c9497c 100644 --- a/sdks/node/types/model/templateResponseCCRole.d.ts +++ b/sdks/node/types/model/templateResponseCCRole.d.ts @@ -1,6 +1,6 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseCCRole { - "name"?: string; + "name": string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocument.d.ts b/sdks/node/types/model/templateResponseDocument.d.ts index 41b453769..211537e77 100644 --- a/sdks/node/types/model/templateResponseDocument.d.ts +++ b/sdks/node/types/model/templateResponseDocument.d.ts @@ -4,12 +4,12 @@ import { TemplateResponseDocumentFieldGroup } from "./templateResponseDocumentFi import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; export declare class TemplateResponseDocument { - "name"?: string; + "name": string; + "fieldGroups": Array; + "formFields": Array; + "customFields": Array; + "staticFields": Array; "index"?: number; - "fieldGroups"?: Array; - "formFields"?: Array; - "customFields"?: Array; - "staticFields"?: Array | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentCustomFieldBase.d.ts b/sdks/node/types/model/templateResponseDocumentCustomFieldBase.d.ts index fa313114d..b3acf15af 100644 --- a/sdks/node/types/model/templateResponseDocumentCustomFieldBase.d.ts +++ b/sdks/node/types/model/templateResponseDocumentCustomFieldBase.d.ts @@ -1,14 +1,14 @@ import { AttributeTypeMap } from "./"; export declare abstract class TemplateResponseDocumentCustomFieldBase { + "apiId": string; + "name": string; "type": string; - "apiId"?: string; - "name"?: string; + "x": number; + "y": number; + "width": number; + "height": number; + "required": boolean; "signer"?: number | string | null; - "x"?: number; - "y"?: number; - "width"?: number; - "height"?: number; - "required"?: boolean; "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentCustomFieldText.d.ts b/sdks/node/types/model/templateResponseDocumentCustomFieldText.d.ts index b2d499e48..f7d28ac9e 100644 --- a/sdks/node/types/model/templateResponseDocumentCustomFieldText.d.ts +++ b/sdks/node/types/model/templateResponseDocumentCustomFieldText.d.ts @@ -3,10 +3,10 @@ import { TemplateResponseDocumentCustomFieldBase } from "./templateResponseDocum import { TemplateResponseFieldAvgTextLength } from "./templateResponseFieldAvgTextLength"; export declare class TemplateResponseDocumentCustomFieldText extends TemplateResponseDocumentCustomFieldBase { "type": string; - "avgTextLength"?: TemplateResponseFieldAvgTextLength; - "isMultiline"?: boolean; - "originalFontSize"?: number; - "fontFamily"?: string; + "avgTextLength": TemplateResponseFieldAvgTextLength; + "isMultiline": boolean; + "originalFontSize": number; + "fontFamily": string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFieldGroup.d.ts b/sdks/node/types/model/templateResponseDocumentFieldGroup.d.ts index d71655df9..da714dbd4 100644 --- a/sdks/node/types/model/templateResponseDocumentFieldGroup.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFieldGroup.d.ts @@ -1,8 +1,8 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFieldGroupRule } from "./templateResponseDocumentFieldGroupRule"; export declare class TemplateResponseDocumentFieldGroup { - "name"?: string; - "rule"?: TemplateResponseDocumentFieldGroupRule; + "name": string; + "rule": TemplateResponseDocumentFieldGroupRule; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFieldGroupRule.d.ts b/sdks/node/types/model/templateResponseDocumentFieldGroupRule.d.ts index 7f23a63d0..c3d444ca4 100644 --- a/sdks/node/types/model/templateResponseDocumentFieldGroupRule.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFieldGroupRule.d.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseDocumentFieldGroupRule { - "requirement"?: string; - "groupLabel"?: string; + "requirement": string; + "groupLabel": string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldBase.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldBase.d.ts index 6df5fc173..935a559d8 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldBase.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldBase.d.ts @@ -1,15 +1,14 @@ import { AttributeTypeMap } from "./"; export declare abstract class TemplateResponseDocumentFormFieldBase { + "apiId": string; + "name": string; "type": string; - "apiId"?: string; - "name"?: string; - "signer"?: number | string; - "x"?: number; - "y"?: number; - "width"?: number; - "height"?: number; - "required"?: boolean; - "group"?: string | null; + "signer": number | string; + "x": number; + "y": number; + "width": number; + "height": number; + "required": boolean; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldCheckbox.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldCheckbox.d.ts index 0748b1e43..40adf3c30 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldCheckbox.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldCheckbox.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldDateSigned.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldDateSigned.d.ts index d66f2cb86..d755cb483 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldDateSigned.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldDateSigned.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldDropdown.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldDropdown.d.ts index deb3e5bc7..b9f96a26f 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldDropdown.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldDropdown.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldHyperlink.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldHyperlink.d.ts index 4d10cf269..26c826911 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldHyperlink.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldHyperlink.d.ts @@ -3,10 +3,11 @@ import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumen import { TemplateResponseFieldAvgTextLength } from "./templateResponseFieldAvgTextLength"; export declare class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumentFormFieldBase { "type": string; - "avgTextLength"?: TemplateResponseFieldAvgTextLength; - "isMultiline"?: boolean; - "originalFontSize"?: number; - "fontFamily"?: string; + "avgTextLength": TemplateResponseFieldAvgTextLength; + "isMultiline": boolean; + "originalFontSize": number; + "fontFamily": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldInitials.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldInitials.d.ts index c935be083..6a1a035f5 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldInitials.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldInitials.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldRadio.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldRadio.d.ts index c3f174782..e0fc8a2bb 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldRadio.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldRadio.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFormFieldBase { "type": string; + "group": string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldSignature.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldSignature.d.ts index 06a96343d..d005bd0ee 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldSignature.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldSignature.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldText.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldText.d.ts index 9a65fc2ce..aa1ab468b 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldText.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldText.d.ts @@ -3,11 +3,12 @@ import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumen import { TemplateResponseFieldAvgTextLength } from "./templateResponseFieldAvgTextLength"; export declare class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentFormFieldBase { "type": string; - "avgTextLength"?: TemplateResponseFieldAvgTextLength; - "isMultiline"?: boolean; - "originalFontSize"?: number; - "fontFamily"?: string; + "avgTextLength": TemplateResponseFieldAvgTextLength; + "isMultiline": boolean; + "originalFontSize": number; + "fontFamily": string; "validationType"?: TemplateResponseDocumentFormFieldText.ValidationTypeEnum; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentStaticFieldBase.d.ts b/sdks/node/types/model/templateResponseDocumentStaticFieldBase.d.ts index 8120739cd..2c38e129d 100644 --- a/sdks/node/types/model/templateResponseDocumentStaticFieldBase.d.ts +++ b/sdks/node/types/model/templateResponseDocumentStaticFieldBase.d.ts @@ -1,14 +1,14 @@ import { AttributeTypeMap } from "./"; export declare abstract class TemplateResponseDocumentStaticFieldBase { + "apiId": string; + "name": string; "type": string; - "apiId"?: string; - "name"?: string; - "signer"?: string; - "x"?: number; - "y"?: number; - "width"?: number; - "height"?: number; - "required"?: boolean; + "signer": string; + "x": number; + "y": number; + "width": number; + "height": number; + "required": boolean; "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseFieldAvgTextLength.d.ts b/sdks/node/types/model/templateResponseFieldAvgTextLength.d.ts index 811eebeb5..af926d77f 100644 --- a/sdks/node/types/model/templateResponseFieldAvgTextLength.d.ts +++ b/sdks/node/types/model/templateResponseFieldAvgTextLength.d.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseFieldAvgTextLength { - "numLines"?: number; - "numCharsPerLine"?: number; + "numLines": number; + "numCharsPerLine": number; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseSignerRole.d.ts b/sdks/node/types/model/templateResponseSignerRole.d.ts index ce2cf439d..27ca5435b 100644 --- a/sdks/node/types/model/templateResponseSignerRole.d.ts +++ b/sdks/node/types/model/templateResponseSignerRole.d.ts @@ -1,6 +1,6 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseSignerRole { - "name"?: string; + "name": string; "order"?: number; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/templateUpdateFilesResponseTemplate.d.ts b/sdks/node/types/model/templateUpdateFilesResponseTemplate.d.ts index b7852797c..978f5030c 100644 --- a/sdks/node/types/model/templateUpdateFilesResponseTemplate.d.ts +++ b/sdks/node/types/model/templateUpdateFilesResponseTemplate.d.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "./"; import { WarningResponse } from "./warningResponse"; export declare class TemplateUpdateFilesResponseTemplate { - "templateId"?: string; + "templateId": string; "warnings"?: Array; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md index 7604fd299..0f30e6698 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -6,9 +6,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | -| `edit_url` | ```string``` | Link to edit the template. | | -| `expires_at` | ```int``` | When the link expires. | | +| `template_id`*_required_ | ```string``` | The id of the Template. | | +| `edit_url`*_required_ | ```string``` | Link to edit the template. | | +| `expires_at`*_required_ | ```int``` | When the link expires. | | | `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[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/TemplateCreateResponseTemplate.md b/sdks/php/docs/Model/TemplateCreateResponseTemplate.md index 0f25586c5..5942ecc07 100644 --- a/sdks/php/docs/Model/TemplateCreateResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateCreateResponseTemplate.md @@ -6,6 +6,6 @@ Template object with parameters: `template_id`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | +| `template_id`*_required_ | ```string``` | The id of the Template. | | [[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/TemplateResponse.md b/sdks/php/docs/Model/TemplateResponse.md index 2d6d768fd..69ea1cc2b 100644 --- a/sdks/php/docs/Model/TemplateResponse.md +++ b/sdks/php/docs/Model/TemplateResponse.md @@ -6,20 +6,21 @@ Contains information about the templates you and your team have created. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | -| `title` | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `template_id`*_required_ | ```string``` | The id of the Template. | | +| `title`*_required_ | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message`*_required_ | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `is_creator`*_required_ | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `can_edit`*_required_ | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `is_locked`*_required_ | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata`*_required_ | ```array``` | The metadata attached to the template. | | +| `signer_roles`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseSignerRole[]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `cc_roles`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseCCRole[]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | +| `documents`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocument[]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `accounts`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updated_at` | ```int``` | Time the template was last updated. | | -| `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `is_creator` | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `can_edit` | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `is_locked` | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata` | ```array``` | The metadata attached to the template. | | -| `signer_roles` | [```\Dropbox\Sign\Model\TemplateResponseSignerRole[]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `cc_roles` | [```\Dropbox\Sign\Model\TemplateResponseCCRole[]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```\Dropbox\Sign\Model\TemplateResponseDocument[]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | | `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | [[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/TemplateResponseAccount.md b/sdks/php/docs/Model/TemplateResponseAccount.md index fb9563bbc..4b7e24197 100644 --- a/sdks/php/docs/Model/TemplateResponseAccount.md +++ b/sdks/php/docs/Model/TemplateResponseAccount.md @@ -6,11 +6,11 @@ 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\TemplateResponseAccountQuota```](TemplateResponseAccountQuota.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\TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | [[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/TemplateResponseAccountQuota.md b/sdks/php/docs/Model/TemplateResponseAccountQuota.md index 7b106a9ac..9002f1f57 100644 --- a/sdks/php/docs/Model/TemplateResponseAccountQuota.md +++ b/sdks/php/docs/Model/TemplateResponseAccountQuota.md @@ -6,9 +6,9 @@ An array of the designated CC roles that must be specified when sending a Signat Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates_left` | ```int``` | API templates remaining. | | -| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | -| `documents_left` | ```int``` | Signature requests remaining. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | +| `templates_left`*_required_ | ```int``` | API templates remaining. | | +| `api_signature_requests_left`*_required_ | ```int``` | API signature requests remaining. | | +| `documents_left`*_required_ | ```int``` | Signature requests remaining. | | +| `sms_verifications_left`*_required_ | ```int``` | SMS verifications remaining. | | [[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/TemplateResponseCCRole.md b/sdks/php/docs/Model/TemplateResponseCCRole.md index 32ad82ef9..74c81b18d 100644 --- a/sdks/php/docs/Model/TemplateResponseCCRole.md +++ b/sdks/php/docs/Model/TemplateResponseCCRole.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the Role. | | +| `name`*_required_ | ```string``` | The name of the Role. | | [[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/TemplateResponseDocument.md b/sdks/php/docs/Model/TemplateResponseDocument.md index ab0518d3a..0d8420597 100644 --- a/sdks/php/docs/Model/TemplateResponseDocument.md +++ b/sdks/php/docs/Model/TemplateResponseDocument.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | Name of the associated file. | | +| `name`*_required_ | ```string``` | Name of the associated file. | | +| `field_groups`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `form_fields`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `custom_fields`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `static_fields`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | | `index` | ```int``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `field_groups` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `static_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | [[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/TemplateResponseDocumentCustomFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md index 47b5bad52..2217892e4 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md @@ -6,15 +6,15 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `api_id`*_required_ | ```string``` | The unique ID for this field. | | +| `name`*_required_ | ```string``` | The name of the Custom Field. | | | `type`*_required_ | ```string``` | | | -| `api_id` | ```string``` | The unique ID for this field. | | -| `name` | ```string``` | The name of the Custom Field. | | +| `x`*_required_ | ```int``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```int``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```int``` | The width in pixels of this form field. | | +| `height`*_required_ | ```int``` | The height in pixels of this form field. | | +| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | | `signer` | ```string``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```int``` | The horizontal offset in pixels for this form field. | | -| `y` | ```int``` | The vertical offset in pixels for this form field. | | -| `width` | ```int``` | The width in pixels of this form field. | | -| `height` | ```int``` | The height in pixels of this form field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseDocumentCustomFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md index 68e40af6b..147490139 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md @@ -7,9 +7,9 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | -| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```string``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```string``` | Font family used in this form field's text. | | [[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/TemplateResponseDocumentFieldGroup.md b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md index 233352654..4f74407c5 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the form field group. | | -| `rule` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name`*_required_ | ```string``` | The name of the form field group. | | +| `rule`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | [[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/TemplateResponseDocumentFieldGroupRule.md b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md index ad79e834e..b105c7ae2 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md @@ -6,7 +6,7 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `requirement` | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `group_label` | ```string``` | Name of the group | | +| `requirement`*_required_ | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `group_label`*_required_ | ```string``` | Name of the group | | [[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/TemplateResponseDocumentFormFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md index 087f01080..867ed2bef 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md @@ -6,15 +6,14 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `api_id`*_required_ | ```string``` | A unique id for the form field. | | +| `name`*_required_ | ```string``` | The name of the form field. | | | `type`*_required_ | ```string``` | | | -| `api_id` | ```string``` | A unique id for the form field. | | -| `name` | ```string``` | The name of the form field. | | -| `signer` | ```string``` | The signer of the Form Field. | | -| `x` | ```int``` | The horizontal offset in pixels for this form field. | | -| `y` | ```int``` | The vertical offset in pixels for this form field. | | -| `width` | ```int``` | The width in pixels of this form field. | | -| `height` | ```int``` | The height in pixels of this form field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `signer`*_required_ | ```string``` | The signer of the Form Field. | | +| `x`*_required_ | ```int``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```int``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```int``` | The width in pixels of this form field. | | +| `height`*_required_ | ```int``` | The height in pixels of this form field. | | +| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | [[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/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md index f2153cbc1..2ee1b9e5e 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md index ada92f315..8996ce7a3 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldDropdown.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md index c868840bd..35cadabb5 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md index d7e53fb84..c009374a8 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md @@ -7,9 +7,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | -| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```string``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```string``` | Font family used in this form field's text. | | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldInitials.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md index 9040699a9..ab0ccda06 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldRadio.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md index 409352e50..3b888caf7 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | +| `group`*_required_ | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldSignature.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md index 3336b5b0d..b46f1d963 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md index 512bb9f15..1bef226d5 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md @@ -7,10 +7,11 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | -| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```string``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```string``` | Font family used in this form field's text. | | | `validation_type` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentStaticFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md index 3a7a044a4..3e681c640 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md @@ -6,15 +6,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `api_id`*_required_ | ```string``` | A unique id for the static field. | | +| `name`*_required_ | ```string``` | The name of the static field. | | | `type`*_required_ | ```string``` | | | -| `api_id` | ```string``` | A unique id for the static field. | | -| `name` | ```string``` | The name of the static field. | | -| `signer` | ```string``` | The signer of the Static Field. | [default to 'me_now'] | -| `x` | ```int``` | The horizontal offset in pixels for this static field. | | -| `y` | ```int``` | The vertical offset in pixels for this static field. | | -| `width` | ```int``` | The width in pixels of this static field. | | -| `height` | ```int``` | The height in pixels of this static field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | +| `signer`*_required_ | ```string``` | The signer of the Static Field. | [default to 'me_now'] | +| `x`*_required_ | ```int``` | The horizontal offset in pixels for this static field. | | +| `y`*_required_ | ```int``` | The vertical offset in pixels for this static field. | | +| `width`*_required_ | ```int``` | The width in pixels of this static field. | | +| `height`*_required_ | ```int``` | The height in pixels of this static field. | | +| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseFieldAvgTextLength.md b/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md index b9db83c57..a1fbc0898 100644 --- a/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md +++ b/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md @@ -6,7 +6,7 @@ Average text length in this field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `num_lines` | ```int``` | Number of lines. | | -| `num_chars_per_line` | ```int``` | Number of characters per line. | | +| `num_lines`*_required_ | ```int``` | Number of lines. | | +| `num_chars_per_line`*_required_ | ```int``` | Number of characters per line. | | [[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/TemplateResponseSignerRole.md b/sdks/php/docs/Model/TemplateResponseSignerRole.md index fdf2f15d0..1881eb0b3 100644 --- a/sdks/php/docs/Model/TemplateResponseSignerRole.md +++ b/sdks/php/docs/Model/TemplateResponseSignerRole.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the Role. | | +| `name`*_required_ | ```string``` | The name of the Role. | | | `order` | ```int``` | If signer order is assigned this is the 0-based index for this role. | | [[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/TemplateUpdateFilesResponseTemplate.md b/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md index b8fb3f5c2..ec5f1db4b 100644 --- a/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md @@ -6,7 +6,7 @@ Contains template id Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | +| `template_id`*_required_ | ```string``` | The id of the Template. | | | `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[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/TemplateCreateEmbeddedDraftResponseTemplate.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php index 44031ce16..05073d3c9 100644 --- a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php +++ b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php @@ -303,7 +303,18 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['template_id'] === null) { + $invalidProperties[] = "'template_id' can't be null"; + } + if ($this->container['edit_url'] === null) { + $invalidProperties[] = "'edit_url' can't be null"; + } + if ($this->container['expires_at'] === null) { + $invalidProperties[] = "'expires_at' can't be null"; + } + return $invalidProperties; } /** @@ -320,7 +331,7 @@ public function valid() /** * Gets template_id * - * @return string|null + * @return string */ public function getTemplateId() { @@ -330,11 +341,11 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string $template_id the id of the Template * * @return self */ - public function setTemplateId(?string $template_id) + public function setTemplateId(string $template_id) { if (is_null($template_id)) { throw new InvalidArgumentException('non-nullable template_id cannot be null'); @@ -347,7 +358,7 @@ public function setTemplateId(?string $template_id) /** * Gets edit_url * - * @return string|null + * @return string */ public function getEditUrl() { @@ -357,11 +368,11 @@ public function getEditUrl() /** * Sets edit_url * - * @param string|null $edit_url link to edit the template + * @param string $edit_url link to edit the template * * @return self */ - public function setEditUrl(?string $edit_url) + public function setEditUrl(string $edit_url) { if (is_null($edit_url)) { throw new InvalidArgumentException('non-nullable edit_url cannot be null'); @@ -374,7 +385,7 @@ public function setEditUrl(?string $edit_url) /** * Gets expires_at * - * @return int|null + * @return int */ public function getExpiresAt() { @@ -384,11 +395,11 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at when the link expires + * @param int $expires_at when the link expires * * @return self */ - public function setExpiresAt(?int $expires_at) + public function setExpiresAt(int $expires_at) { if (is_null($expires_at)) { throw new InvalidArgumentException('non-nullable expires_at cannot be null'); diff --git a/sdks/php/src/Model/TemplateCreateResponseTemplate.php b/sdks/php/src/Model/TemplateCreateResponseTemplate.php index 199aa3f74..d2bed5824 100644 --- a/sdks/php/src/Model/TemplateCreateResponseTemplate.php +++ b/sdks/php/src/Model/TemplateCreateResponseTemplate.php @@ -282,7 +282,12 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['template_id'] === null) { + $invalidProperties[] = "'template_id' can't be null"; + } + return $invalidProperties; } /** @@ -299,7 +304,7 @@ public function valid() /** * Gets template_id * - * @return string|null + * @return string */ public function getTemplateId() { @@ -309,11 +314,11 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string $template_id the id of the Template * * @return self */ - public function setTemplateId(?string $template_id) + public function setTemplateId(string $template_id) { if (is_null($template_id)) { throw new InvalidArgumentException('non-nullable template_id cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponse.php b/sdks/php/src/Model/TemplateResponse.php index 4041f1856..7116ea2a7 100644 --- a/sdks/php/src/Model/TemplateResponse.php +++ b/sdks/php/src/Model/TemplateResponse.php @@ -61,8 +61,6 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'template_id' => 'string', 'title' => 'string', 'message' => 'string', - 'updated_at' => 'int', - 'is_embedded' => 'bool', 'is_creator' => 'bool', 'can_edit' => 'bool', 'is_locked' => 'bool', @@ -70,9 +68,12 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'signer_roles' => '\Dropbox\Sign\Model\TemplateResponseSignerRole[]', 'cc_roles' => '\Dropbox\Sign\Model\TemplateResponseCCRole[]', 'documents' => '\Dropbox\Sign\Model\TemplateResponseDocument[]', + 'accounts' => '\Dropbox\Sign\Model\TemplateResponseAccount[]', + 'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]', + 'updated_at' => 'int', + 'is_embedded' => 'bool', 'custom_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]', 'named_form_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]', - 'accounts' => '\Dropbox\Sign\Model\TemplateResponseAccount[]', ]; /** @@ -86,8 +87,6 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'template_id' => null, 'title' => null, 'message' => null, - 'updated_at' => null, - 'is_embedded' => null, 'is_creator' => null, 'can_edit' => null, 'is_locked' => null, @@ -95,9 +94,12 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'signer_roles' => null, 'cc_roles' => null, 'documents' => null, + 'accounts' => null, + 'attachments' => null, + 'updated_at' => null, + 'is_embedded' => null, 'custom_fields' => null, 'named_form_fields' => null, - 'accounts' => null, ]; /** @@ -109,18 +111,19 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'template_id' => false, 'title' => false, 'message' => false, - 'updated_at' => false, - 'is_embedded' => true, - 'is_creator' => true, - 'can_edit' => true, - 'is_locked' => true, + 'is_creator' => false, + 'can_edit' => false, + 'is_locked' => false, 'metadata' => false, 'signer_roles' => false, 'cc_roles' => false, 'documents' => false, + 'accounts' => false, + 'attachments' => false, + 'updated_at' => false, + 'is_embedded' => true, 'custom_fields' => true, 'named_form_fields' => true, - 'accounts' => true, ]; /** @@ -204,8 +207,6 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'template_id', 'title' => 'title', 'message' => 'message', - 'updated_at' => 'updated_at', - 'is_embedded' => 'is_embedded', 'is_creator' => 'is_creator', 'can_edit' => 'can_edit', 'is_locked' => 'is_locked', @@ -213,9 +214,12 @@ public function isNullableSetToNull(string $property): bool 'signer_roles' => 'signer_roles', 'cc_roles' => 'cc_roles', 'documents' => 'documents', + 'accounts' => 'accounts', + 'attachments' => 'attachments', + 'updated_at' => 'updated_at', + 'is_embedded' => 'is_embedded', 'custom_fields' => 'custom_fields', 'named_form_fields' => 'named_form_fields', - 'accounts' => 'accounts', ]; /** @@ -227,8 +231,6 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'setTemplateId', 'title' => 'setTitle', 'message' => 'setMessage', - 'updated_at' => 'setUpdatedAt', - 'is_embedded' => 'setIsEmbedded', 'is_creator' => 'setIsCreator', 'can_edit' => 'setCanEdit', 'is_locked' => 'setIsLocked', @@ -236,9 +238,12 @@ public function isNullableSetToNull(string $property): bool 'signer_roles' => 'setSignerRoles', 'cc_roles' => 'setCcRoles', 'documents' => 'setDocuments', + 'accounts' => 'setAccounts', + 'attachments' => 'setAttachments', + 'updated_at' => 'setUpdatedAt', + 'is_embedded' => 'setIsEmbedded', 'custom_fields' => 'setCustomFields', 'named_form_fields' => 'setNamedFormFields', - 'accounts' => 'setAccounts', ]; /** @@ -250,8 +255,6 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'getTemplateId', 'title' => 'getTitle', 'message' => 'getMessage', - 'updated_at' => 'getUpdatedAt', - 'is_embedded' => 'getIsEmbedded', 'is_creator' => 'getIsCreator', 'can_edit' => 'getCanEdit', 'is_locked' => 'getIsLocked', @@ -259,9 +262,12 @@ public function isNullableSetToNull(string $property): bool 'signer_roles' => 'getSignerRoles', 'cc_roles' => 'getCcRoles', 'documents' => 'getDocuments', + 'accounts' => 'getAccounts', + 'attachments' => 'getAttachments', + 'updated_at' => 'getUpdatedAt', + 'is_embedded' => 'getIsEmbedded', 'custom_fields' => 'getCustomFields', 'named_form_fields' => 'getNamedFormFields', - 'accounts' => 'getAccounts', ]; /** @@ -323,8 +329,6 @@ public function __construct(array $data = null) $this->setIfExists('template_id', $data ?? [], null); $this->setIfExists('title', $data ?? [], null); $this->setIfExists('message', $data ?? [], null); - $this->setIfExists('updated_at', $data ?? [], null); - $this->setIfExists('is_embedded', $data ?? [], null); $this->setIfExists('is_creator', $data ?? [], null); $this->setIfExists('can_edit', $data ?? [], null); $this->setIfExists('is_locked', $data ?? [], null); @@ -332,9 +336,12 @@ public function __construct(array $data = null) $this->setIfExists('signer_roles', $data ?? [], null); $this->setIfExists('cc_roles', $data ?? [], null); $this->setIfExists('documents', $data ?? [], null); + $this->setIfExists('accounts', $data ?? [], null); + $this->setIfExists('attachments', $data ?? [], null); + $this->setIfExists('updated_at', $data ?? [], null); + $this->setIfExists('is_embedded', $data ?? [], null); $this->setIfExists('custom_fields', $data ?? [], null); $this->setIfExists('named_form_fields', $data ?? [], null); - $this->setIfExists('accounts', $data ?? [], null); } /** @@ -380,7 +387,45 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['template_id'] === null) { + $invalidProperties[] = "'template_id' can't be null"; + } + if ($this->container['title'] === null) { + $invalidProperties[] = "'title' can't be null"; + } + if ($this->container['message'] === null) { + $invalidProperties[] = "'message' can't be null"; + } + if ($this->container['is_creator'] === null) { + $invalidProperties[] = "'is_creator' can't be null"; + } + if ($this->container['can_edit'] === null) { + $invalidProperties[] = "'can_edit' can't be null"; + } + if ($this->container['is_locked'] === null) { + $invalidProperties[] = "'is_locked' can't be null"; + } + if ($this->container['metadata'] === null) { + $invalidProperties[] = "'metadata' can't be null"; + } + if ($this->container['signer_roles'] === null) { + $invalidProperties[] = "'signer_roles' can't be null"; + } + if ($this->container['cc_roles'] === null) { + $invalidProperties[] = "'cc_roles' can't be null"; + } + if ($this->container['documents'] === null) { + $invalidProperties[] = "'documents' can't be null"; + } + if ($this->container['accounts'] === null) { + $invalidProperties[] = "'accounts' can't be null"; + } + if ($this->container['attachments'] === null) { + $invalidProperties[] = "'attachments' can't be null"; + } + return $invalidProperties; } /** @@ -397,7 +442,7 @@ public function valid() /** * Gets template_id * - * @return string|null + * @return string */ public function getTemplateId() { @@ -407,11 +452,11 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string $template_id the id of the Template * * @return self */ - public function setTemplateId(?string $template_id) + public function setTemplateId(string $template_id) { if (is_null($template_id)) { throw new InvalidArgumentException('non-nullable template_id cannot be null'); @@ -424,7 +469,7 @@ public function setTemplateId(?string $template_id) /** * Gets title * - * @return string|null + * @return string */ public function getTitle() { @@ -434,11 +479,11 @@ public function getTitle() /** * Sets title * - * @param string|null $title The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + * @param string $title The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. * * @return self */ - public function setTitle(?string $title) + public function setTitle(string $title) { if (is_null($title)) { throw new InvalidArgumentException('non-nullable title cannot be null'); @@ -451,7 +496,7 @@ public function setTitle(?string $title) /** * Gets message * - * @return string|null + * @return string */ public function getMessage() { @@ -461,11 +506,11 @@ public function getMessage() /** * Sets message * - * @param string|null $message The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + * @param string $message The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. * * @return self */ - public function setMessage(?string $message) + public function setMessage(string $message) { if (is_null($message)) { throw new InvalidArgumentException('non-nullable message cannot be null'); @@ -475,71 +520,10 @@ public function setMessage(?string $message) return $this; } - /** - * Gets updated_at - * - * @return int|null - */ - public function getUpdatedAt() - { - return $this->container['updated_at']; - } - - /** - * Sets updated_at - * - * @param int|null $updated_at time the template was last updated - * - * @return self - */ - public function setUpdatedAt(?int $updated_at) - { - if (is_null($updated_at)) { - throw new InvalidArgumentException('non-nullable updated_at cannot be null'); - } - $this->container['updated_at'] = $updated_at; - - return $this; - } - - /** - * Gets is_embedded - * - * @return bool|null - */ - public function getIsEmbedded() - { - return $this->container['is_embedded']; - } - - /** - * Sets is_embedded - * - * @param bool|null $is_embedded `true` if this template was created using an embedded flow, `false` if it was created on our website - * - * @return self - */ - public function setIsEmbedded(?bool $is_embedded) - { - if (is_null($is_embedded)) { - array_push($this->openAPINullablesSetToNull, 'is_embedded'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('is_embedded', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } - } - $this->container['is_embedded'] = $is_embedded; - - return $this; - } - /** * Gets is_creator * - * @return bool|null + * @return bool */ public function getIsCreator() { @@ -549,21 +533,14 @@ public function getIsCreator() /** * Sets is_creator * - * @param bool|null $is_creator `true` if you are the owner of this template, `false` if it's been shared with you by a team member + * @param bool $is_creator `true` if you are the owner of this template, `false` if it's been shared with you by a team member * * @return self */ - public function setIsCreator(?bool $is_creator) + public function setIsCreator(bool $is_creator) { if (is_null($is_creator)) { - array_push($this->openAPINullablesSetToNull, 'is_creator'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('is_creator', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + throw new InvalidArgumentException('non-nullable is_creator cannot be null'); } $this->container['is_creator'] = $is_creator; @@ -573,7 +550,7 @@ public function setIsCreator(?bool $is_creator) /** * Gets can_edit * - * @return bool|null + * @return bool */ public function getCanEdit() { @@ -583,21 +560,14 @@ public function getCanEdit() /** * Sets can_edit * - * @param bool|null $can_edit indicates whether edit rights have been granted to you by the owner (always `true` if that's you) + * @param bool $can_edit indicates whether edit rights have been granted to you by the owner (always `true` if that's you) * * @return self */ - public function setCanEdit(?bool $can_edit) + public function setCanEdit(bool $can_edit) { if (is_null($can_edit)) { - array_push($this->openAPINullablesSetToNull, 'can_edit'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('can_edit', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + throw new InvalidArgumentException('non-nullable can_edit cannot be null'); } $this->container['can_edit'] = $can_edit; @@ -607,7 +577,7 @@ public function setCanEdit(?bool $can_edit) /** * Gets is_locked * - * @return bool|null + * @return bool */ public function getIsLocked() { @@ -617,21 +587,14 @@ public function getIsLocked() /** * Sets is_locked * - * @param bool|null $is_locked Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. + * @param bool $is_locked Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. * * @return self */ - public function setIsLocked(?bool $is_locked) + public function setIsLocked(bool $is_locked) { if (is_null($is_locked)) { - array_push($this->openAPINullablesSetToNull, 'is_locked'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('is_locked', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + throw new InvalidArgumentException('non-nullable is_locked cannot be null'); } $this->container['is_locked'] = $is_locked; @@ -641,7 +604,7 @@ public function setIsLocked(?bool $is_locked) /** * Gets metadata * - * @return array|null + * @return array */ public function getMetadata() { @@ -651,11 +614,11 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata the metadata attached to the template + * @param array $metadata the metadata attached to the template * * @return self */ - public function setMetadata(?array $metadata) + public function setMetadata(array $metadata) { if (is_null($metadata)) { throw new InvalidArgumentException('non-nullable metadata cannot be null'); @@ -668,7 +631,7 @@ public function setMetadata(?array $metadata) /** * Gets signer_roles * - * @return TemplateResponseSignerRole[]|null + * @return TemplateResponseSignerRole[] */ public function getSignerRoles() { @@ -678,11 +641,11 @@ public function getSignerRoles() /** * Sets signer_roles * - * @param TemplateResponseSignerRole[]|null $signer_roles an array of the designated signer roles that must be specified when sending a SignatureRequest using this Template + * @param TemplateResponseSignerRole[] $signer_roles an array of the designated signer roles that must be specified when sending a SignatureRequest using this Template * * @return self */ - public function setSignerRoles(?array $signer_roles) + public function setSignerRoles(array $signer_roles) { if (is_null($signer_roles)) { throw new InvalidArgumentException('non-nullable signer_roles cannot be null'); @@ -695,7 +658,7 @@ public function setSignerRoles(?array $signer_roles) /** * Gets cc_roles * - * @return TemplateResponseCCRole[]|null + * @return TemplateResponseCCRole[] */ public function getCcRoles() { @@ -705,11 +668,11 @@ public function getCcRoles() /** * Sets cc_roles * - * @param TemplateResponseCCRole[]|null $cc_roles an array of the designated CC roles that must be specified when sending a SignatureRequest using this Template + * @param TemplateResponseCCRole[] $cc_roles an array of the designated CC roles that must be specified when sending a SignatureRequest using this Template * * @return self */ - public function setCcRoles(?array $cc_roles) + public function setCcRoles(array $cc_roles) { if (is_null($cc_roles)) { throw new InvalidArgumentException('non-nullable cc_roles cannot be null'); @@ -722,7 +685,7 @@ public function setCcRoles(?array $cc_roles) /** * Gets documents * - * @return TemplateResponseDocument[]|null + * @return TemplateResponseDocument[] */ public function getDocuments() { @@ -732,11 +695,11 @@ public function getDocuments() /** * Sets documents * - * @param TemplateResponseDocument[]|null $documents An array describing each document associated with this Template. Includes form field data for each document. + * @param TemplateResponseDocument[] $documents An array describing each document associated with this Template. Includes form field data for each document. * * @return self */ - public function setDocuments(?array $documents) + public function setDocuments(array $documents) { if (is_null($documents)) { throw new InvalidArgumentException('non-nullable documents cannot be null'); @@ -746,6 +709,121 @@ public function setDocuments(?array $documents) return $this; } + /** + * Gets accounts + * + * @return TemplateResponseAccount[] + */ + public function getAccounts() + { + return $this->container['accounts']; + } + + /** + * Sets accounts + * + * @param TemplateResponseAccount[] $accounts an array of the Accounts that can use this Template + * + * @return self + */ + public function setAccounts(array $accounts) + { + if (is_null($accounts)) { + throw new InvalidArgumentException('non-nullable accounts cannot be null'); + } + $this->container['accounts'] = $accounts; + + return $this; + } + + /** + * Gets attachments + * + * @return SignatureRequestResponseAttachment[] + */ + public function getAttachments() + { + return $this->container['attachments']; + } + + /** + * Sets attachments + * + * @param SignatureRequestResponseAttachment[] $attachments signer attachments + * + * @return self + */ + public function setAttachments(array $attachments) + { + if (is_null($attachments)) { + throw new InvalidArgumentException('non-nullable attachments cannot be null'); + } + $this->container['attachments'] = $attachments; + + return $this; + } + + /** + * Gets updated_at + * + * @return int|null + */ + public function getUpdatedAt() + { + return $this->container['updated_at']; + } + + /** + * Sets updated_at + * + * @param int|null $updated_at time the template was last updated + * + * @return self + */ + public function setUpdatedAt(?int $updated_at) + { + if (is_null($updated_at)) { + throw new InvalidArgumentException('non-nullable updated_at cannot be null'); + } + $this->container['updated_at'] = $updated_at; + + return $this; + } + + /** + * Gets is_embedded + * + * @return bool|null + */ + public function getIsEmbedded() + { + return $this->container['is_embedded']; + } + + /** + * Sets is_embedded + * + * @param bool|null $is_embedded `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + * + * @return self + */ + public function setIsEmbedded(?bool $is_embedded) + { + if (is_null($is_embedded)) { + array_push($this->openAPINullablesSetToNull, 'is_embedded'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('is_embedded', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['is_embedded'] = $is_embedded; + + return $this; + } + /** * Gets custom_fields * @@ -818,40 +896,6 @@ public function setNamedFormFields(?array $named_form_fields) return $this; } - /** - * Gets accounts - * - * @return TemplateResponseAccount[]|null - */ - public function getAccounts() - { - return $this->container['accounts']; - } - - /** - * Sets accounts - * - * @param TemplateResponseAccount[]|null $accounts an array of the Accounts that can use this Template - * - * @return self - */ - public function setAccounts(?array $accounts) - { - if (is_null($accounts)) { - array_push($this->openAPINullablesSetToNull, 'accounts'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('accounts', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } - } - $this->container['accounts'] = $accounts; - - return $this; - } - /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseAccount.php b/sdks/php/src/Model/TemplateResponseAccount.php index 47ddefabe..538aed394 100644 --- a/sdks/php/src/Model/TemplateResponseAccount.php +++ b/sdks/php/src/Model/TemplateResponseAccount.php @@ -58,11 +58,11 @@ class TemplateResponseAccount implements ModelInterface, ArrayAccess, JsonSerial */ protected static $openAPITypes = [ 'account_id' => 'string', - 'email_address' => 'string', 'is_locked' => 'bool', 'is_paid_hs' => 'bool', 'is_paid_hf' => 'bool', 'quotas' => '\Dropbox\Sign\Model\TemplateResponseAccountQuota', + 'email_address' => 'string', ]; /** @@ -74,11 +74,11 @@ class TemplateResponseAccount implements ModelInterface, ArrayAccess, JsonSerial */ 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, ]; /** @@ -88,11 +88,11 @@ class TemplateResponseAccount implements ModelInterface, ArrayAccess, JsonSerial */ 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, ]; /** @@ -174,11 +174,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', ]; /** @@ -188,11 +188,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', ]; /** @@ -202,11 +202,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', ]; /** @@ -266,11 +266,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); } /** @@ -316,7 +316,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; } /** @@ -333,7 +350,7 @@ public function valid() /** * Gets account_id * - * @return string|null + * @return string */ public function getAccountId() { @@ -343,11 +360,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'); @@ -357,37 +374,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() { @@ -397,11 +387,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'); @@ -414,7 +404,7 @@ public function setIsLocked(?bool $is_locked) /** * Gets is_paid_hs * - * @return bool|null + * @return bool */ public function getIsPaidHs() { @@ -424,11 +414,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'); @@ -441,7 +431,7 @@ public function setIsPaidHs(?bool $is_paid_hs) /** * Gets is_paid_hf * - * @return bool|null + * @return bool */ public function getIsPaidHf() { @@ -451,11 +441,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'); @@ -468,7 +458,7 @@ public function setIsPaidHf(?bool $is_paid_hf) /** * Gets quotas * - * @return TemplateResponseAccountQuota|null + * @return TemplateResponseAccountQuota */ public function getQuotas() { @@ -478,11 +468,11 @@ public function getQuotas() /** * Sets quotas * - * @param TemplateResponseAccountQuota|null $quotas quotas + * @param TemplateResponseAccountQuota $quotas quotas * * @return self */ - public function setQuotas(?TemplateResponseAccountQuota $quotas) + public function setQuotas(TemplateResponseAccountQuota $quotas) { if (is_null($quotas)) { throw new InvalidArgumentException('non-nullable quotas cannot be null'); @@ -492,6 +482,33 @@ public function setQuotas(?TemplateResponseAccountQuota $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; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseAccountQuota.php b/sdks/php/src/Model/TemplateResponseAccountQuota.php index 46386d6ec..e27a97325 100644 --- a/sdks/php/src/Model/TemplateResponseAccountQuota.php +++ b/sdks/php/src/Model/TemplateResponseAccountQuota.php @@ -303,7 +303,21 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['templates_left'] === null) { + $invalidProperties[] = "'templates_left' can't be null"; + } + if ($this->container['api_signature_requests_left'] === null) { + $invalidProperties[] = "'api_signature_requests_left' can't be null"; + } + if ($this->container['documents_left'] === null) { + $invalidProperties[] = "'documents_left' can't be null"; + } + if ($this->container['sms_verifications_left'] === null) { + $invalidProperties[] = "'sms_verifications_left' can't be null"; + } + return $invalidProperties; } /** @@ -320,7 +334,7 @@ public function valid() /** * Gets templates_left * - * @return int|null + * @return int */ public function getTemplatesLeft() { @@ -330,11 +344,11 @@ public function getTemplatesLeft() /** * Sets templates_left * - * @param int|null $templates_left API templates remaining + * @param int $templates_left API templates remaining * * @return self */ - public function setTemplatesLeft(?int $templates_left) + public function setTemplatesLeft(int $templates_left) { if (is_null($templates_left)) { throw new InvalidArgumentException('non-nullable templates_left cannot be null'); @@ -347,7 +361,7 @@ public function setTemplatesLeft(?int $templates_left) /** * Gets api_signature_requests_left * - * @return int|null + * @return int */ public function getApiSignatureRequestsLeft() { @@ -357,11 +371,11 @@ public function getApiSignatureRequestsLeft() /** * Sets api_signature_requests_left * - * @param int|null $api_signature_requests_left API signature requests remaining + * @param int $api_signature_requests_left API signature requests remaining * * @return self */ - public function setApiSignatureRequestsLeft(?int $api_signature_requests_left) + public function setApiSignatureRequestsLeft(int $api_signature_requests_left) { if (is_null($api_signature_requests_left)) { throw new InvalidArgumentException('non-nullable api_signature_requests_left cannot be null'); @@ -374,7 +388,7 @@ public function setApiSignatureRequestsLeft(?int $api_signature_requests_left) /** * Gets documents_left * - * @return int|null + * @return int */ public function getDocumentsLeft() { @@ -384,11 +398,11 @@ public function getDocumentsLeft() /** * Sets documents_left * - * @param int|null $documents_left signature requests remaining + * @param int $documents_left signature requests remaining * * @return self */ - public function setDocumentsLeft(?int $documents_left) + public function setDocumentsLeft(int $documents_left) { if (is_null($documents_left)) { throw new InvalidArgumentException('non-nullable documents_left cannot be null'); @@ -401,7 +415,7 @@ public function setDocumentsLeft(?int $documents_left) /** * Gets sms_verifications_left * - * @return int|null + * @return int */ public function getSmsVerificationsLeft() { @@ -411,11 +425,11 @@ public function getSmsVerificationsLeft() /** * Sets sms_verifications_left * - * @param int|null $sms_verifications_left SMS verifications remaining + * @param int $sms_verifications_left SMS verifications remaining * * @return self */ - public function setSmsVerificationsLeft(?int $sms_verifications_left) + public function setSmsVerificationsLeft(int $sms_verifications_left) { if (is_null($sms_verifications_left)) { throw new InvalidArgumentException('non-nullable sms_verifications_left cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseCCRole.php b/sdks/php/src/Model/TemplateResponseCCRole.php index 06ee33219..28044c0ea 100644 --- a/sdks/php/src/Model/TemplateResponseCCRole.php +++ b/sdks/php/src/Model/TemplateResponseCCRole.php @@ -281,7 +281,12 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } + return $invalidProperties; } /** @@ -298,7 +303,7 @@ public function valid() /** * Gets name * - * @return string|null + * @return string */ public function getName() { @@ -308,11 +313,11 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the Role + * @param string $name the name of the Role * * @return self */ - public function setName(?string $name) + public function setName(string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocument.php b/sdks/php/src/Model/TemplateResponseDocument.php index 5377d4ba9..6bf7ba8e8 100644 --- a/sdks/php/src/Model/TemplateResponseDocument.php +++ b/sdks/php/src/Model/TemplateResponseDocument.php @@ -58,11 +58,11 @@ class TemplateResponseDocument implements ModelInterface, ArrayAccess, JsonSeria */ protected static $openAPITypes = [ 'name' => 'string', - 'index' => 'int', 'field_groups' => '\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]', 'form_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]', 'custom_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]', 'static_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]', + 'index' => 'int', ]; /** @@ -74,11 +74,11 @@ class TemplateResponseDocument implements ModelInterface, ArrayAccess, JsonSeria */ protected static $openAPIFormats = [ 'name' => null, - 'index' => null, 'field_groups' => null, 'form_fields' => null, 'custom_fields' => null, 'static_fields' => null, + 'index' => null, ]; /** @@ -88,11 +88,11 @@ class TemplateResponseDocument implements ModelInterface, ArrayAccess, JsonSeria */ protected static array $openAPINullables = [ 'name' => false, - 'index' => false, 'field_groups' => false, 'form_fields' => false, 'custom_fields' => false, - 'static_fields' => true, + 'static_fields' => false, + 'index' => false, ]; /** @@ -174,11 +174,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'name' => 'name', - 'index' => 'index', 'field_groups' => 'field_groups', 'form_fields' => 'form_fields', 'custom_fields' => 'custom_fields', 'static_fields' => 'static_fields', + 'index' => 'index', ]; /** @@ -188,11 +188,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'name' => 'setName', - 'index' => 'setIndex', 'field_groups' => 'setFieldGroups', 'form_fields' => 'setFormFields', 'custom_fields' => 'setCustomFields', 'static_fields' => 'setStaticFields', + 'index' => 'setIndex', ]; /** @@ -202,11 +202,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'name' => 'getName', - 'index' => 'getIndex', 'field_groups' => 'getFieldGroups', 'form_fields' => 'getFormFields', 'custom_fields' => 'getCustomFields', 'static_fields' => 'getStaticFields', + 'index' => 'getIndex', ]; /** @@ -266,11 +266,11 @@ public function getModelName() public function __construct(array $data = null) { $this->setIfExists('name', $data ?? [], null); - $this->setIfExists('index', $data ?? [], null); $this->setIfExists('field_groups', $data ?? [], null); $this->setIfExists('form_fields', $data ?? [], null); $this->setIfExists('custom_fields', $data ?? [], null); $this->setIfExists('static_fields', $data ?? [], null); + $this->setIfExists('index', $data ?? [], null); } /** @@ -316,7 +316,24 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } + if ($this->container['field_groups'] === null) { + $invalidProperties[] = "'field_groups' can't be null"; + } + if ($this->container['form_fields'] === null) { + $invalidProperties[] = "'form_fields' can't be null"; + } + if ($this->container['custom_fields'] === null) { + $invalidProperties[] = "'custom_fields' can't be null"; + } + if ($this->container['static_fields'] === null) { + $invalidProperties[] = "'static_fields' can't be null"; + } + return $invalidProperties; } /** @@ -333,7 +350,7 @@ public function valid() /** * Gets name * - * @return string|null + * @return string */ public function getName() { @@ -343,11 +360,11 @@ public function getName() /** * Sets name * - * @param string|null $name name of the associated file + * @param string $name name of the associated file * * @return self */ - public function setName(?string $name) + public function setName(string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); @@ -357,37 +374,10 @@ public function setName(?string $name) return $this; } - /** - * Gets index - * - * @return int|null - */ - public function getIndex() - { - return $this->container['index']; - } - - /** - * Sets index - * - * @param int|null $index document ordering, the lowest index is displayed first and the highest last (0-based indexing) - * - * @return self - */ - public function setIndex(?int $index) - { - if (is_null($index)) { - throw new InvalidArgumentException('non-nullable index cannot be null'); - } - $this->container['index'] = $index; - - return $this; - } - /** * Gets field_groups * - * @return TemplateResponseDocumentFieldGroup[]|null + * @return TemplateResponseDocumentFieldGroup[] */ public function getFieldGroups() { @@ -397,11 +387,11 @@ public function getFieldGroups() /** * Sets field_groups * - * @param TemplateResponseDocumentFieldGroup[]|null $field_groups an array of Form Field Group objects + * @param TemplateResponseDocumentFieldGroup[] $field_groups an array of Form Field Group objects * * @return self */ - public function setFieldGroups(?array $field_groups) + public function setFieldGroups(array $field_groups) { if (is_null($field_groups)) { throw new InvalidArgumentException('non-nullable field_groups cannot be null'); @@ -414,7 +404,7 @@ public function setFieldGroups(?array $field_groups) /** * Gets form_fields * - * @return TemplateResponseDocumentFormFieldBase[]|null + * @return TemplateResponseDocumentFormFieldBase[] */ public function getFormFields() { @@ -424,11 +414,11 @@ public function getFormFields() /** * Sets form_fields * - * @param TemplateResponseDocumentFormFieldBase[]|null $form_fields an array of Form Field objects containing the name and type of each named field + * @param TemplateResponseDocumentFormFieldBase[] $form_fields an array of Form Field objects containing the name and type of each named field * * @return self */ - public function setFormFields(?array $form_fields) + public function setFormFields(array $form_fields) { if (is_null($form_fields)) { throw new InvalidArgumentException('non-nullable form_fields cannot be null'); @@ -441,7 +431,7 @@ public function setFormFields(?array $form_fields) /** * Gets custom_fields * - * @return TemplateResponseDocumentCustomFieldBase[]|null + * @return TemplateResponseDocumentCustomFieldBase[] */ public function getCustomFields() { @@ -451,11 +441,11 @@ public function getCustomFields() /** * Sets custom_fields * - * @param TemplateResponseDocumentCustomFieldBase[]|null $custom_fields an array of Form Field objects containing the name and type of each named field + * @param TemplateResponseDocumentCustomFieldBase[] $custom_fields an array of Form Field objects containing the name and type of each named field * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields(array $custom_fields) { if (is_null($custom_fields)) { throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); @@ -468,7 +458,7 @@ public function setCustomFields(?array $custom_fields) /** * Gets static_fields * - * @return TemplateResponseDocumentStaticFieldBase[]|null + * @return TemplateResponseDocumentStaticFieldBase[] */ public function getStaticFields() { @@ -478,27 +468,47 @@ public function getStaticFields() /** * Sets static_fields * - * @param TemplateResponseDocumentStaticFieldBase[]|null $static_fields An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + * @param TemplateResponseDocumentStaticFieldBase[] $static_fields An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. * * @return self */ - public function setStaticFields(?array $static_fields) + public function setStaticFields(array $static_fields) { if (is_null($static_fields)) { - array_push($this->openAPINullablesSetToNull, 'static_fields'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('static_fields', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + throw new InvalidArgumentException('non-nullable static_fields cannot be null'); } $this->container['static_fields'] = $static_fields; return $this; } + /** + * Gets index + * + * @return int|null + */ + public function getIndex() + { + return $this->container['index']; + } + + /** + * Sets index + * + * @param int|null $index document ordering, the lowest index is displayed first and the highest last (0-based indexing) + * + * @return self + */ + public function setIndex(?int $index) + { + if (is_null($index)) { + throw new InvalidArgumentException('non-nullable index cannot be null'); + } + $this->container['index'] = $index; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php index 011502522..0d5f29451 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php @@ -58,15 +58,15 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc * @var string[] */ protected static $openAPITypes = [ - 'type' => 'string', 'api_id' => 'string', 'name' => 'string', - 'signer' => 'string', + 'type' => 'string', 'x' => 'int', 'y' => 'int', 'width' => 'int', 'height' => 'int', 'required' => 'bool', + 'signer' => 'string', 'group' => 'string', ]; @@ -78,15 +78,15 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc * @psalm-var array */ protected static $openAPIFormats = [ - 'type' => null, 'api_id' => null, 'name' => null, - 'signer' => null, + 'type' => null, 'x' => null, 'y' => null, 'width' => null, 'height' => null, 'required' => null, + 'signer' => null, 'group' => null, ]; @@ -96,15 +96,15 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc * @var bool[] */ protected static array $openAPINullables = [ - 'type' => false, 'api_id' => false, 'name' => false, - 'signer' => true, + 'type' => false, 'x' => false, 'y' => false, 'width' => false, 'height' => false, 'required' => false, + 'signer' => true, 'group' => true, ]; @@ -186,15 +186,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', 'api_id' => 'api_id', 'name' => 'name', - 'signer' => 'signer', + 'type' => 'type', 'x' => 'x', 'y' => 'y', 'width' => 'width', 'height' => 'height', 'required' => 'required', + 'signer' => 'signer', 'group' => 'group', ]; @@ -204,15 +204,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', 'api_id' => 'setApiId', 'name' => 'setName', - 'signer' => 'setSigner', + 'type' => 'setType', 'x' => 'setX', 'y' => 'setY', 'width' => 'setWidth', 'height' => 'setHeight', 'required' => 'setRequired', + 'signer' => 'setSigner', 'group' => 'setGroup', ]; @@ -222,15 +222,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', 'api_id' => 'getApiId', 'name' => 'getName', - 'signer' => 'getSigner', + 'type' => 'getType', 'x' => 'getX', 'y' => 'getY', 'width' => 'getWidth', 'height' => 'getHeight', 'required' => 'getRequired', + 'signer' => 'getSigner', 'group' => 'getGroup', ]; @@ -290,15 +290,15 @@ public function getModelName() */ public function __construct(array $data = null) { - $this->setIfExists('type', $data ?? [], null); $this->setIfExists('api_id', $data ?? [], null); $this->setIfExists('name', $data ?? [], null); - $this->setIfExists('signer', $data ?? [], null); + $this->setIfExists('type', $data ?? [], null); $this->setIfExists('x', $data ?? [], null); $this->setIfExists('y', $data ?? [], null); $this->setIfExists('width', $data ?? [], null); $this->setIfExists('height', $data ?? [], null); $this->setIfExists('required', $data ?? [], null); + $this->setIfExists('signer', $data ?? [], null); $this->setIfExists('group', $data ?? [], null); // Initialize discriminator property with the model name. @@ -346,9 +346,30 @@ public function listInvalidProperties() { $invalidProperties = []; + if ($this->container['api_id'] === null) { + $invalidProperties[] = "'api_id' can't be null"; + } + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } + if ($this->container['x'] === null) { + $invalidProperties[] = "'x' can't be null"; + } + if ($this->container['y'] === null) { + $invalidProperties[] = "'y' can't be null"; + } + if ($this->container['width'] === null) { + $invalidProperties[] = "'width' can't be null"; + } + if ($this->container['height'] === null) { + $invalidProperties[] = "'height' can't be null"; + } + if ($this->container['required'] === null) { + $invalidProperties[] = "'required' can't be null"; + } return $invalidProperties; } @@ -363,37 +384,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** - * Gets type - * - * @return string - */ - public function getType() - { - return $this->container['type']; - } - - /** - * Sets type - * - * @param string $type type - * - * @return self - */ - public function setType(string $type) - { - if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); - } - $this->container['type'] = $type; - - return $this; - } - /** * Gets api_id * - * @return string|null + * @return string */ public function getApiId() { @@ -403,11 +397,11 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id the unique ID for this field + * @param string $api_id the unique ID for this field * * @return self */ - public function setApiId(?string $api_id) + public function setApiId(string $api_id) { if (is_null($api_id)) { throw new InvalidArgumentException('non-nullable api_id cannot be null'); @@ -420,7 +414,7 @@ public function setApiId(?string $api_id) /** * Gets name * - * @return string|null + * @return string */ public function getName() { @@ -430,11 +424,11 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the Custom Field + * @param string $name the name of the Custom Field * * @return self */ - public function setName(?string $name) + public function setName(string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); @@ -445,35 +439,28 @@ public function setName(?string $name) } /** - * Gets signer + * Gets type * - * @return string|null + * @return string */ - public function getSigner() + public function getType() { - return $this->container['signer']; + return $this->container['type']; } /** - * Sets signer + * Sets type * - * @param string|null $signer The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + * @param string $type type * * @return self */ - public function setSigner(?string $signer) + public function setType(string $type) { - if (is_null($signer)) { - array_push($this->openAPINullablesSetToNull, 'signer'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('signer', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + if (is_null($type)) { + throw new InvalidArgumentException('non-nullable type cannot be null'); } - $this->container['signer'] = $signer; + $this->container['type'] = $type; return $this; } @@ -481,7 +468,7 @@ public function setSigner(?string $signer) /** * Gets x * - * @return int|null + * @return int */ public function getX() { @@ -491,11 +478,11 @@ public function getX() /** * Sets x * - * @param int|null $x the horizontal offset in pixels for this form field + * @param int $x the horizontal offset in pixels for this form field * * @return self */ - public function setX(?int $x) + public function setX(int $x) { if (is_null($x)) { throw new InvalidArgumentException('non-nullable x cannot be null'); @@ -508,7 +495,7 @@ public function setX(?int $x) /** * Gets y * - * @return int|null + * @return int */ public function getY() { @@ -518,11 +505,11 @@ public function getY() /** * Sets y * - * @param int|null $y the vertical offset in pixels for this form field + * @param int $y the vertical offset in pixels for this form field * * @return self */ - public function setY(?int $y) + public function setY(int $y) { if (is_null($y)) { throw new InvalidArgumentException('non-nullable y cannot be null'); @@ -535,7 +522,7 @@ public function setY(?int $y) /** * Gets width * - * @return int|null + * @return int */ public function getWidth() { @@ -545,11 +532,11 @@ public function getWidth() /** * Sets width * - * @param int|null $width the width in pixels of this form field + * @param int $width the width in pixels of this form field * * @return self */ - public function setWidth(?int $width) + public function setWidth(int $width) { if (is_null($width)) { throw new InvalidArgumentException('non-nullable width cannot be null'); @@ -562,7 +549,7 @@ public function setWidth(?int $width) /** * Gets height * - * @return int|null + * @return int */ public function getHeight() { @@ -572,11 +559,11 @@ public function getHeight() /** * Sets height * - * @param int|null $height the height in pixels of this form field + * @param int $height the height in pixels of this form field * * @return self */ - public function setHeight(?int $height) + public function setHeight(int $height) { if (is_null($height)) { throw new InvalidArgumentException('non-nullable height cannot be null'); @@ -589,7 +576,7 @@ public function setHeight(?int $height) /** * Gets required * - * @return bool|null + * @return bool */ public function getRequired() { @@ -599,11 +586,11 @@ public function getRequired() /** * Sets required * - * @param bool|null $required boolean showing whether or not this field is required + * @param bool $required boolean showing whether or not this field is required * * @return self */ - public function setRequired(?bool $required) + public function setRequired(bool $required) { if (is_null($required)) { throw new InvalidArgumentException('non-nullable required cannot be null'); @@ -613,6 +600,40 @@ public function setRequired(?bool $required) return $this; } + /** + * Gets signer + * + * @return string|null + */ + public function getSigner() + { + return $this->container['signer']; + } + + /** + * Sets signer + * + * @param string|null $signer The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + * + * @return self + */ + public function setSigner(?string $signer) + { + if (is_null($signer)) { + array_push($this->openAPINullablesSetToNull, 'signer'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('signer', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['signer'] = $signer; + + return $this; + } + /** * Gets group * diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php index e63a73978..1ae1955b6 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php @@ -308,6 +308,18 @@ public function listInvalidProperties() if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } + if ($this->container['avg_text_length'] === null) { + $invalidProperties[] = "'avg_text_length' can't be null"; + } + if ($this->container['is_multiline'] === null) { + $invalidProperties[] = "'is_multiline' can't be null"; + } + if ($this->container['original_font_size'] === null) { + $invalidProperties[] = "'original_font_size' can't be null"; + } + if ($this->container['font_family'] === null) { + $invalidProperties[] = "'font_family' can't be null"; + } return $invalidProperties; } @@ -352,7 +364,7 @@ public function setType(string $type) /** * Gets avg_text_length * - * @return TemplateResponseFieldAvgTextLength|null + * @return TemplateResponseFieldAvgTextLength */ public function getAvgTextLength() { @@ -362,11 +374,11 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length + * @param TemplateResponseFieldAvgTextLength $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) + public function setAvgTextLength(TemplateResponseFieldAvgTextLength $avg_text_length) { if (is_null($avg_text_length)) { throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); @@ -379,7 +391,7 @@ public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_l /** * Gets is_multiline * - * @return bool|null + * @return bool */ public function getIsMultiline() { @@ -389,11 +401,11 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline whether this form field is multiline text + * @param bool $is_multiline whether this form field is multiline text * * @return self */ - public function setIsMultiline(?bool $is_multiline) + public function setIsMultiline(bool $is_multiline) { if (is_null($is_multiline)) { throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); @@ -406,7 +418,7 @@ public function setIsMultiline(?bool $is_multiline) /** * Gets original_font_size * - * @return int|null + * @return int */ public function getOriginalFontSize() { @@ -416,11 +428,11 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size original font size used in this form field's text + * @param int $original_font_size original font size used in this form field's text * * @return self */ - public function setOriginalFontSize(?int $original_font_size) + public function setOriginalFontSize(int $original_font_size) { if (is_null($original_font_size)) { throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); @@ -433,7 +445,7 @@ public function setOriginalFontSize(?int $original_font_size) /** * Gets font_family * - * @return string|null + * @return string */ public function getFontFamily() { @@ -443,11 +455,11 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family used in this form field's text + * @param string $font_family font family used in this form field's text * * @return self */ - public function setFontFamily(?string $font_family) + public function setFontFamily(string $font_family) { if (is_null($font_family)) { throw new InvalidArgumentException('non-nullable font_family cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php b/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php index 541714841..6c714950a 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php @@ -288,7 +288,15 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } + if ($this->container['rule'] === null) { + $invalidProperties[] = "'rule' can't be null"; + } + return $invalidProperties; } /** @@ -305,7 +313,7 @@ public function valid() /** * Gets name * - * @return string|null + * @return string */ public function getName() { @@ -315,11 +323,11 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the form field group + * @param string $name the name of the form field group * * @return self */ - public function setName(?string $name) + public function setName(string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); @@ -332,7 +340,7 @@ public function setName(?string $name) /** * Gets rule * - * @return TemplateResponseDocumentFieldGroupRule|null + * @return TemplateResponseDocumentFieldGroupRule */ public function getRule() { @@ -342,11 +350,11 @@ public function getRule() /** * Sets rule * - * @param TemplateResponseDocumentFieldGroupRule|null $rule rule + * @param TemplateResponseDocumentFieldGroupRule $rule rule * * @return self */ - public function setRule(?TemplateResponseDocumentFieldGroupRule $rule) + public function setRule(TemplateResponseDocumentFieldGroupRule $rule) { if (is_null($rule)) { throw new InvalidArgumentException('non-nullable rule cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php b/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php index 1bd31bde9..d46ce788b 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php @@ -289,7 +289,15 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['requirement'] === null) { + $invalidProperties[] = "'requirement' can't be null"; + } + if ($this->container['group_label'] === null) { + $invalidProperties[] = "'group_label' can't be null"; + } + return $invalidProperties; } /** @@ -306,7 +314,7 @@ public function valid() /** * Gets requirement * - * @return string|null + * @return string */ public function getRequirement() { @@ -316,11 +324,11 @@ public function getRequirement() /** * Sets requirement * - * @param string|null $requirement Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. + * @param string $requirement Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. * * @return self */ - public function setRequirement(?string $requirement) + public function setRequirement(string $requirement) { if (is_null($requirement)) { throw new InvalidArgumentException('non-nullable requirement cannot be null'); @@ -333,7 +341,7 @@ public function setRequirement(?string $requirement) /** * Gets group_label * - * @return string|null + * @return string */ public function getGroupLabel() { @@ -343,11 +351,11 @@ public function getGroupLabel() /** * Sets group_label * - * @param string|null $group_label Name of the group + * @param string $group_label Name of the group * * @return self */ - public function setGroupLabel(?string $group_label) + public function setGroupLabel(string $group_label) { if (is_null($group_label)) { throw new InvalidArgumentException('non-nullable group_label cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php index 33cc52c58..cb72f6d81 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php @@ -58,16 +58,15 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce * @var string[] */ protected static $openAPITypes = [ - 'type' => 'string', 'api_id' => 'string', 'name' => 'string', + 'type' => 'string', 'signer' => 'string', 'x' => 'int', 'y' => 'int', 'width' => 'int', 'height' => 'int', 'required' => 'bool', - 'group' => 'string', ]; /** @@ -78,16 +77,15 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce * @psalm-var array */ protected static $openAPIFormats = [ - 'type' => null, 'api_id' => null, 'name' => null, + 'type' => null, 'signer' => null, 'x' => null, 'y' => null, 'width' => null, 'height' => null, 'required' => null, - 'group' => null, ]; /** @@ -96,16 +94,15 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce * @var bool[] */ protected static array $openAPINullables = [ - 'type' => false, 'api_id' => false, 'name' => false, + 'type' => false, 'signer' => false, 'x' => false, 'y' => false, 'width' => false, 'height' => false, 'required' => false, - 'group' => true, ]; /** @@ -186,16 +183,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', 'api_id' => 'api_id', 'name' => 'name', + 'type' => 'type', 'signer' => 'signer', 'x' => 'x', 'y' => 'y', 'width' => 'width', 'height' => 'height', 'required' => 'required', - 'group' => 'group', ]; /** @@ -204,16 +200,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', 'api_id' => 'setApiId', 'name' => 'setName', + 'type' => 'setType', 'signer' => 'setSigner', 'x' => 'setX', 'y' => 'setY', 'width' => 'setWidth', 'height' => 'setHeight', 'required' => 'setRequired', - 'group' => 'setGroup', ]; /** @@ -222,16 +217,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', 'api_id' => 'getApiId', 'name' => 'getName', + 'type' => 'getType', 'signer' => 'getSigner', 'x' => 'getX', 'y' => 'getY', 'width' => 'getWidth', 'height' => 'getHeight', 'required' => 'getRequired', - 'group' => 'getGroup', ]; /** @@ -290,16 +284,15 @@ public function getModelName() */ public function __construct(array $data = null) { - $this->setIfExists('type', $data ?? [], null); $this->setIfExists('api_id', $data ?? [], null); $this->setIfExists('name', $data ?? [], null); + $this->setIfExists('type', $data ?? [], null); $this->setIfExists('signer', $data ?? [], null); $this->setIfExists('x', $data ?? [], null); $this->setIfExists('y', $data ?? [], null); $this->setIfExists('width', $data ?? [], null); $this->setIfExists('height', $data ?? [], null); $this->setIfExists('required', $data ?? [], null); - $this->setIfExists('group', $data ?? [], null); // Initialize discriminator property with the model name. $this->container['type'] = static::$openAPIModelName; @@ -364,9 +357,33 @@ public function listInvalidProperties() { $invalidProperties = []; + if ($this->container['api_id'] === null) { + $invalidProperties[] = "'api_id' can't be null"; + } + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } + if ($this->container['signer'] === null) { + $invalidProperties[] = "'signer' can't be null"; + } + if ($this->container['x'] === null) { + $invalidProperties[] = "'x' can't be null"; + } + if ($this->container['y'] === null) { + $invalidProperties[] = "'y' can't be null"; + } + if ($this->container['width'] === null) { + $invalidProperties[] = "'width' can't be null"; + } + if ($this->container['height'] === null) { + $invalidProperties[] = "'height' can't be null"; + } + if ($this->container['required'] === null) { + $invalidProperties[] = "'required' can't be null"; + } return $invalidProperties; } @@ -382,82 +399,82 @@ public function valid() } /** - * Gets type + * Gets api_id * * @return string */ - public function getType() + public function getApiId() { - return $this->container['type']; + return $this->container['api_id']; } /** - * Sets type + * Sets api_id * - * @param string $type type + * @param string $api_id a unique id for the form field * * @return self */ - public function setType(string $type) + public function setApiId(string $api_id) { - if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + if (is_null($api_id)) { + throw new InvalidArgumentException('non-nullable api_id cannot be null'); } - $this->container['type'] = $type; + $this->container['api_id'] = $api_id; return $this; } /** - * Gets api_id + * Gets name * - * @return string|null + * @return string */ - public function getApiId() + public function getName() { - return $this->container['api_id']; + return $this->container['name']; } /** - * Sets api_id + * Sets name * - * @param string|null $api_id a unique id for the form field + * @param string $name the name of the form field * * @return self */ - public function setApiId(?string $api_id) + public function setName(string $name) { - if (is_null($api_id)) { - throw new InvalidArgumentException('non-nullable api_id cannot be null'); + if (is_null($name)) { + throw new InvalidArgumentException('non-nullable name cannot be null'); } - $this->container['api_id'] = $api_id; + $this->container['name'] = $name; return $this; } /** - * Gets name + * Gets type * - * @return string|null + * @return string */ - public function getName() + public function getType() { - return $this->container['name']; + return $this->container['type']; } /** - * Sets name + * Sets type * - * @param string|null $name the name of the form field + * @param string $type type * * @return self */ - public function setName(?string $name) + public function setType(string $type) { - if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + if (is_null($type)) { + throw new InvalidArgumentException('non-nullable type cannot be null'); } - $this->container['name'] = $name; + $this->container['type'] = $type; return $this; } @@ -465,7 +482,7 @@ public function setName(?string $name) /** * Gets signer * - * @return string|null + * @return string */ public function getSigner() { @@ -475,11 +492,11 @@ public function getSigner() /** * Sets signer * - * @param string|null $signer the signer of the Form Field + * @param string $signer the signer of the Form Field * * @return self */ - public function setSigner(?string $signer) + public function setSigner(string $signer) { if (is_null($signer)) { throw new InvalidArgumentException('non-nullable signer cannot be null'); @@ -492,7 +509,7 @@ public function setSigner(?string $signer) /** * Gets x * - * @return int|null + * @return int */ public function getX() { @@ -502,11 +519,11 @@ public function getX() /** * Sets x * - * @param int|null $x the horizontal offset in pixels for this form field + * @param int $x the horizontal offset in pixels for this form field * * @return self */ - public function setX(?int $x) + public function setX(int $x) { if (is_null($x)) { throw new InvalidArgumentException('non-nullable x cannot be null'); @@ -519,7 +536,7 @@ public function setX(?int $x) /** * Gets y * - * @return int|null + * @return int */ public function getY() { @@ -529,11 +546,11 @@ public function getY() /** * Sets y * - * @param int|null $y the vertical offset in pixels for this form field + * @param int $y the vertical offset in pixels for this form field * * @return self */ - public function setY(?int $y) + public function setY(int $y) { if (is_null($y)) { throw new InvalidArgumentException('non-nullable y cannot be null'); @@ -546,7 +563,7 @@ public function setY(?int $y) /** * Gets width * - * @return int|null + * @return int */ public function getWidth() { @@ -556,11 +573,11 @@ public function getWidth() /** * Sets width * - * @param int|null $width the width in pixels of this form field + * @param int $width the width in pixels of this form field * * @return self */ - public function setWidth(?int $width) + public function setWidth(int $width) { if (is_null($width)) { throw new InvalidArgumentException('non-nullable width cannot be null'); @@ -573,7 +590,7 @@ public function setWidth(?int $width) /** * Gets height * - * @return int|null + * @return int */ public function getHeight() { @@ -583,11 +600,11 @@ public function getHeight() /** * Sets height * - * @param int|null $height the height in pixels of this form field + * @param int $height the height in pixels of this form field * * @return self */ - public function setHeight(?int $height) + public function setHeight(int $height) { if (is_null($height)) { throw new InvalidArgumentException('non-nullable height cannot be null'); @@ -600,7 +617,7 @@ public function setHeight(?int $height) /** * Gets required * - * @return bool|null + * @return bool */ public function getRequired() { @@ -610,11 +627,11 @@ public function getRequired() /** * Sets required * - * @param bool|null $required boolean showing whether or not this field is required + * @param bool $required boolean showing whether or not this field is required * * @return self */ - public function setRequired(?bool $required) + public function setRequired(bool $required) { if (is_null($required)) { throw new InvalidArgumentException('non-nullable required cannot be null'); @@ -624,40 +641,6 @@ public function setRequired(?bool $required) return $this; } - /** - * Gets group - * - * @return string|null - */ - public function getGroup() - { - return $this->container['group']; - } - - /** - * Sets group - * - * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. - * - * @return self - */ - public function setGroup(?string $group) - { - if (is_null($group)) { - array_push($this->openAPINullablesSetToNull, 'group'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('group', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } - } - $this->container['group'] = $group; - - return $this; - } - /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php index bd03254c4..a30010fc1 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php @@ -57,6 +57,7 @@ class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocument */ protected static $openAPITypes = [ 'type' => 'string', + 'group' => 'string', ]; /** @@ -68,6 +69,7 @@ class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocument */ protected static $openAPIFormats = [ 'type' => null, + 'group' => null, ]; /** @@ -77,6 +79,7 @@ class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocument */ protected static array $openAPINullables = [ 'type' => false, + 'group' => true, ]; /** @@ -158,6 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', + 'group' => 'group', ]; /** @@ -167,6 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', + 'group' => 'setGroup', ]; /** @@ -176,6 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', + 'group' => 'getGroup', ]; /** @@ -230,6 +236,7 @@ public function __construct(array $data = null) parent::__construct($data); $this->setIfExists('type', $data ?? [], 'checkbox'); + $this->setIfExists('group', $data ?? [], null); } /** @@ -321,6 +328,40 @@ public function setType(string $type) return $this; } + /** + * Gets group + * + * @return string|null + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(?string $group) + { + if (is_null($group)) { + array_push($this->openAPINullablesSetToNull, 'group'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('group', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php index 158d8159c..bd6072350 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php @@ -57,6 +57,7 @@ class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocume */ protected static $openAPITypes = [ 'type' => 'string', + 'group' => 'string', ]; /** @@ -68,6 +69,7 @@ class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocume */ protected static $openAPIFormats = [ 'type' => null, + 'group' => null, ]; /** @@ -77,6 +79,7 @@ class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocume */ protected static array $openAPINullables = [ 'type' => false, + 'group' => true, ]; /** @@ -158,6 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', + 'group' => 'group', ]; /** @@ -167,6 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', + 'group' => 'setGroup', ]; /** @@ -176,6 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', + 'group' => 'getGroup', ]; /** @@ -230,6 +236,7 @@ public function __construct(array $data = null) parent::__construct($data); $this->setIfExists('type', $data ?? [], 'date_signed'); + $this->setIfExists('group', $data ?? [], null); } /** @@ -321,6 +328,40 @@ public function setType(string $type) return $this; } + /** + * Gets group + * + * @return string|null + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(?string $group) + { + if (is_null($group)) { + array_push($this->openAPINullablesSetToNull, 'group'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('group', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php index 057b5d84d..3e4a827da 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php @@ -57,6 +57,7 @@ class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocument */ protected static $openAPITypes = [ 'type' => 'string', + 'group' => 'string', ]; /** @@ -68,6 +69,7 @@ class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocument */ protected static $openAPIFormats = [ 'type' => null, + 'group' => null, ]; /** @@ -77,6 +79,7 @@ class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocument */ protected static array $openAPINullables = [ 'type' => false, + 'group' => true, ]; /** @@ -158,6 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', + 'group' => 'group', ]; /** @@ -167,6 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', + 'group' => 'setGroup', ]; /** @@ -176,6 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', + 'group' => 'getGroup', ]; /** @@ -230,6 +236,7 @@ public function __construct(array $data = null) parent::__construct($data); $this->setIfExists('type', $data ?? [], 'dropdown'); + $this->setIfExists('group', $data ?? [], null); } /** @@ -321,6 +328,40 @@ public function setType(string $type) return $this; } + /** + * Gets group + * + * @return string|null + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(?string $group) + { + if (is_null($group)) { + array_push($this->openAPINullablesSetToNull, 'group'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('group', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php index 81ffda0ce..0f232111f 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php @@ -61,6 +61,7 @@ class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumen 'is_multiline' => 'bool', 'original_font_size' => 'int', 'font_family' => 'string', + 'group' => 'string', ]; /** @@ -76,6 +77,7 @@ class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumen 'is_multiline' => null, 'original_font_size' => null, 'font_family' => null, + 'group' => null, ]; /** @@ -89,6 +91,7 @@ class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumen 'is_multiline' => false, 'original_font_size' => false, 'font_family' => false, + 'group' => true, ]; /** @@ -174,6 +177,7 @@ public function isNullableSetToNull(string $property): bool 'is_multiline' => 'isMultiline', 'original_font_size' => 'originalFontSize', 'font_family' => 'fontFamily', + 'group' => 'group', ]; /** @@ -187,6 +191,7 @@ public function isNullableSetToNull(string $property): bool 'is_multiline' => 'setIsMultiline', 'original_font_size' => 'setOriginalFontSize', 'font_family' => 'setFontFamily', + 'group' => 'setGroup', ]; /** @@ -200,6 +205,7 @@ public function isNullableSetToNull(string $property): bool 'is_multiline' => 'getIsMultiline', 'original_font_size' => 'getOriginalFontSize', 'font_family' => 'getFontFamily', + 'group' => 'getGroup', ]; /** @@ -258,6 +264,7 @@ public function __construct(array $data = null) $this->setIfExists('is_multiline', $data ?? [], null); $this->setIfExists('original_font_size', $data ?? [], null); $this->setIfExists('font_family', $data ?? [], null); + $this->setIfExists('group', $data ?? [], null); } /** @@ -308,6 +315,18 @@ public function listInvalidProperties() if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } + if ($this->container['avg_text_length'] === null) { + $invalidProperties[] = "'avg_text_length' can't be null"; + } + if ($this->container['is_multiline'] === null) { + $invalidProperties[] = "'is_multiline' can't be null"; + } + if ($this->container['original_font_size'] === null) { + $invalidProperties[] = "'original_font_size' can't be null"; + } + if ($this->container['font_family'] === null) { + $invalidProperties[] = "'font_family' can't be null"; + } return $invalidProperties; } @@ -352,7 +371,7 @@ public function setType(string $type) /** * Gets avg_text_length * - * @return TemplateResponseFieldAvgTextLength|null + * @return TemplateResponseFieldAvgTextLength */ public function getAvgTextLength() { @@ -362,11 +381,11 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length + * @param TemplateResponseFieldAvgTextLength $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) + public function setAvgTextLength(TemplateResponseFieldAvgTextLength $avg_text_length) { if (is_null($avg_text_length)) { throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); @@ -379,7 +398,7 @@ public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_l /** * Gets is_multiline * - * @return bool|null + * @return bool */ public function getIsMultiline() { @@ -389,11 +408,11 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline whether this form field is multiline text + * @param bool $is_multiline whether this form field is multiline text * * @return self */ - public function setIsMultiline(?bool $is_multiline) + public function setIsMultiline(bool $is_multiline) { if (is_null($is_multiline)) { throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); @@ -406,7 +425,7 @@ public function setIsMultiline(?bool $is_multiline) /** * Gets original_font_size * - * @return int|null + * @return int */ public function getOriginalFontSize() { @@ -416,11 +435,11 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size original font size used in this form field's text + * @param int $original_font_size original font size used in this form field's text * * @return self */ - public function setOriginalFontSize(?int $original_font_size) + public function setOriginalFontSize(int $original_font_size) { if (is_null($original_font_size)) { throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); @@ -433,7 +452,7 @@ public function setOriginalFontSize(?int $original_font_size) /** * Gets font_family * - * @return string|null + * @return string */ public function getFontFamily() { @@ -443,11 +462,11 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family used in this form field's text + * @param string $font_family font family used in this form field's text * * @return self */ - public function setFontFamily(?string $font_family) + public function setFontFamily(string $font_family) { if (is_null($font_family)) { throw new InvalidArgumentException('non-nullable font_family cannot be null'); @@ -457,6 +476,40 @@ public function setFontFamily(?string $font_family) return $this; } + /** + * Gets group + * + * @return string|null + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(?string $group) + { + if (is_null($group)) { + array_push($this->openAPINullablesSetToNull, 'group'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('group', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php index 976a27fba..101a6e955 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php @@ -57,6 +57,7 @@ class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocument */ protected static $openAPITypes = [ 'type' => 'string', + 'group' => 'string', ]; /** @@ -68,6 +69,7 @@ class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocument */ protected static $openAPIFormats = [ 'type' => null, + 'group' => null, ]; /** @@ -77,6 +79,7 @@ class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocument */ protected static array $openAPINullables = [ 'type' => false, + 'group' => true, ]; /** @@ -158,6 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', + 'group' => 'group', ]; /** @@ -167,6 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', + 'group' => 'setGroup', ]; /** @@ -176,6 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', + 'group' => 'getGroup', ]; /** @@ -230,6 +236,7 @@ public function __construct(array $data = null) parent::__construct($data); $this->setIfExists('type', $data ?? [], 'initials'); + $this->setIfExists('group', $data ?? [], null); } /** @@ -321,6 +328,40 @@ public function setType(string $type) return $this; } + /** + * Gets group + * + * @return string|null + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(?string $group) + { + if (is_null($group)) { + array_push($this->openAPINullablesSetToNull, 'group'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('group', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php index bd0d28e85..8fd494678 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php @@ -57,6 +57,7 @@ class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFor */ protected static $openAPITypes = [ 'type' => 'string', + 'group' => 'string', ]; /** @@ -68,6 +69,7 @@ class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFor */ protected static $openAPIFormats = [ 'type' => null, + 'group' => null, ]; /** @@ -77,6 +79,7 @@ class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFor */ protected static array $openAPINullables = [ 'type' => false, + 'group' => false, ]; /** @@ -158,6 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', + 'group' => 'group', ]; /** @@ -167,6 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', + 'group' => 'setGroup', ]; /** @@ -176,6 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', + 'group' => 'getGroup', ]; /** @@ -230,6 +236,7 @@ public function __construct(array $data = null) parent::__construct($data); $this->setIfExists('type', $data ?? [], 'radio'); + $this->setIfExists('group', $data ?? [], null); } /** @@ -280,6 +287,9 @@ public function listInvalidProperties() if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } + if ($this->container['group'] === null) { + $invalidProperties[] = "'group' can't be null"; + } return $invalidProperties; } @@ -321,6 +331,33 @@ public function setType(string $type) return $this; } + /** + * Gets group + * + * @return string + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(string $group) + { + if (is_null($group)) { + throw new InvalidArgumentException('non-nullable group cannot be null'); + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php index 9effb72b7..777777464 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php @@ -57,6 +57,7 @@ class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumen */ protected static $openAPITypes = [ 'type' => 'string', + 'group' => 'string', ]; /** @@ -68,6 +69,7 @@ class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumen */ protected static $openAPIFormats = [ 'type' => null, + 'group' => null, ]; /** @@ -77,6 +79,7 @@ class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumen */ protected static array $openAPINullables = [ 'type' => false, + 'group' => true, ]; /** @@ -158,6 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', + 'group' => 'group', ]; /** @@ -167,6 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', + 'group' => 'setGroup', ]; /** @@ -176,6 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', + 'group' => 'getGroup', ]; /** @@ -230,6 +236,7 @@ public function __construct(array $data = null) parent::__construct($data); $this->setIfExists('type', $data ?? [], 'signature'); + $this->setIfExists('group', $data ?? [], null); } /** @@ -321,6 +328,40 @@ public function setType(string $type) return $this; } + /** + * Gets group + * + * @return string|null + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(?string $group) + { + if (is_null($group)) { + array_push($this->openAPINullablesSetToNull, 'group'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('group', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php index 0684e1d67..d8a69b6e0 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php @@ -62,6 +62,7 @@ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentForm 'original_font_size' => 'int', 'font_family' => 'string', 'validation_type' => 'string', + 'group' => 'string', ]; /** @@ -78,6 +79,7 @@ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentForm 'original_font_size' => null, 'font_family' => null, 'validation_type' => null, + 'group' => null, ]; /** @@ -92,6 +94,7 @@ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentForm 'original_font_size' => false, 'font_family' => false, 'validation_type' => true, + 'group' => true, ]; /** @@ -178,6 +181,7 @@ public function isNullableSetToNull(string $property): bool 'original_font_size' => 'originalFontSize', 'font_family' => 'fontFamily', 'validation_type' => 'validation_type', + 'group' => 'group', ]; /** @@ -192,6 +196,7 @@ public function isNullableSetToNull(string $property): bool 'original_font_size' => 'setOriginalFontSize', 'font_family' => 'setFontFamily', 'validation_type' => 'setValidationType', + 'group' => 'setGroup', ]; /** @@ -206,6 +211,7 @@ public function isNullableSetToNull(string $property): bool 'original_font_size' => 'getOriginalFontSize', 'font_family' => 'getFontFamily', 'validation_type' => 'getValidationType', + 'group' => 'getGroup', ]; /** @@ -297,6 +303,7 @@ public function __construct(array $data = null) $this->setIfExists('original_font_size', $data ?? [], null); $this->setIfExists('font_family', $data ?? [], null); $this->setIfExists('validation_type', $data ?? [], null); + $this->setIfExists('group', $data ?? [], null); } /** @@ -347,6 +354,18 @@ public function listInvalidProperties() if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } + if ($this->container['avg_text_length'] === null) { + $invalidProperties[] = "'avg_text_length' can't be null"; + } + if ($this->container['is_multiline'] === null) { + $invalidProperties[] = "'is_multiline' can't be null"; + } + if ($this->container['original_font_size'] === null) { + $invalidProperties[] = "'original_font_size' can't be null"; + } + if ($this->container['font_family'] === null) { + $invalidProperties[] = "'font_family' can't be null"; + } $allowedValues = $this->getValidationTypeAllowableValues(); if (!is_null($this->container['validation_type']) && !in_array($this->container['validation_type'], $allowedValues, true)) { $invalidProperties[] = sprintf( @@ -400,7 +419,7 @@ public function setType(string $type) /** * Gets avg_text_length * - * @return TemplateResponseFieldAvgTextLength|null + * @return TemplateResponseFieldAvgTextLength */ public function getAvgTextLength() { @@ -410,11 +429,11 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length + * @param TemplateResponseFieldAvgTextLength $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) + public function setAvgTextLength(TemplateResponseFieldAvgTextLength $avg_text_length) { if (is_null($avg_text_length)) { throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); @@ -427,7 +446,7 @@ public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_l /** * Gets is_multiline * - * @return bool|null + * @return bool */ public function getIsMultiline() { @@ -437,11 +456,11 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline whether this form field is multiline text + * @param bool $is_multiline whether this form field is multiline text * * @return self */ - public function setIsMultiline(?bool $is_multiline) + public function setIsMultiline(bool $is_multiline) { if (is_null($is_multiline)) { throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); @@ -454,7 +473,7 @@ public function setIsMultiline(?bool $is_multiline) /** * Gets original_font_size * - * @return int|null + * @return int */ public function getOriginalFontSize() { @@ -464,11 +483,11 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size original font size used in this form field's text + * @param int $original_font_size original font size used in this form field's text * * @return self */ - public function setOriginalFontSize(?int $original_font_size) + public function setOriginalFontSize(int $original_font_size) { if (is_null($original_font_size)) { throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); @@ -481,7 +500,7 @@ public function setOriginalFontSize(?int $original_font_size) /** * Gets font_family * - * @return string|null + * @return string */ public function getFontFamily() { @@ -491,11 +510,11 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family used in this form field's text + * @param string $font_family font family used in this form field's text * * @return self */ - public function setFontFamily(?string $font_family) + public function setFontFamily(string $font_family) { if (is_null($font_family)) { throw new InvalidArgumentException('non-nullable font_family cannot be null'); @@ -549,6 +568,40 @@ public function setValidationType(?string $validation_type) return $this; } + /** + * Gets group + * + * @return string|null + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(?string $group) + { + if (is_null($group)) { + array_push($this->openAPINullablesSetToNull, 'group'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('group', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php index bd18e1847..4536c117d 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php @@ -58,9 +58,9 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc * @var string[] */ protected static $openAPITypes = [ - 'type' => 'string', 'api_id' => 'string', 'name' => 'string', + 'type' => 'string', 'signer' => 'string', 'x' => 'int', 'y' => 'int', @@ -78,9 +78,9 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc * @psalm-var array */ protected static $openAPIFormats = [ - 'type' => null, 'api_id' => null, 'name' => null, + 'type' => null, 'signer' => null, 'x' => null, 'y' => null, @@ -96,9 +96,9 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc * @var bool[] */ protected static array $openAPINullables = [ - 'type' => false, 'api_id' => false, 'name' => false, + 'type' => false, 'signer' => false, 'x' => false, 'y' => false, @@ -186,9 +186,9 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', 'api_id' => 'api_id', 'name' => 'name', + 'type' => 'type', 'signer' => 'signer', 'x' => 'x', 'y' => 'y', @@ -204,9 +204,9 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', 'api_id' => 'setApiId', 'name' => 'setName', + 'type' => 'setType', 'signer' => 'setSigner', 'x' => 'setX', 'y' => 'setY', @@ -222,9 +222,9 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', 'api_id' => 'getApiId', 'name' => 'getName', + 'type' => 'getType', 'signer' => 'getSigner', 'x' => 'getX', 'y' => 'getY', @@ -290,9 +290,9 @@ public function getModelName() */ public function __construct(array $data = null) { - $this->setIfExists('type', $data ?? [], null); $this->setIfExists('api_id', $data ?? [], null); $this->setIfExists('name', $data ?? [], null); + $this->setIfExists('type', $data ?? [], null); $this->setIfExists('signer', $data ?? [], 'me_now'); $this->setIfExists('x', $data ?? [], null); $this->setIfExists('y', $data ?? [], null); @@ -364,9 +364,33 @@ public function listInvalidProperties() { $invalidProperties = []; + if ($this->container['api_id'] === null) { + $invalidProperties[] = "'api_id' can't be null"; + } + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } + if ($this->container['signer'] === null) { + $invalidProperties[] = "'signer' can't be null"; + } + if ($this->container['x'] === null) { + $invalidProperties[] = "'x' can't be null"; + } + if ($this->container['y'] === null) { + $invalidProperties[] = "'y' can't be null"; + } + if ($this->container['width'] === null) { + $invalidProperties[] = "'width' can't be null"; + } + if ($this->container['height'] === null) { + $invalidProperties[] = "'height' can't be null"; + } + if ($this->container['required'] === null) { + $invalidProperties[] = "'required' can't be null"; + } return $invalidProperties; } @@ -382,82 +406,82 @@ public function valid() } /** - * Gets type + * Gets api_id * * @return string */ - public function getType() + public function getApiId() { - return $this->container['type']; + return $this->container['api_id']; } /** - * Sets type + * Sets api_id * - * @param string $type type + * @param string $api_id a unique id for the static field * * @return self */ - public function setType(string $type) + public function setApiId(string $api_id) { - if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + if (is_null($api_id)) { + throw new InvalidArgumentException('non-nullable api_id cannot be null'); } - $this->container['type'] = $type; + $this->container['api_id'] = $api_id; return $this; } /** - * Gets api_id + * Gets name * - * @return string|null + * @return string */ - public function getApiId() + public function getName() { - return $this->container['api_id']; + return $this->container['name']; } /** - * Sets api_id + * Sets name * - * @param string|null $api_id a unique id for the static field + * @param string $name the name of the static field * * @return self */ - public function setApiId(?string $api_id) + public function setName(string $name) { - if (is_null($api_id)) { - throw new InvalidArgumentException('non-nullable api_id cannot be null'); + if (is_null($name)) { + throw new InvalidArgumentException('non-nullable name cannot be null'); } - $this->container['api_id'] = $api_id; + $this->container['name'] = $name; return $this; } /** - * Gets name + * Gets type * - * @return string|null + * @return string */ - public function getName() + public function getType() { - return $this->container['name']; + return $this->container['type']; } /** - * Sets name + * Sets type * - * @param string|null $name the name of the static field + * @param string $type type * * @return self */ - public function setName(?string $name) + public function setType(string $type) { - if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + if (is_null($type)) { + throw new InvalidArgumentException('non-nullable type cannot be null'); } - $this->container['name'] = $name; + $this->container['type'] = $type; return $this; } @@ -465,7 +489,7 @@ public function setName(?string $name) /** * Gets signer * - * @return string|null + * @return string */ public function getSigner() { @@ -475,11 +499,11 @@ public function getSigner() /** * Sets signer * - * @param string|null $signer the signer of the Static Field + * @param string $signer the signer of the Static Field * * @return self */ - public function setSigner(?string $signer) + public function setSigner(string $signer) { if (is_null($signer)) { throw new InvalidArgumentException('non-nullable signer cannot be null'); @@ -492,7 +516,7 @@ public function setSigner(?string $signer) /** * Gets x * - * @return int|null + * @return int */ public function getX() { @@ -502,11 +526,11 @@ public function getX() /** * Sets x * - * @param int|null $x the horizontal offset in pixels for this static field + * @param int $x the horizontal offset in pixels for this static field * * @return self */ - public function setX(?int $x) + public function setX(int $x) { if (is_null($x)) { throw new InvalidArgumentException('non-nullable x cannot be null'); @@ -519,7 +543,7 @@ public function setX(?int $x) /** * Gets y * - * @return int|null + * @return int */ public function getY() { @@ -529,11 +553,11 @@ public function getY() /** * Sets y * - * @param int|null $y the vertical offset in pixels for this static field + * @param int $y the vertical offset in pixels for this static field * * @return self */ - public function setY(?int $y) + public function setY(int $y) { if (is_null($y)) { throw new InvalidArgumentException('non-nullable y cannot be null'); @@ -546,7 +570,7 @@ public function setY(?int $y) /** * Gets width * - * @return int|null + * @return int */ public function getWidth() { @@ -556,11 +580,11 @@ public function getWidth() /** * Sets width * - * @param int|null $width the width in pixels of this static field + * @param int $width the width in pixels of this static field * * @return self */ - public function setWidth(?int $width) + public function setWidth(int $width) { if (is_null($width)) { throw new InvalidArgumentException('non-nullable width cannot be null'); @@ -573,7 +597,7 @@ public function setWidth(?int $width) /** * Gets height * - * @return int|null + * @return int */ public function getHeight() { @@ -583,11 +607,11 @@ public function getHeight() /** * Sets height * - * @param int|null $height the height in pixels of this static field + * @param int $height the height in pixels of this static field * * @return self */ - public function setHeight(?int $height) + public function setHeight(int $height) { if (is_null($height)) { throw new InvalidArgumentException('non-nullable height cannot be null'); @@ -600,7 +624,7 @@ public function setHeight(?int $height) /** * Gets required * - * @return bool|null + * @return bool */ public function getRequired() { @@ -610,11 +634,11 @@ public function getRequired() /** * Sets required * - * @param bool|null $required boolean showing whether or not this field is required + * @param bool $required boolean showing whether or not this field is required * * @return self */ - public function setRequired(?bool $required) + public function setRequired(bool $required) { if (is_null($required)) { throw new InvalidArgumentException('non-nullable required cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php b/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php index 9277db26a..f43ee698c 100644 --- a/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php +++ b/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php @@ -289,7 +289,15 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['num_lines'] === null) { + $invalidProperties[] = "'num_lines' can't be null"; + } + if ($this->container['num_chars_per_line'] === null) { + $invalidProperties[] = "'num_chars_per_line' can't be null"; + } + return $invalidProperties; } /** @@ -306,7 +314,7 @@ public function valid() /** * Gets num_lines * - * @return int|null + * @return int */ public function getNumLines() { @@ -316,11 +324,11 @@ public function getNumLines() /** * Sets num_lines * - * @param int|null $num_lines number of lines + * @param int $num_lines number of lines * * @return self */ - public function setNumLines(?int $num_lines) + public function setNumLines(int $num_lines) { if (is_null($num_lines)) { throw new InvalidArgumentException('non-nullable num_lines cannot be null'); @@ -333,7 +341,7 @@ public function setNumLines(?int $num_lines) /** * Gets num_chars_per_line * - * @return int|null + * @return int */ public function getNumCharsPerLine() { @@ -343,11 +351,11 @@ public function getNumCharsPerLine() /** * Sets num_chars_per_line * - * @param int|null $num_chars_per_line number of characters per line + * @param int $num_chars_per_line number of characters per line * * @return self */ - public function setNumCharsPerLine(?int $num_chars_per_line) + public function setNumCharsPerLine(int $num_chars_per_line) { if (is_null($num_chars_per_line)) { throw new InvalidArgumentException('non-nullable num_chars_per_line cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseSignerRole.php b/sdks/php/src/Model/TemplateResponseSignerRole.php index 98a80c6e0..094e01375 100644 --- a/sdks/php/src/Model/TemplateResponseSignerRole.php +++ b/sdks/php/src/Model/TemplateResponseSignerRole.php @@ -288,7 +288,12 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } + return $invalidProperties; } /** @@ -305,7 +310,7 @@ public function valid() /** * Gets name * - * @return string|null + * @return string */ public function getName() { @@ -315,11 +320,11 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the Role + * @param string $name the name of the Role * * @return self */ - public function setName(?string $name) + public function setName(string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); diff --git a/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php b/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php index 70d2e87dc..f3df49b86 100644 --- a/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php +++ b/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php @@ -289,7 +289,12 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['template_id'] === null) { + $invalidProperties[] = "'template_id' can't be null"; + } + return $invalidProperties; } /** @@ -306,7 +311,7 @@ public function valid() /** * Gets template_id * - * @return string|null + * @return string */ public function getTemplateId() { @@ -316,11 +321,11 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string $template_id the id of the Template * * @return self */ - public function setTemplateId(?string $template_id) + public function setTemplateId(string $template_id) { if (is_null($template_id)) { throw new InvalidArgumentException('non-nullable template_id cannot be null'); diff --git a/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 56b48ec48..b8801fb09 100644 --- a/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -5,9 +5,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```str``` | The id of the Template. | | -| `edit_url` | ```str``` | Link to edit the template. | | -| `expires_at` | ```int``` | When the link expires. | | +| `template_id`*_required_ | ```str``` | The id of the Template. | | +| `edit_url`*_required_ | ```str``` | Link to edit the template. | | +| `expires_at`*_required_ | ```int``` | When the link expires. | | | `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | [[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/TemplateCreateResponseTemplate.md b/sdks/python/docs/TemplateCreateResponseTemplate.md index 1c3d76f37..8281fab89 100644 --- a/sdks/python/docs/TemplateCreateResponseTemplate.md +++ b/sdks/python/docs/TemplateCreateResponseTemplate.md @@ -5,7 +5,7 @@ Template object with parameters: `template_id`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```str``` | The id of the Template. | | +| `template_id`*_required_ | ```str``` | The id of the Template. | | [[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/TemplateResponse.md b/sdks/python/docs/TemplateResponse.md index 7fb5cedbc..c86b24d1f 100644 --- a/sdks/python/docs/TemplateResponse.md +++ b/sdks/python/docs/TemplateResponse.md @@ -5,21 +5,22 @@ Contains information about the templates you and your team have created. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```str``` | The id of the Template. | | -| `title` | ```str``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```str``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `template_id`*_required_ | ```str``` | The id of the Template. | | +| `title`*_required_ | ```str``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message`*_required_ | ```str``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `is_creator`*_required_ | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `can_edit`*_required_ | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `is_locked`*_required_ | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata`*_required_ | ```object``` | The metadata attached to the template. | | +| `signer_roles`*_required_ | [```List[TemplateResponseSignerRole]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `cc_roles`*_required_ | [```List[TemplateResponseCCRole]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | +| `documents`*_required_ | [```List[TemplateResponseDocument]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `accounts`*_required_ | [```List[TemplateResponseAccount]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments`*_required_ | [```List[SignatureRequestResponseAttachment]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updated_at` | ```int``` | Time the template was last updated. | | -| `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `is_creator` | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `can_edit` | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `is_locked` | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata` | ```object``` | The metadata attached to the template. | | -| `signer_roles` | [```List[TemplateResponseSignerRole]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `cc_roles` | [```List[TemplateResponseCCRole]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```List[TemplateResponseDocument]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | | `custom_fields` | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```List[TemplateResponseAccount]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | [[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/TemplateResponseAccount.md b/sdks/python/docs/TemplateResponseAccount.md index 7668fc726..da824a979 100644 --- a/sdks/python/docs/TemplateResponseAccount.md +++ b/sdks/python/docs/TemplateResponseAccount.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_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.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` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | [[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/TemplateResponseAccountQuota.md b/sdks/python/docs/TemplateResponseAccountQuota.md index 7e83dcc11..18ab10015 100644 --- a/sdks/python/docs/TemplateResponseAccountQuota.md +++ b/sdks/python/docs/TemplateResponseAccountQuota.md @@ -5,10 +5,10 @@ An array of the designated CC roles that must be specified when sending a Signat ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates_left` | ```int``` | API templates remaining. | | -| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | -| `documents_left` | ```int``` | Signature requests remaining. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | +| `templates_left`*_required_ | ```int``` | API templates remaining. | | +| `api_signature_requests_left`*_required_ | ```int``` | API signature requests remaining. | | +| `documents_left`*_required_ | ```int``` | Signature requests remaining. | | +| `sms_verifications_left`*_required_ | ```int``` | SMS verifications remaining. | | [[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/TemplateResponseCCRole.md b/sdks/python/docs/TemplateResponseCCRole.md index 1aa9fa707..81fe0a22d 100644 --- a/sdks/python/docs/TemplateResponseCCRole.md +++ b/sdks/python/docs/TemplateResponseCCRole.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | The name of the Role. | | +| `name`*_required_ | ```str``` | The name of the Role. | | [[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/TemplateResponseDocument.md b/sdks/python/docs/TemplateResponseDocument.md index 8071995b9..6ce6cded9 100644 --- a/sdks/python/docs/TemplateResponseDocument.md +++ b/sdks/python/docs/TemplateResponseDocument.md @@ -5,12 +5,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | Name of the associated file. | | +| `name`*_required_ | ```str``` | Name of the associated file. | | +| `field_groups`*_required_ | [```List[TemplateResponseDocumentFieldGroup]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `form_fields`*_required_ | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `custom_fields`*_required_ | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `static_fields`*_required_ | [```List[TemplateResponseDocumentStaticFieldBase]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | | `index` | ```int``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `field_groups` | [```List[TemplateResponseDocumentFieldGroup]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `form_fields` | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `custom_fields` | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `static_fields` | [```List[TemplateResponseDocumentStaticFieldBase]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | [[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/TemplateResponseDocumentCustomFieldBase.md b/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md index 83354a3f4..802b74749 100644 --- a/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md @@ -5,15 +5,15 @@ An array of Form Field objects containing the name and type of each named field. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `api_id`*_required_ | ```str``` | The unique ID for this field. | | +| `name`*_required_ | ```str``` | The name of the Custom Field. | | | `type`*_required_ | ```str``` | | | -| `api_id` | ```str``` | The unique ID for this field. | | -| `name` | ```str``` | The name of the Custom Field. | | +| `x`*_required_ | ```int``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```int``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```int``` | The width in pixels of this form field. | | +| `height`*_required_ | ```int``` | The height in pixels of this form field. | | +| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | | `signer` | ```str``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```int``` | The horizontal offset in pixels for this form field. | | -| `y` | ```int``` | The vertical offset in pixels for this form field. | | -| `width` | ```int``` | The width in pixels of this form field. | | -| `height` | ```int``` | The height in pixels of this form field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseDocumentCustomFieldText.md b/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md index 474097e03..35f8038d8 100644 --- a/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md @@ -6,10 +6,10 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | -| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```str``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```str``` | Font family used in this form field's text. | | [[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/TemplateResponseDocumentFieldGroup.md b/sdks/python/docs/TemplateResponseDocumentFieldGroup.md index 29a19c7cf..718a3e198 100644 --- a/sdks/python/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/python/docs/TemplateResponseDocumentFieldGroup.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | The name of the form field group. | | -| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name`*_required_ | ```str``` | The name of the form field group. | | +| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | [[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/TemplateResponseDocumentFieldGroupRule.md b/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md index 3f0a44f1a..2b44ba01e 100644 --- a/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md @@ -5,8 +5,8 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `requirement` | ```str``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `group_label` | ```str``` | Name of the group | | +| `requirement`*_required_ | ```str``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `group_label`*_required_ | ```str``` | Name of the group | | [[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/TemplateResponseDocumentFormFieldBase.md b/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md index b8aecfa10..fa864f418 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md @@ -5,16 +5,15 @@ An array of Form Field objects containing the name and type of each named field. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `api_id`*_required_ | ```str``` | A unique id for the form field. | | +| `name`*_required_ | ```str``` | The name of the form field. | | | `type`*_required_ | ```str``` | | | -| `api_id` | ```str``` | A unique id for the form field. | | -| `name` | ```str``` | The name of the form field. | | -| `signer` | ```str``` | The signer of the Form Field. | | -| `x` | ```int``` | The horizontal offset in pixels for this form field. | | -| `y` | ```int``` | The vertical offset in pixels for this form field. | | -| `width` | ```int``` | The width in pixels of this form field. | | -| `height` | ```int``` | The height in pixels of this form field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | -| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `signer`*_required_ | ```str``` | The signer of the Form Field. | | +| `x`*_required_ | ```int``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```int``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```int``` | The width in pixels of this form field. | | +| `height`*_required_ | ```int``` | The height in pixels of this form field. | | +| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | [[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/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/python/docs/TemplateResponseDocumentFormFieldCheckbox.md index 6d35e1c71..1a2167a2e 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -6,6 +6,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | +| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/python/docs/TemplateResponseDocumentFormFieldDateSigned.md index 863ed1190..a9add1a93 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -6,6 +6,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | +| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldDropdown.md b/sdks/python/docs/TemplateResponseDocumentFormFieldDropdown.md index 99d07332c..40d2cf2c0 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -6,6 +6,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | +| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md index dd7db8dde..574f277e4 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -6,10 +6,11 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | -| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```str``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```str``` | Font family used in this form field's text. | | +| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldInitials.md b/sdks/python/docs/TemplateResponseDocumentFormFieldInitials.md index 80cc52231..77acaa80b 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldInitials.md @@ -6,6 +6,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | +| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldRadio.md b/sdks/python/docs/TemplateResponseDocumentFormFieldRadio.md index af3e60ed9..9db9a8d03 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldRadio.md @@ -6,6 +6,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | +| `group`*_required_ | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldSignature.md b/sdks/python/docs/TemplateResponseDocumentFormFieldSignature.md index 304eaf502..adce267f0 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldSignature.md @@ -6,6 +6,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | +| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldText.md b/sdks/python/docs/TemplateResponseDocumentFormFieldText.md index bafb6e36b..b1c58101f 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldText.md @@ -6,11 +6,12 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | -| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```str``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```str``` | Font family used in this form field's text. | | | `validation_type` | ```str``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | +| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentStaticFieldBase.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md index a7347b687..39a2be0f7 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md @@ -5,15 +5,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `api_id`*_required_ | ```str``` | A unique id for the static field. | | +| `name`*_required_ | ```str``` | The name of the static field. | | | `type`*_required_ | ```str``` | | | -| `api_id` | ```str``` | A unique id for the static field. | | -| `name` | ```str``` | The name of the static field. | | -| `signer` | ```str``` | The signer of the Static Field. | [default to 'me_now'] | -| `x` | ```int``` | The horizontal offset in pixels for this static field. | | -| `y` | ```int``` | The vertical offset in pixels for this static field. | | -| `width` | ```int``` | The width in pixels of this static field. | | -| `height` | ```int``` | The height in pixels of this static field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | +| `signer`*_required_ | ```str``` | The signer of the Static Field. | [default to 'me_now'] | +| `x`*_required_ | ```int``` | The horizontal offset in pixels for this static field. | | +| `y`*_required_ | ```int``` | The vertical offset in pixels for this static field. | | +| `width`*_required_ | ```int``` | The width in pixels of this static field. | | +| `height`*_required_ | ```int``` | The height in pixels of this static field. | | +| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseFieldAvgTextLength.md b/sdks/python/docs/TemplateResponseFieldAvgTextLength.md index f50991c74..7cb7f1475 100644 --- a/sdks/python/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/python/docs/TemplateResponseFieldAvgTextLength.md @@ -5,8 +5,8 @@ Average text length in this field. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `num_lines` | ```int``` | Number of lines. | | -| `num_chars_per_line` | ```int``` | Number of characters per line. | | +| `num_lines`*_required_ | ```int``` | Number of lines. | | +| `num_chars_per_line`*_required_ | ```int``` | Number of characters per line. | | [[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/TemplateResponseSignerRole.md b/sdks/python/docs/TemplateResponseSignerRole.md index 7a65a361d..75bd84379 100644 --- a/sdks/python/docs/TemplateResponseSignerRole.md +++ b/sdks/python/docs/TemplateResponseSignerRole.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | The name of the Role. | | +| `name`*_required_ | ```str``` | The name of the Role. | | | `order` | ```int``` | If signer order is assigned this is the 0-based index for this role. | | [[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/TemplateUpdateFilesResponseTemplate.md b/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md index 27ea3171f..fbd42b28c 100644 --- a/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md @@ -5,7 +5,7 @@ Contains template id ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```str``` | The id of the Template. | | +| `template_id`*_required_ | ```str``` | The id of the Template. | | | `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | [[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/template_create_embedded_draft_response_template.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py index be23c205a..bc66784aa 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py @@ -33,15 +33,9 @@ class TemplateCreateEmbeddedDraftResponseTemplate(BaseModel): Template object with parameters: `template_id`, `edit_url`, `expires_at`. """ # noqa: E501 - template_id: Optional[StrictStr] = Field( - default=None, description="The id of the Template." - ) - edit_url: Optional[StrictStr] = Field( - default=None, description="Link to edit the template." - ) - expires_at: Optional[StrictInt] = Field( - default=None, description="When the link expires." - ) + template_id: StrictStr = Field(description="The id of the Template.") + edit_url: StrictStr = Field(description="Link to edit the template.") + expires_at: StrictInt = Field(description="When the link expires.") warnings: Optional[List[WarningResponse]] = Field( default=None, description="A list of warnings." ) diff --git a/sdks/python/dropbox_sign/models/template_create_response_template.py b/sdks/python/dropbox_sign/models/template_create_response_template.py index e4f253ef0..77253dcd3 100644 --- a/sdks/python/dropbox_sign/models/template_create_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_response_template.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -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 TemplateCreateResponseTemplate(BaseModel): Template object with parameters: `template_id`. """ # noqa: E501 - template_id: Optional[StrictStr] = Field( - default=None, description="The id of the Template." - ) + template_id: StrictStr = Field(description="The id of the Template.") __properties: ClassVar[List[str]] = ["template_id"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/template_response.py b/sdks/python/dropbox_sign/models/template_response.py index 12d203c42..7b55f5e58 100644 --- a/sdks/python/dropbox_sign/models/template_response.py +++ b/sdks/python/dropbox_sign/models/template_response.py @@ -20,6 +20,9 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional +from dropbox_sign.models.signature_request_response_attachment import ( + SignatureRequestResponseAttachment, +) from dropbox_sign.models.template_response_account import TemplateResponseAccount from dropbox_sign.models.template_response_cc_role import TemplateResponseCCRole from dropbox_sign.models.template_response_document import TemplateResponseDocument @@ -42,50 +45,46 @@ class TemplateResponse(BaseModel): Contains information about the templates you and your team have created. """ # noqa: E501 - template_id: Optional[StrictStr] = Field( - default=None, description="The id of the Template." + template_id: StrictStr = Field(description="The id of the Template.") + title: StrictStr = Field( + description="The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest." ) - title: Optional[StrictStr] = Field( - default=None, - description="The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.", + message: StrictStr = Field( + description="The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest." ) - message: Optional[StrictStr] = Field( - default=None, - description="The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.", + is_creator: StrictBool = Field( + description="`true` if you are the owner of this template, `false` if it's been shared with you by a team member." ) - updated_at: Optional[StrictInt] = Field( - default=None, description="Time the template was last updated." + can_edit: StrictBool = Field( + description="Indicates whether edit rights have been granted to you by the owner (always `true` if that's you)." ) - is_embedded: Optional[StrictBool] = Field( - default=None, - description="`true` if this template was created using an embedded flow, `false` if it was created on our website.", + is_locked: StrictBool = Field( + description="Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests." ) - is_creator: Optional[StrictBool] = Field( - default=None, - description="`true` if you are the owner of this template, `false` if it's been shared with you by a team member.", + metadata: Dict[str, Any] = Field( + description="The metadata attached to the template." ) - can_edit: Optional[StrictBool] = Field( - default=None, - description="Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).", + signer_roles: List[TemplateResponseSignerRole] = Field( + description="An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template." ) - is_locked: Optional[StrictBool] = Field( - default=None, - description="Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.", + cc_roles: List[TemplateResponseCCRole] = Field( + description="An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template." ) - metadata: Optional[Dict[str, Any]] = Field( - default=None, description="The metadata attached to the template." + documents: List[TemplateResponseDocument] = Field( + description="An array describing each document associated with this Template. Includes form field data for each document." ) - signer_roles: Optional[List[TemplateResponseSignerRole]] = Field( - default=None, - description="An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.", + accounts: List[TemplateResponseAccount] = Field( + description="An array of the Accounts that can use this Template." ) - cc_roles: Optional[List[TemplateResponseCCRole]] = Field( - default=None, - description="An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.", + attachments: List[SignatureRequestResponseAttachment] = Field( + description="Signer attachments." ) - documents: Optional[List[TemplateResponseDocument]] = Field( + updated_at: Optional[StrictInt] = Field( + default=None, description="Time the template was last updated." + ) + is_embedded: Optional[StrictBool] = Field( default=None, - description="An array describing each document associated with this Template. Includes form field data for each document.", + description="`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.", ) custom_fields: Optional[List[TemplateResponseDocumentCustomFieldBase]] = Field( default=None, @@ -95,15 +94,10 @@ class TemplateResponse(BaseModel): default=None, description="Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.", ) - accounts: Optional[List[TemplateResponseAccount]] = Field( - default=None, description="An array of the Accounts that can use this Template." - ) __properties: ClassVar[List[str]] = [ "template_id", "title", "message", - "updated_at", - "is_embedded", "is_creator", "can_edit", "is_locked", @@ -111,9 +105,12 @@ class TemplateResponse(BaseModel): "signer_roles", "cc_roles", "documents", + "accounts", + "attachments", + "updated_at", + "is_embedded", "custom_fields", "named_form_fields", - "accounts", ] model_config = ConfigDict( @@ -187,6 +184,20 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: if _item_documents: _items.append(_item_documents.to_dict()) _dict["documents"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in accounts (list) + _items = [] + if self.accounts: + for _item_accounts in self.accounts: + if _item_accounts: + _items.append(_item_accounts.to_dict()) + _dict["accounts"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in attachments (list) + _items = [] + if self.attachments: + for _item_attachments in self.attachments: + if _item_attachments: + _items.append(_item_attachments.to_dict()) + _dict["attachments"] = _items # override the default output from pydantic by calling `to_dict()` of each item in custom_fields (list) _items = [] if self.custom_fields: @@ -201,13 +212,6 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: if _item_named_form_fields: _items.append(_item_named_form_fields.to_dict()) _dict["named_form_fields"] = _items - # override the default output from pydantic by calling `to_dict()` of each item in accounts (list) - _items = [] - if self.accounts: - for _item_accounts in self.accounts: - if _item_accounts: - _items.append(_item_accounts.to_dict()) - _dict["accounts"] = _items return _dict @classmethod @@ -224,8 +228,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "template_id": obj.get("template_id"), "title": obj.get("title"), "message": obj.get("message"), - "updated_at": obj.get("updated_at"), - "is_embedded": obj.get("is_embedded"), "is_creator": obj.get("is_creator"), "can_edit": obj.get("can_edit"), "is_locked": obj.get("is_locked"), @@ -254,6 +256,24 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("documents") is not None else None ), + "accounts": ( + [ + TemplateResponseAccount.from_dict(_item) + for _item in obj["accounts"] + ] + if obj.get("accounts") is not None + else None + ), + "attachments": ( + [ + SignatureRequestResponseAttachment.from_dict(_item) + for _item in obj["attachments"] + ] + if obj.get("attachments") is not None + else None + ), + "updated_at": obj.get("updated_at"), + "is_embedded": obj.get("is_embedded"), "custom_fields": ( [ TemplateResponseDocumentCustomFieldBase.from_dict(_item) @@ -270,14 +290,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("named_form_fields") is not None else None ), - "accounts": ( - [ - TemplateResponseAccount.from_dict(_item) - for _item in obj["accounts"] - ] - if obj.get("accounts") is not None - else None - ), } ) return _obj @@ -298,8 +310,6 @@ def openapi_types(cls) -> Dict[str, str]: "template_id": "(str,)", "title": "(str,)", "message": "(str,)", - "updated_at": "(int,)", - "is_embedded": "(bool,)", "is_creator": "(bool,)", "can_edit": "(bool,)", "is_locked": "(bool,)", @@ -307,9 +317,12 @@ def openapi_types(cls) -> Dict[str, str]: "signer_roles": "(List[TemplateResponseSignerRole],)", "cc_roles": "(List[TemplateResponseCCRole],)", "documents": "(List[TemplateResponseDocument],)", + "accounts": "(List[TemplateResponseAccount],)", + "attachments": "(List[SignatureRequestResponseAttachment],)", + "updated_at": "(int,)", + "is_embedded": "(bool,)", "custom_fields": "(List[TemplateResponseDocumentCustomFieldBase],)", "named_form_fields": "(List[TemplateResponseDocumentFormFieldBase],)", - "accounts": "(List[TemplateResponseAccount],)", } @classmethod @@ -318,7 +331,8 @@ def openapi_type_is_array(cls, property_name: str) -> bool: "signer_roles", "cc_roles", "documents", + "accounts", + "attachments", "custom_fields", "named_form_fields", - "accounts", ] diff --git a/sdks/python/dropbox_sign/models/template_response_account.py b/sdks/python/dropbox_sign/models/template_response_account.py index 71358ff84..1b34f5e00 100644 --- a/sdks/python/dropbox_sign/models/template_response_account.py +++ b/sdks/python/dropbox_sign/models/template_response_account.py @@ -35,32 +35,27 @@ class TemplateResponseAccount(BaseModel): TemplateResponseAccount """ # 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_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: StrictBool = Field( + description="Returns `true` if the user has a paid Dropbox Sign account." ) - is_paid_hs: Optional[StrictBool] = Field( - default=None, - 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." ) - is_paid_hf: Optional[StrictBool] = Field( - default=None, - description="Returns `true` if the user has a paid HelloFax account.", + quotas: TemplateResponseAccountQuota + email_address: Optional[StrictStr] = Field( + default=None, description="The email address associated with the Account." ) - quotas: Optional[TemplateResponseAccountQuota] = None __properties: ClassVar[List[str]] = [ "account_id", - "email_address", "is_locked", "is_paid_hs", "is_paid_hf", "quotas", + "email_address", ] model_config = ConfigDict( @@ -130,7 +125,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"), @@ -139,6 +133,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"), } ) return _obj @@ -157,11 +152,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": "(TemplateResponseAccountQuota,)", + "email_address": "(str,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_response_account_quota.py b/sdks/python/dropbox_sign/models/template_response_account_quota.py index 6c03effe9..6c96e8cd7 100644 --- a/sdks/python/dropbox_sign/models/template_response_account_quota.py +++ b/sdks/python/dropbox_sign/models/template_response_account_quota.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,17 +32,13 @@ class TemplateResponseAccountQuota(BaseModel): An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. """ # noqa: E501 - templates_left: Optional[StrictInt] = Field( - default=None, description="API templates remaining." + templates_left: StrictInt = Field(description="API templates remaining.") + api_signature_requests_left: StrictInt = Field( + description="API signature requests remaining." ) - api_signature_requests_left: Optional[StrictInt] = Field( - default=None, description="API signature requests remaining." - ) - documents_left: Optional[StrictInt] = Field( - default=None, description="Signature requests remaining." - ) - sms_verifications_left: Optional[StrictInt] = Field( - default=None, description="SMS verifications remaining." + documents_left: StrictInt = Field(description="Signature requests remaining.") + sms_verifications_left: StrictInt = Field( + description="SMS verifications remaining." ) __properties: ClassVar[List[str]] = [ "templates_left", diff --git a/sdks/python/dropbox_sign/models/template_response_cc_role.py b/sdks/python/dropbox_sign/models/template_response_cc_role.py index 8c005227d..2a9e77900 100644 --- a/sdks/python/dropbox_sign/models/template_response_cc_role.py +++ b/sdks/python/dropbox_sign/models/template_response_cc_role.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -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,7 +32,7 @@ class TemplateResponseCCRole(BaseModel): TemplateResponseCCRole """ # noqa: E501 - name: Optional[StrictStr] = Field(default=None, description="The name of the Role.") + name: StrictStr = Field(description="The name of the Role.") __properties: ClassVar[List[str]] = ["name"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/template_response_document.py b/sdks/python/dropbox_sign/models/template_response_document.py index 56e887bd0..e7b4be883 100644 --- a/sdks/python/dropbox_sign/models/template_response_document.py +++ b/sdks/python/dropbox_sign/models/template_response_document.py @@ -44,35 +44,30 @@ class TemplateResponseDocument(BaseModel): TemplateResponseDocument """ # noqa: E501 - name: Optional[StrictStr] = Field( - default=None, description="Name of the associated file." + name: StrictStr = Field(description="Name of the associated file.") + field_groups: List[TemplateResponseDocumentFieldGroup] = Field( + description="An array of Form Field Group objects." ) - index: Optional[StrictInt] = Field( - default=None, - description="Document ordering, the lowest index is displayed first and the highest last (0-based indexing).", + form_fields: List[TemplateResponseDocumentFormFieldBase] = Field( + description="An array of Form Field objects containing the name and type of each named field." ) - field_groups: Optional[List[TemplateResponseDocumentFieldGroup]] = Field( - default=None, description="An array of Form Field Group objects." + custom_fields: List[TemplateResponseDocumentCustomFieldBase] = Field( + description="An array of Form Field objects containing the name and type of each named field." ) - form_fields: Optional[List[TemplateResponseDocumentFormFieldBase]] = Field( - default=None, - description="An array of Form Field objects containing the name and type of each named field.", + static_fields: List[TemplateResponseDocumentStaticFieldBase] = Field( + description="An array describing static overlay fields. **NOTE:** Only available for certain subscriptions." ) - custom_fields: Optional[List[TemplateResponseDocumentCustomFieldBase]] = Field( - default=None, - description="An array of Form Field objects containing the name and type of each named field.", - ) - static_fields: Optional[List[TemplateResponseDocumentStaticFieldBase]] = Field( + index: Optional[StrictInt] = Field( default=None, - description="An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.", + description="Document ordering, the lowest index is displayed first and the highest last (0-based indexing).", ) __properties: ClassVar[List[str]] = [ "name", - "index", "field_groups", "form_fields", "custom_fields", "static_fields", + "index", ] model_config = ConfigDict( @@ -167,7 +162,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { "name": obj.get("name"), - "index": obj.get("index"), "field_groups": ( [ TemplateResponseDocumentFieldGroup.from_dict(_item) @@ -200,6 +194,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("static_fields") is not None else None ), + "index": obj.get("index"), } ) return _obj @@ -218,11 +213,11 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "name": "(str,)", - "index": "(int,)", "field_groups": "(List[TemplateResponseDocumentFieldGroup],)", "form_fields": "(List[TemplateResponseDocumentFormFieldBase],)", "custom_fields": "(List[TemplateResponseDocumentCustomFieldBase],)", "static_fields": "(List[TemplateResponseDocumentStaticFieldBase],)", + "index": "(int,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py index a7d2fa60c..988002152 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py @@ -43,46 +43,37 @@ class TemplateResponseDocumentCustomFieldBase(BaseModel): An array of Form Field objects containing the name and type of each named field. """ # noqa: E501 + api_id: StrictStr = Field(description="The unique ID for this field.") + name: StrictStr = Field(description="The name of the Custom Field.") type: StrictStr - api_id: Optional[StrictStr] = Field( - default=None, description="The unique ID for this field." + x: StrictInt = Field( + description="The horizontal offset in pixels for this form field." ) - name: Optional[StrictStr] = Field( - default=None, description="The name of the Custom Field." + y: StrictInt = Field( + description="The vertical offset in pixels for this form field." + ) + width: StrictInt = Field(description="The width in pixels of this form field.") + height: StrictInt = Field(description="The height in pixels of this form field.") + required: StrictBool = Field( + description="Boolean showing whether or not this field is required." ) signer: Union[StrictStr, StrictInt, None] = Field( description="The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender)." ) - x: Optional[StrictInt] = Field( - default=None, description="The horizontal offset in pixels for this form field." - ) - y: Optional[StrictInt] = Field( - default=None, description="The vertical offset in pixels for this form field." - ) - width: Optional[StrictInt] = Field( - default=None, description="The width in pixels of this form field." - ) - height: Optional[StrictInt] = Field( - default=None, description="The height in pixels of this form field." - ) - required: Optional[StrictBool] = Field( - default=None, - description="Boolean showing whether or not this field is required.", - ) group: Optional[StrictStr] = Field( default=None, description="The name of the group this field is in. If this field is not a group, this defaults to `null`.", ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", - "signer", + "type", "x", "y", "width", "height", "required", + "signer", "group", ] @@ -192,15 +183,15 @@ def from_dict(cls, obj: Dict[str, Any]) -> Optional[ @classmethod def openapi_types(cls) -> Dict[str, str]: return { - "type": "(str,)", "api_id": "(str,)", "name": "(str,)", - "signer": "(int, str,)", + "type": "(str,)", "x": "(int,)", "y": "(int,)", "width": "(int,)", "height": "(int,)", "required": "(bool,)", + "signer": "(int, str,)", "group": "(str,)", } diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py index 4edf644c2..620e742fe 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py @@ -41,15 +41,15 @@ class TemplateResponseDocumentCustomFieldCheckbox( description="The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", - "signer", + "type", "x", "y", "width", "height", "required", + "signer", "group", ] @@ -116,15 +116,15 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "checkbox", "api_id": obj.get("api_id"), "name": obj.get("name"), - "signer": obj.get("signer"), + "type": obj.get("type") if obj.get("type") is not None else "checkbox", "x": obj.get("x"), "y": obj.get("y"), "width": obj.get("width"), "height": obj.get("height"), "required": obj.get("required"), + "signer": obj.get("signer"), "group": obj.get("group"), } ) @@ -146,12 +146,12 @@ def openapi_types(cls) -> Dict[str, str]: "type": "(str,)", "api_id": "(str,)", "name": "(str,)", - "signer": "(int, str,)", "x": "(int,)", "y": "(int,)", "width": "(int,)", "height": "(int,)", "required": "(bool,)", + "signer": "(int, str,)", "group": "(str,)", } diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py index 760dd57a4..79e87d225 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py @@ -19,7 +19,7 @@ import json from pydantic import ConfigDict, Field, StrictBool, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Optional +from typing import Any, ClassVar, Dict, List from dropbox_sign.models.template_response_document_custom_field_base import ( TemplateResponseDocumentCustomFieldBase, ) @@ -41,37 +41,32 @@ class TemplateResponseDocumentCustomFieldText(TemplateResponseDocumentCustomFiel type: StrictStr = Field( description="The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`" ) - avg_text_length: Optional[TemplateResponseFieldAvgTextLength] = None - is_multiline: Optional[StrictBool] = Field( - default=None, - description="Whether this form field is multiline text.", - alias="isMultiline", + avg_text_length: TemplateResponseFieldAvgTextLength + is_multiline: StrictBool = Field( + description="Whether this form field is multiline text.", alias="isMultiline" ) - original_font_size: Optional[StrictInt] = Field( - default=None, + original_font_size: StrictInt = Field( description="Original font size used in this form field's text.", alias="originalFontSize", ) - font_family: Optional[StrictStr] = Field( - default=None, - description="Font family used in this form field's text.", - alias="fontFamily", + font_family: StrictStr = Field( + description="Font family used in this form field's text.", alias="fontFamily" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", - "signer", + "type", "x", "y", "width", "height", "required", - "group", "avg_text_length", "isMultiline", "originalFontSize", "fontFamily", + "signer", + "group", ] model_config = ConfigDict( @@ -140,16 +135,14 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "text", "api_id": obj.get("api_id"), "name": obj.get("name"), - "signer": obj.get("signer"), + "type": obj.get("type") if obj.get("type") is not None else "text", "x": obj.get("x"), "y": obj.get("y"), "width": obj.get("width"), "height": obj.get("height"), "required": obj.get("required"), - "group": obj.get("group"), "avg_text_length": ( TemplateResponseFieldAvgTextLength.from_dict(obj["avg_text_length"]) if obj.get("avg_text_length") is not None @@ -158,6 +151,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "isMultiline": obj.get("isMultiline"), "originalFontSize": obj.get("originalFontSize"), "fontFamily": obj.get("fontFamily"), + "signer": obj.get("signer"), + "group": obj.get("group"), } ) return _obj @@ -182,12 +177,12 @@ def openapi_types(cls) -> Dict[str, str]: "font_family": "(str,)", "api_id": "(str,)", "name": "(str,)", - "signer": "(int, str,)", "x": "(int,)", "y": "(int,)", "width": "(int,)", "height": "(int,)", "required": "(bool,)", + "signer": "(int, str,)", "group": "(str,)", } diff --git a/sdks/python/dropbox_sign/models/template_response_document_field_group.py b/sdks/python/dropbox_sign/models/template_response_document_field_group.py index 201bd139e..c74f1fe64 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_field_group.py +++ b/sdks/python/dropbox_sign/models/template_response_document_field_group.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List, Optional +from typing import Any, ClassVar, Dict, List from dropbox_sign.models.template_response_document_field_group_rule import ( TemplateResponseDocumentFieldGroupRule, ) @@ -35,10 +35,8 @@ class TemplateResponseDocumentFieldGroup(BaseModel): TemplateResponseDocumentFieldGroup """ # noqa: E501 - name: Optional[StrictStr] = Field( - default=None, description="The name of the form field group." - ) - rule: Optional[TemplateResponseDocumentFieldGroupRule] = None + name: StrictStr = Field(description="The name of the form field group.") + rule: TemplateResponseDocumentFieldGroupRule __properties: ClassVar[List[str]] = ["name", "rule"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py b/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py index e5ade9d4e..b932c4984 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py +++ b/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -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,13 +32,10 @@ class TemplateResponseDocumentFieldGroupRule(BaseModel): The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). """ # noqa: E501 - requirement: Optional[StrictStr] = Field( - default=None, - description="Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group.", - ) - group_label: Optional[StrictStr] = Field( - default=None, description="Name of the group", alias="groupLabel" + requirement: StrictStr = Field( + description="Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group." ) + group_label: StrictStr = Field(description="Name of the group", alias="groupLabel") __properties: ClassVar[List[str]] = ["requirement", "groupLabel"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py index a8052fd2a..2b5660900 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py @@ -20,7 +20,7 @@ from importlib import import_module from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Union from typing import Optional, Set, Tuple from typing_extensions import Self import io @@ -61,47 +61,33 @@ class TemplateResponseDocumentFormFieldBase(BaseModel): An array of Form Field objects containing the name and type of each named field. """ # noqa: E501 + api_id: StrictStr = Field(description="A unique id for the form field.") + name: StrictStr = Field(description="The name of the form field.") type: StrictStr - api_id: Optional[StrictStr] = Field( - default=None, description="A unique id for the form field." - ) - name: Optional[StrictStr] = Field( - default=None, description="The name of the form field." - ) signer: Union[StrictStr, StrictInt] = Field( description="The signer of the Form Field." ) - x: Optional[StrictInt] = Field( - default=None, description="The horizontal offset in pixels for this form field." - ) - y: Optional[StrictInt] = Field( - default=None, description="The vertical offset in pixels for this form field." - ) - width: Optional[StrictInt] = Field( - default=None, description="The width in pixels of this form field." - ) - height: Optional[StrictInt] = Field( - default=None, description="The height in pixels of this form field." + x: StrictInt = Field( + description="The horizontal offset in pixels for this form field." ) - required: Optional[StrictBool] = Field( - default=None, - description="Boolean showing whether or not this field is required.", + y: StrictInt = Field( + description="The vertical offset in pixels for this form field." ) - group: Optional[StrictStr] = Field( - default=None, - description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + width: StrictInt = Field(description="The width in pixels of this form field.") + height: StrictInt = Field(description="The height in pixels of this form field.") + required: StrictBool = Field( + description="Boolean showing whether or not this field is required." ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", "width", "height", "required", - "group", ] model_config = ConfigDict( @@ -252,16 +238,15 @@ def from_dict(cls, obj: Dict[str, Any]) -> Optional[ @classmethod def openapi_types(cls) -> Dict[str, str]: return { - "type": "(str,)", "api_id": "(str,)", "name": "(str,)", + "type": "(str,)", "signer": "(int, str,)", "x": "(int,)", "y": "(int,)", "width": "(int,)", "height": "(int,)", "required": "(bool,)", - "group": "(str,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py index 9804d5077..807940bca 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py @@ -19,7 +19,7 @@ import json from pydantic import ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) @@ -38,10 +38,14 @@ class TemplateResponseDocumentFormFieldCheckbox(TemplateResponseDocumentFormFiel type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) + group: Optional[StrictStr] = Field( + default=None, + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -114,9 +118,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "checkbox", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "checkbox", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py index 14a9a2a08..0a58c895d 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py @@ -19,7 +19,7 @@ import json from pydantic import ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) @@ -40,10 +40,14 @@ class TemplateResponseDocumentFormFieldDateSigned( type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) + group: Optional[StrictStr] = Field( + default=None, + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -116,11 +120,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "api_id": obj.get("api_id"), + "name": obj.get("name"), "type": ( obj.get("type") if obj.get("type") is not None else "date_signed" ), - "api_id": obj.get("api_id"), - "name": obj.get("name"), "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py index 89351e112..6f99acde6 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py @@ -19,7 +19,7 @@ import json from pydantic import ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) @@ -38,10 +38,14 @@ class TemplateResponseDocumentFormFieldDropdown(TemplateResponseDocumentFormFiel type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) + group: Optional[StrictStr] = Field( + default=None, + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -114,9 +118,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "dropdown", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "dropdown", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py index 2c7529891..da496caa2 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py @@ -41,37 +41,36 @@ class TemplateResponseDocumentFormFieldHyperlink(TemplateResponseDocumentFormFie type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) - avg_text_length: Optional[TemplateResponseFieldAvgTextLength] = None - is_multiline: Optional[StrictBool] = Field( - default=None, - description="Whether this form field is multiline text.", - alias="isMultiline", + avg_text_length: TemplateResponseFieldAvgTextLength + is_multiline: StrictBool = Field( + description="Whether this form field is multiline text.", alias="isMultiline" ) - original_font_size: Optional[StrictInt] = Field( - default=None, + original_font_size: StrictInt = Field( description="Original font size used in this form field's text.", alias="originalFontSize", ) - font_family: Optional[StrictStr] = Field( + font_family: StrictStr = Field( + description="Font family used in this form field's text.", alias="fontFamily" + ) + group: Optional[StrictStr] = Field( default=None, - description="Font family used in this form field's text.", - alias="fontFamily", + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", "width", "height", "required", - "group", "avg_text_length", "isMultiline", "originalFontSize", "fontFamily", + "group", ] model_config = ConfigDict( @@ -140,16 +139,15 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "hyperlink", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "hyperlink", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), "width": obj.get("width"), "height": obj.get("height"), "required": obj.get("required"), - "group": obj.get("group"), "avg_text_length": ( TemplateResponseFieldAvgTextLength.from_dict(obj["avg_text_length"]) if obj.get("avg_text_length") is not None @@ -158,6 +156,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "isMultiline": obj.get("isMultiline"), "originalFontSize": obj.get("originalFontSize"), "fontFamily": obj.get("fontFamily"), + "group": obj.get("group"), } ) return _obj diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py index bded1e5f6..71b714532 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py @@ -19,7 +19,7 @@ import json from pydantic import ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) @@ -38,10 +38,14 @@ class TemplateResponseDocumentFormFieldInitials(TemplateResponseDocumentFormFiel type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) + group: Optional[StrictStr] = Field( + default=None, + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -114,9 +118,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "initials", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "initials", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py index dd394e149..a38a7a65f 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py @@ -38,17 +38,20 @@ class TemplateResponseDocumentFormFieldRadio(TemplateResponseDocumentFormFieldBa type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) + group: StrictStr = Field( + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields." + ) __properties: ClassVar[List[str]] = [ - "type", - "group", "api_id", "name", + "type", "signer", "x", "y", "width", "height", "required", + "group", ] model_config = ConfigDict( @@ -114,16 +117,16 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "radio", - "group": obj.get("group"), "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "radio", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), "width": obj.get("width"), "height": obj.get("height"), "required": obj.get("required"), + "group": obj.get("group"), } ) return _obj diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py index fd82759b1..89ba48fcc 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py @@ -19,7 +19,7 @@ import json from pydantic import ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) @@ -38,10 +38,14 @@ class TemplateResponseDocumentFormFieldSignature(TemplateResponseDocumentFormFie type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) + group: Optional[StrictStr] = Field( + default=None, + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -114,9 +118,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "signature", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "signature", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py index 752e9a25b..8282093d9 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py @@ -48,42 +48,41 @@ class TemplateResponseDocumentFormFieldText(TemplateResponseDocumentFormFieldBas type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) - avg_text_length: Optional[TemplateResponseFieldAvgTextLength] = None - is_multiline: Optional[StrictBool] = Field( - default=None, - description="Whether this form field is multiline text.", - alias="isMultiline", + avg_text_length: TemplateResponseFieldAvgTextLength + is_multiline: StrictBool = Field( + description="Whether this form field is multiline text.", alias="isMultiline" ) - original_font_size: Optional[StrictInt] = Field( - default=None, + original_font_size: StrictInt = Field( description="Original font size used in this form field's text.", alias="originalFontSize", ) - font_family: Optional[StrictStr] = Field( - default=None, - description="Font family used in this form field's text.", - alias="fontFamily", + font_family: StrictStr = Field( + description="Font family used in this form field's text.", alias="fontFamily" ) validation_type: Optional[StrictStr] = Field( default=None, description="Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.", ) + group: Optional[StrictStr] = Field( + default=None, + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", "width", "height", "required", - "group", "avg_text_length", "isMultiline", "originalFontSize", "fontFamily", "validation_type", + "group", ] @field_validator("validation_type") @@ -177,16 +176,15 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "text", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "text", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), "width": obj.get("width"), "height": obj.get("height"), "required": obj.get("required"), - "group": obj.get("group"), "avg_text_length": ( TemplateResponseFieldAvgTextLength.from_dict(obj["avg_text_length"]) if obj.get("avg_text_length") is not None @@ -196,6 +194,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "originalFontSize": obj.get("originalFontSize"), "fontFamily": obj.get("fontFamily"), "validation_type": obj.get("validation_type"), + "group": obj.get("group"), } ) return _obj @@ -218,7 +217,6 @@ def openapi_types(cls) -> Dict[str, str]: "is_multiline": "(bool,)", "original_font_size": "(int,)", "font_family": "(str,)", - "validation_type": "(str,)", "api_id": "(str,)", "name": "(str,)", "signer": "(int, str,)", @@ -227,6 +225,7 @@ def openapi_types(cls) -> Dict[str, str]: "width": "(int,)", "height": "(int,)", "required": "(bool,)", + "validation_type": "(str,)", "group": "(str,)", } diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py index 4c16302d2..18d800e8f 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py @@ -61,41 +61,29 @@ class TemplateResponseDocumentStaticFieldBase(BaseModel): An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. """ # noqa: E501 + api_id: StrictStr = Field(description="A unique id for the static field.") + name: StrictStr = Field(description="The name of the static field.") type: StrictStr - api_id: Optional[StrictStr] = Field( - default=None, description="A unique id for the static field." + signer: StrictStr = Field(description="The signer of the Static Field.") + x: StrictInt = Field( + description="The horizontal offset in pixels for this static field." ) - name: Optional[StrictStr] = Field( - default=None, description="The name of the static field." + y: StrictInt = Field( + description="The vertical offset in pixels for this static field." ) - signer: Optional[StrictStr] = Field( - default="me_now", description="The signer of the Static Field." - ) - x: Optional[StrictInt] = Field( - default=None, - description="The horizontal offset in pixels for this static field.", - ) - y: Optional[StrictInt] = Field( - default=None, description="The vertical offset in pixels for this static field." - ) - width: Optional[StrictInt] = Field( - default=None, description="The width in pixels of this static field." - ) - height: Optional[StrictInt] = Field( - default=None, description="The height in pixels of this static field." - ) - required: Optional[StrictBool] = Field( - default=None, - description="Boolean showing whether or not this field is required.", + width: StrictInt = Field(description="The width in pixels of this static field.") + height: StrictInt = Field(description="The height in pixels of this static field.") + required: StrictBool = Field( + description="Boolean showing whether or not this field is required." ) group: Optional[StrictStr] = Field( default=None, description="The name of the group this field is in. If this field is not a group, this defaults to `null`.", ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -253,9 +241,9 @@ def from_dict(cls, obj: Dict[str, Any]) -> Optional[ @classmethod def openapi_types(cls) -> Dict[str, str]: return { - "type": "(str,)", "api_id": "(str,)", "name": "(str,)", + "type": "(str,)", "signer": "(str,)", "x": "(int,)", "y": "(int,)", diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py index ea1c2b787..e56e41e37 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldCheckbox( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "checkbox", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "checkbox", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py index 3a9bf86e0..e24b49d0d 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldDateSigned( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -116,11 +116,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "api_id": obj.get("api_id"), + "name": obj.get("name"), "type": ( obj.get("type") if obj.get("type") is not None else "date_signed" ), - "api_id": obj.get("api_id"), - "name": obj.get("name"), "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py index 8444e77d8..7689e4f80 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldDropdown( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "dropdown", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "dropdown", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py index 43106f1b1..8b5e4a5a9 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldHyperlink( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "hyperlink", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "hyperlink", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py index 884425354..e6880abd5 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldInitials( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "initials", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "initials", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py index e0701f1cc..94873742e 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py @@ -39,9 +39,9 @@ class TemplateResponseDocumentStaticFieldRadio(TemplateResponseDocumentStaticFie description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -114,9 +114,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "radio", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "radio", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py index dbd12110f..417f92b19 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldSignature( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "signature", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "signature", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py index 7fe3d5925..deda059a0 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py @@ -39,9 +39,9 @@ class TemplateResponseDocumentStaticFieldText(TemplateResponseDocumentStaticFiel description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -114,9 +114,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "text", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "text", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py b/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py index b3b5d4aff..e2e27d72f 100644 --- a/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py +++ b/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.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,10 +32,8 @@ class TemplateResponseFieldAvgTextLength(BaseModel): Average text length in this field. """ # noqa: E501 - num_lines: Optional[StrictInt] = Field(default=None, description="Number of lines.") - num_chars_per_line: Optional[StrictInt] = Field( - default=None, description="Number of characters per line." - ) + num_lines: StrictInt = Field(description="Number of lines.") + num_chars_per_line: StrictInt = Field(description="Number of characters per line.") __properties: ClassVar[List[str]] = ["num_lines", "num_chars_per_line"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/template_response_signer_role.py b/sdks/python/dropbox_sign/models/template_response_signer_role.py index aab8250c4..ffbf7a5b3 100644 --- a/sdks/python/dropbox_sign/models/template_response_signer_role.py +++ b/sdks/python/dropbox_sign/models/template_response_signer_role.py @@ -32,7 +32,7 @@ class TemplateResponseSignerRole(BaseModel): TemplateResponseSignerRole """ # noqa: E501 - name: Optional[StrictStr] = Field(default=None, description="The name of the Role.") + name: StrictStr = Field(description="The name of the Role.") order: Optional[StrictInt] = Field( default=None, description="If signer order is assigned this is the 0-based index for this role.", diff --git a/sdks/python/dropbox_sign/models/template_update_files_response_template.py b/sdks/python/dropbox_sign/models/template_update_files_response_template.py index a8fb50fa3..fc44b1dda 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_response_template.py +++ b/sdks/python/dropbox_sign/models/template_update_files_response_template.py @@ -33,9 +33,7 @@ class TemplateUpdateFilesResponseTemplate(BaseModel): Contains template id """ # noqa: E501 - template_id: Optional[StrictStr] = Field( - default=None, description="The id of the Template." - ) + template_id: StrictStr = Field(description="The id of the Template.") warnings: Optional[List[WarningResponse]] = Field( default=None, description="A list of warnings." ) diff --git a/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 9006aa0f8..d33b22d57 100644 --- a/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -6,8 +6,8 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id` | ```String``` | The id of the Template. | | -| `edit_url` | ```String``` | Link to edit the template. | | -| `expires_at` | ```Integer``` | When the link expires. | | +| `template_id`*_required_ | ```String``` | The id of the Template. | | +| `edit_url`*_required_ | ```String``` | Link to edit the template. | | +| `expires_at`*_required_ | ```Integer``` | When the link expires. | | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/ruby/docs/TemplateCreateResponseTemplate.md b/sdks/ruby/docs/TemplateCreateResponseTemplate.md index 4d9488de7..4e63e9ea8 100644 --- a/sdks/ruby/docs/TemplateCreateResponseTemplate.md +++ b/sdks/ruby/docs/TemplateCreateResponseTemplate.md @@ -6,5 +6,5 @@ Template object with parameters: `template_id`. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id` | ```String``` | The id of the Template. | | +| `template_id`*_required_ | ```String``` | The id of the Template. | | diff --git a/sdks/ruby/docs/TemplateResponse.md b/sdks/ruby/docs/TemplateResponse.md index 18c191b7b..0d850ce62 100644 --- a/sdks/ruby/docs/TemplateResponse.md +++ b/sdks/ruby/docs/TemplateResponse.md @@ -6,19 +6,20 @@ Contains information about the templates you and your team have created. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id` | ```String``` | The id of the Template. | | -| `title` | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `template_id`*_required_ | ```String``` | The id of the Template. | | +| `title`*_required_ | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message`*_required_ | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `is_creator`*_required_ | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `can_edit`*_required_ | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `is_locked`*_required_ | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata`*_required_ | ```Object``` | The metadata attached to the template. | | +| `signer_roles`*_required_ | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `cc_roles`*_required_ | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | +| `documents`*_required_ | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `accounts`*_required_ | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments`*_required_ | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updated_at` | ```Integer``` | Time the template was last updated. | | -| `is_embedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `is_creator` | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `can_edit` | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `is_locked` | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata` | ```Object``` | The metadata attached to the template. | | -| `signer_roles` | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `cc_roles` | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `is_embedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | | `custom_fields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | diff --git a/sdks/ruby/docs/TemplateResponseAccount.md b/sdks/ruby/docs/TemplateResponseAccount.md index dcb2bc328..3c4b18f3c 100644 --- a/sdks/ruby/docs/TemplateResponseAccount.md +++ b/sdks/ruby/docs/TemplateResponseAccount.md @@ -6,10 +6,10 @@ | 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_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.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` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | diff --git a/sdks/ruby/docs/TemplateResponseAccountQuota.md b/sdks/ruby/docs/TemplateResponseAccountQuota.md index 8e314836a..1b67e4ee6 100644 --- a/sdks/ruby/docs/TemplateResponseAccountQuota.md +++ b/sdks/ruby/docs/TemplateResponseAccountQuota.md @@ -6,8 +6,8 @@ An array of the designated CC roles that must be specified when sending a Signat | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `templates_left` | ```Integer``` | API templates remaining. | | -| `api_signature_requests_left` | ```Integer``` | API signature requests remaining. | | -| `documents_left` | ```Integer``` | Signature requests remaining. | | -| `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | | +| `templates_left`*_required_ | ```Integer``` | API templates remaining. | | +| `api_signature_requests_left`*_required_ | ```Integer``` | API signature requests remaining. | | +| `documents_left`*_required_ | ```Integer``` | Signature requests remaining. | | +| `sms_verifications_left`*_required_ | ```Integer``` | SMS verifications remaining. | | diff --git a/sdks/ruby/docs/TemplateResponseCCRole.md b/sdks/ruby/docs/TemplateResponseCCRole.md index b8c9b08f8..00ab61067 100644 --- a/sdks/ruby/docs/TemplateResponseCCRole.md +++ b/sdks/ruby/docs/TemplateResponseCCRole.md @@ -6,5 +6,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | The name of the Role. | | +| `name`*_required_ | ```String``` | The name of the Role. | | diff --git a/sdks/ruby/docs/TemplateResponseDocument.md b/sdks/ruby/docs/TemplateResponseDocument.md index 5b9a105ae..6959cb0fa 100644 --- a/sdks/ruby/docs/TemplateResponseDocument.md +++ b/sdks/ruby/docs/TemplateResponseDocument.md @@ -6,10 +6,10 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | Name of the associated file. | | +| `name`*_required_ | ```String``` | Name of the associated file. | | +| `field_groups`*_required_ | [```Array```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `form_fields`*_required_ | [```Array```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `custom_fields`*_required_ | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `static_fields`*_required_ | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | | `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `field_groups` | [```Array```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `form_fields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `custom_fields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `static_fields` | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md index 53f1fae78..01e988fcb 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md @@ -6,14 +6,14 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| `api_id`*_required_ | ```String``` | The unique ID for this field. | | +| `name`*_required_ | ```String``` | The name of the Custom Field. | | | `type`*_required_ | ```String``` | | | -| `api_id` | ```String``` | The unique ID for this field. | | -| `name` | ```String``` | The name of the Custom Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | | `signer` | ```String``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md index 52138173c..9582a0b11 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md @@ -7,8 +7,8 @@ This class extends `TemplateResponseDocumentCustomFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | -| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | | -| `font_family` | ```String``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```String``` | Font family used in this form field's text. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md b/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md index 114dba8b6..c8fea8928 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | The name of the form field group. | | -| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name`*_required_ | ```String``` | The name of the form field group. | | +| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md index 601ef69a3..ef8689712 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md @@ -6,6 +6,6 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `requirement` | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `group_label` | ```String``` | Name of the group | | +| `requirement`*_required_ | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `group_label`*_required_ | ```String``` | Name of the group | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md index 52620dc6d..0daaa439a 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md @@ -6,14 +6,13 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| `api_id`*_required_ | ```String``` | A unique id for the form field. | | +| `name`*_required_ | ```String``` | The name of the form field. | | | `type`*_required_ | ```String``` | | | -| `api_id` | ```String``` | A unique id for the form field. | | -| `name` | ```String``` | The name of the form field. | | -| `signer` | ```String``` | The signer of the Form Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `signer`*_required_ | ```String``` | The signer of the Form Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldCheckbox.md index 9eb4d6eed..13dd5cb48 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldDateSigned.md index 3c1a4525b..253d8b41e 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldDropdown.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldDropdown.md index adf242b2f..b224d1011 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md index 7c6059afb..83c3646b1 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -7,8 +7,9 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | -| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | | -| `font_family` | ```String``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```String``` | Font family used in this form field's text. | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldInitials.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldInitials.md index de0250ace..63387d36e 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldInitials.md @@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldRadio.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldRadio.md index ef2728b81..fcdc459aa 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldRadio.md @@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | +| `group`*_required_ | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldSignature.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldSignature.md index fd9e2b241..552a3c814 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldSignature.md @@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md index c35a1e3a1..15341ae02 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md @@ -7,9 +7,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | -| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | | -| `font_family` | ```String``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```String``` | Font family used in this form field's text. | | | `validation_type` | ```String``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md index 49696a59f..b7b085348 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md @@ -6,14 +6,14 @@ An array describing static overlay fields. **NOTE:** Only available for certain | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| `api_id`*_required_ | ```String``` | A unique id for the static field. | | +| `name`*_required_ | ```String``` | The name of the static field. | | | `type`*_required_ | ```String``` | | | -| `api_id` | ```String``` | A unique id for the static field. | | -| `name` | ```String``` | The name of the static field. | | -| `signer` | ```String``` | The signer of the Static Field. | [default to 'me_now'] | -| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this static field. | | -| `width` | ```Integer``` | The width in pixels of this static field. | | -| `height` | ```Integer``` | The height in pixels of this static field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `signer`*_required_ | ```String``` | The signer of the Static Field. | [default to 'me_now'] | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this static field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this static field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this static field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this static field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md b/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md index 923bc0fc1..ee8754dfc 100644 --- a/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md @@ -6,6 +6,6 @@ Average text length in this field. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `num_lines` | ```Integer``` | Number of lines. | | -| `num_chars_per_line` | ```Integer``` | Number of characters per line. | | +| `num_lines`*_required_ | ```Integer``` | Number of lines. | | +| `num_chars_per_line`*_required_ | ```Integer``` | Number of characters per line. | | diff --git a/sdks/ruby/docs/TemplateResponseSignerRole.md b/sdks/ruby/docs/TemplateResponseSignerRole.md index e61e1ef66..16d41a529 100644 --- a/sdks/ruby/docs/TemplateResponseSignerRole.md +++ b/sdks/ruby/docs/TemplateResponseSignerRole.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | The name of the Role. | | +| `name`*_required_ | ```String``` | The name of the Role. | | | `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this role. | | diff --git a/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md index f0964f519..5f03f54e9 100644 --- a/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md @@ -6,6 +6,6 @@ Contains template id | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id` | ```String``` | The id of the Template. | | +| `template_id`*_required_ | ```String``` | The id of the Template. | | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb index a8eeafb20..7d005908e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb @@ -129,12 +129,27 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @template_id.nil? + invalid_properties.push('invalid value for "template_id", template_id cannot be nil.') + end + + if @edit_url.nil? + invalid_properties.push('invalid value for "edit_url", edit_url cannot be nil.') + end + + if @expires_at.nil? + invalid_properties.push('invalid value for "expires_at", expires_at 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 @template_id.nil? + return false if @edit_url.nil? + return false if @expires_at.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb index 91e0dc57f..4abd9bbdc 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb @@ -97,12 +97,17 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @template_id.nil? + invalid_properties.push('invalid value for "template_id", template_id 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 @template_id.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response.rb b/sdks/ruby/lib/dropbox-sign/models/template_response.rb index 7d14e8a13..e070bc7a7 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response.rb @@ -31,24 +31,16 @@ class TemplateResponse # @return [String] attr_accessor :message - # Time the template was last updated. - # @return [Integer] - attr_accessor :updated_at - - # `true` if this template was created using an embedded flow, `false` if it was created on our website. - # @return [Boolean, nil] - attr_accessor :is_embedded - # `true` if you are the owner of this template, `false` if it's been shared with you by a team member. - # @return [Boolean, nil] + # @return [Boolean] attr_accessor :is_creator # Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). - # @return [Boolean, nil] + # @return [Boolean] attr_accessor :can_edit # Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. - # @return [Boolean, nil] + # @return [Boolean] attr_accessor :is_locked # The metadata attached to the template. @@ -67,6 +59,22 @@ class TemplateResponse # @return [Array] attr_accessor :documents + # An array of the Accounts that can use this Template. + # @return [Array] + attr_accessor :accounts + + # Signer attachments. + # @return [Array] + attr_accessor :attachments + + # Time the template was last updated. + # @return [Integer] + attr_accessor :updated_at + + # `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + # @return [Boolean, nil] + attr_accessor :is_embedded + # Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. # @return [Array, nil] attr_accessor :custom_fields @@ -75,18 +83,12 @@ class TemplateResponse # @return [Array, nil] attr_accessor :named_form_fields - # An array of the Accounts that can use this Template. - # @return [Array, nil] - attr_accessor :accounts - # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'template_id' => :'template_id', :'title' => :'title', :'message' => :'message', - :'updated_at' => :'updated_at', - :'is_embedded' => :'is_embedded', :'is_creator' => :'is_creator', :'can_edit' => :'can_edit', :'is_locked' => :'is_locked', @@ -94,9 +96,12 @@ def self.attribute_map :'signer_roles' => :'signer_roles', :'cc_roles' => :'cc_roles', :'documents' => :'documents', + :'accounts' => :'accounts', + :'attachments' => :'attachments', + :'updated_at' => :'updated_at', + :'is_embedded' => :'is_embedded', :'custom_fields' => :'custom_fields', - :'named_form_fields' => :'named_form_fields', - :'accounts' => :'accounts' + :'named_form_fields' => :'named_form_fields' } end @@ -111,8 +116,6 @@ def self.openapi_types :'template_id' => :'String', :'title' => :'String', :'message' => :'String', - :'updated_at' => :'Integer', - :'is_embedded' => :'Boolean', :'is_creator' => :'Boolean', :'can_edit' => :'Boolean', :'is_locked' => :'Boolean', @@ -120,9 +123,12 @@ def self.openapi_types :'signer_roles' => :'Array', :'cc_roles' => :'Array', :'documents' => :'Array', + :'accounts' => :'Array', + :'attachments' => :'Array', + :'updated_at' => :'Integer', + :'is_embedded' => :'Boolean', :'custom_fields' => :'Array', - :'named_form_fields' => :'Array', - :'accounts' => :'Array' + :'named_form_fields' => :'Array' } end @@ -130,12 +136,8 @@ def self.openapi_types def self.openapi_nullable Set.new([ :'is_embedded', - :'is_creator', - :'can_edit', - :'is_locked', :'custom_fields', - :'named_form_fields', - :'accounts' + :'named_form_fields' ]) end @@ -191,14 +193,6 @@ def initialize(attributes = {}) self.message = attributes[:'message'] end - if attributes.key?(:'updated_at') - self.updated_at = attributes[:'updated_at'] - end - - if attributes.key?(:'is_embedded') - self.is_embedded = attributes[:'is_embedded'] - end - if attributes.key?(:'is_creator') self.is_creator = attributes[:'is_creator'] end @@ -233,6 +227,26 @@ def initialize(attributes = {}) end end + if attributes.key?(:'accounts') + if (value = attributes[:'accounts']).is_a?(Array) + self.accounts = value + end + end + + if attributes.key?(:'attachments') + if (value = attributes[:'attachments']).is_a?(Array) + self.attachments = value + end + end + + if attributes.key?(:'updated_at') + self.updated_at = attributes[:'updated_at'] + end + + if attributes.key?(:'is_embedded') + self.is_embedded = attributes[:'is_embedded'] + end + if attributes.key?(:'custom_fields') if (value = attributes[:'custom_fields']).is_a?(Array) self.custom_fields = value @@ -244,24 +258,78 @@ def initialize(attributes = {}) self.named_form_fields = value end end - - if attributes.key?(:'accounts') - if (value = attributes[:'accounts']).is_a?(Array) - self.accounts = value - end - end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @template_id.nil? + invalid_properties.push('invalid value for "template_id", template_id cannot be nil.') + end + + if @title.nil? + invalid_properties.push('invalid value for "title", title cannot be nil.') + end + + if @message.nil? + invalid_properties.push('invalid value for "message", message cannot be nil.') + end + + if @is_creator.nil? + invalid_properties.push('invalid value for "is_creator", is_creator cannot be nil.') + end + + if @can_edit.nil? + invalid_properties.push('invalid value for "can_edit", can_edit cannot be nil.') + end + + if @is_locked.nil? + invalid_properties.push('invalid value for "is_locked", is_locked cannot be nil.') + end + + if @metadata.nil? + invalid_properties.push('invalid value for "metadata", metadata cannot be nil.') + end + + if @signer_roles.nil? + invalid_properties.push('invalid value for "signer_roles", signer_roles cannot be nil.') + end + + if @cc_roles.nil? + invalid_properties.push('invalid value for "cc_roles", cc_roles cannot be nil.') + end + + if @documents.nil? + invalid_properties.push('invalid value for "documents", documents cannot be nil.') + end + + if @accounts.nil? + invalid_properties.push('invalid value for "accounts", accounts cannot be nil.') + end + + if @attachments.nil? + invalid_properties.push('invalid value for "attachments", attachments 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 @template_id.nil? + return false if @title.nil? + return false if @message.nil? + return false if @is_creator.nil? + return false if @can_edit.nil? + return false if @is_locked.nil? + return false if @metadata.nil? + return false if @signer_roles.nil? + return false if @cc_roles.nil? + return false if @documents.nil? + return false if @accounts.nil? + return false if @attachments.nil? true end @@ -273,8 +341,6 @@ def ==(o) template_id == o.template_id && title == o.title && message == o.message && - updated_at == o.updated_at && - is_embedded == o.is_embedded && is_creator == o.is_creator && can_edit == o.can_edit && is_locked == o.is_locked && @@ -282,9 +348,12 @@ def ==(o) signer_roles == o.signer_roles && cc_roles == o.cc_roles && documents == o.documents && + accounts == o.accounts && + attachments == o.attachments && + updated_at == o.updated_at && + is_embedded == o.is_embedded && custom_fields == o.custom_fields && - named_form_fields == o.named_form_fields && - accounts == o.accounts + named_form_fields == o.named_form_fields end # @see the `==` method @@ -296,7 +365,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [template_id, title, message, updated_at, is_embedded, is_creator, can_edit, is_locked, metadata, signer_roles, cc_roles, documents, custom_fields, named_form_fields, accounts].hash + [template_id, title, message, is_creator, can_edit, is_locked, metadata, signer_roles, cc_roles, documents, accounts, attachments, updated_at, is_embedded, custom_fields, named_form_fields].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb index c40120392..81a10b28d 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb @@ -22,10 +22,6 @@ class TemplateResponseAccount # @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,15 +37,19 @@ class TemplateResponseAccount # @return [TemplateResponseAccountQuota] attr_accessor :quotas + # The email address associated with the Account. + # @return [String] + attr_accessor :email_address + # Attribute mapping from ruby-style variable name to JSON key. 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' + :'quotas' => :'quotas', + :'email_address' => :'email_address' } end @@ -62,11 +62,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' => :'TemplateResponseAccountQuota' + :'quotas' => :'TemplateResponseAccountQuota', + :'email_address' => :'String' } end @@ -120,10 +120,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 @@ -139,18 +135,47 @@ def initialize(attributes = {}) if attributes.key?(:'quotas') self.quotas = attributes[:'quotas'] end + + if attributes.key?(:'email_address') + self.email_address = attributes[:'email_address'] + end end # Show invalid properties with the reasons. Usually used together with valid? # @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 @@ -160,11 +185,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 + quotas == o.quotas && + email_address == o.email_address end # @see the `==` method @@ -176,7 +201,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].hash + [account_id, is_locked, is_paid_hs, is_paid_hf, quotas, email_address].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb index 4e46afa40..5ae884798 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb @@ -127,12 +127,32 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @templates_left.nil? + invalid_properties.push('invalid value for "templates_left", templates_left cannot be nil.') + end + + if @api_signature_requests_left.nil? + invalid_properties.push('invalid value for "api_signature_requests_left", api_signature_requests_left cannot be nil.') + end + + if @documents_left.nil? + invalid_properties.push('invalid value for "documents_left", documents_left cannot be nil.') + end + + if @sms_verifications_left.nil? + invalid_properties.push('invalid value for "sms_verifications_left", sms_verifications_left 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 @templates_left.nil? + return false if @api_signature_requests_left.nil? + return false if @documents_left.nil? + return false if @sms_verifications_left.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb index 7b73e8d36..6b62d9366 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb @@ -96,12 +96,17 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @name.nil? + invalid_properties.push('invalid value for "name", name 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 @name.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb index 6d23cb39f..c1103ef2b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb @@ -22,10 +22,6 @@ class TemplateResponseDocument # @return [String] attr_accessor :name - # Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - # @return [Integer] - attr_accessor :index - # An array of Form Field Group objects. # @return [Array] attr_accessor :field_groups @@ -39,18 +35,22 @@ class TemplateResponseDocument attr_accessor :custom_fields # An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. - # @return [Array, nil] + # @return [Array] attr_accessor :static_fields + # Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + # @return [Integer] + attr_accessor :index + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'name' => :'name', - :'index' => :'index', :'field_groups' => :'field_groups', :'form_fields' => :'form_fields', :'custom_fields' => :'custom_fields', - :'static_fields' => :'static_fields' + :'static_fields' => :'static_fields', + :'index' => :'index' } end @@ -63,18 +63,17 @@ def self.acceptable_attributes def self.openapi_types { :'name' => :'String', - :'index' => :'Integer', :'field_groups' => :'Array', :'form_fields' => :'Array', :'custom_fields' => :'Array', - :'static_fields' => :'Array' + :'static_fields' => :'Array', + :'index' => :'Integer' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'static_fields' ]) end @@ -122,10 +121,6 @@ def initialize(attributes = {}) self.name = attributes[:'name'] end - if attributes.key?(:'index') - self.index = attributes[:'index'] - end - if attributes.key?(:'field_groups') if (value = attributes[:'field_groups']).is_a?(Array) self.field_groups = value @@ -149,18 +144,47 @@ def initialize(attributes = {}) self.static_fields = value end end + + if attributes.key?(:'index') + self.index = attributes[:'index'] + end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + + if @field_groups.nil? + invalid_properties.push('invalid value for "field_groups", field_groups cannot be nil.') + end + + if @form_fields.nil? + invalid_properties.push('invalid value for "form_fields", form_fields cannot be nil.') + end + + if @custom_fields.nil? + invalid_properties.push('invalid value for "custom_fields", custom_fields cannot be nil.') + end + + if @static_fields.nil? + invalid_properties.push('invalid value for "static_fields", static_fields 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 @name.nil? + return false if @field_groups.nil? + return false if @form_fields.nil? + return false if @custom_fields.nil? + return false if @static_fields.nil? true end @@ -170,11 +194,11 @@ def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && - index == o.index && field_groups == o.field_groups && form_fields == o.form_fields && custom_fields == o.custom_fields && - static_fields == o.static_fields + static_fields == o.static_fields && + index == o.index end # @see the `==` method @@ -186,7 +210,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [name, index, field_groups, form_fields, custom_fields, static_fields].hash + [name, field_groups, form_fields, custom_fields, static_fields, index].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb index a80739b91..76ae0662a 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb @@ -19,9 +19,6 @@ module Dropbox module Dropbox::Sign # An array of Form Field objects containing the name and type of each named field. class TemplateResponseDocumentCustomFieldBase - # @return [String] - attr_accessor :type - # The unique ID for this field. # @return [String] attr_accessor :api_id @@ -30,9 +27,8 @@ class TemplateResponseDocumentCustomFieldBase # @return [String] attr_accessor :name - # The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). - # @return [Integer, String, nil] - attr_accessor :signer + # @return [String] + attr_accessor :type # The horizontal offset in pixels for this form field. # @return [Integer] @@ -54,6 +50,10 @@ class TemplateResponseDocumentCustomFieldBase # @return [Boolean] attr_accessor :required + # The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + # @return [Integer, String, nil] + attr_accessor :signer + # The name of the group this field is in. If this field is not a group, this defaults to `null`. # @return [String, nil] attr_accessor :group @@ -61,15 +61,15 @@ class TemplateResponseDocumentCustomFieldBase # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type', :'api_id' => :'api_id', :'name' => :'name', - :'signer' => :'signer', + :'type' => :'type', :'x' => :'x', :'y' => :'y', :'width' => :'width', :'height' => :'height', :'required' => :'required', + :'signer' => :'signer', :'group' => :'group' } end @@ -82,15 +82,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String', :'api_id' => :'String', :'name' => :'String', - :'signer' => :'String', + :'type' => :'String', :'x' => :'Integer', :'y' => :'Integer', :'width' => :'Integer', :'height' => :'Integer', :'required' => :'Boolean', + :'signer' => :'String', :'group' => :'String' } end @@ -151,10 +151,6 @@ def initialize(attributes = {}) h[k.to_sym] = v } - if attributes.key?(:'type') - self.type = attributes[:'type'] - end - if attributes.key?(:'api_id') self.api_id = attributes[:'api_id'] end @@ -163,8 +159,8 @@ def initialize(attributes = {}) self.name = attributes[:'name'] end - if attributes.key?(:'signer') - self.signer = attributes[:'signer'] + if attributes.key?(:'type') + self.type = attributes[:'type'] end if attributes.key?(:'x') @@ -187,6 +183,10 @@ def initialize(attributes = {}) self.required = attributes[:'required'] end + if attributes.key?(:'signer') + self.signer = attributes[:'signer'] + end + if attributes.key?(:'group') self.group = attributes[:'group'] end @@ -196,17 +196,52 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @api_id.nil? + invalid_properties.push('invalid value for "api_id", api_id cannot be nil.') + end + + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end + if @x.nil? + invalid_properties.push('invalid value for "x", x cannot be nil.') + end + + if @y.nil? + invalid_properties.push('invalid value for "y", y cannot be nil.') + end + + if @width.nil? + invalid_properties.push('invalid value for "width", width cannot be nil.') + end + + if @height.nil? + invalid_properties.push('invalid value for "height", height cannot be nil.') + end + + if @required.nil? + invalid_properties.push('invalid value for "required", required 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 @api_id.nil? + return false if @name.nil? return false if @type.nil? + return false if @x.nil? + return false if @y.nil? + return false if @width.nil? + return false if @height.nil? + return false if @required.nil? true end @@ -215,15 +250,15 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && api_id == o.api_id && name == o.name && - signer == o.signer && + type == o.type && x == o.x && y == o.y && width == o.width && height == o.height && required == o.required && + signer == o.signer && group == o.group end @@ -236,7 +271,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type, api_id, name, signer, x, y, width, height, required, group].hash + [api_id, name, type, x, y, width, height, required, signer, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb index 653b131ae..6205bf088 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb @@ -145,6 +145,22 @@ def list_invalid_properties invalid_properties.push('invalid value for "type", type cannot be nil.') end + if @avg_text_length.nil? + invalid_properties.push('invalid value for "avg_text_length", avg_text_length cannot be nil.') + end + + if @is_multiline.nil? + invalid_properties.push('invalid value for "is_multiline", is_multiline cannot be nil.') + end + + if @original_font_size.nil? + invalid_properties.push('invalid value for "original_font_size", original_font_size cannot be nil.') + end + + if @font_family.nil? + invalid_properties.push('invalid value for "font_family", font_family cannot be nil.') + end + invalid_properties end @@ -152,6 +168,10 @@ def list_invalid_properties # @return true if the model is valid def valid? return false if @type.nil? + return false if @avg_text_length.nil? + return false if @is_multiline.nil? + return false if @original_font_size.nil? + return false if @font_family.nil? true && super end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb index ce2389e3a..0352a4080 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb @@ -105,12 +105,22 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + + if @rule.nil? + invalid_properties.push('invalid value for "rule", rule 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 @name.nil? + return false if @rule.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb index 5b0d3ec6d..27ba34343 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb @@ -107,12 +107,22 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @requirement.nil? + invalid_properties.push('invalid value for "requirement", requirement cannot be nil.') + end + + if @group_label.nil? + invalid_properties.push('invalid value for "group_label", group_label 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 @requirement.nil? + return false if @group_label.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb index f9917555b..c7aa4af27 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb @@ -19,9 +19,6 @@ module Dropbox module Dropbox::Sign # An array of Form Field objects containing the name and type of each named field. class TemplateResponseDocumentFormFieldBase - # @return [String] - attr_accessor :type - # A unique id for the form field. # @return [String] attr_accessor :api_id @@ -30,6 +27,9 @@ class TemplateResponseDocumentFormFieldBase # @return [String] attr_accessor :name + # @return [String] + attr_accessor :type + # The signer of the Form Field. # @return [Integer, String] attr_accessor :signer @@ -54,23 +54,18 @@ class TemplateResponseDocumentFormFieldBase # @return [Boolean] attr_accessor :required - # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. - # @return [String, nil] - attr_accessor :group - # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type', :'api_id' => :'api_id', :'name' => :'name', + :'type' => :'type', :'signer' => :'signer', :'x' => :'x', :'y' => :'y', :'width' => :'width', :'height' => :'height', - :'required' => :'required', - :'group' => :'group' + :'required' => :'required' } end @@ -82,23 +77,21 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String', :'api_id' => :'String', :'name' => :'String', + :'type' => :'String', :'signer' => :'String', :'x' => :'Integer', :'y' => :'Integer', :'width' => :'Integer', :'height' => :'Integer', - :'required' => :'Boolean', - :'group' => :'String' + :'required' => :'Boolean' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'group' ]) end @@ -168,10 +161,6 @@ def initialize(attributes = {}) h[k.to_sym] = v } - if attributes.key?(:'type') - self.type = attributes[:'type'] - end - if attributes.key?(:'api_id') self.api_id = attributes[:'api_id'] end @@ -180,6 +169,10 @@ def initialize(attributes = {}) self.name = attributes[:'name'] end + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + if attributes.key?(:'signer') self.signer = attributes[:'signer'] end @@ -203,27 +196,63 @@ def initialize(attributes = {}) if attributes.key?(:'required') self.required = attributes[:'required'] end - - if attributes.key?(:'group') - self.group = attributes[:'group'] - end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @api_id.nil? + invalid_properties.push('invalid value for "api_id", api_id cannot be nil.') + end + + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end + if @signer.nil? + invalid_properties.push('invalid value for "signer", signer cannot be nil.') + end + + if @x.nil? + invalid_properties.push('invalid value for "x", x cannot be nil.') + end + + if @y.nil? + invalid_properties.push('invalid value for "y", y cannot be nil.') + end + + if @width.nil? + invalid_properties.push('invalid value for "width", width cannot be nil.') + end + + if @height.nil? + invalid_properties.push('invalid value for "height", height cannot be nil.') + end + + if @required.nil? + invalid_properties.push('invalid value for "required", required 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 @api_id.nil? + return false if @name.nil? return false if @type.nil? + return false if @signer.nil? + return false if @x.nil? + return false if @y.nil? + return false if @width.nil? + return false if @height.nil? + return false if @required.nil? true end @@ -232,16 +261,15 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && api_id == o.api_id && name == o.name && + type == o.type && signer == o.signer && x == o.x && y == o.y && width == o.width && height == o.height && - required == o.required && - group == o.group + required == o.required end # @see the `==` method @@ -253,7 +281,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type, api_id, name, signer, x, y, width, height, required, group].hash + [api_id, name, type, signer, x, y, width, height, required].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb index c888138c3..a4c759c12 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb @@ -23,10 +23,15 @@ class TemplateResponseDocumentFormFieldCheckbox < TemplateResponseDocumentFormFi # @return [String] attr_accessor :type + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String, nil] + attr_accessor :group + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type' + :'type' => :'type', + :'group' => :'group' } end @@ -38,13 +43,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String' + :'type' => :'String', + :'group' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'group' ]) end @@ -96,6 +103,10 @@ def initialize(attributes = {}) else self.type = 'checkbox' end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -121,7 +132,8 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && super(o) + type == o.type && + group == o.group && super(o) end # @see the `==` method @@ -133,7 +145,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type].hash + [type, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb index 94ec5f659..f20f04c4f 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb @@ -23,10 +23,15 @@ class TemplateResponseDocumentFormFieldDateSigned < TemplateResponseDocumentForm # @return [String] attr_accessor :type + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String, nil] + attr_accessor :group + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type' + :'type' => :'type', + :'group' => :'group' } end @@ -38,13 +43,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String' + :'type' => :'String', + :'group' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'group' ]) end @@ -96,6 +103,10 @@ def initialize(attributes = {}) else self.type = 'date_signed' end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -121,7 +132,8 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && super(o) + type == o.type && + group == o.group && super(o) end # @see the `==` method @@ -133,7 +145,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type].hash + [type, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb index 0291303b4..c6ad1b3dd 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb @@ -23,10 +23,15 @@ class TemplateResponseDocumentFormFieldDropdown < TemplateResponseDocumentFormFi # @return [String] attr_accessor :type + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String, nil] + attr_accessor :group + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type' + :'type' => :'type', + :'group' => :'group' } end @@ -38,13 +43,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String' + :'type' => :'String', + :'group' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'group' ]) end @@ -96,6 +103,10 @@ def initialize(attributes = {}) else self.type = 'dropdown' end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -121,7 +132,8 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && super(o) + type == o.type && + group == o.group && super(o) end # @see the `==` method @@ -133,7 +145,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type].hash + [type, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb index 7c8992ffa..8ae570661 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb @@ -38,6 +38,10 @@ class TemplateResponseDocumentFormFieldHyperlink < TemplateResponseDocumentFormF # @return [String] attr_accessor :font_family + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String, nil] + attr_accessor :group + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -45,7 +49,8 @@ def self.attribute_map :'avg_text_length' => :'avg_text_length', :'is_multiline' => :'isMultiline', :'original_font_size' => :'originalFontSize', - :'font_family' => :'fontFamily' + :'font_family' => :'fontFamily', + :'group' => :'group' } end @@ -61,13 +66,15 @@ def self.openapi_types :'avg_text_length' => :'TemplateResponseFieldAvgTextLength', :'is_multiline' => :'Boolean', :'original_font_size' => :'Integer', - :'font_family' => :'String' + :'font_family' => :'String', + :'group' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'group' ]) end @@ -135,6 +142,10 @@ def initialize(attributes = {}) if attributes.key?(:'font_family') self.font_family = attributes[:'font_family'] end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -145,6 +156,22 @@ def list_invalid_properties invalid_properties.push('invalid value for "type", type cannot be nil.') end + if @avg_text_length.nil? + invalid_properties.push('invalid value for "avg_text_length", avg_text_length cannot be nil.') + end + + if @is_multiline.nil? + invalid_properties.push('invalid value for "is_multiline", is_multiline cannot be nil.') + end + + if @original_font_size.nil? + invalid_properties.push('invalid value for "original_font_size", original_font_size cannot be nil.') + end + + if @font_family.nil? + invalid_properties.push('invalid value for "font_family", font_family cannot be nil.') + end + invalid_properties end @@ -152,6 +179,10 @@ def list_invalid_properties # @return true if the model is valid def valid? return false if @type.nil? + return false if @avg_text_length.nil? + return false if @is_multiline.nil? + return false if @original_font_size.nil? + return false if @font_family.nil? true && super end @@ -164,7 +195,8 @@ def ==(o) avg_text_length == o.avg_text_length && is_multiline == o.is_multiline && original_font_size == o.original_font_size && - font_family == o.font_family && super(o) + font_family == o.font_family && + group == o.group && super(o) end # @see the `==` method @@ -176,7 +208,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type, avg_text_length, is_multiline, original_font_size, font_family].hash + [type, avg_text_length, is_multiline, original_font_size, font_family, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_initials.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_initials.rb index 70f5ed581..3ff48a726 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_initials.rb @@ -23,10 +23,15 @@ class TemplateResponseDocumentFormFieldInitials < TemplateResponseDocumentFormFi # @return [String] attr_accessor :type + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String, nil] + attr_accessor :group + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type' + :'type' => :'type', + :'group' => :'group' } end @@ -38,13 +43,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String' + :'type' => :'String', + :'group' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'group' ]) end @@ -96,6 +103,10 @@ def initialize(attributes = {}) else self.type = 'initials' end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -121,7 +132,8 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && super(o) + type == o.type && + group == o.group && super(o) end # @see the `==` method @@ -133,7 +145,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type].hash + [type, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_radio.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_radio.rb index 2412dc9dc..6af0b07d8 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_radio.rb @@ -23,10 +23,15 @@ class TemplateResponseDocumentFormFieldRadio < TemplateResponseDocumentFormField # @return [String] attr_accessor :type + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String] + attr_accessor :group + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type' + :'type' => :'type', + :'group' => :'group' } end @@ -38,7 +43,8 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String' + :'type' => :'String', + :'group' => :'String' } end @@ -96,6 +102,10 @@ def initialize(attributes = {}) else self.type = 'radio' end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -106,6 +116,10 @@ def list_invalid_properties invalid_properties.push('invalid value for "type", type cannot be nil.') end + if @group.nil? + invalid_properties.push('invalid value for "group", group cannot be nil.') + end + invalid_properties end @@ -113,6 +127,7 @@ def list_invalid_properties # @return true if the model is valid def valid? return false if @type.nil? + return false if @group.nil? true && super end @@ -121,7 +136,8 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && super(o) + type == o.type && + group == o.group && super(o) end # @see the `==` method @@ -133,7 +149,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type].hash + [type, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_signature.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_signature.rb index 49fdbbbc4..c48d15719 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_signature.rb @@ -23,10 +23,15 @@ class TemplateResponseDocumentFormFieldSignature < TemplateResponseDocumentFormF # @return [String] attr_accessor :type + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String, nil] + attr_accessor :group + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type' + :'type' => :'type', + :'group' => :'group' } end @@ -38,13 +43,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String' + :'type' => :'String', + :'group' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'group' ]) end @@ -96,6 +103,10 @@ def initialize(attributes = {}) else self.type = 'signature' end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -121,7 +132,8 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && super(o) + type == o.type && + group == o.group && super(o) end # @see the `==` method @@ -133,7 +145,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type].hash + [type, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb index 6a11d8a29..b5b10d59d 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb @@ -42,6 +42,10 @@ class TemplateResponseDocumentFormFieldText < TemplateResponseDocumentFormFieldB # @return [String, nil] attr_accessor :validation_type + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String, nil] + attr_accessor :group + class EnumAttributeValidator attr_reader :datatype attr_reader :allowable_values @@ -72,7 +76,8 @@ def self.attribute_map :'is_multiline' => :'isMultiline', :'original_font_size' => :'originalFontSize', :'font_family' => :'fontFamily', - :'validation_type' => :'validation_type' + :'validation_type' => :'validation_type', + :'group' => :'group' } end @@ -89,14 +94,16 @@ def self.openapi_types :'is_multiline' => :'Boolean', :'original_font_size' => :'Integer', :'font_family' => :'String', - :'validation_type' => :'String' + :'validation_type' => :'String', + :'group' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'validation_type' + :'validation_type', + :'group' ]) end @@ -168,6 +175,10 @@ def initialize(attributes = {}) if attributes.key?(:'validation_type') self.validation_type = attributes[:'validation_type'] end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -178,6 +189,22 @@ def list_invalid_properties invalid_properties.push('invalid value for "type", type cannot be nil.') end + if @avg_text_length.nil? + invalid_properties.push('invalid value for "avg_text_length", avg_text_length cannot be nil.') + end + + if @is_multiline.nil? + invalid_properties.push('invalid value for "is_multiline", is_multiline cannot be nil.') + end + + if @original_font_size.nil? + invalid_properties.push('invalid value for "original_font_size", original_font_size cannot be nil.') + end + + if @font_family.nil? + invalid_properties.push('invalid value for "font_family", font_family cannot be nil.') + end + invalid_properties end @@ -185,6 +212,10 @@ def list_invalid_properties # @return true if the model is valid def valid? return false if @type.nil? + return false if @avg_text_length.nil? + return false if @is_multiline.nil? + return false if @original_font_size.nil? + return false if @font_family.nil? validation_type_validator = EnumAttributeValidator.new('String', ["numbers_only", "letters_only", "phone_number", "bank_routing_number", "bank_account_number", "email_address", "zip_code", "social_security_number", "employer_identification_number", "custom_regex"]) return false unless validation_type_validator.valid?(@validation_type) true && super @@ -210,7 +241,8 @@ def ==(o) is_multiline == o.is_multiline && original_font_size == o.original_font_size && font_family == o.font_family && - validation_type == o.validation_type && super(o) + validation_type == o.validation_type && + group == o.group && super(o) end # @see the `==` method @@ -222,7 +254,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type, avg_text_length, is_multiline, original_font_size, font_family, validation_type].hash + [type, avg_text_length, is_multiline, original_font_size, font_family, validation_type, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb index a2d962291..8a4cbac11 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb @@ -19,9 +19,6 @@ module Dropbox module Dropbox::Sign # An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. class TemplateResponseDocumentStaticFieldBase - # @return [String] - attr_accessor :type - # A unique id for the static field. # @return [String] attr_accessor :api_id @@ -30,6 +27,9 @@ class TemplateResponseDocumentStaticFieldBase # @return [String] attr_accessor :name + # @return [String] + attr_accessor :type + # The signer of the Static Field. # @return [String] attr_accessor :signer @@ -61,9 +61,9 @@ class TemplateResponseDocumentStaticFieldBase # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type', :'api_id' => :'api_id', :'name' => :'name', + :'type' => :'type', :'signer' => :'signer', :'x' => :'x', :'y' => :'y', @@ -82,9 +82,9 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String', :'api_id' => :'String', :'name' => :'String', + :'type' => :'String', :'signer' => :'String', :'x' => :'Integer', :'y' => :'Integer', @@ -168,10 +168,6 @@ def initialize(attributes = {}) h[k.to_sym] = v } - if attributes.key?(:'type') - self.type = attributes[:'type'] - end - if attributes.key?(:'api_id') self.api_id = attributes[:'api_id'] end @@ -180,6 +176,10 @@ def initialize(attributes = {}) self.name = attributes[:'name'] end + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + if attributes.key?(:'signer') self.signer = attributes[:'signer'] else @@ -215,17 +215,57 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @api_id.nil? + invalid_properties.push('invalid value for "api_id", api_id cannot be nil.') + end + + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end + if @signer.nil? + invalid_properties.push('invalid value for "signer", signer cannot be nil.') + end + + if @x.nil? + invalid_properties.push('invalid value for "x", x cannot be nil.') + end + + if @y.nil? + invalid_properties.push('invalid value for "y", y cannot be nil.') + end + + if @width.nil? + invalid_properties.push('invalid value for "width", width cannot be nil.') + end + + if @height.nil? + invalid_properties.push('invalid value for "height", height cannot be nil.') + end + + if @required.nil? + invalid_properties.push('invalid value for "required", required 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 @api_id.nil? + return false if @name.nil? return false if @type.nil? + return false if @signer.nil? + return false if @x.nil? + return false if @y.nil? + return false if @width.nil? + return false if @height.nil? + return false if @required.nil? true end @@ -234,9 +274,9 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && api_id == o.api_id && name == o.name && + type == o.type && signer == o.signer && x == o.x && y == o.y && @@ -255,7 +295,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type, api_id, name, signer, x, y, width, height, required, group].hash + [api_id, name, type, signer, x, y, width, height, required, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb index a85e2c339..172098f29 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb @@ -107,12 +107,22 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @num_lines.nil? + invalid_properties.push('invalid value for "num_lines", num_lines cannot be nil.') + end + + if @num_chars_per_line.nil? + invalid_properties.push('invalid value for "num_chars_per_line", num_chars_per_line 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 @num_lines.nil? + return false if @num_chars_per_line.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb index 286607280..ea43ce2bc 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb @@ -106,12 +106,17 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @name.nil? + invalid_properties.push('invalid value for "name", name 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 @name.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb b/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb index 97280f302..23748015e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb @@ -109,12 +109,17 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @template_id.nil? + invalid_properties.push('invalid value for "template_id", template_id 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 @template_id.nil? true end diff --git a/test_fixtures/TemplateGetResponse.json b/test_fixtures/TemplateGetResponse.json index 52ff62260..b025913a0 100644 --- a/test_fixtures/TemplateGetResponse.json +++ b/test_fixtures/TemplateGetResponse.json @@ -5,7 +5,10 @@ "title": "Mutual NDA", "message": "Please sign this NDA as soon as possible.", "updated_at": 1570471067, + "can_edit": true, + "is_creator": true, "is_embedded": false, + "is_locked": false, "metadata": {}, "signer_roles": [ { @@ -566,496 +569,40 @@ ] } ], - "custom_fields": [ - { - "name": "merge_field_1", - "type": "text", - "x": 417, - "y": 219, - "width": 72, - "height": 15, - "required": false, - "api_id": "967c3e5f-2912-4f53-8ea3-c750652d29fc", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "merge_field_2", - "type": "checkbox", - "x": 515, - "y": 346, - "width": 18, - "height": 18, - "required": false, - "api_id": "5e8fe02f-51cf-4f0b-b1d9-2b1e4f6ad07f" - } - ], - "named_form_fields": [ - { - "name": "Signature1", - "type": "signature", - "signer": "1", - "x": 136, - "y": 17, - "width": 108, - "height": 27, - "required": true, - "api_id": "8b6d78a5-0870-4f46-af9c-b78b54a49348" - }, - { - "name": "Textbox1", - "type": "text", - "signer": "1", - "x": 328, - "y": 17, - "width": 144, - "height": 14, - "required": true, - "api_id": "7ec10d80-53c9-433b-b252-0b8daa90a8e0", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Textbox2", - "type": "text", - "signer": "1", - "x": 328, - "y": 48, - "width": 144, - "height": 14, - "required": true, - "api_id": "6574e6ad-7dac-49a2-9d56-650d7c5ade6e", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Initial1", - "type": "initials", - "signer": "1", - "x": 148, - "y": 66, - "width": 72, - "height": 27, - "required": true, - "api_id": "30f41f54-c7f3-46c3-a29a-bb76ec40b552" - }, - { - "name": "Checkbox1", - "type": "checkbox", - "signer": "1", - "x": 325, - "y": 111, - "width": 18, - "height": 18, - "required": false, - "api_id": "d4d6ada9-e1dc-419e-bc0d-1478da694449", - "group": "75a6e4b5fea47" - }, - { - "name": "Dropdown1", - "type": "dropdown", - "signer": "1", - "x": 423, - "y": 108, - "width": 70, - "height": 14, - "required": true, - "api_id": "5863be5e-ce5a-4c9d-aabe-c221914d73c2" - }, - { - "name": "DateSigned1", - "type": "date_signed", - "signer": "1", - "x": 150, - "y": 119, - "width": 105, - "height": 18, - "required": true, - "api_id": "9f6d3722-6db7-46da-8fac-3bc09f510262" - }, - { - "name": "Checkbox2", - "type": "checkbox", - "signer": "1", - "x": 325, - "y": 135, - "width": 18, - "height": 18, - "required": false, - "api_id": "edd732b8-b158-4714-a87b-503637d09ded", - "group": "75a6e4b5fea47" - }, - { - "name": "FullName1", - "type": "text", - "signer": "1", - "x": 144, - "y": 158, - "width": 72, - "height": 14, - "required": true, - "api_id": "62fd3f85-4808-4011-8eae-a14ebe9105ef", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Email1", - "type": "text", - "signer": "1", - "x": 133, - "y": 191, - "width": 144, - "height": 14, - "required": true, - "api_id": "a1c9bc6b-d498-4787-86e0-30ea779f06a7", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "email_address" - }, - { - "name": "RadioItem1", - "type": "radio", - "signer": "1", - "x": 307, - "y": 211, - "width": 18, - "height": 18, - "required": false, - "api_id": "fc8a1277-f757-47a2-aeea-5113fa81f2d5", - "group": "0831822584086" - }, - { - "name": "Company1", - "type": "text", - "signer": "1", - "x": 128, - "y": 221, - "width": 144, - "height": 14, - "required": true, - "api_id": "279b4e7f-e71f-426d-845c-6308cddde379", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Title1", - "type": "text", - "signer": "1", - "x": 127, - "y": 250, - "width": 144, - "height": 14, - "required": true, - "api_id": "8809e39a-a46c-4dae-aaf9-06fc6355d80f", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "RadioItem2", - "type": "radio", - "signer": "1", - "x": 307, - "y": 253, - "width": 18, - "height": 18, - "required": false, - "api_id": "f7b6b70d-0522-4ab7-bfec-b86f147c8be3", - "group": "0831822584086" - }, - { - "name": "Textbox3", - "type": "text", - "signer": "1", - "x": 410, - "y": 279, - "width": 144, - "height": 14, - "required": true, - "api_id": "bad7512a-e22b-46ed-ba03-123db0eda932", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Textbox4", - "type": "text", - "signer": "1", - "x": 101, - "y": 314, - "width": 72, - "height": 14, - "required": true, - "api_id": "368ed029-bc93-4f92-8f7a-14c3bf8109b5", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "custom_regex" - }, - { - "name": "Textbox8", - "type": "text", - "signer": "1", - "x": 218, - "y": 313, - "width": 72, - "height": 14, - "required": true, - "api_id": "ecf2ae95-d2e6-41b2-819a-836a6fa8c7c5", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "bank_routing_number" - }, - { - "name": "Textbox12", - "type": "text", - "signer": "1", - "x": 339, - "y": 315, - "width": 72, - "height": 14, - "required": true, - "api_id": "3cb90a0a-a433-4f30-8af8-8fb4c747b704", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "social_security_number" - }, - { - "name": "Textbox9", - "type": "text", - "signer": "1", - "x": 224, - "y": 343, - "width": 72, - "height": 14, - "required": true, - "api_id": "5b9eb331-c97d-435b-a563-d936a9b930c0", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "bank_account_number" - }, - { - "name": "Textbox13", - "type": "text", - "signer": "1", - "x": 339, - "y": 345, - "width": 72, - "height": 14, - "required": true, - "api_id": "2b98ce7e-e53a-4cf8-a9f3-d7fb18d88631", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "employer_identification_number" - }, - { - "name": "Textbox5", - "type": "text", - "signer": "1", - "x": 113, - "y": 350, - "width": 72, - "height": 14, - "required": true, - "api_id": "5f52c011-2c5f-4143-bf04-4694fb4a0d3f", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "numbers_only" - }, - { - "name": "Textbox6", - "type": "text", - "signer": "1", - "x": 122, - "y": 374, - "width": 72, - "height": 14, - "required": true, - "api_id": "47457b7d-b1e8-41a0-93ad-60ba30e64bb1", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "letters_only" - }, - { - "name": "Textbox10", - "type": "text", - "signer": "1", - "x": 234, - "y": 373, - "width": 72, - "height": 14, - "required": true, - "api_id": "18e3f994-1675-4d58-9b4a-4f92a2614551", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "email_address" - }, - { - "name": "Textbox14", - "type": "text", - "signer": "1", - "x": 339, - "y": 376, - "width": 72, - "height": 14, - "required": true, - "api_id": "9ad4b8cc-bac9-432b-8836-9f80f86fc7e0", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Textbox7", - "type": "text", - "signer": "1", - "x": 130, - "y": 401, - "width": 72, - "height": 14, - "required": true, - "api_id": "58c5f942-04fb-45f1-9703-5e8411f3a3bb", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "phone_number" - }, - { - "name": "me_now_hyperlink_1", - "type": "hyperlink", - "signer": "me_now", - "x": 434, - "y": 400, - "width": 112, - "height": 14, - "required": false, - "api_id": "fd928b56-cf59-40a4-9a90-62f97ffd0ddc", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 30 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "helvetica" - }, - { - "name": "Textbox11", - "type": "text", - "signer": "1", - "x": 237, - "y": 405, - "width": 72, - "height": 14, - "required": true, - "api_id": "e48c388d-8c26-4f20-848e-f8587a631746", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "zip_code" - } - ], "accounts": [ { "account_id": "5008b25c7f67153e57d5a357b1687968068fb465", "email_address": "me@dropboxsign.com", "is_locked": false, "is_paid_hs": false, - "is_paid_hf": false + "is_paid_hf": false, + "quotas": { + "templates_left": 5, + "api_signature_requests_left": 5, + "documents_left": 5, + "sms_verifications_left": 0 + } }, { "account_id": "", "email_address": "teammate@dropboxsign.com", "is_locked": false, "is_paid_hs": false, - "is_paid_hf": false + "is_paid_hf": false, + "quotas": { + "templates_left": 5, + "api_signature_requests_left": 5, + "documents_left": 5, + "sms_verifications_left": 0 + } + } + ], + "attachments": [ + { + "id": "attachment_1", + "signer": "Outside Vendor", + "name": "Attachment #1", + "required": true } ] } diff --git a/test_fixtures/TemplateListResponse.json b/test_fixtures/TemplateListResponse.json index 7c4768b82..caa5e6d8f 100644 --- a/test_fixtures/TemplateListResponse.json +++ b/test_fixtures/TemplateListResponse.json @@ -12,7 +12,10 @@ "title": "Purchase order", "message": "", "updated_at": 1570471067, + "can_edit": true, + "is_creator": true, "is_embedded": false, + "is_locked": false, "metadata": {}, "signer_roles": [ { @@ -49,7 +52,8 @@ "originalFontSize": 12, "fontFamily": "arial" } - ] + ], + "static_fields": [] } ], "accounts": [ @@ -58,7 +62,21 @@ "email_address": "me@dropboxsign.com", "is_locked": false, "is_paid_hs": false, - "is_paid_hf": false + "is_paid_hf": false, + "quotas": { + "templates_left": 5, + "api_signature_requests_left": 5, + "documents_left": 5, + "sms_verifications_left": 0 + } + } + ], + "attachments": [ + { + "id": "attachment_1", + "signer": "Outside Vendor", + "name": "Attachment #1", + "required": true } ] }, @@ -67,7 +85,10 @@ "title": "Mutual NDA", "message": "Please sign this NDA as soon as possible.", "updated_at": 1329478947, + "can_edit": true, + "is_creator": true, "is_embedded": false, + "is_locked": false, "metadata": {}, "signer_roles": [ { @@ -564,7 +585,8 @@ "fontFamily": "arial", "validation_type": "zip_code" } - ] + ], + "static_fields": [] } ], "accounts": [ @@ -573,9 +595,16 @@ "email_address": "me@dropboxsign.com", "is_locked": false, "is_paid_hs": false, - "is_paid_hf": false + "is_paid_hf": false, + "quotas": { + "templates_left": 5, + "api_signature_requests_left": 5, + "documents_left": 5, + "sms_verifications_left": 0 + } } - ] + ], + "attachments": [] } ] } diff --git a/translations/en.yaml b/translations/en.yaml index 74340f9bb..a2b4a367c 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -1449,7 +1449,7 @@ "TemplateResponse::TEMPLATE_ID": The id of the Template. "TemplateResponse::CAN_EDIT": Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). "TemplateResponse::IS_CREATOR": "`true` if you are the owner of this template, `false` if it's been shared with you by a team member." -"TemplateResponse::IS_EMBEDDED": "`true` if this template was created using an embedded flow, `false` if it was created on our website." +"TemplateResponse::IS_EMBEDDED": "`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template." "TemplateResponse::IS_LOCKED": |- Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. From 999bd125f6ad2c68cb60829c8fb86ec5108356ec Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Fri, 18 Oct 2024 14:58:40 -0500 Subject: [PATCH 10/16] Revert recent changes to "required" properties (#441) --- openapi-raw.yaml | 135 +---- openapi-sdk.yaml | 135 +---- openapi.yaml | 135 +---- sdks/dotnet/docs/ApiAppResponse.md | 2 +- sdks/dotnet/docs/ApiAppResponseOAuth.md | 2 +- sdks/dotnet/docs/ApiAppResponseOptions.md | 2 +- .../dotnet/docs/ApiAppResponseOwnerAccount.md | 2 +- .../ApiAppResponseWhiteLabelingOptions.md | 2 +- sdks/dotnet/docs/BulkSendJobResponse.md | 2 +- sdks/dotnet/docs/FaxLineResponseFaxLine.md | 2 +- sdks/dotnet/docs/TeamResponse.md | 2 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 2 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/dotnet/docs/TemplateResponse.md | 2 +- sdks/dotnet/docs/TemplateResponseAccount.md | 2 +- .../docs/TemplateResponseAccountQuota.md | 2 +- sdks/dotnet/docs/TemplateResponseCCRole.md | 2 +- sdks/dotnet/docs/TemplateResponseDocument.md | 2 +- ...TemplateResponseDocumentCustomFieldBase.md | 2 +- ...lateResponseDocumentCustomFieldCheckbox.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 16 +- .../TemplateResponseDocumentFieldGroup.md | 2 +- .../TemplateResponseDocumentFieldGroupRule.md | 2 +- .../TemplateResponseDocumentFormFieldBase.md | 2 +- ...mplateResponseDocumentFormFieldCheckbox.md | 16 +- ...lateResponseDocumentFormFieldDateSigned.md | 16 +- ...mplateResponseDocumentFormFieldDropdown.md | 16 +- ...plateResponseDocumentFormFieldHyperlink.md | 18 +- ...mplateResponseDocumentFormFieldInitials.md | 16 +- .../TemplateResponseDocumentFormFieldRadio.md | 16 +- ...plateResponseDocumentFormFieldSignature.md | 16 +- .../TemplateResponseDocumentFormFieldText.md | 18 +- ...TemplateResponseDocumentStaticFieldBase.md | 2 +- ...lateResponseDocumentStaticFieldCheckbox.md | 16 +- ...teResponseDocumentStaticFieldDateSigned.md | 16 +- ...lateResponseDocumentStaticFieldDropdown.md | 16 +- ...ateResponseDocumentStaticFieldHyperlink.md | 16 +- ...lateResponseDocumentStaticFieldInitials.md | 16 +- ...emplateResponseDocumentStaticFieldRadio.md | 16 +- ...ateResponseDocumentStaticFieldSignature.md | 16 +- ...TemplateResponseDocumentStaticFieldText.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 2 +- .../dotnet/docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- .../src/Dropbox.Sign/Model/ApiAppResponse.cs | 151 +++--- .../Dropbox.Sign/Model/ApiAppResponseOAuth.cs | 72 ++- .../Model/ApiAppResponseOptions.cs | 4 +- .../Model/ApiAppResponseOwnerAccount.cs | 18 +- .../ApiAppResponseWhiteLabelingOptions.cs | 126 +---- .../Dropbox.Sign/Model/BulkSendJobResponse.cs | 21 +- .../Model/FaxLineResponseFaxLine.cs | 26 +- .../src/Dropbox.Sign/Model/TeamResponse.cs | 36 +- ...lateCreateEmbeddedDraftResponseTemplate.cs | 22 +- .../Model/TemplateCreateResponseTemplate.cs | 9 +- .../Dropbox.Sign/Model/TemplateResponse.cs | 285 +++++----- .../Model/TemplateResponseAccount.cs | 80 ++- .../Model/TemplateResponseAccountQuota.cs | 16 +- .../Model/TemplateResponseCCRole.cs | 9 +- .../Model/TemplateResponseDocument.cs | 87 ++- ...TemplateResponseDocumentCustomFieldBase.cs | 126 ++--- ...lateResponseDocumentCustomFieldCheckbox.cs | 16 +- ...TemplateResponseDocumentCustomFieldText.cs | 42 +- .../TemplateResponseDocumentFieldGroup.cs | 18 +- .../TemplateResponseDocumentFieldGroupRule.cs | 18 +- .../TemplateResponseDocumentFormFieldBase.cs | 97 ++-- ...mplateResponseDocumentFormFieldCheckbox.cs | 16 +- ...lateResponseDocumentFormFieldDateSigned.cs | 16 +- ...mplateResponseDocumentFormFieldDropdown.cs | 16 +- ...plateResponseDocumentFormFieldHyperlink.cs | 42 +- ...mplateResponseDocumentFormFieldInitials.cs | 16 +- .../TemplateResponseDocumentFormFieldRadio.cs | 16 +- ...plateResponseDocumentFormFieldSignature.cs | 16 +- .../TemplateResponseDocumentFormFieldText.cs | 42 +- ...TemplateResponseDocumentStaticFieldBase.cs | 100 ++-- ...lateResponseDocumentStaticFieldCheckbox.cs | 16 +- ...teResponseDocumentStaticFieldDateSigned.cs | 16 +- ...lateResponseDocumentStaticFieldDropdown.cs | 16 +- ...ateResponseDocumentStaticFieldHyperlink.cs | 16 +- ...lateResponseDocumentStaticFieldInitials.cs | 16 +- ...emplateResponseDocumentStaticFieldRadio.cs | 16 +- ...ateResponseDocumentStaticFieldSignature.cs | 16 +- ...TemplateResponseDocumentStaticFieldText.cs | 16 +- .../TemplateResponseFieldAvgTextLength.cs | 8 +- .../Model/TemplateResponseSignerRole.cs | 9 +- .../TemplateUpdateFilesResponseTemplate.cs | 9 +- sdks/java-v1/docs/ApiAppResponse.md | 14 +- sdks/java-v1/docs/ApiAppResponseOAuth.md | 6 +- sdks/java-v1/docs/ApiAppResponseOptions.md | 2 +- .../docs/ApiAppResponseOwnerAccount.md | 4 +- .../ApiAppResponseWhiteLabelingOptions.md | 28 +- sdks/java-v1/docs/BulkSendJobResponse.md | 8 +- sdks/java-v1/docs/FaxLineResponseFaxLine.md | 8 +- sdks/java-v1/docs/TeamResponse.md | 8 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/java-v1/docs/TemplateResponse.md | 24 +- sdks/java-v1/docs/TemplateResponseAccount.md | 10 +- .../docs/TemplateResponseAccountQuota.md | 8 +- sdks/java-v1/docs/TemplateResponseCCRole.md | 2 +- sdks/java-v1/docs/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 16 +- ...plateResponseDocumentFormFieldHyperlink.md | 8 +- .../TemplateResponseDocumentFormFieldText.md | 8 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- .../dropbox/sign/model/ApiAppResponse.java | 245 ++++----- .../sign/model/ApiAppResponseOAuth.java | 121 ++--- .../sign/model/ApiAppResponseOptions.java | 7 +- .../model/ApiAppResponseOwnerAccount.java | 14 +- .../ApiAppResponseWhiteLabelingOptions.java | 98 ++-- .../sign/model/BulkSendJobResponse.java | 28 +- .../sign/model/FaxLineResponseFaxLine.java | 30 +- .../com/dropbox/sign/model/TeamResponse.java | 34 +- ...teCreateEmbeddedDraftResponseTemplate.java | 21 +- .../model/TemplateCreateResponseTemplate.java | 7 +- .../dropbox/sign/model/TemplateResponse.java | 508 +++++++++--------- .../sign/model/TemplateResponseAccount.java | 137 +++-- .../model/TemplateResponseAccountQuota.java | 28 +- .../sign/model/TemplateResponseCCRole.java | 7 +- .../sign/model/TemplateResponseDocument.java | 143 +++-- ...mplateResponseDocumentCustomFieldBase.java | 223 ++++---- ...mplateResponseDocumentCustomFieldText.java | 28 +- .../TemplateResponseDocumentFieldGroup.java | 14 +- ...emplateResponseDocumentFieldGroupRule.java | 14 +- ...TemplateResponseDocumentFormFieldBase.java | 154 +++--- ...ateResponseDocumentFormFieldHyperlink.java | 28 +- ...TemplateResponseDocumentFormFieldText.java | 28 +- ...mplateResponseDocumentStaticFieldBase.java | 154 +++--- .../TemplateResponseFieldAvgTextLength.java | 14 +- .../model/TemplateResponseSignerRole.java | 7 +- .../TemplateUpdateFilesResponseTemplate.java | 7 +- sdks/java-v2/docs/ApiAppResponse.md | 14 +- sdks/java-v2/docs/ApiAppResponseOAuth.md | 6 +- sdks/java-v2/docs/ApiAppResponseOptions.md | 2 +- .../docs/ApiAppResponseOwnerAccount.md | 4 +- .../ApiAppResponseWhiteLabelingOptions.md | 28 +- sdks/java-v2/docs/BulkSendJobResponse.md | 8 +- sdks/java-v2/docs/FaxLineResponseFaxLine.md | 8 +- sdks/java-v2/docs/TeamResponse.md | 8 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/java-v2/docs/TemplateResponse.md | 24 +- sdks/java-v2/docs/TemplateResponseAccount.md | 10 +- .../docs/TemplateResponseAccountQuota.md | 8 +- sdks/java-v2/docs/TemplateResponseCCRole.md | 2 +- sdks/java-v2/docs/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 16 +- ...plateResponseDocumentFormFieldHyperlink.md | 8 +- .../TemplateResponseDocumentFormFieldText.md | 8 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- .../dropbox/sign/model/ApiAppResponse.java | 248 ++++----- .../sign/model/ApiAppResponseOAuth.java | 126 ++--- .../sign/model/ApiAppResponseOptions.java | 6 +- .../model/ApiAppResponseOwnerAccount.java | 12 +- .../ApiAppResponseWhiteLabelingOptions.java | 84 +-- .../sign/model/BulkSendJobResponse.java | 24 +- .../sign/model/FaxLineResponseFaxLine.java | 26 +- .../com/dropbox/sign/model/TeamResponse.java | 30 +- ...teCreateEmbeddedDraftResponseTemplate.java | 18 +- .../model/TemplateCreateResponseTemplate.java | 6 +- .../dropbox/sign/model/TemplateResponse.java | 504 ++++++++--------- .../sign/model/TemplateResponseAccount.java | 136 ++--- .../model/TemplateResponseAccountQuota.java | 24 +- .../sign/model/TemplateResponseCCRole.java | 6 +- .../sign/model/TemplateResponseDocument.java | 144 ++--- ...mplateResponseDocumentCustomFieldBase.java | 220 ++++---- ...mplateResponseDocumentCustomFieldText.java | 24 +- .../TemplateResponseDocumentFieldGroup.java | 12 +- ...emplateResponseDocumentFieldGroupRule.java | 12 +- ...TemplateResponseDocumentFormFieldBase.java | 152 +++--- ...ateResponseDocumentFormFieldHyperlink.java | 24 +- ...TemplateResponseDocumentFormFieldText.java | 24 +- ...mplateResponseDocumentStaticFieldBase.java | 152 +++--- .../TemplateResponseFieldAvgTextLength.java | 12 +- .../model/TemplateResponseSignerRole.java | 6 +- .../TemplateUpdateFilesResponseTemplate.java | 6 +- sdks/node/dist/api.js | 124 ++--- sdks/node/docs/model/ApiAppResponse.md | 14 +- sdks/node/docs/model/ApiAppResponseOAuth.md | 6 +- sdks/node/docs/model/ApiAppResponseOptions.md | 2 +- .../docs/model/ApiAppResponseOwnerAccount.md | 4 +- .../ApiAppResponseWhiteLabelingOptions.md | 28 +- sdks/node/docs/model/BulkSendJobResponse.md | 8 +- .../node/docs/model/FaxLineResponseFaxLine.md | 8 +- sdks/node/docs/model/TeamResponse.md | 8 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../model/TemplateCreateResponseTemplate.md | 2 +- sdks/node/docs/model/TemplateResponse.md | 24 +- .../docs/model/TemplateResponseAccount.md | 10 +- .../model/TemplateResponseAccountQuota.md | 8 +- .../node/docs/model/TemplateResponseCCRole.md | 2 +- .../docs/model/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 16 +- ...plateResponseDocumentFormFieldHyperlink.md | 8 +- .../TemplateResponseDocumentFormFieldText.md | 8 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../docs/model/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- sdks/node/model/apiAppResponse.ts | 42 +- sdks/node/model/apiAppResponseOAuth.ts | 24 +- sdks/node/model/apiAppResponseOptions.ts | 2 +- sdks/node/model/apiAppResponseOwnerAccount.ts | 4 +- .../apiAppResponseWhiteLabelingOptions.ts | 28 +- sdks/node/model/bulkSendJobResponse.ts | 8 +- sdks/node/model/faxLineResponseFaxLine.ts | 8 +- sdks/node/model/teamResponse.ts | 8 +- ...lateCreateEmbeddedDraftResponseTemplate.ts | 6 +- .../model/templateCreateResponseTemplate.ts | 2 +- sdks/node/model/templateResponse.ts | 92 ++-- sdks/node/model/templateResponseAccount.ts | 28 +- .../model/templateResponseAccountQuota.ts | 8 +- sdks/node/model/templateResponseCCRole.ts | 2 +- sdks/node/model/templateResponseDocument.ts | 28 +- ...templateResponseDocumentCustomFieldBase.ts | 38 +- ...templateResponseDocumentCustomFieldText.ts | 8 +- .../templateResponseDocumentFieldGroup.ts | 4 +- .../templateResponseDocumentFieldGroupRule.ts | 4 +- .../templateResponseDocumentFormFieldBase.ts | 28 +- ...plateResponseDocumentFormFieldHyperlink.ts | 8 +- .../templateResponseDocumentFormFieldText.ts | 8 +- ...templateResponseDocumentStaticFieldBase.ts | 28 +- .../templateResponseFieldAvgTextLength.ts | 4 +- sdks/node/model/templateResponseSignerRole.ts | 2 +- .../templateUpdateFilesResponseTemplate.ts | 2 +- sdks/node/types/model/apiAppResponse.d.ts | 14 +- .../node/types/model/apiAppResponseOAuth.d.ts | 6 +- .../types/model/apiAppResponseOptions.d.ts | 2 +- .../model/apiAppResponseOwnerAccount.d.ts | 4 +- .../apiAppResponseWhiteLabelingOptions.d.ts | 28 +- .../node/types/model/bulkSendJobResponse.d.ts | 8 +- .../types/model/faxLineResponseFaxLine.d.ts | 8 +- sdks/node/types/model/teamResponse.d.ts | 8 +- ...teCreateEmbeddedDraftResponseTemplate.d.ts | 6 +- .../model/templateCreateResponseTemplate.d.ts | 2 +- sdks/node/types/model/templateResponse.d.ts | 24 +- .../types/model/templateResponseAccount.d.ts | 10 +- .../model/templateResponseAccountQuota.d.ts | 8 +- .../types/model/templateResponseCCRole.d.ts | 2 +- .../types/model/templateResponseDocument.d.ts | 10 +- ...mplateResponseDocumentCustomFieldBase.d.ts | 14 +- ...mplateResponseDocumentCustomFieldText.d.ts | 8 +- .../templateResponseDocumentFieldGroup.d.ts | 4 +- ...emplateResponseDocumentFieldGroupRule.d.ts | 4 +- ...templateResponseDocumentFormFieldBase.d.ts | 16 +- ...ateResponseDocumentFormFieldHyperlink.d.ts | 8 +- ...templateResponseDocumentFormFieldText.d.ts | 8 +- ...mplateResponseDocumentStaticFieldBase.d.ts | 16 +- .../templateResponseFieldAvgTextLength.d.ts | 4 +- .../model/templateResponseSignerRole.d.ts | 2 +- .../templateUpdateFilesResponseTemplate.d.ts | 2 +- sdks/php/docs/Model/ApiAppResponse.md | 14 +- sdks/php/docs/Model/ApiAppResponseOAuth.md | 6 +- sdks/php/docs/Model/ApiAppResponseOptions.md | 2 +- .../docs/Model/ApiAppResponseOwnerAccount.md | 4 +- .../ApiAppResponseWhiteLabelingOptions.md | 28 +- sdks/php/docs/Model/BulkSendJobResponse.md | 8 +- sdks/php/docs/Model/FaxLineResponseFaxLine.md | 8 +- sdks/php/docs/Model/TeamResponse.md | 8 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../Model/TemplateCreateResponseTemplate.md | 2 +- sdks/php/docs/Model/TemplateResponse.md | 24 +- .../php/docs/Model/TemplateResponseAccount.md | 10 +- .../Model/TemplateResponseAccountQuota.md | 8 +- sdks/php/docs/Model/TemplateResponseCCRole.md | 2 +- .../docs/Model/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 16 +- ...plateResponseDocumentFormFieldHyperlink.md | 8 +- .../TemplateResponseDocumentFormFieldText.md | 8 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../docs/Model/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- sdks/php/src/Model/ApiAppResponse.php | 222 ++++---- sdks/php/src/Model/ApiAppResponseOAuth.php | 107 ++-- sdks/php/src/Model/ApiAppResponseOptions.php | 13 +- .../src/Model/ApiAppResponseOwnerAccount.php | 22 +- .../ApiAppResponseWhiteLabelingOptions.php | 130 ++--- sdks/php/src/Model/BulkSendJobResponse.php | 51 +- sdks/php/src/Model/FaxLineResponseFaxLine.php | 40 +- sdks/php/src/Model/TeamResponse.php | 40 +- ...ateCreateEmbeddedDraftResponseTemplate.php | 31 +- .../Model/TemplateCreateResponseTemplate.php | 13 +- sdks/php/src/Model/TemplateResponse.php | 382 ++++++------- .../php/src/Model/TemplateResponseAccount.php | 117 ++-- .../Model/TemplateResponseAccountQuota.php | 40 +- sdks/php/src/Model/TemplateResponseCCRole.php | 13 +- .../src/Model/TemplateResponseDocument.php | 117 ++-- ...emplateResponseDocumentCustomFieldBase.php | 179 +++--- ...emplateResponseDocumentCustomFieldText.php | 36 +- .../TemplateResponseDocumentFieldGroup.php | 22 +- ...TemplateResponseDocumentFieldGroupRule.php | 22 +- .../TemplateResponseDocumentFormFieldBase.php | 132 ++--- ...lateResponseDocumentFormFieldHyperlink.php | 36 +- .../TemplateResponseDocumentFormFieldText.php | 36 +- ...emplateResponseDocumentStaticFieldBase.php | 132 ++--- .../TemplateResponseFieldAvgTextLength.php | 22 +- .../src/Model/TemplateResponseSignerRole.php | 13 +- .../TemplateUpdateFilesResponseTemplate.php | 13 +- sdks/python/docs/ApiAppResponse.md | 14 +- sdks/python/docs/ApiAppResponseOAuth.md | 6 +- sdks/python/docs/ApiAppResponseOptions.md | 2 +- .../python/docs/ApiAppResponseOwnerAccount.md | 4 +- .../ApiAppResponseWhiteLabelingOptions.md | 28 +- sdks/python/docs/BulkSendJobResponse.md | 8 +- sdks/python/docs/FaxLineResponseFaxLine.md | 8 +- sdks/python/docs/TeamResponse.md | 8 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/python/docs/TemplateResponse.md | 24 +- sdks/python/docs/TemplateResponseAccount.md | 10 +- .../docs/TemplateResponseAccountQuota.md | 8 +- sdks/python/docs/TemplateResponseCCRole.md | 2 +- sdks/python/docs/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 16 +- ...plateResponseDocumentFormFieldHyperlink.md | 8 +- .../TemplateResponseDocumentFormFieldText.md | 8 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../python/docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- .../dropbox_sign/models/api_app_response.py | 52 +- .../models/api_app_response_o_auth.py | 21 +- .../models/api_app_response_options.py | 7 +- .../models/api_app_response_owner_account.py | 10 +- ...api_app_response_white_labeling_options.py | 30 +- .../models/bulk_send_job_response.py | 20 +- .../models/fax_line_response_fax_line.py | 10 +- .../dropbox_sign/models/team_response.py | 16 +- ...create_embedded_draft_response_template.py | 12 +- .../template_create_response_template.py | 6 +- .../dropbox_sign/models/template_response.py | 150 +++--- .../models/template_response_account.py | 31 +- .../models/template_response_account_quota.py | 18 +- .../models/template_response_cc_role.py | 4 +- .../models/template_response_document.py | 33 +- ...ate_response_document_custom_field_base.py | 39 +- ...response_document_custom_field_checkbox.py | 10 +- ...ate_response_document_custom_field_text.py | 33 +- .../template_response_document_field_group.py | 8 +- ...late_response_document_field_group_rule.py | 11 +- ...plate_response_document_form_field_base.py | 35 +- ...e_response_document_form_field_checkbox.py | 6 +- ...esponse_document_form_field_date_signed.py | 8 +- ...e_response_document_form_field_dropdown.py | 6 +- ..._response_document_form_field_hyperlink.py | 23 +- ...e_response_document_form_field_initials.py | 6 +- ...late_response_document_form_field_radio.py | 8 +- ..._response_document_form_field_signature.py | 6 +- ...plate_response_document_form_field_text.py | 25 +- ...ate_response_document_static_field_base.py | 38 +- ...response_document_static_field_checkbox.py | 4 +- ...ponse_document_static_field_date_signed.py | 6 +- ...response_document_static_field_dropdown.py | 4 +- ...esponse_document_static_field_hyperlink.py | 4 +- ...response_document_static_field_initials.py | 4 +- ...te_response_document_static_field_radio.py | 4 +- ...esponse_document_static_field_signature.py | 4 +- ...ate_response_document_static_field_text.py | 4 +- ...template_response_field_avg_text_length.py | 8 +- .../models/template_response_signer_role.py | 2 +- ...template_update_files_response_template.py | 4 +- sdks/ruby/docs/ApiAppResponse.md | 14 +- sdks/ruby/docs/ApiAppResponseOAuth.md | 6 +- sdks/ruby/docs/ApiAppResponseOptions.md | 2 +- sdks/ruby/docs/ApiAppResponseOwnerAccount.md | 4 +- .../ApiAppResponseWhiteLabelingOptions.md | 28 +- sdks/ruby/docs/BulkSendJobResponse.md | 8 +- sdks/ruby/docs/FaxLineResponseFaxLine.md | 8 +- sdks/ruby/docs/TeamResponse.md | 8 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/ruby/docs/TemplateResponse.md | 24 +- sdks/ruby/docs/TemplateResponseAccount.md | 10 +- .../ruby/docs/TemplateResponseAccountQuota.md | 8 +- sdks/ruby/docs/TemplateResponseCCRole.md | 2 +- sdks/ruby/docs/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 16 +- ...plateResponseDocumentFormFieldHyperlink.md | 8 +- .../TemplateResponseDocumentFormFieldText.md | 8 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- sdks/ruby/docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- .../dropbox-sign/models/api_app_response.rb | 82 +-- .../models/api_app_response_o_auth.rb | 47 +- .../models/api_app_response_options.rb | 5 - .../models/api_app_response_owner_account.rb | 10 - ...api_app_response_white_labeling_options.rb | 70 --- .../models/bulk_send_job_response.rb | 23 +- .../models/fax_line_response_fax_line.rb | 20 - .../lib/dropbox-sign/models/team_response.rb | 20 - ...create_embedded_draft_response_template.rb | 15 - .../template_create_response_template.rb | 5 - .../dropbox-sign/models/template_response.rb | 166 ++---- .../models/template_response_account.rb | 55 +- .../models/template_response_account_quota.rb | 20 - .../models/template_response_cc_role.rb | 5 - .../models/template_response_document.rb | 55 +- ...ate_response_document_custom_field_base.rb | 73 +-- ...ate_response_document_custom_field_text.rb | 20 - .../template_response_document_field_group.rb | 10 - ...late_response_document_field_group_rule.rb | 10 - ...plate_response_document_form_field_base.rb | 62 +-- ..._response_document_form_field_hyperlink.rb | 20 - ...plate_response_document_form_field_text.rb | 20 - ...ate_response_document_static_field_base.rb | 62 +-- ...template_response_field_avg_text_length.rb | 10 - .../models/template_response_signer_role.rb | 5 - ...template_update_files_response_template.rb | 5 - 439 files changed, 5325 insertions(+), 7002 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index e0d57e123..07648f251 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -9847,14 +9847,6 @@ components: x-internal-class: true ApiAppResponse: description: '_t__ApiAppResponse::DESCRIPTION' - required: - - client_id - - created_at - - domains - - is_approved - - name - - options - - owner_account properties: callback_url: description: '_t__ApiAppResponse::CALLBACK_URL' @@ -9889,10 +9881,6 @@ components: x-internal-class: true ApiAppResponseOAuth: description: '_t__ApiAppResponseOAuth::DESCRIPTION' - required: - - callback_url - - charges_users - - scopes properties: callback_url: description: '_t__ApiAppResponseOAuth::CALLBACK_URL' @@ -9914,19 +9902,15 @@ components: x-internal-class: true ApiAppResponseOptions: description: '_t__ApiAppResponseOptions::DESCRIPTION' - required: - - can_insert_everywhere properties: can_insert_everywhere: description: '_t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE' type: boolean type: object + nullable: true x-internal-class: true ApiAppResponseOwnerAccount: description: '_t__ApiAppResponseOwnerAccount::DESCRIPTION' - required: - - account_id - - email_address properties: account_id: description: '_t__ApiAppResponseOwnerAccount::ACCOUNT_ID' @@ -9938,21 +9922,6 @@ components: x-internal-class: true ApiAppResponseWhiteLabelingOptions: description: '_t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION' - required: - - header_background_color - - legal_version - - link_color - - page_background_color - - primary_button_color - - primary_button_color_hover - - primary_button_text_color - - primary_button_text_color_hover - - secondary_button_color - - secondary_button_color_hover - - secondary_button_text_color - - secondary_button_text_color_hover - - text_color1 - - text_color2 properties: header_background_color: type: string @@ -9987,15 +9956,11 @@ components: x-internal-class: true BulkSendJobResponse: description: '_t__BulkSendJobResponse::DESCRIPTION' - required: - - bulk_send_job_id - - created_at - - is_creator - - total properties: bulk_send_job_id: description: '_t__BulkSendJobResponse::BULK_SEND_JOB_ID' type: string + nullable: true total: description: '_t__BulkSendJobResponse::TOTAL' type: integer @@ -10058,11 +10023,6 @@ components: type: string type: object FaxLineResponseFaxLine: - required: - - accounts - - created_at - - number - - updated_at properties: number: description: '_t__FaxLineResponseFaxLine::NUMBER' @@ -10572,11 +10532,6 @@ components: x-internal-class: true TeamResponse: description: '_t__TeamResponse::DESCRIPTION' - required: - - name - - accounts - - invited_accounts - - invited_emails properties: name: description: '_t__Team::NAME' @@ -10674,19 +10629,6 @@ components: x-internal-class: true TemplateResponse: description: '_t__TemplateResponse::DESCRIPTION' - required: - - accounts - - attachments - - can_edit - - cc_roles - - documents - - is_creator - - is_locked - - message - - metadata - - signer_roles - - template_id - - title properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' @@ -10758,12 +10700,6 @@ components: type: object x-internal-class: true TemplateResponseAccount: - required: - - account_id - - is_locked - - is_paid_hf - - is_paid_hs - - quotas properties: account_id: description: '_t__TemplateResponseAccount::ACCOUNT_ID' @@ -10786,11 +10722,6 @@ components: x-internal-class: true TemplateResponseAccountQuota: description: '_t__TemplateResponseAccountQuota::DESCRIPTION' - required: - - templates_left - - api_signature_requests_left - - documents_left - - sms_verifications_left properties: templates_left: description: '_t__TemplateResponseAccountQuota::TEMPLATES_LEFT' @@ -10807,8 +10738,6 @@ components: type: object x-internal-class: true TemplateResponseCCRole: - required: - - name properties: name: description: '_t__TemplateResponseCCRole::NAME' @@ -10817,10 +10746,6 @@ components: x-internal-class: true TemplateCreateEmbeddedDraftResponseTemplate: description: '_t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION' - required: - - edit_url - - expires_at - - template_id properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' @@ -10841,8 +10766,6 @@ components: x-internal-class: true TemplateCreateResponseTemplate: description: '_t__TemplateCreateResponseTemplate::DESCRIPTION' - required: - - template_id properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' @@ -10850,12 +10773,6 @@ components: type: object x-internal-class: true TemplateResponseDocument: - required: - - custom_fields - - field_groups - - form_fields - - name - - static_fields properties: name: description: '_t__TemplateResponseDocument::NAME' @@ -10888,14 +10805,7 @@ components: TemplateResponseDocumentCustomFieldBase: description: '_t__TemplateResponseDocumentCustomField::DESCRIPTION' required: - - api_id - - height - - name - - required - type - - width - - x - - 'y' properties: api_id: description: '_t__TemplateResponseDocumentCustomField::API_ID' @@ -10954,10 +10864,6 @@ components: TemplateResponseDocumentCustomFieldText: description: '_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS' required: - - avg_text_length - - fontFamily - - isMultiline - - originalFontSize - type allOf: - @@ -10981,9 +10887,6 @@ components: type: string type: object TemplateResponseDocumentFieldGroup: - required: - - name - - rule properties: name: description: '_t__TemplateResponseDocumentFieldGroup::NAME' @@ -10994,9 +10897,6 @@ components: x-internal-class: true TemplateResponseDocumentFieldGroupRule: description: '_t__TemplateResponseDocumentFieldGroup::RULE' - required: - - groupLabel - - requirement properties: requirement: description: '_t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT' @@ -11009,15 +10909,7 @@ components: TemplateResponseDocumentFormFieldBase: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION' required: - - api_id - - height - - name - - required - - signer - type - - width - - x - - 'y' properties: api_id: description: '_t__TemplateResponseDocumentFormField::API_ID' @@ -11117,10 +11009,6 @@ components: TemplateResponseDocumentFormFieldHyperlink: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - - avg_text_length - - fontFamily - - isMultiline - - originalFontSize - type allOf: - @@ -11204,10 +11092,6 @@ components: TemplateResponseDocumentFormFieldText: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - - avg_text_length - - fontFamily - - isMultiline - - originalFontSize - type allOf: - @@ -11252,15 +11136,7 @@ components: TemplateResponseDocumentStaticFieldBase: description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION' required: - - api_id - - height - - name - - required - - signer - type - - width - - x - - 'y' properties: api_id: description: '_t__TemplateResponseDocumentStaticField::API_ID' @@ -11421,9 +11297,6 @@ components: type: object TemplateResponseFieldAvgTextLength: description: '_t__TemplateResponseFieldAvgTextLength::DESCRIPTION' - required: - - num_lines - - num_chars_per_line properties: num_lines: description: '_t__TemplateResponseFieldAvgTextLength::NUM_LINES' @@ -11434,8 +11307,6 @@ components: type: object x-internal-class: true TemplateResponseSignerRole: - required: - - name properties: name: description: '_t__TemplateResponseSignerRole::NAME' @@ -11447,8 +11318,6 @@ components: x-internal-class: true TemplateUpdateFilesResponseTemplate: description: '_t__TemplateUpdateFilesResponseTemplate::DESCRIPTION' - required: - - template_id properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index f24937c67..0473fccb3 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -10455,14 +10455,6 @@ components: x-internal-class: true ApiAppResponse: description: 'Contains information about an API App.' - required: - - client_id - - created_at - - domains - - is_approved - - name - - options - - owner_account properties: callback_url: description: 'The app''s callback URL (for events)' @@ -10497,10 +10489,6 @@ components: x-internal-class: true ApiAppResponseOAuth: description: 'An object describing the app''s OAuth properties, or null if OAuth is not configured for the app.' - required: - - callback_url - - charges_users - - scopes properties: callback_url: description: 'The app''s OAuth callback URL.' @@ -10522,19 +10510,15 @@ components: x-internal-class: true ApiAppResponseOptions: description: 'An object with options that override account settings.' - required: - - can_insert_everywhere properties: can_insert_everywhere: description: 'Boolean denoting if signers can "Insert Everywhere" in one click while signing a document' type: boolean type: object + nullable: true x-internal-class: true ApiAppResponseOwnerAccount: description: 'An object describing the app''s owner' - required: - - account_id - - email_address properties: account_id: description: 'The owner account''s ID' @@ -10546,21 +10530,6 @@ components: x-internal-class: true ApiAppResponseWhiteLabelingOptions: description: 'An object with options to customize the app''s signer page' - required: - - header_background_color - - legal_version - - link_color - - page_background_color - - primary_button_color - - primary_button_color_hover - - primary_button_text_color - - primary_button_text_color_hover - - secondary_button_color - - secondary_button_color_hover - - secondary_button_text_color - - secondary_button_text_color_hover - - text_color1 - - text_color2 properties: header_background_color: type: string @@ -10595,15 +10564,11 @@ components: x-internal-class: true BulkSendJobResponse: description: 'Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.' - required: - - bulk_send_job_id - - created_at - - is_creator - - total properties: bulk_send_job_id: description: 'The id of the BulkSendJob.' type: string + nullable: true total: description: 'The total amount of Signature Requests queued for sending.' type: integer @@ -10666,11 +10631,6 @@ components: type: string type: object FaxLineResponseFaxLine: - required: - - accounts - - created_at - - number - - updated_at properties: number: description: Number @@ -11188,11 +11148,6 @@ components: x-internal-class: true TeamResponse: description: 'Contains information about your team and its members' - required: - - name - - accounts - - invited_accounts - - invited_emails properties: name: description: 'The name of your Team' @@ -11290,19 +11245,6 @@ components: x-internal-class: true TemplateResponse: description: 'Contains information about the templates you and your team have created.' - required: - - accounts - - attachments - - can_edit - - cc_roles - - documents - - is_creator - - is_locked - - message - - metadata - - signer_roles - - template_id - - title properties: template_id: description: 'The id of the Template.' @@ -11377,12 +11319,6 @@ components: type: object x-internal-class: true TemplateResponseAccount: - required: - - account_id - - is_locked - - is_paid_hf - - is_paid_hs - - quotas properties: account_id: description: 'The id of the Account.' @@ -11405,11 +11341,6 @@ components: x-internal-class: true TemplateResponseAccountQuota: description: 'An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.' - required: - - templates_left - - api_signature_requests_left - - documents_left - - sms_verifications_left properties: templates_left: description: 'API templates remaining.' @@ -11426,8 +11357,6 @@ components: type: object x-internal-class: true TemplateResponseCCRole: - required: - - name properties: name: description: 'The name of the Role.' @@ -11436,10 +11365,6 @@ components: x-internal-class: true TemplateCreateEmbeddedDraftResponseTemplate: description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.' - required: - - edit_url - - expires_at - - template_id properties: template_id: description: 'The id of the Template.' @@ -11460,8 +11385,6 @@ components: x-internal-class: true TemplateCreateResponseTemplate: description: 'Template object with parameters: `template_id`.' - required: - - template_id properties: template_id: description: 'The id of the Template.' @@ -11469,12 +11392,6 @@ components: type: object x-internal-class: true TemplateResponseDocument: - required: - - custom_fields - - field_groups - - form_fields - - name - - static_fields properties: name: description: 'Name of the associated file.' @@ -11507,14 +11424,7 @@ components: TemplateResponseDocumentCustomFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: - - api_id - - height - - name - - required - type - - width - - x - - 'y' properties: api_id: description: 'The unique ID for this field.' @@ -11577,10 +11487,6 @@ components: TemplateResponseDocumentCustomFieldText: description: 'This class extends `TemplateResponseDocumentCustomFieldBase`' required: - - avg_text_length - - fontFamily - - isMultiline - - originalFontSize - type allOf: - @@ -11608,9 +11514,6 @@ components: type: string type: object TemplateResponseDocumentFieldGroup: - required: - - name - - rule properties: name: description: 'The name of the form field group.' @@ -11621,9 +11524,6 @@ components: x-internal-class: true TemplateResponseDocumentFieldGroupRule: description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).' - required: - - groupLabel - - requirement properties: requirement: description: |- @@ -11641,15 +11541,7 @@ components: TemplateResponseDocumentFormFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: - - api_id - - height - - name - - required - - signer - type - - width - - x - - 'y' properties: api_id: description: 'A unique id for the form field.' @@ -11779,10 +11671,6 @@ components: TemplateResponseDocumentFormFieldHyperlink: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: - - avg_text_length - - fontFamily - - isMultiline - - originalFontSize - type allOf: - @@ -11906,10 +11794,6 @@ components: TemplateResponseDocumentFormFieldText: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: - - avg_text_length - - fontFamily - - isMultiline - - originalFontSize - type allOf: - @@ -11964,15 +11848,7 @@ components: TemplateResponseDocumentStaticFieldBase: description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' required: - - api_id - - height - - name - - required - - signer - type - - width - - x - - 'y' properties: api_id: description: 'A unique id for the static field.' @@ -12213,9 +12089,6 @@ components: type: object TemplateResponseFieldAvgTextLength: description: 'Average text length in this field.' - required: - - num_lines - - num_chars_per_line properties: num_lines: description: 'Number of lines.' @@ -12226,8 +12099,6 @@ components: type: object x-internal-class: true TemplateResponseSignerRole: - required: - - name properties: name: description: 'The name of the Role.' @@ -12239,8 +12110,6 @@ components: x-internal-class: true TemplateUpdateFilesResponseTemplate: description: 'Contains template id' - required: - - template_id properties: template_id: description: 'The id of the Template.' diff --git a/openapi.yaml b/openapi.yaml index 56be94ebe..6ff9bab8b 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -10433,14 +10433,6 @@ components: x-internal-class: true ApiAppResponse: description: 'Contains information about an API App.' - required: - - client_id - - created_at - - domains - - is_approved - - name - - options - - owner_account properties: callback_url: description: 'The app''s callback URL (for events)' @@ -10475,10 +10467,6 @@ components: x-internal-class: true ApiAppResponseOAuth: description: 'An object describing the app''s OAuth properties, or null if OAuth is not configured for the app.' - required: - - callback_url - - charges_users - - scopes properties: callback_url: description: 'The app''s OAuth callback URL.' @@ -10500,19 +10488,15 @@ components: x-internal-class: true ApiAppResponseOptions: description: 'An object with options that override account settings.' - required: - - can_insert_everywhere properties: can_insert_everywhere: description: 'Boolean denoting if signers can "Insert Everywhere" in one click while signing a document' type: boolean type: object + nullable: true x-internal-class: true ApiAppResponseOwnerAccount: description: 'An object describing the app''s owner' - required: - - account_id - - email_address properties: account_id: description: 'The owner account''s ID' @@ -10524,21 +10508,6 @@ components: x-internal-class: true ApiAppResponseWhiteLabelingOptions: description: 'An object with options to customize the app''s signer page' - required: - - header_background_color - - legal_version - - link_color - - page_background_color - - primary_button_color - - primary_button_color_hover - - primary_button_text_color - - primary_button_text_color_hover - - secondary_button_color - - secondary_button_color_hover - - secondary_button_text_color - - secondary_button_text_color_hover - - text_color1 - - text_color2 properties: header_background_color: type: string @@ -10573,15 +10542,11 @@ components: x-internal-class: true BulkSendJobResponse: description: 'Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.' - required: - - bulk_send_job_id - - created_at - - is_creator - - total properties: bulk_send_job_id: description: 'The id of the BulkSendJob.' type: string + nullable: true total: description: 'The total amount of Signature Requests queued for sending.' type: integer @@ -10644,11 +10609,6 @@ components: type: string type: object FaxLineResponseFaxLine: - required: - - accounts - - created_at - - number - - updated_at properties: number: description: Number @@ -11166,11 +11126,6 @@ components: x-internal-class: true TeamResponse: description: 'Contains information about your team and its members' - required: - - name - - accounts - - invited_accounts - - invited_emails properties: name: description: 'The name of your Team' @@ -11268,19 +11223,6 @@ components: x-internal-class: true TemplateResponse: description: 'Contains information about the templates you and your team have created.' - required: - - accounts - - attachments - - can_edit - - cc_roles - - documents - - is_creator - - is_locked - - message - - metadata - - signer_roles - - template_id - - title properties: template_id: description: 'The id of the Template.' @@ -11355,12 +11297,6 @@ components: type: object x-internal-class: true TemplateResponseAccount: - required: - - account_id - - is_locked - - is_paid_hf - - is_paid_hs - - quotas properties: account_id: description: 'The id of the Account.' @@ -11383,11 +11319,6 @@ components: x-internal-class: true TemplateResponseAccountQuota: description: 'An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.' - required: - - templates_left - - api_signature_requests_left - - documents_left - - sms_verifications_left properties: templates_left: description: 'API templates remaining.' @@ -11404,8 +11335,6 @@ components: type: object x-internal-class: true TemplateResponseCCRole: - required: - - name properties: name: description: 'The name of the Role.' @@ -11414,10 +11343,6 @@ components: x-internal-class: true TemplateCreateEmbeddedDraftResponseTemplate: description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.' - required: - - edit_url - - expires_at - - template_id properties: template_id: description: 'The id of the Template.' @@ -11438,8 +11363,6 @@ components: x-internal-class: true TemplateCreateResponseTemplate: description: 'Template object with parameters: `template_id`.' - required: - - template_id properties: template_id: description: 'The id of the Template.' @@ -11447,12 +11370,6 @@ components: type: object x-internal-class: true TemplateResponseDocument: - required: - - custom_fields - - field_groups - - form_fields - - name - - static_fields properties: name: description: 'Name of the associated file.' @@ -11485,14 +11402,7 @@ components: TemplateResponseDocumentCustomFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: - - api_id - - height - - name - - required - type - - width - - x - - 'y' properties: api_id: description: 'The unique ID for this field.' @@ -11555,10 +11465,6 @@ components: TemplateResponseDocumentCustomFieldText: description: 'This class extends `TemplateResponseDocumentCustomFieldBase`' required: - - avg_text_length - - fontFamily - - isMultiline - - originalFontSize - type allOf: - @@ -11586,9 +11492,6 @@ components: type: string type: object TemplateResponseDocumentFieldGroup: - required: - - name - - rule properties: name: description: 'The name of the form field group.' @@ -11599,9 +11502,6 @@ components: x-internal-class: true TemplateResponseDocumentFieldGroupRule: description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).' - required: - - groupLabel - - requirement properties: requirement: description: |- @@ -11619,15 +11519,7 @@ components: TemplateResponseDocumentFormFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: - - api_id - - height - - name - - required - - signer - type - - width - - x - - 'y' properties: api_id: description: 'A unique id for the form field.' @@ -11757,10 +11649,6 @@ components: TemplateResponseDocumentFormFieldHyperlink: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: - - avg_text_length - - fontFamily - - isMultiline - - originalFontSize - type allOf: - @@ -11884,10 +11772,6 @@ components: TemplateResponseDocumentFormFieldText: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: - - avg_text_length - - fontFamily - - isMultiline - - originalFontSize - type allOf: - @@ -11942,15 +11826,7 @@ components: TemplateResponseDocumentStaticFieldBase: description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' required: - - api_id - - height - - name - - required - - signer - type - - width - - x - - 'y' properties: api_id: description: 'A unique id for the static field.' @@ -12191,9 +12067,6 @@ components: type: object TemplateResponseFieldAvgTextLength: description: 'Average text length in this field.' - required: - - num_lines - - num_chars_per_line properties: num_lines: description: 'Number of lines.' @@ -12204,8 +12077,6 @@ components: type: object x-internal-class: true TemplateResponseSignerRole: - required: - - name properties: name: description: 'The name of the Role.' @@ -12217,8 +12088,6 @@ components: x-internal-class: true TemplateUpdateFilesResponseTemplate: description: 'Contains template id' - required: - - template_id properties: template_id: description: 'The id of the Template.' diff --git a/sdks/dotnet/docs/ApiAppResponse.md b/sdks/dotnet/docs/ApiAppResponse.md index e7b3c6e30..f27ff0659 100644 --- a/sdks/dotnet/docs/ApiAppResponse.md +++ b/sdks/dotnet/docs/ApiAppResponse.md @@ -5,7 +5,7 @@ Contains information about an API App. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | The app's client id | **CreatedAt** | **int** | The time that the app was created | **Domains** | **List<string>** | The domain name(s) associated with the app | **Name** | **string** | The name of the app | **IsApproved** | **bool** | Boolean to indicate if the app has been approved | **Options** | [**ApiAppResponseOptions**](ApiAppResponseOptions.md) | | **OwnerAccount** | [**ApiAppResponseOwnerAccount**](ApiAppResponseOwnerAccount.md) | | **CallbackUrl** | **string** | The app's callback URL (for events) | [optional] **Oauth** | [**ApiAppResponseOAuth**](ApiAppResponseOAuth.md) | | [optional] **WhiteLabelingOptions** | [**ApiAppResponseWhiteLabelingOptions**](ApiAppResponseWhiteLabelingOptions.md) | | [optional] +**CallbackUrl** | **string** | The app's callback URL (for events) | [optional] **ClientId** | **string** | The app's client id | [optional] **CreatedAt** | **int** | The time that the app was created | [optional] **Domains** | **List<string>** | The domain name(s) associated with the app | [optional] **Name** | **string** | The name of the app | [optional] **IsApproved** | **bool** | Boolean to indicate if the app has been approved | [optional] **Oauth** | [**ApiAppResponseOAuth**](ApiAppResponseOAuth.md) | | [optional] **Options** | [**ApiAppResponseOptions**](ApiAppResponseOptions.md) | | [optional] **OwnerAccount** | [**ApiAppResponseOwnerAccount**](ApiAppResponseOwnerAccount.md) | | [optional] **WhiteLabelingOptions** | [**ApiAppResponseWhiteLabelingOptions**](ApiAppResponseWhiteLabelingOptions.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/ApiAppResponseOAuth.md b/sdks/dotnet/docs/ApiAppResponseOAuth.md index 69de8316d..cffe8900f 100644 --- a/sdks/dotnet/docs/ApiAppResponseOAuth.md +++ b/sdks/dotnet/docs/ApiAppResponseOAuth.md @@ -5,7 +5,7 @@ An object describing the app's OAuth properties, or null if OAuth is not configu Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CallbackUrl** | **string** | The app's OAuth callback URL. | **Scopes** | **List<string>** | Array of OAuth scopes used by the app. | **ChargesUsers** | **bool** | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | **Secret** | **string** | The app's OAuth secret, or null if the app does not belong to user. | [optional] +**CallbackUrl** | **string** | The app's OAuth callback URL. | [optional] **Secret** | **string** | The app's OAuth secret, or null if the app does not belong to user. | [optional] **Scopes** | **List<string>** | Array of OAuth scopes used by the app. | [optional] **ChargesUsers** | **bool** | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | [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/ApiAppResponseOptions.md b/sdks/dotnet/docs/ApiAppResponseOptions.md index 97fdc5d08..e484ad16b 100644 --- a/sdks/dotnet/docs/ApiAppResponseOptions.md +++ b/sdks/dotnet/docs/ApiAppResponseOptions.md @@ -5,7 +5,7 @@ An object with options that override account settings. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CanInsertEverywhere** | **bool** | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | +**CanInsertEverywhere** | **bool** | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | [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/ApiAppResponseOwnerAccount.md b/sdks/dotnet/docs/ApiAppResponseOwnerAccount.md index fa9c19b3f..eee4afc3e 100644 --- a/sdks/dotnet/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/dotnet/docs/ApiAppResponseOwnerAccount.md @@ -5,7 +5,7 @@ An object describing the app's owner Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AccountId** | **string** | The owner account's ID | **EmailAddress** | **string** | The owner account's email address | +**AccountId** | **string** | The owner account's ID | [optional] **EmailAddress** | **string** | The owner account's email address | [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/ApiAppResponseWhiteLabelingOptions.md b/sdks/dotnet/docs/ApiAppResponseWhiteLabelingOptions.md index 0f3960188..3f3eb34a3 100644 --- a/sdks/dotnet/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/dotnet/docs/ApiAppResponseWhiteLabelingOptions.md @@ -5,7 +5,7 @@ An object with options to customize the app's signer page Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HeaderBackgroundColor** | **string** | | **LegalVersion** | **string** | | **LinkColor** | **string** | | **PageBackgroundColor** | **string** | | **PrimaryButtonColor** | **string** | | **PrimaryButtonColorHover** | **string** | | **PrimaryButtonTextColor** | **string** | | **PrimaryButtonTextColorHover** | **string** | | **SecondaryButtonColor** | **string** | | **SecondaryButtonColorHover** | **string** | | **SecondaryButtonTextColor** | **string** | | **SecondaryButtonTextColorHover** | **string** | | **TextColor1** | **string** | | **TextColor2** | **string** | | +**HeaderBackgroundColor** | **string** | | [optional] **LegalVersion** | **string** | | [optional] **LinkColor** | **string** | | [optional] **PageBackgroundColor** | **string** | | [optional] **PrimaryButtonColor** | **string** | | [optional] **PrimaryButtonColorHover** | **string** | | [optional] **PrimaryButtonTextColor** | **string** | | [optional] **PrimaryButtonTextColorHover** | **string** | | [optional] **SecondaryButtonColor** | **string** | | [optional] **SecondaryButtonColorHover** | **string** | | [optional] **SecondaryButtonTextColor** | **string** | | [optional] **SecondaryButtonTextColorHover** | **string** | | [optional] **TextColor1** | **string** | | [optional] **TextColor2** | **string** | | [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/BulkSendJobResponse.md b/sdks/dotnet/docs/BulkSendJobResponse.md index f4678792b..6a9e580db 100644 --- a/sdks/dotnet/docs/BulkSendJobResponse.md +++ b/sdks/dotnet/docs/BulkSendJobResponse.md @@ -5,7 +5,7 @@ Contains information about the BulkSendJob such as when it was created and how m Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**BulkSendJobId** | **string** | The id of the BulkSendJob. | **Total** | **int** | The total amount of Signature Requests queued for sending. | **IsCreator** | **bool** | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | **CreatedAt** | **int** | Time that the BulkSendJob was created. | +**BulkSendJobId** | **string** | The id of the BulkSendJob. | [optional] **Total** | **int** | The total amount of Signature Requests queued for sending. | [optional] **IsCreator** | **bool** | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | [optional] **CreatedAt** | **int** | Time that the BulkSendJob was created. | [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/FaxLineResponseFaxLine.md b/sdks/dotnet/docs/FaxLineResponseFaxLine.md index d540d8ead..672e73d56 100644 --- a/sdks/dotnet/docs/FaxLineResponseFaxLine.md +++ b/sdks/dotnet/docs/FaxLineResponseFaxLine.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Number** | **string** | Number | **CreatedAt** | **int** | Created at | **UpdatedAt** | **int** | Updated at | **Accounts** | [**List<AccountResponse>**](AccountResponse.md) | | +**Number** | **string** | Number | [optional] **CreatedAt** | **int** | Created at | [optional] **UpdatedAt** | **int** | Updated at | [optional] **Accounts** | [**List<AccountResponse>**](AccountResponse.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/TeamResponse.md b/sdks/dotnet/docs/TeamResponse.md index 65276cf8e..977696c0a 100644 --- a/sdks/dotnet/docs/TeamResponse.md +++ b/sdks/dotnet/docs/TeamResponse.md @@ -5,7 +5,7 @@ Contains information about your team and its members Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of your Team | **Accounts** | [**List<AccountResponse>**](AccountResponse.md) | | **InvitedAccounts** | [**List<AccountResponse>**](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | **InvitedEmails** | **List<string>** | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | +**Name** | **string** | The name of your Team | [optional] **Accounts** | [**List<AccountResponse>**](AccountResponse.md) | | [optional] **InvitedAccounts** | [**List<AccountResponse>**](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | [optional] **InvitedEmails** | **List<string>** | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | [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/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 14e94249e..d23893dd3 100644 --- a/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -5,7 +5,7 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | **EditUrl** | **string** | Link to edit the template. | **ExpiresAt** | **int** | When the link expires. | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**TemplateId** | **string** | The id of the Template. | [optional] **EditUrl** | **string** | Link to edit the template. | [optional] **ExpiresAt** | **int** | When the link expires. | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateCreateResponseTemplate.md b/sdks/dotnet/docs/TemplateCreateResponseTemplate.md index e8b10cc5e..85941fc4e 100644 --- a/sdks/dotnet/docs/TemplateCreateResponseTemplate.md +++ b/sdks/dotnet/docs/TemplateCreateResponseTemplate.md @@ -5,7 +5,7 @@ Template object with parameters: `template_id`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | +**TemplateId** | **string** | The id of the Template. | [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/TemplateResponse.md b/sdks/dotnet/docs/TemplateResponse.md index 5e8b837b9..ded2dee38 100644 --- a/sdks/dotnet/docs/TemplateResponse.md +++ b/sdks/dotnet/docs/TemplateResponse.md @@ -5,7 +5,7 @@ Contains information about the templates you and your team have created. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | **Metadata** | **Object** | The metadata attached to the template. | **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] +**TemplateId** | **string** | The id of the Template. | [optional] **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | [optional] **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | [optional] **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | [optional] **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | [optional] **Metadata** | **Object** | The metadata attached to the template. | [optional] **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | [optional] **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | [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/TemplateResponseAccount.md b/sdks/dotnet/docs/TemplateResponseAccount.md index 297e5209a..b69b4ebaa 100644 --- a/sdks/dotnet/docs/TemplateResponseAccount.md +++ b/sdks/dotnet/docs/TemplateResponseAccount.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** | [**TemplateResponseAccountQuota**](TemplateResponseAccountQuota.md) | | **EmailAddress** | **string** | The email address associated with the Account. | [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** | [**TemplateResponseAccountQuota**](TemplateResponseAccountQuota.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/TemplateResponseAccountQuota.md b/sdks/dotnet/docs/TemplateResponseAccountQuota.md index 9b51ccf96..5051dc54f 100644 --- a/sdks/dotnet/docs/TemplateResponseAccountQuota.md +++ b/sdks/dotnet/docs/TemplateResponseAccountQuota.md @@ -5,7 +5,7 @@ An array of the designated CC roles that must be specified when sending a Signat Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplatesLeft** | **int** | API templates remaining. | **ApiSignatureRequestsLeft** | **int** | API signature requests remaining. | **DocumentsLeft** | **int** | Signature requests remaining. | **SmsVerificationsLeft** | **int** | SMS verifications remaining. | +**TemplatesLeft** | **int** | API templates remaining. | [optional] **ApiSignatureRequestsLeft** | **int** | API signature requests remaining. | [optional] **DocumentsLeft** | **int** | Signature requests remaining. | [optional] **SmsVerificationsLeft** | **int** | SMS verifications remaining. | [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/TemplateResponseCCRole.md b/sdks/dotnet/docs/TemplateResponseCCRole.md index fbb67b662..1e8067443 100644 --- a/sdks/dotnet/docs/TemplateResponseCCRole.md +++ b/sdks/dotnet/docs/TemplateResponseCCRole.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the Role. | +**Name** | **string** | The name of the Role. | [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/TemplateResponseDocument.md b/sdks/dotnet/docs/TemplateResponseDocument.md index 2d475d964..6847d7b3c 100644 --- a/sdks/dotnet/docs/TemplateResponseDocument.md +++ b/sdks/dotnet/docs/TemplateResponseDocument.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | Name of the associated file. | **FieldGroups** | [**List<TemplateResponseDocumentFieldGroup>**](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | **FormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | **StaticFields** | [**List<TemplateResponseDocumentStaticFieldBase>**](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | **Index** | **int** | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | [optional] +**Name** | **string** | Name of the associated file. | [optional] **Index** | **int** | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | [optional] **FieldGroups** | [**List<TemplateResponseDocumentFieldGroup>**](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | [optional] **FormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | [optional] **StaticFields** | [**List<TemplateResponseDocumentStaticFieldBase>**](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | [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/TemplateResponseDocumentCustomFieldBase.md b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldBase.md index 11b988b67..9f349a7ab 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldBase.md @@ -5,7 +5,7 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | **Name** | **string** | The name of the Custom Field. | **Type** | **string** | | **X** | **int** | The horizontal offset in pixels for this form field. | **Y** | **int** | The vertical offset in pixels for this form field. | **Width** | **int** | The width in pixels of this form field. | **Height** | **int** | The height in pixels of this form field. | **Required** | **bool** | Boolean showing whether or not this field is required. | **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] +**Type** | **string** | | **ApiId** | **string** | The unique ID for this field. | [optional] **Name** | **string** | The name of the Custom Field. | [optional] **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] **X** | **int** | The horizontal offset in pixels for this form field. | [optional] **Y** | **int** | The vertical offset in pixels for this form field. | [optional] **Width** | **int** | The width in pixels of this form field. | [optional] **Height** | **int** | The height in pixels of this form field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [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/TemplateResponseDocumentCustomFieldCheckbox.md b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldCheckbox.md index 83b4c54aa..11a948265 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldCheckbox.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldCheckbox.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | -**Name** | **string** | The name of the Custom Field. | -**X** | **int** | The horizontal offset in pixels for this form field. | -**Y** | **int** | The vertical offset in pixels for this form field. | -**Width** | **int** | The width in pixels of this form field. | -**Height** | **int** | The height in pixels of this form field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | The unique ID for this field. | [optional] +**Name** | **string** | The name of the Custom Field. | [optional] **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] +**X** | **int** | The horizontal offset in pixels for this form field. | [optional] +**Y** | **int** | The vertical offset in pixels for this form field. | [optional] +**Width** | **int** | The width in pixels of this form field. | [optional] +**Height** | **int** | The height in pixels of this form field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to "checkbox"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md index 4e2fb5a19..8db16365b 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md @@ -5,16 +5,16 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | -**Name** | **string** | The name of the Custom Field. | -**X** | **int** | The horizontal offset in pixels for this form field. | -**Y** | **int** | The vertical offset in pixels for this form field. | -**Width** | **int** | The width in pixels of this form field. | -**Height** | **int** | The height in pixels of this form field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | The unique ID for this field. | [optional] +**Name** | **string** | The name of the Custom Field. | [optional] **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] +**X** | **int** | The horizontal offset in pixels for this form field. | [optional] +**Y** | **int** | The vertical offset in pixels for this form field. | [optional] +**Width** | **int** | The width in pixels of this form field. | [optional] +**Height** | **int** | The height in pixels of this form field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] -**Type** | **string** | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | **IsMultiline** | **bool** | Whether this form field is multiline text. | **OriginalFontSize** | **int** | Original font size used in this form field's text. | **FontFamily** | **string** | Font family used in this form field's text. | +**Type** | **string** | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [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/TemplateResponseDocumentFieldGroup.md b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroup.md index 8d3113005..0dfac711c 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroup.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the form field group. | **Rule** | [**TemplateResponseDocumentFieldGroupRule**](TemplateResponseDocumentFieldGroupRule.md) | | +**Name** | **string** | The name of the form field group. | [optional] **Rule** | [**TemplateResponseDocumentFieldGroupRule**](TemplateResponseDocumentFieldGroupRule.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/TemplateResponseDocumentFieldGroupRule.md b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroupRule.md index bf5970a2d..44dd2eb4a 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroupRule.md @@ -5,7 +5,7 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Requirement** | **string** | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | **GroupLabel** | **string** | Name of the group | +**Requirement** | **string** | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | [optional] **GroupLabel** | **string** | Name of the group | [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/TemplateResponseDocumentFormFieldBase.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldBase.md index 3d29f4f62..191f73cd2 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldBase.md @@ -5,7 +5,7 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | **Name** | **string** | The name of the form field. | **Type** | **string** | | **Signer** | **string** | The signer of the Form Field. | **X** | **int** | The horizontal offset in pixels for this form field. | **Y** | **int** | The vertical offset in pixels for this form field. | **Width** | **int** | The width in pixels of this form field. | **Height** | **int** | The height in pixels of this form field. | **Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | | **ApiId** | **string** | A unique id for the form field. | [optional] **Name** | **string** | The name of the form field. | [optional] **Signer** | **string** | The signer of the Form Field. | [optional] **X** | **int** | The horizontal offset in pixels for this form field. | [optional] **Y** | **int** | The vertical offset in pixels for this form field. | [optional] **Width** | **int** | The width in pixels of this form field. | [optional] **Height** | **int** | The height in pixels of this form field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [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/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldCheckbox.md index add6e9a18..4a94b377c 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | -**Name** | **string** | The name of the form field. | -**Signer** | **string** | The signer of the Form Field. | -**X** | **int** | The horizontal offset in pixels for this form field. | -**Y** | **int** | The vertical offset in pixels for this form field. | -**Width** | **int** | The width in pixels of this form field. | -**Height** | **int** | The height in pixels of this form field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | A unique id for the form field. | [optional] +**Name** | **string** | The name of the form field. | [optional] +**Signer** | **string** | The signer of the Form Field. | [optional] +**X** | **int** | The horizontal offset in pixels for this form field. | [optional] +**Y** | **int** | The vertical offset in pixels for this form field. | [optional] +**Width** | **int** | The width in pixels of this form field. | [optional] +**Height** | **int** | The height in pixels of this form field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "checkbox"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDateSigned.md index 0c08c5ab2..7356475f5 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | -**Name** | **string** | The name of the form field. | -**Signer** | **string** | The signer of the Form Field. | -**X** | **int** | The horizontal offset in pixels for this form field. | -**Y** | **int** | The vertical offset in pixels for this form field. | -**Width** | **int** | The width in pixels of this form field. | -**Height** | **int** | The height in pixels of this form field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | A unique id for the form field. | [optional] +**Name** | **string** | The name of the form field. | [optional] +**Signer** | **string** | The signer of the Form Field. | [optional] +**X** | **int** | The horizontal offset in pixels for this form field. | [optional] +**Y** | **int** | The vertical offset in pixels for this form field. | [optional] +**Width** | **int** | The width in pixels of this form field. | [optional] +**Height** | **int** | The height in pixels of this form field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "date_signed"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldDropdown.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDropdown.md index cde089bc9..62b9123c6 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | -**Name** | **string** | The name of the form field. | -**Signer** | **string** | The signer of the Form Field. | -**X** | **int** | The horizontal offset in pixels for this form field. | -**Y** | **int** | The vertical offset in pixels for this form field. | -**Width** | **int** | The width in pixels of this form field. | -**Height** | **int** | The height in pixels of this form field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | A unique id for the form field. | [optional] +**Name** | **string** | The name of the form field. | [optional] +**Signer** | **string** | The signer of the Form Field. | [optional] +**X** | **int** | The horizontal offset in pixels for this form field. | [optional] +**Y** | **int** | The vertical offset in pixels for this form field. | [optional] +**Width** | **int** | The width in pixels of this form field. | [optional] +**Height** | **int** | The height in pixels of this form field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "dropdown"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldHyperlink.md index 481e7f478..51222f57a 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -5,15 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | -**Name** | **string** | The name of the form field. | -**Signer** | **string** | The signer of the Form Field. | -**X** | **int** | The horizontal offset in pixels for this form field. | -**Y** | **int** | The vertical offset in pixels for this form field. | -**Width** | **int** | The width in pixels of this form field. | -**Height** | **int** | The height in pixels of this form field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "hyperlink"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | **IsMultiline** | **bool** | Whether this form field is multiline text. | **OriginalFontSize** | **int** | Original font size used in this form field's text. | **FontFamily** | **string** | Font family used in this form field's text. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] +**ApiId** | **string** | A unique id for the form field. | [optional] +**Name** | **string** | The name of the form field. | [optional] +**Signer** | **string** | The signer of the Form Field. | [optional] +**X** | **int** | The horizontal offset in pixels for this form field. | [optional] +**Y** | **int** | The vertical offset in pixels for this form field. | [optional] +**Width** | **int** | The width in pixels of this form field. | [optional] +**Height** | **int** | The height in pixels of this form field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "hyperlink"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldInitials.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldInitials.md index 86905a63f..d519b4978 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldInitials.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | -**Name** | **string** | The name of the form field. | -**Signer** | **string** | The signer of the Form Field. | -**X** | **int** | The horizontal offset in pixels for this form field. | -**Y** | **int** | The vertical offset in pixels for this form field. | -**Width** | **int** | The width in pixels of this form field. | -**Height** | **int** | The height in pixels of this form field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | A unique id for the form field. | [optional] +**Name** | **string** | The name of the form field. | [optional] +**Signer** | **string** | The signer of the Form Field. | [optional] +**X** | **int** | The horizontal offset in pixels for this form field. | [optional] +**Y** | **int** | The vertical offset in pixels for this form field. | [optional] +**Width** | **int** | The width in pixels of this form field. | [optional] +**Height** | **int** | The height in pixels of this form field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "initials"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldRadio.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldRadio.md index 217c5357c..52f877294 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldRadio.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | -**Name** | **string** | The name of the form field. | -**Signer** | **string** | The signer of the Form Field. | -**X** | **int** | The horizontal offset in pixels for this form field. | -**Y** | **int** | The vertical offset in pixels for this form field. | -**Width** | **int** | The width in pixels of this form field. | -**Height** | **int** | The height in pixels of this form field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | A unique id for the form field. | [optional] +**Name** | **string** | The name of the form field. | [optional] +**Signer** | **string** | The signer of the Form Field. | [optional] +**X** | **int** | The horizontal offset in pixels for this form field. | [optional] +**Y** | **int** | The vertical offset in pixels for this form field. | [optional] +**Width** | **int** | The width in pixels of this form field. | [optional] +**Height** | **int** | The height in pixels of this form field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "radio"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [[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/TemplateResponseDocumentFormFieldSignature.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldSignature.md index 08452c6cb..f173e61f1 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldSignature.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | -**Name** | **string** | The name of the form field. | -**Signer** | **string** | The signer of the Form Field. | -**X** | **int** | The horizontal offset in pixels for this form field. | -**Y** | **int** | The vertical offset in pixels for this form field. | -**Width** | **int** | The width in pixels of this form field. | -**Height** | **int** | The height in pixels of this form field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | A unique id for the form field. | [optional] +**Name** | **string** | The name of the form field. | [optional] +**Signer** | **string** | The signer of the Form Field. | [optional] +**X** | **int** | The horizontal offset in pixels for this form field. | [optional] +**Y** | **int** | The vertical offset in pixels for this form field. | [optional] +**Width** | **int** | The width in pixels of this form field. | [optional] +**Height** | **int** | The height in pixels of this form field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "signature"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldText.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldText.md index 030296903..368fec852 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldText.md @@ -5,15 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | -**Name** | **string** | The name of the form field. | -**Signer** | **string** | The signer of the Form Field. | -**X** | **int** | The horizontal offset in pixels for this form field. | -**Y** | **int** | The vertical offset in pixels for this form field. | -**Width** | **int** | The width in pixels of this form field. | -**Height** | **int** | The height in pixels of this form field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | **IsMultiline** | **bool** | Whether this form field is multiline text. | **OriginalFontSize** | **int** | Original font size used in this form field's text. | **FontFamily** | **string** | Font family used in this form field's text. | **ValidationType** | **string** | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] +**ApiId** | **string** | A unique id for the form field. | [optional] +**Name** | **string** | The name of the form field. | [optional] +**Signer** | **string** | The signer of the Form Field. | [optional] +**X** | **int** | The horizontal offset in pixels for this form field. | [optional] +**Y** | **int** | The vertical offset in pixels for this form field. | [optional] +**Width** | **int** | The width in pixels of this form field. | [optional] +**Height** | **int** | The height in pixels of this form field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional] **ValidationType** | **string** | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentStaticFieldBase.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldBase.md index 368bc5d06..b147460c8 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldBase.md @@ -5,7 +5,7 @@ An array describing static overlay fields. **NOTE:** Only available for certain Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | **Name** | **string** | The name of the static field. | **Type** | **string** | | **Signer** | **string** | The signer of the Static Field. | [default to "me_now"]**X** | **int** | The horizontal offset in pixels for this static field. | **Y** | **int** | The vertical offset in pixels for this static field. | **Width** | **int** | The width in pixels of this static field. | **Height** | **int** | The height in pixels of this static field. | **Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] +**Type** | **string** | | **ApiId** | **string** | A unique id for the static field. | [optional] **Name** | **string** | The name of the static field. | [optional] **Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"]**X** | **int** | The horizontal offset in pixels for this static field. | [optional] **Y** | **int** | The vertical offset in pixels for this static field. | [optional] **Width** | **int** | The width in pixels of this static field. | [optional] **Height** | **int** | The height in pixels of this static field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [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/TemplateResponseDocumentStaticFieldCheckbox.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldCheckbox.md index b70eab4c5..cfa9ccb8c 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldCheckbox.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldCheckbox.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | -**Name** | **string** | The name of the static field. | -**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | -**Y** | **int** | The vertical offset in pixels for this static field. | -**Width** | **int** | The width in pixels of this static field. | -**Height** | **int** | The height in pixels of this static field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | A unique id for the static field. | [optional] +**Name** | **string** | The name of the static field. | [optional] +**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | [optional] +**Y** | **int** | The vertical offset in pixels for this static field. | [optional] +**Width** | **int** | The width in pixels of this static field. | [optional] +**Height** | **int** | The height in pixels of this static field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "checkbox"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md index 935ac5748..bae7b8ab4 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | -**Name** | **string** | The name of the static field. | -**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | -**Y** | **int** | The vertical offset in pixels for this static field. | -**Width** | **int** | The width in pixels of this static field. | -**Height** | **int** | The height in pixels of this static field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | A unique id for the static field. | [optional] +**Name** | **string** | The name of the static field. | [optional] +**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | [optional] +**Y** | **int** | The vertical offset in pixels for this static field. | [optional] +**Width** | **int** | The width in pixels of this static field. | [optional] +**Height** | **int** | The height in pixels of this static field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "date_signed"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md index 327d1ccb1..7815923f9 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | -**Name** | **string** | The name of the static field. | -**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | -**Y** | **int** | The vertical offset in pixels for this static field. | -**Width** | **int** | The width in pixels of this static field. | -**Height** | **int** | The height in pixels of this static field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | A unique id for the static field. | [optional] +**Name** | **string** | The name of the static field. | [optional] +**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | [optional] +**Y** | **int** | The vertical offset in pixels for this static field. | [optional] +**Width** | **int** | The width in pixels of this static field. | [optional] +**Height** | **int** | The height in pixels of this static field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "dropdown"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md index f2a3de8a4..81b419793 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | -**Name** | **string** | The name of the static field. | -**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | -**Y** | **int** | The vertical offset in pixels for this static field. | -**Width** | **int** | The width in pixels of this static field. | -**Height** | **int** | The height in pixels of this static field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | A unique id for the static field. | [optional] +**Name** | **string** | The name of the static field. | [optional] +**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | [optional] +**Y** | **int** | The vertical offset in pixels for this static field. | [optional] +**Width** | **int** | The width in pixels of this static field. | [optional] +**Height** | **int** | The height in pixels of this static field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "hyperlink"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md index 0cc875be7..a9dae476b 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | -**Name** | **string** | The name of the static field. | -**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | -**Y** | **int** | The vertical offset in pixels for this static field. | -**Width** | **int** | The width in pixels of this static field. | -**Height** | **int** | The height in pixels of this static field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | A unique id for the static field. | [optional] +**Name** | **string** | The name of the static field. | [optional] +**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | [optional] +**Y** | **int** | The vertical offset in pixels for this static field. | [optional] +**Width** | **int** | The width in pixels of this static field. | [optional] +**Height** | **int** | The height in pixels of this static field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "initials"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md index e73fa66a8..a13dc60d2 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | -**Name** | **string** | The name of the static field. | -**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | -**Y** | **int** | The vertical offset in pixels for this static field. | -**Width** | **int** | The width in pixels of this static field. | -**Height** | **int** | The height in pixels of this static field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | A unique id for the static field. | [optional] +**Name** | **string** | The name of the static field. | [optional] +**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | [optional] +**Y** | **int** | The vertical offset in pixels for this static field. | [optional] +**Width** | **int** | The width in pixels of this static field. | [optional] +**Height** | **int** | The height in pixels of this static field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "radio"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md index 6900f646f..7d2481d97 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | -**Name** | **string** | The name of the static field. | -**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | -**Y** | **int** | The vertical offset in pixels for this static field. | -**Width** | **int** | The width in pixels of this static field. | -**Height** | **int** | The height in pixels of this static field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | A unique id for the static field. | [optional] +**Name** | **string** | The name of the static field. | [optional] +**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | [optional] +**Y** | **int** | The vertical offset in pixels for this static field. | [optional] +**Width** | **int** | The width in pixels of this static field. | [optional] +**Height** | **int** | The height in pixels of this static field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "signature"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md index 8ec627f04..b44f3f3e4 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | -**Name** | **string** | The name of the static field. | -**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | -**Y** | **int** | The vertical offset in pixels for this static field. | -**Width** | **int** | The width in pixels of this static field. | -**Height** | **int** | The height in pixels of this static field. | -**Required** | **bool** | Boolean showing whether or not this field is required. | +**ApiId** | **string** | A unique id for the static field. | [optional] +**Name** | **string** | The name of the static field. | [optional] +**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | [optional] +**Y** | **int** | The vertical offset in pixels for this static field. | [optional] +**Width** | **int** | The width in pixels of this static field. | [optional] +**Height** | **int** | The height in pixels of this static field. | [optional] +**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "text"] diff --git a/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md b/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md index 58559eab7..a2773f068 100644 --- a/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md @@ -5,7 +5,7 @@ Average text length in this field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**NumLines** | **int** | Number of lines. | **NumCharsPerLine** | **int** | Number of characters per line. | +**NumLines** | **int** | Number of lines. | [optional] **NumCharsPerLine** | **int** | Number of characters per line. | [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/TemplateResponseSignerRole.md b/sdks/dotnet/docs/TemplateResponseSignerRole.md index 8a1fe3d5e..ddead2a48 100644 --- a/sdks/dotnet/docs/TemplateResponseSignerRole.md +++ b/sdks/dotnet/docs/TemplateResponseSignerRole.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the Role. | **Order** | **int** | If signer order is assigned this is the 0-based index for this role. | [optional] +**Name** | **string** | The name of the Role. | [optional] **Order** | **int** | If signer order is assigned this is the 0-based index for this role. | [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/TemplateUpdateFilesResponseTemplate.md b/sdks/dotnet/docs/TemplateUpdateFilesResponseTemplate.md index c057d7d3a..390961e68 100644 --- a/sdks/dotnet/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/dotnet/docs/TemplateUpdateFilesResponseTemplate.md @@ -5,7 +5,7 @@ Contains template id Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**TemplateId** | **string** | The id of the Template. | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponse.cs index a1bfc7b45..f4e1da05a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponse.cs @@ -42,52 +42,27 @@ protected ApiAppResponse() { } /// Initializes a new instance of the class. /// /// The app's callback URL (for events). - /// The app's client id (required). - /// The time that the app was created (required). - /// The domain name(s) associated with the app (required). - /// The name of the app (required). - /// Boolean to indicate if the app has been approved (required). + /// The app's client id. + /// The time that the app was created. + /// The domain name(s) associated with the app. + /// The name of the app. + /// Boolean to indicate if the app has been approved. /// oauth. - /// options (required). - /// ownerAccount (required). + /// options. + /// ownerAccount. /// whiteLabelingOptions. public ApiAppResponse(string callbackUrl = default(string), string clientId = default(string), int createdAt = default(int), List domains = default(List), string name = default(string), bool isApproved = default(bool), ApiAppResponseOAuth oauth = default(ApiAppResponseOAuth), ApiAppResponseOptions options = default(ApiAppResponseOptions), ApiAppResponseOwnerAccount ownerAccount = default(ApiAppResponseOwnerAccount), ApiAppResponseWhiteLabelingOptions whiteLabelingOptions = default(ApiAppResponseWhiteLabelingOptions)) { - // to ensure "clientId" is required (not null) - if (clientId == null) - { - throw new ArgumentNullException("clientId is a required property for ApiAppResponse and cannot be null"); - } + this.CallbackUrl = callbackUrl; this.ClientId = clientId; this.CreatedAt = createdAt; - // to ensure "domains" is required (not null) - if (domains == null) - { - throw new ArgumentNullException("domains is a required property for ApiAppResponse and cannot be null"); - } this.Domains = domains; - // to ensure "name" is required (not null) - if (name == null) - { - throw new ArgumentNullException("name is a required property for ApiAppResponse and cannot be null"); - } this.Name = name; this.IsApproved = isApproved; - // to ensure "options" is required (not null) - if (options == null) - { - throw new ArgumentNullException("options is a required property for ApiAppResponse and cannot be null"); - } + this.Oauth = oauth; this.Options = options; - // to ensure "ownerAccount" is required (not null) - if (ownerAccount == null) - { - throw new ArgumentNullException("ownerAccount is a required property for ApiAppResponse and cannot be null"); - } this.OwnerAccount = ownerAccount; - this.CallbackUrl = callbackUrl; - this.Oauth = oauth; this.WhiteLabelingOptions = whiteLabelingOptions; } @@ -107,66 +82,66 @@ public static ApiAppResponse Init(string jsonData) return obj; } + /// + /// The app's callback URL (for events) + /// + /// The app's callback URL (for events) + [DataMember(Name = "callback_url", EmitDefaultValue = true)] + public string CallbackUrl { get; set; } + /// /// The app's client id /// /// The app's client id - [DataMember(Name = "client_id", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "client_id", EmitDefaultValue = true)] public string ClientId { get; set; } /// /// The time that the app was created /// /// The time that the app was created - [DataMember(Name = "created_at", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "created_at", EmitDefaultValue = true)] public int CreatedAt { get; set; } /// /// The domain name(s) associated with the app /// /// The domain name(s) associated with the app - [DataMember(Name = "domains", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "domains", EmitDefaultValue = true)] public List Domains { get; set; } /// /// The name of the app /// /// The name of the app - [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// /// Boolean to indicate if the app has been approved /// /// Boolean to indicate if the app has been approved - [DataMember(Name = "is_approved", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "is_approved", EmitDefaultValue = true)] public bool IsApproved { get; set; } + /// + /// Gets or Sets Oauth + /// + [DataMember(Name = "oauth", EmitDefaultValue = true)] + public ApiAppResponseOAuth Oauth { get; set; } + /// /// Gets or Sets Options /// - [DataMember(Name = "options", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "options", EmitDefaultValue = true)] public ApiAppResponseOptions Options { get; set; } /// /// Gets or Sets OwnerAccount /// - [DataMember(Name = "owner_account", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "owner_account", EmitDefaultValue = true)] public ApiAppResponseOwnerAccount OwnerAccount { get; set; } - /// - /// The app's callback URL (for events) - /// - /// The app's callback URL (for events) - [DataMember(Name = "callback_url", EmitDefaultValue = true)] - public string CallbackUrl { get; set; } - - /// - /// Gets or Sets Oauth - /// - [DataMember(Name = "oauth", EmitDefaultValue = true)] - public ApiAppResponseOAuth Oauth { get; set; } - /// /// Gets or Sets WhiteLabelingOptions /// @@ -181,15 +156,15 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class ApiAppResponse {\n"); + sb.Append(" CallbackUrl: ").Append(CallbackUrl).Append("\n"); sb.Append(" ClientId: ").Append(ClientId).Append("\n"); sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" Domains: ").Append(Domains).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); sb.Append(" IsApproved: ").Append(IsApproved).Append("\n"); + sb.Append(" Oauth: ").Append(Oauth).Append("\n"); sb.Append(" Options: ").Append(Options).Append("\n"); sb.Append(" OwnerAccount: ").Append(OwnerAccount).Append("\n"); - sb.Append(" CallbackUrl: ").Append(CallbackUrl).Append("\n"); - sb.Append(" Oauth: ").Append(Oauth).Append("\n"); sb.Append(" WhiteLabelingOptions: ").Append(WhiteLabelingOptions).Append("\n"); sb.Append("}\n"); return sb.ToString(); @@ -226,6 +201,11 @@ public bool Equals(ApiAppResponse input) return false; } return + ( + this.CallbackUrl == input.CallbackUrl || + (this.CallbackUrl != null && + this.CallbackUrl.Equals(input.CallbackUrl)) + ) && ( this.ClientId == input.ClientId || (this.ClientId != null && @@ -250,6 +230,11 @@ public bool Equals(ApiAppResponse input) this.IsApproved == input.IsApproved || this.IsApproved.Equals(input.IsApproved) ) && + ( + this.Oauth == input.Oauth || + (this.Oauth != null && + this.Oauth.Equals(input.Oauth)) + ) && ( this.Options == input.Options || (this.Options != null && @@ -260,16 +245,6 @@ public bool Equals(ApiAppResponse input) (this.OwnerAccount != null && this.OwnerAccount.Equals(input.OwnerAccount)) ) && - ( - this.CallbackUrl == input.CallbackUrl || - (this.CallbackUrl != null && - this.CallbackUrl.Equals(input.CallbackUrl)) - ) && - ( - this.Oauth == input.Oauth || - (this.Oauth != null && - this.Oauth.Equals(input.Oauth)) - ) && ( this.WhiteLabelingOptions == input.WhiteLabelingOptions || (this.WhiteLabelingOptions != null && @@ -286,6 +261,10 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; + if (this.CallbackUrl != null) + { + hashCode = (hashCode * 59) + this.CallbackUrl.GetHashCode(); + } if (this.ClientId != null) { hashCode = (hashCode * 59) + this.ClientId.GetHashCode(); @@ -300,6 +279,10 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Name.GetHashCode(); } hashCode = (hashCode * 59) + this.IsApproved.GetHashCode(); + if (this.Oauth != null) + { + hashCode = (hashCode * 59) + this.Oauth.GetHashCode(); + } if (this.Options != null) { hashCode = (hashCode * 59) + this.Options.GetHashCode(); @@ -308,14 +291,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.OwnerAccount.GetHashCode(); } - if (this.CallbackUrl != null) - { - hashCode = (hashCode * 59) + this.CallbackUrl.GetHashCode(); - } - if (this.Oauth != null) - { - hashCode = (hashCode * 59) + this.Oauth.GetHashCode(); - } if (this.WhiteLabelingOptions != null) { hashCode = (hashCode * 59) + this.WhiteLabelingOptions.GetHashCode(); @@ -337,6 +312,13 @@ public List GetOpenApiTypes() { var types = new List(); types.Add(new OpenApiType() + { + Name = "callback_url", + Property = "CallbackUrl", + Type = "string", + Value = CallbackUrl, + }); + types.Add(new OpenApiType() { Name = "client_id", Property = "ClientId", @@ -372,6 +354,13 @@ public List GetOpenApiTypes() Value = IsApproved, }); types.Add(new OpenApiType() + { + Name = "oauth", + Property = "Oauth", + Type = "ApiAppResponseOAuth", + Value = Oauth, + }); + types.Add(new OpenApiType() { Name = "options", Property = "Options", @@ -386,20 +375,6 @@ public List GetOpenApiTypes() Value = OwnerAccount, }); types.Add(new OpenApiType() - { - Name = "callback_url", - Property = "CallbackUrl", - Type = "string", - Value = CallbackUrl, - }); - types.Add(new OpenApiType() - { - Name = "oauth", - Property = "Oauth", - Type = "ApiAppResponseOAuth", - Value = Oauth, - }); - types.Add(new OpenApiType() { Name = "white_labeling_options", Property = "WhiteLabelingOptions", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOAuth.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOAuth.cs index cb35f5013..d5ceebef6 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOAuth.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOAuth.cs @@ -41,27 +41,17 @@ protected ApiAppResponseOAuth() { } /// /// Initializes a new instance of the class. /// - /// The app's OAuth callback URL. (required). + /// The app's OAuth callback URL.. /// The app's OAuth secret, or null if the app does not belong to user.. - /// Array of OAuth scopes used by the app. (required). - /// Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. (required). + /// Array of OAuth scopes used by the app.. + /// Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.. public ApiAppResponseOAuth(string callbackUrl = default(string), string secret = default(string), List scopes = default(List), bool chargesUsers = default(bool)) { - // to ensure "callbackUrl" is required (not null) - if (callbackUrl == null) - { - throw new ArgumentNullException("callbackUrl is a required property for ApiAppResponseOAuth and cannot be null"); - } this.CallbackUrl = callbackUrl; - // to ensure "scopes" is required (not null) - if (scopes == null) - { - throw new ArgumentNullException("scopes is a required property for ApiAppResponseOAuth and cannot be null"); - } + this.Secret = secret; this.Scopes = scopes; this.ChargesUsers = chargesUsers; - this.Secret = secret; } /// @@ -84,30 +74,30 @@ public static ApiAppResponseOAuth Init(string jsonData) /// The app's OAuth callback URL. /// /// The app's OAuth callback URL. - [DataMember(Name = "callback_url", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "callback_url", EmitDefaultValue = true)] public string CallbackUrl { get; set; } + /// + /// The app's OAuth secret, or null if the app does not belong to user. + /// + /// The app's OAuth secret, or null if the app does not belong to user. + [DataMember(Name = "secret", EmitDefaultValue = true)] + public string Secret { get; set; } + /// /// Array of OAuth scopes used by the app. /// /// Array of OAuth scopes used by the app. - [DataMember(Name = "scopes", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "scopes", EmitDefaultValue = true)] public List Scopes { get; set; } /// /// Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. /// /// Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. - [DataMember(Name = "charges_users", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "charges_users", EmitDefaultValue = true)] public bool ChargesUsers { get; set; } - /// - /// The app's OAuth secret, or null if the app does not belong to user. - /// - /// The app's OAuth secret, or null if the app does not belong to user. - [DataMember(Name = "secret", EmitDefaultValue = true)] - public string Secret { get; set; } - /// /// Returns the string presentation of the object /// @@ -117,9 +107,9 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class ApiAppResponseOAuth {\n"); sb.Append(" CallbackUrl: ").Append(CallbackUrl).Append("\n"); + sb.Append(" Secret: ").Append(Secret).Append("\n"); sb.Append(" Scopes: ").Append(Scopes).Append("\n"); sb.Append(" ChargesUsers: ").Append(ChargesUsers).Append("\n"); - sb.Append(" Secret: ").Append(Secret).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -160,6 +150,11 @@ public bool Equals(ApiAppResponseOAuth input) (this.CallbackUrl != null && this.CallbackUrl.Equals(input.CallbackUrl)) ) && + ( + this.Secret == input.Secret || + (this.Secret != null && + this.Secret.Equals(input.Secret)) + ) && ( this.Scopes == input.Scopes || this.Scopes != null && @@ -169,11 +164,6 @@ public bool Equals(ApiAppResponseOAuth input) ( this.ChargesUsers == input.ChargesUsers || this.ChargesUsers.Equals(input.ChargesUsers) - ) && - ( - this.Secret == input.Secret || - (this.Secret != null && - this.Secret.Equals(input.Secret)) ); } @@ -190,15 +180,15 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.CallbackUrl.GetHashCode(); } + if (this.Secret != null) + { + hashCode = (hashCode * 59) + this.Secret.GetHashCode(); + } if (this.Scopes != null) { hashCode = (hashCode * 59) + this.Scopes.GetHashCode(); } hashCode = (hashCode * 59) + this.ChargesUsers.GetHashCode(); - if (this.Secret != null) - { - hashCode = (hashCode * 59) + this.Secret.GetHashCode(); - } return hashCode; } } @@ -223,6 +213,13 @@ public List GetOpenApiTypes() Value = CallbackUrl, }); types.Add(new OpenApiType() + { + Name = "secret", + Property = "Secret", + Type = "string", + Value = Secret, + }); + types.Add(new OpenApiType() { Name = "scopes", Property = "Scopes", @@ -236,13 +233,6 @@ public List GetOpenApiTypes() Type = "bool", Value = ChargesUsers, }); - types.Add(new OpenApiType() - { - Name = "secret", - Property = "Secret", - Type = "string", - Value = Secret, - }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOptions.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOptions.cs index 345f572dc..10d6df91a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOptions.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOptions.cs @@ -41,7 +41,7 @@ protected ApiAppResponseOptions() { } /// /// Initializes a new instance of the class. /// - /// Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document (required). + /// Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document. public ApiAppResponseOptions(bool canInsertEverywhere = default(bool)) { @@ -68,7 +68,7 @@ public static ApiAppResponseOptions Init(string jsonData) /// Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document /// /// Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document - [DataMember(Name = "can_insert_everywhere", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "can_insert_everywhere", EmitDefaultValue = true)] public bool CanInsertEverywhere { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOwnerAccount.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOwnerAccount.cs index 284dc155e..efb47222d 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOwnerAccount.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOwnerAccount.cs @@ -41,22 +41,12 @@ protected ApiAppResponseOwnerAccount() { } /// /// Initializes a new instance of the class. /// - /// The owner account's ID (required). - /// The owner account's email address (required). + /// The owner account's ID. + /// The owner account's email address. public ApiAppResponseOwnerAccount(string accountId = default(string), string emailAddress = default(string)) { - // to ensure "accountId" is required (not null) - if (accountId == null) - { - throw new ArgumentNullException("accountId is a required property for ApiAppResponseOwnerAccount and cannot be null"); - } this.AccountId = accountId; - // to ensure "emailAddress" is required (not null) - if (emailAddress == null) - { - throw new ArgumentNullException("emailAddress is a required property for ApiAppResponseOwnerAccount and cannot be null"); - } this.EmailAddress = emailAddress; } @@ -80,14 +70,14 @@ public static ApiAppResponseOwnerAccount Init(string jsonData) /// The owner account's ID /// /// The owner account's ID - [DataMember(Name = "account_id", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "account_id", EmitDefaultValue = true)] public string AccountId { get; set; } /// /// The owner account's email address /// /// The owner account's email address - [DataMember(Name = "email_address", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "email_address", EmitDefaultValue = true)] public string EmailAddress { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseWhiteLabelingOptions.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseWhiteLabelingOptions.cs index 005d6b50f..095ef8e70 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseWhiteLabelingOptions.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseWhiteLabelingOptions.cs @@ -41,106 +41,36 @@ protected ApiAppResponseWhiteLabelingOptions() { } /// /// Initializes a new instance of the class. /// - /// headerBackgroundColor (required). - /// legalVersion (required). - /// linkColor (required). - /// pageBackgroundColor (required). - /// primaryButtonColor (required). - /// primaryButtonColorHover (required). - /// primaryButtonTextColor (required). - /// primaryButtonTextColorHover (required). - /// secondaryButtonColor (required). - /// secondaryButtonColorHover (required). - /// secondaryButtonTextColor (required). - /// secondaryButtonTextColorHover (required). - /// textColor1 (required). - /// textColor2 (required). + /// headerBackgroundColor. + /// legalVersion. + /// linkColor. + /// pageBackgroundColor. + /// primaryButtonColor. + /// primaryButtonColorHover. + /// primaryButtonTextColor. + /// primaryButtonTextColorHover. + /// secondaryButtonColor. + /// secondaryButtonColorHover. + /// secondaryButtonTextColor. + /// secondaryButtonTextColorHover. + /// textColor1. + /// textColor2. public ApiAppResponseWhiteLabelingOptions(string headerBackgroundColor = default(string), string legalVersion = default(string), string linkColor = default(string), string pageBackgroundColor = default(string), string primaryButtonColor = default(string), string primaryButtonColorHover = default(string), string primaryButtonTextColor = default(string), string primaryButtonTextColorHover = default(string), string secondaryButtonColor = default(string), string secondaryButtonColorHover = default(string), string secondaryButtonTextColor = default(string), string secondaryButtonTextColorHover = default(string), string textColor1 = default(string), string textColor2 = default(string)) { - // to ensure "headerBackgroundColor" is required (not null) - if (headerBackgroundColor == null) - { - throw new ArgumentNullException("headerBackgroundColor is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); - } this.HeaderBackgroundColor = headerBackgroundColor; - // to ensure "legalVersion" is required (not null) - if (legalVersion == null) - { - throw new ArgumentNullException("legalVersion is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); - } this.LegalVersion = legalVersion; - // to ensure "linkColor" is required (not null) - if (linkColor == null) - { - throw new ArgumentNullException("linkColor is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); - } this.LinkColor = linkColor; - // to ensure "pageBackgroundColor" is required (not null) - if (pageBackgroundColor == null) - { - throw new ArgumentNullException("pageBackgroundColor is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); - } this.PageBackgroundColor = pageBackgroundColor; - // to ensure "primaryButtonColor" is required (not null) - if (primaryButtonColor == null) - { - throw new ArgumentNullException("primaryButtonColor is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); - } this.PrimaryButtonColor = primaryButtonColor; - // to ensure "primaryButtonColorHover" is required (not null) - if (primaryButtonColorHover == null) - { - throw new ArgumentNullException("primaryButtonColorHover is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); - } this.PrimaryButtonColorHover = primaryButtonColorHover; - // to ensure "primaryButtonTextColor" is required (not null) - if (primaryButtonTextColor == null) - { - throw new ArgumentNullException("primaryButtonTextColor is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); - } this.PrimaryButtonTextColor = primaryButtonTextColor; - // to ensure "primaryButtonTextColorHover" is required (not null) - if (primaryButtonTextColorHover == null) - { - throw new ArgumentNullException("primaryButtonTextColorHover is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); - } this.PrimaryButtonTextColorHover = primaryButtonTextColorHover; - // to ensure "secondaryButtonColor" is required (not null) - if (secondaryButtonColor == null) - { - throw new ArgumentNullException("secondaryButtonColor is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); - } this.SecondaryButtonColor = secondaryButtonColor; - // to ensure "secondaryButtonColorHover" is required (not null) - if (secondaryButtonColorHover == null) - { - throw new ArgumentNullException("secondaryButtonColorHover is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); - } this.SecondaryButtonColorHover = secondaryButtonColorHover; - // to ensure "secondaryButtonTextColor" is required (not null) - if (secondaryButtonTextColor == null) - { - throw new ArgumentNullException("secondaryButtonTextColor is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); - } this.SecondaryButtonTextColor = secondaryButtonTextColor; - // to ensure "secondaryButtonTextColorHover" is required (not null) - if (secondaryButtonTextColorHover == null) - { - throw new ArgumentNullException("secondaryButtonTextColorHover is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); - } this.SecondaryButtonTextColorHover = secondaryButtonTextColorHover; - // to ensure "textColor1" is required (not null) - if (textColor1 == null) - { - throw new ArgumentNullException("textColor1 is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); - } this.TextColor1 = textColor1; - // to ensure "textColor2" is required (not null) - if (textColor2 == null) - { - throw new ArgumentNullException("textColor2 is a required property for ApiAppResponseWhiteLabelingOptions and cannot be null"); - } this.TextColor2 = textColor2; } @@ -163,85 +93,85 @@ public static ApiAppResponseWhiteLabelingOptions Init(string jsonData) /// /// Gets or Sets HeaderBackgroundColor /// - [DataMember(Name = "header_background_color", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "header_background_color", EmitDefaultValue = true)] public string HeaderBackgroundColor { get; set; } /// /// Gets or Sets LegalVersion /// - [DataMember(Name = "legal_version", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "legal_version", EmitDefaultValue = true)] public string LegalVersion { get; set; } /// /// Gets or Sets LinkColor /// - [DataMember(Name = "link_color", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "link_color", EmitDefaultValue = true)] public string LinkColor { get; set; } /// /// Gets or Sets PageBackgroundColor /// - [DataMember(Name = "page_background_color", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "page_background_color", EmitDefaultValue = true)] public string PageBackgroundColor { get; set; } /// /// Gets or Sets PrimaryButtonColor /// - [DataMember(Name = "primary_button_color", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "primary_button_color", EmitDefaultValue = true)] public string PrimaryButtonColor { get; set; } /// /// Gets or Sets PrimaryButtonColorHover /// - [DataMember(Name = "primary_button_color_hover", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "primary_button_color_hover", EmitDefaultValue = true)] public string PrimaryButtonColorHover { get; set; } /// /// Gets or Sets PrimaryButtonTextColor /// - [DataMember(Name = "primary_button_text_color", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "primary_button_text_color", EmitDefaultValue = true)] public string PrimaryButtonTextColor { get; set; } /// /// Gets or Sets PrimaryButtonTextColorHover /// - [DataMember(Name = "primary_button_text_color_hover", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "primary_button_text_color_hover", EmitDefaultValue = true)] public string PrimaryButtonTextColorHover { get; set; } /// /// Gets or Sets SecondaryButtonColor /// - [DataMember(Name = "secondary_button_color", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "secondary_button_color", EmitDefaultValue = true)] public string SecondaryButtonColor { get; set; } /// /// Gets or Sets SecondaryButtonColorHover /// - [DataMember(Name = "secondary_button_color_hover", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "secondary_button_color_hover", EmitDefaultValue = true)] public string SecondaryButtonColorHover { get; set; } /// /// Gets or Sets SecondaryButtonTextColor /// - [DataMember(Name = "secondary_button_text_color", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "secondary_button_text_color", EmitDefaultValue = true)] public string SecondaryButtonTextColor { get; set; } /// /// Gets or Sets SecondaryButtonTextColorHover /// - [DataMember(Name = "secondary_button_text_color_hover", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "secondary_button_text_color_hover", EmitDefaultValue = true)] public string SecondaryButtonTextColorHover { get; set; } /// /// Gets or Sets TextColor1 /// - [DataMember(Name = "text_color1", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "text_color1", EmitDefaultValue = true)] public string TextColor1 { get; set; } /// /// Gets or Sets TextColor2 /// - [DataMember(Name = "text_color2", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "text_color2", EmitDefaultValue = true)] public string TextColor2 { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobResponse.cs index c643f4077..ee798bc24 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobResponse.cs @@ -41,18 +41,13 @@ protected BulkSendJobResponse() { } /// /// Initializes a new instance of the class. /// - /// The id of the BulkSendJob. (required). - /// The total amount of Signature Requests queued for sending. (required). - /// True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. (required). - /// Time that the BulkSendJob was created. (required). + /// The id of the BulkSendJob.. + /// The total amount of Signature Requests queued for sending.. + /// True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member.. + /// Time that the BulkSendJob was created.. public BulkSendJobResponse(string bulkSendJobId = default(string), int total = default(int), bool isCreator = default(bool), int createdAt = default(int)) { - // to ensure "bulkSendJobId" is required (not null) - if (bulkSendJobId == null) - { - throw new ArgumentNullException("bulkSendJobId is a required property for BulkSendJobResponse and cannot be null"); - } this.BulkSendJobId = bulkSendJobId; this.Total = total; this.IsCreator = isCreator; @@ -79,28 +74,28 @@ public static BulkSendJobResponse Init(string jsonData) /// The id of the BulkSendJob. /// /// The id of the BulkSendJob. - [DataMember(Name = "bulk_send_job_id", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "bulk_send_job_id", EmitDefaultValue = true)] public string BulkSendJobId { get; set; } /// /// The total amount of Signature Requests queued for sending. /// /// The total amount of Signature Requests queued for sending. - [DataMember(Name = "total", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "total", EmitDefaultValue = true)] public int Total { get; set; } /// /// True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. /// /// True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. - [DataMember(Name = "is_creator", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "is_creator", EmitDefaultValue = true)] public bool IsCreator { get; set; } /// /// Time that the BulkSendJob was created. /// /// Time that the BulkSendJob was created. - [DataMember(Name = "created_at", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "created_at", EmitDefaultValue = true)] public int CreatedAt { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineResponseFaxLine.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineResponseFaxLine.cs index c2261e452..f52374953 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineResponseFaxLine.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineResponseFaxLine.cs @@ -41,26 +41,16 @@ protected FaxLineResponseFaxLine() { } /// /// Initializes a new instance of the class. /// - /// Number (required). - /// Created at (required). - /// Updated at (required). - /// accounts (required). + /// Number. + /// Created at. + /// Updated at. + /// accounts. public FaxLineResponseFaxLine(string number = default(string), int createdAt = default(int), int updatedAt = default(int), List accounts = default(List)) { - // to ensure "number" is required (not null) - if (number == null) - { - throw new ArgumentNullException("number is a required property for FaxLineResponseFaxLine and cannot be null"); - } this.Number = number; this.CreatedAt = createdAt; this.UpdatedAt = updatedAt; - // to ensure "accounts" is required (not null) - if (accounts == null) - { - throw new ArgumentNullException("accounts is a required property for FaxLineResponseFaxLine and cannot be null"); - } this.Accounts = accounts; } @@ -84,27 +74,27 @@ public static FaxLineResponseFaxLine Init(string jsonData) /// Number /// /// Number - [DataMember(Name = "number", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "number", EmitDefaultValue = true)] public string Number { get; set; } /// /// Created at /// /// Created at - [DataMember(Name = "created_at", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "created_at", EmitDefaultValue = true)] public int CreatedAt { get; set; } /// /// Updated at /// /// Updated at - [DataMember(Name = "updated_at", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "updated_at", EmitDefaultValue = true)] public int UpdatedAt { get; set; } /// /// Gets or Sets Accounts /// - [DataMember(Name = "accounts", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "accounts", EmitDefaultValue = true)] public List Accounts { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs index 11b18b70a..56d78eb53 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs @@ -41,36 +41,16 @@ protected TeamResponse() { } /// /// Initializes a new instance of the class. /// - /// The name of your Team (required). - /// accounts (required). - /// A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. (required). - /// A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. (required). + /// The name of your Team. + /// accounts. + /// A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`.. + /// A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account.. public TeamResponse(string name = default(string), List accounts = default(List), List invitedAccounts = default(List), List invitedEmails = default(List)) { - // to ensure "name" is required (not null) - if (name == null) - { - throw new ArgumentNullException("name is a required property for TeamResponse and cannot be null"); - } this.Name = name; - // to ensure "accounts" is required (not null) - if (accounts == null) - { - throw new ArgumentNullException("accounts is a required property for TeamResponse and cannot be null"); - } this.Accounts = accounts; - // to ensure "invitedAccounts" is required (not null) - if (invitedAccounts == null) - { - throw new ArgumentNullException("invitedAccounts is a required property for TeamResponse and cannot be null"); - } this.InvitedAccounts = invitedAccounts; - // to ensure "invitedEmails" is required (not null) - if (invitedEmails == null) - { - throw new ArgumentNullException("invitedEmails is a required property for TeamResponse and cannot be null"); - } this.InvitedEmails = invitedEmails; } @@ -94,27 +74,27 @@ public static TeamResponse Init(string jsonData) /// The name of your Team /// /// The name of your Team - [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// /// Gets or Sets Accounts /// - [DataMember(Name = "accounts", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "accounts", EmitDefaultValue = true)] public List Accounts { get; set; } /// /// A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. /// /// A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. - [DataMember(Name = "invited_accounts", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "invited_accounts", EmitDefaultValue = true)] public List InvitedAccounts { get; set; } /// /// A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. /// /// A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. - [DataMember(Name = "invited_emails", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "invited_emails", EmitDefaultValue = true)] public List InvitedEmails { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs index db713a0e3..fb8ca4762 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs @@ -41,24 +41,14 @@ protected TemplateCreateEmbeddedDraftResponseTemplate() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template. (required). - /// Link to edit the template. (required). - /// When the link expires. (required). + /// The id of the Template.. + /// Link to edit the template.. + /// When the link expires.. /// A list of warnings.. public TemplateCreateEmbeddedDraftResponseTemplate(string templateId = default(string), string editUrl = default(string), int expiresAt = default(int), List warnings = default(List)) { - // to ensure "templateId" is required (not null) - if (templateId == null) - { - throw new ArgumentNullException("templateId is a required property for TemplateCreateEmbeddedDraftResponseTemplate and cannot be null"); - } this.TemplateId = templateId; - // to ensure "editUrl" is required (not null) - if (editUrl == null) - { - throw new ArgumentNullException("editUrl is a required property for TemplateCreateEmbeddedDraftResponseTemplate and cannot be null"); - } this.EditUrl = editUrl; this.ExpiresAt = expiresAt; this.Warnings = warnings; @@ -84,21 +74,21 @@ public static TemplateCreateEmbeddedDraftResponseTemplate Init(string jsonData) /// The id of the Template. /// /// The id of the Template. - [DataMember(Name = "template_id", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "template_id", EmitDefaultValue = true)] public string TemplateId { get; set; } /// /// Link to edit the template. /// /// Link to edit the template. - [DataMember(Name = "edit_url", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "edit_url", EmitDefaultValue = true)] public string EditUrl { get; set; } /// /// When the link expires. /// /// When the link expires. - [DataMember(Name = "expires_at", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "expires_at", EmitDefaultValue = true)] public int ExpiresAt { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs index 1ad97711a..1c362dd91 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs @@ -41,15 +41,10 @@ protected TemplateCreateResponseTemplate() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template. (required). + /// The id of the Template.. public TemplateCreateResponseTemplate(string templateId = default(string)) { - // to ensure "templateId" is required (not null) - if (templateId == null) - { - throw new ArgumentNullException("templateId is a required property for TemplateCreateResponseTemplate and cannot be null"); - } this.TemplateId = templateId; } @@ -73,7 +68,7 @@ public static TemplateCreateResponseTemplate Init(string jsonData) /// The id of the Template. /// /// The id of the Template. - [DataMember(Name = "template_id", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "template_id", EmitDefaultValue = true)] public string TemplateId { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs index 9a96d947e..f0124cc90 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs @@ -41,86 +41,41 @@ protected TemplateResponse() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template. (required). - /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. (required). - /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. (required). + /// The id of the Template.. + /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.. + /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.. /// Time the template was last updated.. /// `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.. - /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member. (required). - /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). (required). - /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. (required). - /// The metadata attached to the template. (required). - /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. (required). - /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. (required). - /// An array describing each document associated with this Template. Includes form field data for each document. (required). + /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member.. + /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).. + /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.. + /// The metadata attached to the template.. + /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.. + /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.. + /// An array describing each document associated with this Template. Includes form field data for each document.. /// Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.. /// Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.. - /// An array of the Accounts that can use this Template. (required). - /// Signer attachments. (required). + /// An array of the Accounts that can use this Template.. + /// Signer attachments.. public TemplateResponse(string templateId = default(string), string title = default(string), string message = default(string), int updatedAt = default(int), bool? isEmbedded = default(bool?), bool isCreator = default(bool), bool canEdit = default(bool), bool isLocked = default(bool), Object metadata = default(Object), List signerRoles = default(List), List ccRoles = default(List), List documents = default(List), List customFields = default(List), List namedFormFields = default(List), List accounts = default(List), List attachments = default(List)) { - // to ensure "templateId" is required (not null) - if (templateId == null) - { - throw new ArgumentNullException("templateId is a required property for TemplateResponse and cannot be null"); - } this.TemplateId = templateId; - // to ensure "title" is required (not null) - if (title == null) - { - throw new ArgumentNullException("title is a required property for TemplateResponse and cannot be null"); - } this.Title = title; - // to ensure "message" is required (not null) - if (message == null) - { - throw new ArgumentNullException("message is a required property for TemplateResponse and cannot be null"); - } this.Message = message; + this.UpdatedAt = updatedAt; + this.IsEmbedded = isEmbedded; this.IsCreator = isCreator; this.CanEdit = canEdit; this.IsLocked = isLocked; - // to ensure "metadata" is required (not null) - if (metadata == null) - { - throw new ArgumentNullException("metadata is a required property for TemplateResponse and cannot be null"); - } this.Metadata = metadata; - // to ensure "signerRoles" is required (not null) - if (signerRoles == null) - { - throw new ArgumentNullException("signerRoles is a required property for TemplateResponse and cannot be null"); - } this.SignerRoles = signerRoles; - // to ensure "ccRoles" is required (not null) - if (ccRoles == null) - { - throw new ArgumentNullException("ccRoles is a required property for TemplateResponse and cannot be null"); - } this.CcRoles = ccRoles; - // to ensure "documents" is required (not null) - if (documents == null) - { - throw new ArgumentNullException("documents is a required property for TemplateResponse and cannot be null"); - } this.Documents = documents; - // to ensure "accounts" is required (not null) - if (accounts == null) - { - throw new ArgumentNullException("accounts is a required property for TemplateResponse and cannot be null"); - } - this.Accounts = accounts; - // to ensure "attachments" is required (not null) - if (attachments == null) - { - throw new ArgumentNullException("attachments is a required property for TemplateResponse and cannot be null"); - } - this.Attachments = attachments; - this.UpdatedAt = updatedAt; - this.IsEmbedded = isEmbedded; this.CustomFields = customFields; this.NamedFormFields = namedFormFields; + this.Accounts = accounts; + this.Attachments = attachments; } /// @@ -143,100 +98,86 @@ public static TemplateResponse Init(string jsonData) /// The id of the Template. /// /// The id of the Template. - [DataMember(Name = "template_id", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "template_id", EmitDefaultValue = true)] public string TemplateId { get; set; } /// /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. /// /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. - [DataMember(Name = "title", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "title", EmitDefaultValue = true)] public string Title { get; set; } /// /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. /// /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. - [DataMember(Name = "message", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "message", EmitDefaultValue = true)] public string Message { get; set; } + /// + /// Time the template was last updated. + /// + /// Time the template was last updated. + [DataMember(Name = "updated_at", EmitDefaultValue = true)] + public int UpdatedAt { get; set; } + + /// + /// `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + /// + /// `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + [DataMember(Name = "is_embedded", EmitDefaultValue = true)] + public bool? IsEmbedded { get; set; } + /// /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member. /// /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member. - [DataMember(Name = "is_creator", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "is_creator", EmitDefaultValue = true)] public bool IsCreator { get; set; } /// /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). /// /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). - [DataMember(Name = "can_edit", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "can_edit", EmitDefaultValue = true)] public bool CanEdit { get; set; } /// /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. /// /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. - [DataMember(Name = "is_locked", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "is_locked", EmitDefaultValue = true)] public bool IsLocked { get; set; } /// /// The metadata attached to the template. /// /// The metadata attached to the template. - [DataMember(Name = "metadata", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "metadata", EmitDefaultValue = true)] public Object Metadata { get; set; } /// /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. /// /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. - [DataMember(Name = "signer_roles", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "signer_roles", EmitDefaultValue = true)] public List SignerRoles { get; set; } /// /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. /// /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. - [DataMember(Name = "cc_roles", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "cc_roles", EmitDefaultValue = true)] public List CcRoles { get; set; } /// /// An array describing each document associated with this Template. Includes form field data for each document. /// /// An array describing each document associated with this Template. Includes form field data for each document. - [DataMember(Name = "documents", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "documents", EmitDefaultValue = true)] public List Documents { get; set; } - /// - /// An array of the Accounts that can use this Template. - /// - /// An array of the Accounts that can use this Template. - [DataMember(Name = "accounts", IsRequired = true, EmitDefaultValue = true)] - public List Accounts { get; set; } - - /// - /// Signer attachments. - /// - /// Signer attachments. - [DataMember(Name = "attachments", IsRequired = true, EmitDefaultValue = true)] - public List Attachments { get; set; } - - /// - /// Time the template was last updated. - /// - /// Time the template was last updated. - [DataMember(Name = "updated_at", EmitDefaultValue = true)] - public int UpdatedAt { get; set; } - - /// - /// `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. - /// - /// `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. - [DataMember(Name = "is_embedded", EmitDefaultValue = true)] - public bool? IsEmbedded { get; set; } - /// /// Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. /// @@ -253,6 +194,20 @@ public static TemplateResponse Init(string jsonData) [Obsolete] public List NamedFormFields { get; set; } + /// + /// An array of the Accounts that can use this Template. + /// + /// An array of the Accounts that can use this Template. + [DataMember(Name = "accounts", EmitDefaultValue = true)] + public List Accounts { get; set; } + + /// + /// Signer attachments. + /// + /// Signer attachments. + [DataMember(Name = "attachments", EmitDefaultValue = true)] + public List Attachments { get; set; } + /// /// Returns the string presentation of the object /// @@ -264,6 +219,8 @@ public override string ToString() sb.Append(" TemplateId: ").Append(TemplateId).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" Message: ").Append(Message).Append("\n"); + sb.Append(" UpdatedAt: ").Append(UpdatedAt).Append("\n"); + sb.Append(" IsEmbedded: ").Append(IsEmbedded).Append("\n"); sb.Append(" IsCreator: ").Append(IsCreator).Append("\n"); sb.Append(" CanEdit: ").Append(CanEdit).Append("\n"); sb.Append(" IsLocked: ").Append(IsLocked).Append("\n"); @@ -271,12 +228,10 @@ public override string ToString() sb.Append(" SignerRoles: ").Append(SignerRoles).Append("\n"); sb.Append(" CcRoles: ").Append(CcRoles).Append("\n"); sb.Append(" Documents: ").Append(Documents).Append("\n"); - sb.Append(" Accounts: ").Append(Accounts).Append("\n"); - sb.Append(" Attachments: ").Append(Attachments).Append("\n"); - sb.Append(" UpdatedAt: ").Append(UpdatedAt).Append("\n"); - sb.Append(" IsEmbedded: ").Append(IsEmbedded).Append("\n"); sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); sb.Append(" NamedFormFields: ").Append(NamedFormFields).Append("\n"); + sb.Append(" Accounts: ").Append(Accounts).Append("\n"); + sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -327,6 +282,15 @@ public bool Equals(TemplateResponse input) (this.Message != null && this.Message.Equals(input.Message)) ) && + ( + this.UpdatedAt == input.UpdatedAt || + this.UpdatedAt.Equals(input.UpdatedAt) + ) && + ( + this.IsEmbedded == input.IsEmbedded || + (this.IsEmbedded != null && + this.IsEmbedded.Equals(input.IsEmbedded)) + ) && ( this.IsCreator == input.IsCreator || this.IsCreator.Equals(input.IsCreator) @@ -362,27 +326,6 @@ public bool Equals(TemplateResponse input) input.Documents != null && this.Documents.SequenceEqual(input.Documents) ) && - ( - this.Accounts == input.Accounts || - this.Accounts != null && - input.Accounts != null && - this.Accounts.SequenceEqual(input.Accounts) - ) && - ( - this.Attachments == input.Attachments || - this.Attachments != null && - input.Attachments != null && - this.Attachments.SequenceEqual(input.Attachments) - ) && - ( - this.UpdatedAt == input.UpdatedAt || - this.UpdatedAt.Equals(input.UpdatedAt) - ) && - ( - this.IsEmbedded == input.IsEmbedded || - (this.IsEmbedded != null && - this.IsEmbedded.Equals(input.IsEmbedded)) - ) && ( this.CustomFields == input.CustomFields || this.CustomFields != null && @@ -394,6 +337,18 @@ public bool Equals(TemplateResponse input) this.NamedFormFields != null && input.NamedFormFields != null && this.NamedFormFields.SequenceEqual(input.NamedFormFields) + ) && + ( + this.Accounts == input.Accounts || + this.Accounts != null && + input.Accounts != null && + this.Accounts.SequenceEqual(input.Accounts) + ) && + ( + this.Attachments == input.Attachments || + this.Attachments != null && + input.Attachments != null && + this.Attachments.SequenceEqual(input.Attachments) ); } @@ -418,6 +373,11 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Message.GetHashCode(); } + hashCode = (hashCode * 59) + this.UpdatedAt.GetHashCode(); + if (this.IsEmbedded != null) + { + hashCode = (hashCode * 59) + this.IsEmbedded.GetHashCode(); + } hashCode = (hashCode * 59) + this.IsCreator.GetHashCode(); hashCode = (hashCode * 59) + this.CanEdit.GetHashCode(); hashCode = (hashCode * 59) + this.IsLocked.GetHashCode(); @@ -437,19 +397,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Documents.GetHashCode(); } - if (this.Accounts != null) - { - hashCode = (hashCode * 59) + this.Accounts.GetHashCode(); - } - if (this.Attachments != null) - { - hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); - } - hashCode = (hashCode * 59) + this.UpdatedAt.GetHashCode(); - if (this.IsEmbedded != null) - { - hashCode = (hashCode * 59) + this.IsEmbedded.GetHashCode(); - } if (this.CustomFields != null) { hashCode = (hashCode * 59) + this.CustomFields.GetHashCode(); @@ -458,6 +405,14 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.NamedFormFields.GetHashCode(); } + if (this.Accounts != null) + { + hashCode = (hashCode * 59) + this.Accounts.GetHashCode(); + } + if (this.Attachments != null) + { + hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); + } return hashCode; } } @@ -496,6 +451,20 @@ public List GetOpenApiTypes() Value = Message, }); types.Add(new OpenApiType() + { + Name = "updated_at", + Property = "UpdatedAt", + Type = "int", + Value = UpdatedAt, + }); + types.Add(new OpenApiType() + { + Name = "is_embedded", + Property = "IsEmbedded", + Type = "bool?", + Value = IsEmbedded, + }); + types.Add(new OpenApiType() { Name = "is_creator", Property = "IsCreator", @@ -545,34 +514,6 @@ public List GetOpenApiTypes() Value = Documents, }); types.Add(new OpenApiType() - { - Name = "accounts", - Property = "Accounts", - Type = "List", - Value = Accounts, - }); - types.Add(new OpenApiType() - { - Name = "attachments", - Property = "Attachments", - Type = "List", - Value = Attachments, - }); - types.Add(new OpenApiType() - { - Name = "updated_at", - Property = "UpdatedAt", - Type = "int", - Value = UpdatedAt, - }); - types.Add(new OpenApiType() - { - Name = "is_embedded", - Property = "IsEmbedded", - Type = "bool?", - Value = IsEmbedded, - }); - types.Add(new OpenApiType() { Name = "custom_fields", Property = "CustomFields", @@ -586,6 +527,20 @@ public List GetOpenApiTypes() Type = "List", Value = NamedFormFields, }); + types.Add(new OpenApiType() + { + Name = "accounts", + Property = "Accounts", + Type = "List", + Value = Accounts, + }); + types.Add(new OpenApiType() + { + Name = "attachments", + Property = "Attachments", + Type = "List", + Value = Attachments, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs index ef4030d8f..0a40c5548 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs @@ -41,31 +41,21 @@ protected TemplateResponseAccount() { } /// /// 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. public TemplateResponseAccount(string accountId = default(string), string emailAddress = default(string), bool isLocked = default(bool), bool isPaidHs = default(bool), bool isPaidHf = default(bool), TemplateResponseAccountQuota quotas = default(TemplateResponseAccountQuota)) { - // to ensure "accountId" is required (not null) - if (accountId == null) - { - throw new ArgumentNullException("accountId is a required property for TemplateResponseAccount 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 TemplateResponseAccount and cannot be null"); - } this.Quotas = quotas; - this.EmailAddress = emailAddress; } /// @@ -88,43 +78,43 @@ public static TemplateResponseAccount 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 TemplateResponseAccountQuota 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; } - /// /// Returns the string presentation of the object /// @@ -134,11 +124,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseAccount {\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("}\n"); return sb.ToString(); } @@ -179,6 +169,11 @@ public bool Equals(TemplateResponseAccount 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) @@ -195,11 +190,6 @@ public bool Equals(TemplateResponseAccount input) this.Quotas == input.Quotas || (this.Quotas != null && this.Quotas.Equals(input.Quotas)) - ) && - ( - this.EmailAddress == input.EmailAddress || - (this.EmailAddress != null && - this.EmailAddress.Equals(input.EmailAddress)) ); } @@ -216,6 +206,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(); @@ -223,10 +217,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Quotas.GetHashCode(); } - if (this.EmailAddress != null) - { - hashCode = (hashCode * 59) + this.EmailAddress.GetHashCode(); - } return hashCode; } } @@ -251,6 +241,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", @@ -278,13 +275,6 @@ public List GetOpenApiTypes() Type = "TemplateResponseAccountQuota", Value = Quotas, }); - types.Add(new OpenApiType() - { - Name = "email_address", - Property = "EmailAddress", - Type = "string", - Value = EmailAddress, - }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs index cc5c7177a..5a67d889c 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs @@ -41,10 +41,10 @@ protected TemplateResponseAccountQuota() { } /// /// Initializes a new instance of the class. /// - /// API templates remaining. (required). - /// API signature requests remaining. (required). - /// Signature requests remaining. (required). - /// SMS verifications remaining. (required). + /// API templates remaining.. + /// API signature requests remaining.. + /// Signature requests remaining.. + /// SMS verifications remaining.. public TemplateResponseAccountQuota(int templatesLeft = default(int), int apiSignatureRequestsLeft = default(int), int documentsLeft = default(int), int smsVerificationsLeft = default(int)) { @@ -74,28 +74,28 @@ public static TemplateResponseAccountQuota Init(string jsonData) /// API templates remaining. /// /// API templates remaining. - [DataMember(Name = "templates_left", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "templates_left", EmitDefaultValue = true)] public int TemplatesLeft { get; set; } /// /// API signature requests remaining. /// /// API signature requests remaining. - [DataMember(Name = "api_signature_requests_left", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "api_signature_requests_left", EmitDefaultValue = true)] public int ApiSignatureRequestsLeft { get; set; } /// /// Signature requests remaining. /// /// Signature requests remaining. - [DataMember(Name = "documents_left", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "documents_left", EmitDefaultValue = true)] public int DocumentsLeft { get; set; } /// /// SMS verifications remaining. /// /// SMS verifications remaining. - [DataMember(Name = "sms_verifications_left", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "sms_verifications_left", EmitDefaultValue = true)] public int SmsVerificationsLeft { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs index 444000308..e153a6836 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs @@ -41,15 +41,10 @@ protected TemplateResponseCCRole() { } /// /// Initializes a new instance of the class. /// - /// The name of the Role. (required). + /// The name of the Role.. public TemplateResponseCCRole(string name = default(string)) { - // to ensure "name" is required (not null) - if (name == null) - { - throw new ArgumentNullException("name is a required property for TemplateResponseCCRole and cannot be null"); - } this.Name = name; } @@ -73,7 +68,7 @@ public static TemplateResponseCCRole Init(string jsonData) /// The name of the Role. /// /// The name of the Role. - [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs index 8a1b856c7..461b2f2fa 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs @@ -41,46 +41,21 @@ protected TemplateResponseDocument() { } /// /// Initializes a new instance of the class. /// - /// Name of the associated file. (required). + /// Name of the associated file.. /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing).. - /// An array of Form Field Group objects. (required). - /// An array of Form Field objects containing the name and type of each named field. (required). - /// An array of Form Field objects containing the name and type of each named field. (required). - /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. (required). + /// An array of Form Field Group objects.. + /// An array of Form Field objects containing the name and type of each named field.. + /// An array of Form Field objects containing the name and type of each named field.. + /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.. public TemplateResponseDocument(string name = default(string), int index = default(int), List fieldGroups = default(List), List formFields = default(List), List customFields = default(List), List staticFields = default(List)) { - // to ensure "name" is required (not null) - if (name == null) - { - throw new ArgumentNullException("name is a required property for TemplateResponseDocument and cannot be null"); - } this.Name = name; - // to ensure "fieldGroups" is required (not null) - if (fieldGroups == null) - { - throw new ArgumentNullException("fieldGroups is a required property for TemplateResponseDocument and cannot be null"); - } + this.Index = index; this.FieldGroups = fieldGroups; - // to ensure "formFields" is required (not null) - if (formFields == null) - { - throw new ArgumentNullException("formFields is a required property for TemplateResponseDocument and cannot be null"); - } this.FormFields = formFields; - // to ensure "customFields" is required (not null) - if (customFields == null) - { - throw new ArgumentNullException("customFields is a required property for TemplateResponseDocument and cannot be null"); - } this.CustomFields = customFields; - // to ensure "staticFields" is required (not null) - if (staticFields == null) - { - throw new ArgumentNullException("staticFields is a required property for TemplateResponseDocument and cannot be null"); - } this.StaticFields = staticFields; - this.Index = index; } /// @@ -103,44 +78,44 @@ public static TemplateResponseDocument Init(string jsonData) /// Name of the associated file. /// /// Name of the associated file. - [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } + /// + /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + /// + /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + [DataMember(Name = "index", EmitDefaultValue = true)] + public int Index { get; set; } + /// /// An array of Form Field Group objects. /// /// An array of Form Field Group objects. - [DataMember(Name = "field_groups", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "field_groups", EmitDefaultValue = true)] public List FieldGroups { get; set; } /// /// An array of Form Field objects containing the name and type of each named field. /// /// An array of Form Field objects containing the name and type of each named field. - [DataMember(Name = "form_fields", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "form_fields", EmitDefaultValue = true)] public List FormFields { get; set; } /// /// An array of Form Field objects containing the name and type of each named field. /// /// An array of Form Field objects containing the name and type of each named field. - [DataMember(Name = "custom_fields", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "custom_fields", EmitDefaultValue = true)] public List CustomFields { get; set; } /// /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. /// /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. - [DataMember(Name = "static_fields", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "static_fields", EmitDefaultValue = true)] public List StaticFields { get; set; } - /// - /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - /// - /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - [DataMember(Name = "index", EmitDefaultValue = true)] - public int Index { get; set; } - /// /// Returns the string presentation of the object /// @@ -150,11 +125,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseDocument {\n"); sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Index: ").Append(Index).Append("\n"); sb.Append(" FieldGroups: ").Append(FieldGroups).Append("\n"); sb.Append(" FormFields: ").Append(FormFields).Append("\n"); sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); sb.Append(" StaticFields: ").Append(StaticFields).Append("\n"); - sb.Append(" Index: ").Append(Index).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -195,6 +170,10 @@ public bool Equals(TemplateResponseDocument input) (this.Name != null && this.Name.Equals(input.Name)) ) && + ( + this.Index == input.Index || + this.Index.Equals(input.Index) + ) && ( this.FieldGroups == input.FieldGroups || this.FieldGroups != null && @@ -218,10 +197,6 @@ public bool Equals(TemplateResponseDocument input) this.StaticFields != null && input.StaticFields != null && this.StaticFields.SequenceEqual(input.StaticFields) - ) && - ( - this.Index == input.Index || - this.Index.Equals(input.Index) ); } @@ -238,6 +213,7 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Name.GetHashCode(); } + hashCode = (hashCode * 59) + this.Index.GetHashCode(); if (this.FieldGroups != null) { hashCode = (hashCode * 59) + this.FieldGroups.GetHashCode(); @@ -254,7 +230,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.StaticFields.GetHashCode(); } - hashCode = (hashCode * 59) + this.Index.GetHashCode(); return hashCode; } } @@ -279,6 +254,13 @@ public List GetOpenApiTypes() Value = Name, }); types.Add(new OpenApiType() + { + Name = "index", + Property = "Index", + Type = "int", + Value = Index, + }); + types.Add(new OpenApiType() { Name = "field_groups", Property = "FieldGroups", @@ -306,13 +288,6 @@ public List GetOpenApiTypes() Type = "List", Value = StaticFields, }); - types.Add(new OpenApiType() - { - Name = "index", - Property = "Index", - Type = "int", - Value = Index, - }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs index 2e6953d02..de66ae6db 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs @@ -45,43 +45,33 @@ protected TemplateResponseDocumentCustomFieldBase() { } /// /// Initializes a new instance of the class. /// - /// The unique ID for this field. (required). - /// The name of the Custom Field. (required). + /// The unique ID for this field.. + /// The name of the Custom Field.. /// type (required). /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).. - /// The horizontal offset in pixels for this form field. (required). - /// The vertical offset in pixels for this form field. (required). - /// The width in pixels of this form field. (required). - /// The height in pixels of this form field. (required). - /// Boolean showing whether or not this field is required. (required). + /// The horizontal offset in pixels for this form field.. + /// The vertical offset in pixels for this form field.. + /// The width in pixels of this form field.. + /// The height in pixels of this form field.. + /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentCustomFieldBase(string apiId = default(string), string name = default(string), string type = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { - // to ensure "apiId" is required (not null) - if (apiId == null) - { - throw new ArgumentNullException("apiId is a required property for TemplateResponseDocumentCustomFieldBase and cannot be null"); - } - this.ApiId = apiId; - // to ensure "name" is required (not null) - if (name == null) - { - throw new ArgumentNullException("name is a required property for TemplateResponseDocumentCustomFieldBase and cannot be null"); - } - this.Name = name; // to ensure "type" is required (not null) if (type == null) { throw new ArgumentNullException("type is a required property for TemplateResponseDocumentCustomFieldBase and cannot be null"); } this.Type = type; + this.ApiId = apiId; + this.Name = name; + this.Signer = Convert.ToString(signer); this.X = x; this.Y = y; this.Width = width; this.Height = height; this.Required = required; - this.Signer = Convert.ToString(signer); this.Group = group; } @@ -101,73 +91,73 @@ public static TemplateResponseDocumentCustomFieldBase Init(string jsonData) return obj; } + /// + /// Gets or Sets Type + /// + [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] + public string Type { get; set; } + /// /// The unique ID for this field. /// /// The unique ID for this field. - [DataMember(Name = "api_id", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "api_id", EmitDefaultValue = true)] public string ApiId { get; set; } /// /// The name of the Custom Field. /// /// The name of the Custom Field. - [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// - /// Gets or Sets Type + /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). /// - [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] - public string Type { get; set; } + /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + [DataMember(Name = "signer", EmitDefaultValue = true)] + public object Signer + { + get => this._signer; + set => this._signer = Convert.ToString(value); + } + private string _signer; /// /// The horizontal offset in pixels for this form field. /// /// The horizontal offset in pixels for this form field. - [DataMember(Name = "x", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "x", EmitDefaultValue = true)] public int X { get; set; } /// /// The vertical offset in pixels for this form field. /// /// The vertical offset in pixels for this form field. - [DataMember(Name = "y", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "y", EmitDefaultValue = true)] public int Y { get; set; } /// /// The width in pixels of this form field. /// /// The width in pixels of this form field. - [DataMember(Name = "width", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "width", EmitDefaultValue = true)] public int Width { get; set; } /// /// The height in pixels of this form field. /// /// The height in pixels of this form field. - [DataMember(Name = "height", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "height", EmitDefaultValue = true)] public int Height { get; set; } /// /// Boolean showing whether or not this field is required. /// /// Boolean showing whether or not this field is required. - [DataMember(Name = "required", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "required", EmitDefaultValue = true)] public bool Required { get; set; } - /// - /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). - /// - /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). - [DataMember(Name = "signer", EmitDefaultValue = true)] - public object Signer - { - get => this._signer; - set => this._signer = Convert.ToString(value); - } - - private string _signer; /// /// The name of the group this field is in. If this field is not a group, this defaults to `null`. /// @@ -183,15 +173,15 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseDocumentCustomFieldBase {\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" ApiId: ").Append(ApiId).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Signer: ").Append(Signer).Append("\n"); sb.Append(" X: ").Append(X).Append("\n"); sb.Append(" Y: ").Append(Y).Append("\n"); sb.Append(" Width: ").Append(Width).Append("\n"); sb.Append(" Height: ").Append(Height).Append("\n"); sb.Append(" Required: ").Append(Required).Append("\n"); - sb.Append(" Signer: ").Append(Signer).Append("\n"); sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); @@ -228,6 +218,11 @@ public bool Equals(TemplateResponseDocumentCustomFieldBase input) return false; } return + ( + this.Type == input.Type || + (this.Type != null && + this.Type.Equals(input.Type)) + ) && ( this.ApiId == input.ApiId || (this.ApiId != null && @@ -239,9 +234,9 @@ public bool Equals(TemplateResponseDocumentCustomFieldBase input) this.Name.Equals(input.Name)) ) && ( - this.Type == input.Type || - (this.Type != null && - this.Type.Equals(input.Type)) + this.Signer == input.Signer || + (this.Signer != null && + this.Signer.Equals(input.Signer)) ) && ( this.X == input.X || @@ -263,11 +258,6 @@ public bool Equals(TemplateResponseDocumentCustomFieldBase input) this.Required == input.Required || this.Required.Equals(input.Required) ) && - ( - this.Signer == input.Signer || - (this.Signer != null && - this.Signer.Equals(input.Signer)) - ) && ( this.Group == input.Group || (this.Group != null && @@ -284,6 +274,10 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; + if (this.Type != null) + { + hashCode = (hashCode * 59) + this.Type.GetHashCode(); + } if (this.ApiId != null) { hashCode = (hashCode * 59) + this.ApiId.GetHashCode(); @@ -292,19 +286,15 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Name.GetHashCode(); } - if (this.Type != null) + if (this.Signer != null) { - hashCode = (hashCode * 59) + this.Type.GetHashCode(); + hashCode = (hashCode * 59) + this.Signer.GetHashCode(); } hashCode = (hashCode * 59) + this.X.GetHashCode(); hashCode = (hashCode * 59) + this.Y.GetHashCode(); hashCode = (hashCode * 59) + this.Width.GetHashCode(); hashCode = (hashCode * 59) + this.Height.GetHashCode(); hashCode = (hashCode * 59) + this.Required.GetHashCode(); - if (this.Signer != null) - { - hashCode = (hashCode * 59) + this.Signer.GetHashCode(); - } if (this.Group != null) { hashCode = (hashCode * 59) + this.Group.GetHashCode(); @@ -336,6 +326,13 @@ public List GetOpenApiTypes() { var types = new List(); types.Add(new OpenApiType() + { + Name = "type", + Property = "Type", + Type = "string", + Value = Type, + }); + types.Add(new OpenApiType() { Name = "api_id", Property = "ApiId", @@ -351,10 +348,10 @@ public List GetOpenApiTypes() }); types.Add(new OpenApiType() { - Name = "type", - Property = "Type", + Name = "signer", + Property = "Signer", Type = "string", - Value = Type, + Value = Signer, }); types.Add(new OpenApiType() { @@ -392,13 +389,6 @@ public List GetOpenApiTypes() Value = Required, }); types.Add(new OpenApiType() - { - Name = "signer", - Property = "Signer", - Type = "string", - Value = Signer, - }); - types.Add(new OpenApiType() { Name = "group", Property = "Group", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs index 7f0e4909d..dde2bef21 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs @@ -42,25 +42,25 @@ protected TemplateResponseDocumentCustomFieldCheckbox() { } /// Initializes a new instance of the class. /// /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` (required) (default to "checkbox"). - /// The unique ID for this field. (required). - /// The name of the Custom Field. (required). + /// The unique ID for this field.. + /// The name of the Custom Field.. /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).. - /// The horizontal offset in pixels for this form field. (required). - /// The vertical offset in pixels for this form field. (required). - /// The width in pixels of this form field. (required). - /// The height in pixels of this form field. (required). - /// Boolean showing whether or not this field is required. (required). + /// The horizontal offset in pixels for this form field.. + /// The vertical offset in pixels for this form field.. + /// The width in pixels of this form field.. + /// The height in pixels of this form field.. + /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentCustomFieldCheckbox(string type = @"checkbox", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; this.Name = name; + this.Signer = Convert.ToString(signer); this.X = x; this.Y = y; this.Width = width; this.Height = height; this.Required = required; - this.Signer = Convert.ToString(signer); this.Group = group; // to ensure "type" is required (not null) diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs index d7966950a..1e850816f 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs @@ -42,29 +42,29 @@ protected TemplateResponseDocumentCustomFieldText() { } /// Initializes a new instance of the class. /// /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` (required) (default to "text"). - /// avgTextLength (required). - /// Whether this form field is multiline text. (required). - /// Original font size used in this form field's text. (required). - /// Font family used in this form field's text. (required). - /// The unique ID for this field. (required). - /// The name of the Custom Field. (required). + /// avgTextLength. + /// Whether this form field is multiline text.. + /// Original font size used in this form field's text.. + /// Font family used in this form field's text.. + /// The unique ID for this field.. + /// The name of the Custom Field.. /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).. - /// The horizontal offset in pixels for this form field. (required). - /// The vertical offset in pixels for this form field. (required). - /// The width in pixels of this form field. (required). - /// The height in pixels of this form field. (required). - /// Boolean showing whether or not this field is required. (required). + /// The horizontal offset in pixels for this form field.. + /// The vertical offset in pixels for this form field.. + /// The width in pixels of this form field.. + /// The height in pixels of this form field.. + /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentCustomFieldText(string type = @"text", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; this.Name = name; + this.Signer = Convert.ToString(signer); this.X = x; this.Y = y; this.Width = width; this.Height = height; this.Required = required; - this.Signer = Convert.ToString(signer); this.Group = group; // to ensure "type" is required (not null) @@ -73,19 +73,9 @@ protected TemplateResponseDocumentCustomFieldText() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentCustomFieldText and cannot be null"); } this.Type = type; - // to ensure "avgTextLength" is required (not null) - if (avgTextLength == null) - { - throw new ArgumentNullException("avgTextLength is a required property for TemplateResponseDocumentCustomFieldText and cannot be null"); - } this.AvgTextLength = avgTextLength; this.IsMultiline = isMultiline; this.OriginalFontSize = originalFontSize; - // to ensure "fontFamily" is required (not null) - if (fontFamily == null) - { - throw new ArgumentNullException("fontFamily is a required property for TemplateResponseDocumentCustomFieldText and cannot be null"); - } this.FontFamily = fontFamily; } @@ -115,28 +105,28 @@ public static TemplateResponseDocumentCustomFieldText Init(string jsonData) /// /// Gets or Sets AvgTextLength /// - [DataMember(Name = "avg_text_length", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "avg_text_length", EmitDefaultValue = true)] public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } /// /// Whether this form field is multiline text. /// /// Whether this form field is multiline text. - [DataMember(Name = "isMultiline", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "isMultiline", EmitDefaultValue = true)] public bool IsMultiline { get; set; } /// /// Original font size used in this form field's text. /// /// Original font size used in this form field's text. - [DataMember(Name = "originalFontSize", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] public int OriginalFontSize { get; set; } /// /// Font family used in this form field's text. /// /// Font family used in this form field's text. - [DataMember(Name = "fontFamily", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "fontFamily", EmitDefaultValue = true)] public string FontFamily { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs index 1e27c0f38..019491e26 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs @@ -41,22 +41,12 @@ protected TemplateResponseDocumentFieldGroup() { } /// /// Initializes a new instance of the class. /// - /// The name of the form field group. (required). - /// rule (required). + /// The name of the form field group.. + /// rule. public TemplateResponseDocumentFieldGroup(string name = default(string), TemplateResponseDocumentFieldGroupRule rule = default(TemplateResponseDocumentFieldGroupRule)) { - // to ensure "name" is required (not null) - if (name == null) - { - throw new ArgumentNullException("name is a required property for TemplateResponseDocumentFieldGroup and cannot be null"); - } this.Name = name; - // to ensure "rule" is required (not null) - if (rule == null) - { - throw new ArgumentNullException("rule is a required property for TemplateResponseDocumentFieldGroup and cannot be null"); - } this.Rule = rule; } @@ -80,13 +70,13 @@ public static TemplateResponseDocumentFieldGroup Init(string jsonData) /// The name of the form field group. /// /// The name of the form field group. - [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// /// Gets or Sets Rule /// - [DataMember(Name = "rule", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "rule", EmitDefaultValue = true)] public TemplateResponseDocumentFieldGroupRule Rule { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs index 8f690dccc..ad19e0e20 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs @@ -41,22 +41,12 @@ protected TemplateResponseDocumentFieldGroupRule() { } /// /// Initializes a new instance of the class. /// - /// Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. (required). - /// Name of the group (required). + /// Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group.. + /// Name of the group. public TemplateResponseDocumentFieldGroupRule(string requirement = default(string), string groupLabel = default(string)) { - // to ensure "requirement" is required (not null) - if (requirement == null) - { - throw new ArgumentNullException("requirement is a required property for TemplateResponseDocumentFieldGroupRule and cannot be null"); - } this.Requirement = requirement; - // to ensure "groupLabel" is required (not null) - if (groupLabel == null) - { - throw new ArgumentNullException("groupLabel is a required property for TemplateResponseDocumentFieldGroupRule and cannot be null"); - } this.GroupLabel = groupLabel; } @@ -80,14 +70,14 @@ public static TemplateResponseDocumentFieldGroupRule Init(string jsonData) /// Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. /// /// Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. - [DataMember(Name = "requirement", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "requirement", EmitDefaultValue = true)] public string Requirement { get; set; } /// /// Name of the group /// /// Name of the group - [DataMember(Name = "groupLabel", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "groupLabel", EmitDefaultValue = true)] public string GroupLabel { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs index 4e55daa18..416901304 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs @@ -51,41 +51,26 @@ protected TemplateResponseDocumentFormFieldBase() { } /// /// Initializes a new instance of the class. /// - /// A unique id for the form field. (required). - /// The name of the form field. (required). + /// A unique id for the form field.. + /// The name of the form field.. /// type (required). - /// The signer of the Form Field. (required). - /// The horizontal offset in pixels for this form field. (required). - /// The vertical offset in pixels for this form field. (required). - /// The width in pixels of this form field. (required). - /// The height in pixels of this form field. (required). - /// Boolean showing whether or not this field is required. (required). + /// The signer of the Form Field.. + /// The horizontal offset in pixels for this form field.. + /// The vertical offset in pixels for this form field.. + /// The width in pixels of this form field.. + /// The height in pixels of this form field.. + /// Boolean showing whether or not this field is required.. public TemplateResponseDocumentFormFieldBase(string apiId = default(string), string name = default(string), string type = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { - // to ensure "apiId" is required (not null) - if (apiId == null) - { - throw new ArgumentNullException("apiId is a required property for TemplateResponseDocumentFormFieldBase and cannot be null"); - } - this.ApiId = apiId; - // to ensure "name" is required (not null) - if (name == null) - { - throw new ArgumentNullException("name is a required property for TemplateResponseDocumentFormFieldBase and cannot be null"); - } - this.Name = name; // to ensure "type" is required (not null) if (type == null) { throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldBase and cannot be null"); } this.Type = type; - // to ensure "signer" is required (not null) - if (signer == null) - { - throw new ArgumentNullException("signer is a required property for TemplateResponseDocumentFormFieldBase and cannot be null"); - } + this.ApiId = apiId; + this.Name = name; this.Signer = Convert.ToString(signer); this.X = x; this.Y = y; @@ -110,31 +95,31 @@ public static TemplateResponseDocumentFormFieldBase Init(string jsonData) return obj; } + /// + /// Gets or Sets Type + /// + [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] + public string Type { get; set; } + /// /// A unique id for the form field. /// /// A unique id for the form field. - [DataMember(Name = "api_id", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "api_id", EmitDefaultValue = true)] public string ApiId { get; set; } /// /// The name of the form field. /// /// The name of the form field. - [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } - /// - /// Gets or Sets Type - /// - [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] - public string Type { get; set; } - /// /// The signer of the Form Field. /// /// The signer of the Form Field. - [DataMember(Name = "signer", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "signer", EmitDefaultValue = true)] public object Signer { get => this._signer; @@ -146,35 +131,35 @@ public object Signer /// The horizontal offset in pixels for this form field. /// /// The horizontal offset in pixels for this form field. - [DataMember(Name = "x", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "x", EmitDefaultValue = true)] public int X { get; set; } /// /// The vertical offset in pixels for this form field. /// /// The vertical offset in pixels for this form field. - [DataMember(Name = "y", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "y", EmitDefaultValue = true)] public int Y { get; set; } /// /// The width in pixels of this form field. /// /// The width in pixels of this form field. - [DataMember(Name = "width", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "width", EmitDefaultValue = true)] public int Width { get; set; } /// /// The height in pixels of this form field. /// /// The height in pixels of this form field. - [DataMember(Name = "height", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "height", EmitDefaultValue = true)] public int Height { get; set; } /// /// Boolean showing whether or not this field is required. /// /// Boolean showing whether or not this field is required. - [DataMember(Name = "required", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "required", EmitDefaultValue = true)] public bool Required { get; set; } /// @@ -185,9 +170,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseDocumentFormFieldBase {\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" ApiId: ").Append(ApiId).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" Signer: ").Append(Signer).Append("\n"); sb.Append(" X: ").Append(X).Append("\n"); sb.Append(" Y: ").Append(Y).Append("\n"); @@ -229,6 +214,11 @@ public bool Equals(TemplateResponseDocumentFormFieldBase input) return false; } return + ( + this.Type == input.Type || + (this.Type != null && + this.Type.Equals(input.Type)) + ) && ( this.ApiId == input.ApiId || (this.ApiId != null && @@ -239,11 +229,6 @@ public bool Equals(TemplateResponseDocumentFormFieldBase input) (this.Name != null && this.Name.Equals(input.Name)) ) && - ( - this.Type == input.Type || - (this.Type != null && - this.Type.Equals(input.Type)) - ) && ( this.Signer == input.Signer || (this.Signer != null && @@ -280,6 +265,10 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; + if (this.Type != null) + { + hashCode = (hashCode * 59) + this.Type.GetHashCode(); + } if (this.ApiId != null) { hashCode = (hashCode * 59) + this.ApiId.GetHashCode(); @@ -288,10 +277,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Name.GetHashCode(); } - if (this.Type != null) - { - hashCode = (hashCode * 59) + this.Type.GetHashCode(); - } if (this.Signer != null) { hashCode = (hashCode * 59) + this.Signer.GetHashCode(); @@ -328,6 +313,13 @@ public List GetOpenApiTypes() { var types = new List(); types.Add(new OpenApiType() + { + Name = "type", + Property = "Type", + Type = "string", + Value = Type, + }); + types.Add(new OpenApiType() { Name = "api_id", Property = "ApiId", @@ -342,13 +334,6 @@ public List GetOpenApiTypes() Value = Name, }); types.Add(new OpenApiType() - { - Name = "type", - Property = "Type", - Type = "string", - Value = Type, - }); - types.Add(new OpenApiType() { Name = "signer", Property = "Signer", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs index 98508a633..47f9cafc7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs @@ -43,14 +43,14 @@ protected TemplateResponseDocumentFormFieldCheckbox() { } /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "checkbox"). /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - /// A unique id for the form field. (required). - /// The name of the form field. (required). - /// The signer of the Form Field. (required). - /// The horizontal offset in pixels for this form field. (required). - /// The vertical offset in pixels for this form field. (required). - /// The width in pixels of this form field. (required). - /// The height in pixels of this form field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the form field.. + /// The name of the form field.. + /// The signer of the Form Field.. + /// The horizontal offset in pixels for this form field.. + /// The vertical offset in pixels for this form field.. + /// The width in pixels of this form field.. + /// The height in pixels of this form field.. + /// Boolean showing whether or not this field is required.. public TemplateResponseDocumentFormFieldCheckbox(string type = @"checkbox", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs index 96cba8647..d40024e3d 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs @@ -43,14 +43,14 @@ protected TemplateResponseDocumentFormFieldDateSigned() { } /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "date_signed"). /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - /// A unique id for the form field. (required). - /// The name of the form field. (required). - /// The signer of the Form Field. (required). - /// The horizontal offset in pixels for this form field. (required). - /// The vertical offset in pixels for this form field. (required). - /// The width in pixels of this form field. (required). - /// The height in pixels of this form field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the form field.. + /// The name of the form field.. + /// The signer of the Form Field.. + /// The horizontal offset in pixels for this form field.. + /// The vertical offset in pixels for this form field.. + /// The width in pixels of this form field.. + /// The height in pixels of this form field.. + /// Boolean showing whether or not this field is required.. public TemplateResponseDocumentFormFieldDateSigned(string type = @"date_signed", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs index a100c7984..b1670234d 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs @@ -43,14 +43,14 @@ protected TemplateResponseDocumentFormFieldDropdown() { } /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "dropdown"). /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - /// A unique id for the form field. (required). - /// The name of the form field. (required). - /// The signer of the Form Field. (required). - /// The horizontal offset in pixels for this form field. (required). - /// The vertical offset in pixels for this form field. (required). - /// The width in pixels of this form field. (required). - /// The height in pixels of this form field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the form field.. + /// The name of the form field.. + /// The signer of the Form Field.. + /// The horizontal offset in pixels for this form field.. + /// The vertical offset in pixels for this form field.. + /// The width in pixels of this form field.. + /// The height in pixels of this form field.. + /// Boolean showing whether or not this field is required.. public TemplateResponseDocumentFormFieldDropdown(string type = @"dropdown", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs index 7138491b7..49bee3679 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs @@ -42,19 +42,19 @@ protected TemplateResponseDocumentFormFieldHyperlink() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "hyperlink"). - /// avgTextLength (required). - /// Whether this form field is multiline text. (required). - /// Original font size used in this form field's text. (required). - /// Font family used in this form field's text. (required). + /// avgTextLength. + /// Whether this form field is multiline text.. + /// Original font size used in this form field's text.. + /// Font family used in this form field's text.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - /// A unique id for the form field. (required). - /// The name of the form field. (required). - /// The signer of the Form Field. (required). - /// The horizontal offset in pixels for this form field. (required). - /// The vertical offset in pixels for this form field. (required). - /// The width in pixels of this form field. (required). - /// The height in pixels of this form field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the form field.. + /// The name of the form field.. + /// The signer of the Form Field.. + /// The horizontal offset in pixels for this form field.. + /// The vertical offset in pixels for this form field.. + /// The width in pixels of this form field.. + /// The height in pixels of this form field.. + /// Boolean showing whether or not this field is required.. public TemplateResponseDocumentFormFieldHyperlink(string type = @"hyperlink", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; @@ -72,19 +72,9 @@ protected TemplateResponseDocumentFormFieldHyperlink() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldHyperlink and cannot be null"); } this.Type = type; - // to ensure "avgTextLength" is required (not null) - if (avgTextLength == null) - { - throw new ArgumentNullException("avgTextLength is a required property for TemplateResponseDocumentFormFieldHyperlink and cannot be null"); - } this.AvgTextLength = avgTextLength; this.IsMultiline = isMultiline; this.OriginalFontSize = originalFontSize; - // to ensure "fontFamily" is required (not null) - if (fontFamily == null) - { - throw new ArgumentNullException("fontFamily is a required property for TemplateResponseDocumentFormFieldHyperlink and cannot be null"); - } this.FontFamily = fontFamily; this.Group = group; } @@ -115,28 +105,28 @@ public static TemplateResponseDocumentFormFieldHyperlink Init(string jsonData) /// /// Gets or Sets AvgTextLength /// - [DataMember(Name = "avg_text_length", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "avg_text_length", EmitDefaultValue = true)] public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } /// /// Whether this form field is multiline text. /// /// Whether this form field is multiline text. - [DataMember(Name = "isMultiline", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "isMultiline", EmitDefaultValue = true)] public bool IsMultiline { get; set; } /// /// Original font size used in this form field's text. /// /// Original font size used in this form field's text. - [DataMember(Name = "originalFontSize", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] public int OriginalFontSize { get; set; } /// /// Font family used in this form field's text. /// /// Font family used in this form field's text. - [DataMember(Name = "fontFamily", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "fontFamily", EmitDefaultValue = true)] public string FontFamily { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs index cff4fe342..8e8456328 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs @@ -43,14 +43,14 @@ protected TemplateResponseDocumentFormFieldInitials() { } /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "initials"). /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - /// A unique id for the form field. (required). - /// The name of the form field. (required). - /// The signer of the Form Field. (required). - /// The horizontal offset in pixels for this form field. (required). - /// The vertical offset in pixels for this form field. (required). - /// The width in pixels of this form field. (required). - /// The height in pixels of this form field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the form field.. + /// The name of the form field.. + /// The signer of the Form Field.. + /// The horizontal offset in pixels for this form field.. + /// The vertical offset in pixels for this form field.. + /// The width in pixels of this form field.. + /// The height in pixels of this form field.. + /// Boolean showing whether or not this field is required.. public TemplateResponseDocumentFormFieldInitials(string type = @"initials", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs index 0d1eec061..cbb5d59b3 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs @@ -43,14 +43,14 @@ protected TemplateResponseDocumentFormFieldRadio() { } /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "radio"). /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. (required). - /// A unique id for the form field. (required). - /// The name of the form field. (required). - /// The signer of the Form Field. (required). - /// The horizontal offset in pixels for this form field. (required). - /// The vertical offset in pixels for this form field. (required). - /// The width in pixels of this form field. (required). - /// The height in pixels of this form field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the form field.. + /// The name of the form field.. + /// The signer of the Form Field.. + /// The horizontal offset in pixels for this form field.. + /// The vertical offset in pixels for this form field.. + /// The width in pixels of this form field.. + /// The height in pixels of this form field.. + /// Boolean showing whether or not this field is required.. public TemplateResponseDocumentFormFieldRadio(string type = @"radio", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs index f5301dd13..b42f09d33 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs @@ -43,14 +43,14 @@ protected TemplateResponseDocumentFormFieldSignature() { } /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "signature"). /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - /// A unique id for the form field. (required). - /// The name of the form field. (required). - /// The signer of the Form Field. (required). - /// The horizontal offset in pixels for this form field. (required). - /// The vertical offset in pixels for this form field. (required). - /// The width in pixels of this form field. (required). - /// The height in pixels of this form field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the form field.. + /// The name of the form field.. + /// The signer of the Form Field.. + /// The horizontal offset in pixels for this form field.. + /// The vertical offset in pixels for this form field.. + /// The width in pixels of this form field.. + /// The height in pixels of this form field.. + /// Boolean showing whether or not this field is required.. public TemplateResponseDocumentFormFieldSignature(string type = @"signature", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs index 0d9bbbe31..70797b67d 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs @@ -117,20 +117,20 @@ protected TemplateResponseDocumentFormFieldText() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "text"). - /// avgTextLength (required). - /// Whether this form field is multiline text. (required). - /// Original font size used in this form field's text. (required). - /// Font family used in this form field's text. (required). + /// avgTextLength. + /// Whether this form field is multiline text.. + /// Original font size used in this form field's text.. + /// Font family used in this form field's text.. /// Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - /// A unique id for the form field. (required). - /// The name of the form field. (required). - /// The signer of the Form Field. (required). - /// The horizontal offset in pixels for this form field. (required). - /// The vertical offset in pixels for this form field. (required). - /// The width in pixels of this form field. (required). - /// The height in pixels of this form field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the form field.. + /// The name of the form field.. + /// The signer of the Form Field.. + /// The horizontal offset in pixels for this form field.. + /// The vertical offset in pixels for this form field.. + /// The width in pixels of this form field.. + /// The height in pixels of this form field.. + /// Boolean showing whether or not this field is required.. public TemplateResponseDocumentFormFieldText(string type = @"text", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), ValidationTypeEnum? validationType = default(ValidationTypeEnum?), string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; @@ -148,19 +148,9 @@ protected TemplateResponseDocumentFormFieldText() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldText and cannot be null"); } this.Type = type; - // to ensure "avgTextLength" is required (not null) - if (avgTextLength == null) - { - throw new ArgumentNullException("avgTextLength is a required property for TemplateResponseDocumentFormFieldText and cannot be null"); - } this.AvgTextLength = avgTextLength; this.IsMultiline = isMultiline; this.OriginalFontSize = originalFontSize; - // to ensure "fontFamily" is required (not null) - if (fontFamily == null) - { - throw new ArgumentNullException("fontFamily is a required property for TemplateResponseDocumentFormFieldText and cannot be null"); - } this.FontFamily = fontFamily; this.ValidationType = validationType; this.Group = group; @@ -192,28 +182,28 @@ public static TemplateResponseDocumentFormFieldText Init(string jsonData) /// /// Gets or Sets AvgTextLength /// - [DataMember(Name = "avg_text_length", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "avg_text_length", EmitDefaultValue = true)] public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } /// /// Whether this form field is multiline text. /// /// Whether this form field is multiline text. - [DataMember(Name = "isMultiline", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "isMultiline", EmitDefaultValue = true)] public bool IsMultiline { get; set; } /// /// Original font size used in this form field's text. /// /// Original font size used in this form field's text. - [DataMember(Name = "originalFontSize", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] public int OriginalFontSize { get; set; } /// /// Font family used in this form field's text. /// /// Font family used in this form field's text. - [DataMember(Name = "fontFamily", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "fontFamily", EmitDefaultValue = true)] public string FontFamily { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs index cac470d89..69281b328 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs @@ -51,43 +51,29 @@ protected TemplateResponseDocumentStaticFieldBase() { } /// /// Initializes a new instance of the class. /// - /// A unique id for the static field. (required). - /// The name of the static field. (required). + /// A unique id for the static field.. + /// The name of the static field.. /// type (required). - /// The signer of the Static Field. (required) (default to "me_now"). - /// The horizontal offset in pixels for this static field. (required). - /// The vertical offset in pixels for this static field. (required). - /// The width in pixels of this static field. (required). - /// The height in pixels of this static field. (required). - /// Boolean showing whether or not this field is required. (required). + /// The signer of the Static Field. (default to "me_now"). + /// The horizontal offset in pixels for this static field.. + /// The vertical offset in pixels for this static field.. + /// The width in pixels of this static field.. + /// The height in pixels of this static field.. + /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldBase(string apiId = default(string), string name = default(string), string type = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { - // to ensure "apiId" is required (not null) - if (apiId == null) - { - throw new ArgumentNullException("apiId is a required property for TemplateResponseDocumentStaticFieldBase and cannot be null"); - } - this.ApiId = apiId; - // to ensure "name" is required (not null) - if (name == null) - { - throw new ArgumentNullException("name is a required property for TemplateResponseDocumentStaticFieldBase and cannot be null"); - } - this.Name = name; // to ensure "type" is required (not null) if (type == null) { throw new ArgumentNullException("type is a required property for TemplateResponseDocumentStaticFieldBase and cannot be null"); } this.Type = type; - // to ensure "signer" is required (not null) - if (signer == null) - { - throw new ArgumentNullException("signer is a required property for TemplateResponseDocumentStaticFieldBase and cannot be null"); - } - this.Signer = signer; + this.ApiId = apiId; + this.Name = name; + // use default value if no "signer" provided + this.Signer = signer ?? "me_now"; this.X = x; this.Y = y; this.Width = width; @@ -112,66 +98,66 @@ public static TemplateResponseDocumentStaticFieldBase Init(string jsonData) return obj; } + /// + /// Gets or Sets Type + /// + [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] + public string Type { get; set; } + /// /// A unique id for the static field. /// /// A unique id for the static field. - [DataMember(Name = "api_id", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "api_id", EmitDefaultValue = true)] public string ApiId { get; set; } /// /// The name of the static field. /// /// The name of the static field. - [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } - /// - /// Gets or Sets Type - /// - [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] - public string Type { get; set; } - /// /// The signer of the Static Field. /// /// The signer of the Static Field. - [DataMember(Name = "signer", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "signer", EmitDefaultValue = true)] public string Signer { get; set; } /// /// The horizontal offset in pixels for this static field. /// /// The horizontal offset in pixels for this static field. - [DataMember(Name = "x", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "x", EmitDefaultValue = true)] public int X { get; set; } /// /// The vertical offset in pixels for this static field. /// /// The vertical offset in pixels for this static field. - [DataMember(Name = "y", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "y", EmitDefaultValue = true)] public int Y { get; set; } /// /// The width in pixels of this static field. /// /// The width in pixels of this static field. - [DataMember(Name = "width", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "width", EmitDefaultValue = true)] public int Width { get; set; } /// /// The height in pixels of this static field. /// /// The height in pixels of this static field. - [DataMember(Name = "height", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "height", EmitDefaultValue = true)] public int Height { get; set; } /// /// Boolean showing whether or not this field is required. /// /// Boolean showing whether or not this field is required. - [DataMember(Name = "required", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "required", EmitDefaultValue = true)] public bool Required { get; set; } /// @@ -189,9 +175,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseDocumentStaticFieldBase {\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" ApiId: ").Append(ApiId).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" Signer: ").Append(Signer).Append("\n"); sb.Append(" X: ").Append(X).Append("\n"); sb.Append(" Y: ").Append(Y).Append("\n"); @@ -234,6 +220,11 @@ public bool Equals(TemplateResponseDocumentStaticFieldBase input) return false; } return + ( + this.Type == input.Type || + (this.Type != null && + this.Type.Equals(input.Type)) + ) && ( this.ApiId == input.ApiId || (this.ApiId != null && @@ -244,11 +235,6 @@ public bool Equals(TemplateResponseDocumentStaticFieldBase input) (this.Name != null && this.Name.Equals(input.Name)) ) && - ( - this.Type == input.Type || - (this.Type != null && - this.Type.Equals(input.Type)) - ) && ( this.Signer == input.Signer || (this.Signer != null && @@ -290,6 +276,10 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; + if (this.Type != null) + { + hashCode = (hashCode * 59) + this.Type.GetHashCode(); + } if (this.ApiId != null) { hashCode = (hashCode * 59) + this.ApiId.GetHashCode(); @@ -298,10 +288,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Name.GetHashCode(); } - if (this.Type != null) - { - hashCode = (hashCode * 59) + this.Type.GetHashCode(); - } if (this.Signer != null) { hashCode = (hashCode * 59) + this.Signer.GetHashCode(); @@ -342,6 +328,13 @@ public List GetOpenApiTypes() { var types = new List(); types.Add(new OpenApiType() + { + Name = "type", + Property = "Type", + Type = "string", + Value = Type, + }); + types.Add(new OpenApiType() { Name = "api_id", Property = "ApiId", @@ -356,13 +349,6 @@ public List GetOpenApiTypes() Value = Name, }); types.Add(new OpenApiType() - { - Name = "type", - Property = "Type", - Type = "string", - Value = Type, - }); - types.Add(new OpenApiType() { Name = "signer", Property = "Signer", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs index ecc2a11d8..0d5fce147 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldCheckbox() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "checkbox"). - /// A unique id for the static field. (required). - /// The name of the static field. (required). - /// The signer of the Static Field. (required) (default to "me_now"). - /// The horizontal offset in pixels for this static field. (required). - /// The vertical offset in pixels for this static field. (required). - /// The width in pixels of this static field. (required). - /// The height in pixels of this static field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the static field.. + /// The name of the static field.. + /// The signer of the Static Field. (default to "me_now"). + /// The horizontal offset in pixels for this static field.. + /// The vertical offset in pixels for this static field.. + /// The width in pixels of this static field.. + /// The height in pixels of this static field.. + /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldCheckbox(string type = @"checkbox", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs index af09f33ac..4d30a2038 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldDateSigned() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "date_signed"). - /// A unique id for the static field. (required). - /// The name of the static field. (required). - /// The signer of the Static Field. (required) (default to "me_now"). - /// The horizontal offset in pixels for this static field. (required). - /// The vertical offset in pixels for this static field. (required). - /// The width in pixels of this static field. (required). - /// The height in pixels of this static field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the static field.. + /// The name of the static field.. + /// The signer of the Static Field. (default to "me_now"). + /// The horizontal offset in pixels for this static field.. + /// The vertical offset in pixels for this static field.. + /// The width in pixels of this static field.. + /// The height in pixels of this static field.. + /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldDateSigned(string type = @"date_signed", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs index 381e2eed8..423e983f4 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldDropdown() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "dropdown"). - /// A unique id for the static field. (required). - /// The name of the static field. (required). - /// The signer of the Static Field. (required) (default to "me_now"). - /// The horizontal offset in pixels for this static field. (required). - /// The vertical offset in pixels for this static field. (required). - /// The width in pixels of this static field. (required). - /// The height in pixels of this static field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the static field.. + /// The name of the static field.. + /// The signer of the Static Field. (default to "me_now"). + /// The horizontal offset in pixels for this static field.. + /// The vertical offset in pixels for this static field.. + /// The width in pixels of this static field.. + /// The height in pixels of this static field.. + /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldDropdown(string type = @"dropdown", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs index 4d3426e92..78b8bd087 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldHyperlink() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "hyperlink"). - /// A unique id for the static field. (required). - /// The name of the static field. (required). - /// The signer of the Static Field. (required) (default to "me_now"). - /// The horizontal offset in pixels for this static field. (required). - /// The vertical offset in pixels for this static field. (required). - /// The width in pixels of this static field. (required). - /// The height in pixels of this static field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the static field.. + /// The name of the static field.. + /// The signer of the Static Field. (default to "me_now"). + /// The horizontal offset in pixels for this static field.. + /// The vertical offset in pixels for this static field.. + /// The width in pixels of this static field.. + /// The height in pixels of this static field.. + /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldHyperlink(string type = @"hyperlink", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs index 0d07e78f2..cc5526323 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldInitials() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "initials"). - /// A unique id for the static field. (required). - /// The name of the static field. (required). - /// The signer of the Static Field. (required) (default to "me_now"). - /// The horizontal offset in pixels for this static field. (required). - /// The vertical offset in pixels for this static field. (required). - /// The width in pixels of this static field. (required). - /// The height in pixels of this static field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the static field.. + /// The name of the static field.. + /// The signer of the Static Field. (default to "me_now"). + /// The horizontal offset in pixels for this static field.. + /// The vertical offset in pixels for this static field.. + /// The width in pixels of this static field.. + /// The height in pixels of this static field.. + /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldInitials(string type = @"initials", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs index c25fd9db6..24f09b8c1 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldRadio() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "radio"). - /// A unique id for the static field. (required). - /// The name of the static field. (required). - /// The signer of the Static Field. (required) (default to "me_now"). - /// The horizontal offset in pixels for this static field. (required). - /// The vertical offset in pixels for this static field. (required). - /// The width in pixels of this static field. (required). - /// The height in pixels of this static field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the static field.. + /// The name of the static field.. + /// The signer of the Static Field. (default to "me_now"). + /// The horizontal offset in pixels for this static field.. + /// The vertical offset in pixels for this static field.. + /// The width in pixels of this static field.. + /// The height in pixels of this static field.. + /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldRadio(string type = @"radio", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs index f4f5b70e2..0d7ea03a6 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldSignature() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "signature"). - /// A unique id for the static field. (required). - /// The name of the static field. (required). - /// The signer of the Static Field. (required) (default to "me_now"). - /// The horizontal offset in pixels for this static field. (required). - /// The vertical offset in pixels for this static field. (required). - /// The width in pixels of this static field. (required). - /// The height in pixels of this static field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the static field.. + /// The name of the static field.. + /// The signer of the Static Field. (default to "me_now"). + /// The horizontal offset in pixels for this static field.. + /// The vertical offset in pixels for this static field.. + /// The width in pixels of this static field.. + /// The height in pixels of this static field.. + /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldSignature(string type = @"signature", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs index ba2930e53..48c59ea75 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldText() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "text"). - /// A unique id for the static field. (required). - /// The name of the static field. (required). - /// The signer of the Static Field. (required) (default to "me_now"). - /// The horizontal offset in pixels for this static field. (required). - /// The vertical offset in pixels for this static field. (required). - /// The width in pixels of this static field. (required). - /// The height in pixels of this static field. (required). - /// Boolean showing whether or not this field is required. (required). + /// A unique id for the static field.. + /// The name of the static field.. + /// The signer of the Static Field. (default to "me_now"). + /// The horizontal offset in pixels for this static field.. + /// The vertical offset in pixels for this static field.. + /// The width in pixels of this static field.. + /// The height in pixels of this static field.. + /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldText(string type = @"text", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs index 6ed7b426c..3d3ae1df2 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs @@ -41,8 +41,8 @@ protected TemplateResponseFieldAvgTextLength() { } /// /// Initializes a new instance of the class. /// - /// Number of lines. (required). - /// Number of characters per line. (required). + /// Number of lines.. + /// Number of characters per line.. public TemplateResponseFieldAvgTextLength(int numLines = default(int), int numCharsPerLine = default(int)) { @@ -70,14 +70,14 @@ public static TemplateResponseFieldAvgTextLength Init(string jsonData) /// Number of lines. /// /// Number of lines. - [DataMember(Name = "num_lines", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "num_lines", EmitDefaultValue = true)] public int NumLines { get; set; } /// /// Number of characters per line. /// /// Number of characters per line. - [DataMember(Name = "num_chars_per_line", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "num_chars_per_line", EmitDefaultValue = true)] public int NumCharsPerLine { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs index f11de6735..db464fd46 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs @@ -41,16 +41,11 @@ protected TemplateResponseSignerRole() { } /// /// Initializes a new instance of the class. /// - /// The name of the Role. (required). + /// The name of the Role.. /// If signer order is assigned this is the 0-based index for this role.. public TemplateResponseSignerRole(string name = default(string), int order = default(int)) { - // to ensure "name" is required (not null) - if (name == null) - { - throw new ArgumentNullException("name is a required property for TemplateResponseSignerRole and cannot be null"); - } this.Name = name; this.Order = order; } @@ -75,7 +70,7 @@ public static TemplateResponseSignerRole Init(string jsonData) /// The name of the Role. /// /// The name of the Role. - [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs index d82c11047..4a8863338 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs @@ -41,16 +41,11 @@ protected TemplateUpdateFilesResponseTemplate() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template. (required). + /// The id of the Template.. /// A list of warnings.. public TemplateUpdateFilesResponseTemplate(string templateId = default(string), List warnings = default(List)) { - // to ensure "templateId" is required (not null) - if (templateId == null) - { - throw new ArgumentNullException("templateId is a required property for TemplateUpdateFilesResponseTemplate and cannot be null"); - } this.TemplateId = templateId; this.Warnings = warnings; } @@ -75,7 +70,7 @@ public static TemplateUpdateFilesResponseTemplate Init(string jsonData) /// The id of the Template. /// /// The id of the Template. - [DataMember(Name = "template_id", IsRequired = true, EmitDefaultValue = true)] + [DataMember(Name = "template_id", EmitDefaultValue = true)] public string TemplateId { get; set; } /// diff --git a/sdks/java-v1/docs/ApiAppResponse.md b/sdks/java-v1/docs/ApiAppResponse.md index 7eb6e967d..afe95c850 100644 --- a/sdks/java-v1/docs/ApiAppResponse.md +++ b/sdks/java-v1/docs/ApiAppResponse.md @@ -8,15 +8,15 @@ Contains information about an API App. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `clientId`*_required_ | ```String``` | The app's client id | | -| `createdAt`*_required_ | ```Integer``` | The time that the app was created | | -| `domains`*_required_ | ```List``` | The domain name(s) associated with the app | | -| `name`*_required_ | ```String``` | The name of the app | | -| `isApproved`*_required_ | ```Boolean``` | Boolean to indicate if the app has been approved | | -| `options`*_required_ | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | -| `ownerAccount`*_required_ | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `callbackUrl` | ```String``` | The app's callback URL (for events) | | +| `clientId` | ```String``` | The app's client id | | +| `createdAt` | ```Integer``` | The time that the app was created | | +| `domains` | ```List``` | The domain name(s) associated with the app | | +| `name` | ```String``` | The name of the app | | +| `isApproved` | ```Boolean``` | Boolean to indicate if the app has been approved | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | +| `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | +| `ownerAccount` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `whiteLabelingOptions` | [```ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | | diff --git a/sdks/java-v1/docs/ApiAppResponseOAuth.md b/sdks/java-v1/docs/ApiAppResponseOAuth.md index 93f22d3cc..c2f705c7a 100644 --- a/sdks/java-v1/docs/ApiAppResponseOAuth.md +++ b/sdks/java-v1/docs/ApiAppResponseOAuth.md @@ -8,10 +8,10 @@ An object describing the app's OAuth properties, or null if OAuth is not con | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `callbackUrl`*_required_ | ```String``` | The app's OAuth callback URL. | | -| `scopes`*_required_ | ```List``` | Array of OAuth scopes used by the app. | | -| `chargesUsers`*_required_ | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | +| `callbackUrl` | ```String``` | The app's OAuth callback URL. | | | `secret` | ```String``` | The app's OAuth secret, or null if the app does not belong to user. | | +| `scopes` | ```List``` | Array of OAuth scopes used by the app. | | +| `chargesUsers` | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | diff --git a/sdks/java-v1/docs/ApiAppResponseOptions.md b/sdks/java-v1/docs/ApiAppResponseOptions.md index e6694664d..07979f387 100644 --- a/sdks/java-v1/docs/ApiAppResponseOptions.md +++ b/sdks/java-v1/docs/ApiAppResponseOptions.md @@ -8,7 +8,7 @@ An object with options that override account settings. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `canInsertEverywhere`*_required_ | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `canInsertEverywhere` | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | diff --git a/sdks/java-v1/docs/ApiAppResponseOwnerAccount.md b/sdks/java-v1/docs/ApiAppResponseOwnerAccount.md index a9c5142b3..b4d6d4249 100644 --- a/sdks/java-v1/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/java-v1/docs/ApiAppResponseOwnerAccount.md @@ -8,8 +8,8 @@ An object describing the app's owner | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId`*_required_ | ```String``` | The owner account's ID | | -| `emailAddress`*_required_ | ```String``` | The owner account's email address | | +| `accountId` | ```String``` | The owner account's ID | | +| `emailAddress` | ```String``` | The owner account's email address | | diff --git a/sdks/java-v1/docs/ApiAppResponseWhiteLabelingOptions.md b/sdks/java-v1/docs/ApiAppResponseWhiteLabelingOptions.md index f26b0591e..be6d022fd 100644 --- a/sdks/java-v1/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/java-v1/docs/ApiAppResponseWhiteLabelingOptions.md @@ -8,20 +8,20 @@ An object with options to customize the app's signer page | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `headerBackgroundColor`*_required_ | ```String``` | | | -| `legalVersion`*_required_ | ```String``` | | | -| `linkColor`*_required_ | ```String``` | | | -| `pageBackgroundColor`*_required_ | ```String``` | | | -| `primaryButtonColor`*_required_ | ```String``` | | | -| `primaryButtonColorHover`*_required_ | ```String``` | | | -| `primaryButtonTextColor`*_required_ | ```String``` | | | -| `primaryButtonTextColorHover`*_required_ | ```String``` | | | -| `secondaryButtonColor`*_required_ | ```String``` | | | -| `secondaryButtonColorHover`*_required_ | ```String``` | | | -| `secondaryButtonTextColor`*_required_ | ```String``` | | | -| `secondaryButtonTextColorHover`*_required_ | ```String``` | | | -| `textColor1`*_required_ | ```String``` | | | -| `textColor2`*_required_ | ```String``` | | | +| `headerBackgroundColor` | ```String``` | | | +| `legalVersion` | ```String``` | | | +| `linkColor` | ```String``` | | | +| `pageBackgroundColor` | ```String``` | | | +| `primaryButtonColor` | ```String``` | | | +| `primaryButtonColorHover` | ```String``` | | | +| `primaryButtonTextColor` | ```String``` | | | +| `primaryButtonTextColorHover` | ```String``` | | | +| `secondaryButtonColor` | ```String``` | | | +| `secondaryButtonColorHover` | ```String``` | | | +| `secondaryButtonTextColor` | ```String``` | | | +| `secondaryButtonTextColorHover` | ```String``` | | | +| `textColor1` | ```String``` | | | +| `textColor2` | ```String``` | | | diff --git a/sdks/java-v1/docs/BulkSendJobResponse.md b/sdks/java-v1/docs/BulkSendJobResponse.md index e177a023a..eb2278a34 100644 --- a/sdks/java-v1/docs/BulkSendJobResponse.md +++ b/sdks/java-v1/docs/BulkSendJobResponse.md @@ -8,10 +8,10 @@ Contains information about the BulkSendJob such as when it was created and how m | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `bulkSendJobId`*_required_ | ```String``` | The id of the BulkSendJob. | | -| `total`*_required_ | ```Integer``` | The total amount of Signature Requests queued for sending. | | -| `isCreator`*_required_ | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `createdAt`*_required_ | ```Integer``` | Time that the BulkSendJob was created. | | +| `bulkSendJobId` | ```String``` | The id of the BulkSendJob. | | +| `total` | ```Integer``` | The total amount of Signature Requests queued for sending. | | +| `isCreator` | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | +| `createdAt` | ```Integer``` | Time that the BulkSendJob was created. | | diff --git a/sdks/java-v1/docs/FaxLineResponseFaxLine.md b/sdks/java-v1/docs/FaxLineResponseFaxLine.md index eac0a881f..daf0d206a 100644 --- a/sdks/java-v1/docs/FaxLineResponseFaxLine.md +++ b/sdks/java-v1/docs/FaxLineResponseFaxLine.md @@ -8,10 +8,10 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | Number | | -| `createdAt`*_required_ | ```Integer``` | Created at | | -| `updatedAt`*_required_ | ```Integer``` | Updated at | | -| `accounts`*_required_ | [```List```](AccountResponse.md) | | | +| `number` | ```String``` | Number | | +| `createdAt` | ```Integer``` | Created at | | +| `updatedAt` | ```Integer``` | Updated at | | +| `accounts` | [```List```](AccountResponse.md) | | | diff --git a/sdks/java-v1/docs/TeamResponse.md b/sdks/java-v1/docs/TeamResponse.md index 6dfe49923..ca6344cfc 100644 --- a/sdks/java-v1/docs/TeamResponse.md +++ b/sdks/java-v1/docs/TeamResponse.md @@ -8,10 +8,10 @@ Contains information about your team and its members | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name`*_required_ | ```String``` | The name of your Team | | -| `accounts`*_required_ | [```List```](AccountResponse.md) | | | -| `invitedAccounts`*_required_ | [```List```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | -| `invitedEmails`*_required_ | ```List``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `name` | ```String``` | The name of your Team | | +| `accounts` | [```List```](AccountResponse.md) | | | +| `invitedAccounts` | [```List```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | +| `invitedEmails` | ```List``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | diff --git a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 224ec6c71..770cce434 100644 --- a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -8,9 +8,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId`*_required_ | ```String``` | The id of the Template. | | -| `editUrl`*_required_ | ```String``` | Link to edit the template. | | -| `expiresAt`*_required_ | ```Integer``` | When the link expires. | | +| `templateId` | ```String``` | The id of the Template. | | +| `editUrl` | ```String``` | Link to edit the template. | | +| `expiresAt` | ```Integer``` | When the link expires. | | | `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/java-v1/docs/TemplateCreateResponseTemplate.md b/sdks/java-v1/docs/TemplateCreateResponseTemplate.md index 79801d898..1dcd4bd79 100644 --- a/sdks/java-v1/docs/TemplateCreateResponseTemplate.md +++ b/sdks/java-v1/docs/TemplateCreateResponseTemplate.md @@ -8,7 +8,7 @@ Template object with parameters: `template_id`. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId`*_required_ | ```String``` | The id of the Template. | | +| `templateId` | ```String``` | The id of the Template. | | diff --git a/sdks/java-v1/docs/TemplateResponse.md b/sdks/java-v1/docs/TemplateResponse.md index 87d844276..27673e39b 100644 --- a/sdks/java-v1/docs/TemplateResponse.md +++ b/sdks/java-v1/docs/TemplateResponse.md @@ -8,22 +8,22 @@ Contains information about the templates you and your team have created. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId`*_required_ | ```String``` | The id of the Template. | | -| `title`*_required_ | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message`*_required_ | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `isCreator`*_required_ | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `canEdit`*_required_ | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `isLocked`*_required_ | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata`*_required_ | ```Object``` | The metadata attached to the template. | | -| `signerRoles`*_required_ | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `ccRoles`*_required_ | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents`*_required_ | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | -| `accounts`*_required_ | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | -| `attachments`*_required_ | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `templateId` | ```String``` | The id of the Template. | | +| `title` | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message` | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | | `updatedAt` | ```Integer``` | Time the template was last updated. | | | `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | +| `isCreator` | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `canEdit` | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `isLocked` | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata` | ```Object``` | The metadata attached to the template. | | +| `signerRoles` | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `ccRoles` | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | +| `documents` | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | +| `accounts` | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments` | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | diff --git a/sdks/java-v1/docs/TemplateResponseAccount.md b/sdks/java-v1/docs/TemplateResponseAccount.md index dd8ebce7f..10c996408 100644 --- a/sdks/java-v1/docs/TemplateResponseAccount.md +++ b/sdks/java-v1/docs/TemplateResponseAccount.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_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.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` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | diff --git a/sdks/java-v1/docs/TemplateResponseAccountQuota.md b/sdks/java-v1/docs/TemplateResponseAccountQuota.md index 72160ca8f..ad94c2493 100644 --- a/sdks/java-v1/docs/TemplateResponseAccountQuota.md +++ b/sdks/java-v1/docs/TemplateResponseAccountQuota.md @@ -8,10 +8,10 @@ An array of the designated CC roles that must be specified when sending a Signat | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templatesLeft`*_required_ | ```Integer``` | API templates remaining. | | -| `apiSignatureRequestsLeft`*_required_ | ```Integer``` | API signature requests remaining. | | -| `documentsLeft`*_required_ | ```Integer``` | Signature requests remaining. | | -| `smsVerificationsLeft`*_required_ | ```Integer``` | SMS verifications remaining. | | +| `templatesLeft` | ```Integer``` | API templates remaining. | | +| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | | +| `documentsLeft` | ```Integer``` | Signature requests remaining. | | +| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | diff --git a/sdks/java-v1/docs/TemplateResponseCCRole.md b/sdks/java-v1/docs/TemplateResponseCCRole.md index 06e61bff4..64069b826 100644 --- a/sdks/java-v1/docs/TemplateResponseCCRole.md +++ b/sdks/java-v1/docs/TemplateResponseCCRole.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name`*_required_ | ```String``` | The name of the Role. | | +| `name` | ```String``` | The name of the Role. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocument.md b/sdks/java-v1/docs/TemplateResponseDocument.md index cb69a481f..65da85d42 100644 --- a/sdks/java-v1/docs/TemplateResponseDocument.md +++ b/sdks/java-v1/docs/TemplateResponseDocument.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name`*_required_ | ```String``` | Name of the associated file. | | -| `fieldGroups`*_required_ | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `formFields`*_required_ | [```List```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `customFields`*_required_ | [```List```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `staticFields`*_required_ | [```List```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | +| `name` | ```String``` | Name of the associated file. | | | `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | +| `fieldGroups` | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `formFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `staticFields` | [```List```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md index c7c7f8264..edd461727 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md @@ -8,15 +8,15 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiId`*_required_ | ```String``` | The unique ID for this field. | | -| `name`*_required_ | ```String``` | The name of the Custom Field. | | | `type`*_required_ | ```String``` | | | -| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | -| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | -| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `apiId` | ```String``` | The unique ID for this field. | | +| `name` | ```String``` | The name of the Custom Field. | | | `signer` | ```String``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | +| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width` | ```Integer``` | The width in pixels of this form field. | | +| `height` | ```Integer``` | The height in pixels of this form field. | | +| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md index 70c991777..ccaf19394 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md @@ -9,10 +9,10 @@ This class extends `TemplateResponseDocumentCustomFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | | -| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | +| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily` | ```String``` | Font family used in this form field's text. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md index 7dd066f54..03b5ffbb8 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name`*_required_ | ```String``` | The name of the form field group. | | -| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name` | ```String``` | The name of the form field group. | | +| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md index 59d4e5e06..e0f4dcc8a 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md @@ -8,8 +8,8 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `requirement`*_required_ | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `groupLabel`*_required_ | ```String``` | Name of the group | | +| `requirement` | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `groupLabel` | ```String``` | Name of the group | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md index 8d8766339..6ff896074 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md @@ -8,15 +8,15 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiId`*_required_ | ```String``` | A unique id for the form field. | | -| `name`*_required_ | ```String``` | The name of the form field. | | | `type`*_required_ | ```String``` | | | -| `signer`*_required_ | ```String``` | The signer of the Form Field. | | -| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | -| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | -| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `apiId` | ```String``` | A unique id for the form field. | | +| `name` | ```String``` | The name of the form field. | | +| `signer` | ```String``` | The signer of the Form Field. | | +| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width` | ```Integer``` | The width in pixels of this form field. | | +| `height` | ```Integer``` | The height in pixels of this form field. | | +| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md index 104029730..e8efcf2d7 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -9,10 +9,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | +| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily` | ```String``` | Font family used in this form field's text. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md index 31520bd6f..49cdfaad6 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md @@ -9,10 +9,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | +| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily` | ```String``` | Font family used in this form field's text. | | | `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md index f52329b04..4be3cf070 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md @@ -8,15 +8,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiId`*_required_ | ```String``` | A unique id for the static field. | | -| `name`*_required_ | ```String``` | The name of the static field. | | | `type`*_required_ | ```String``` | | | -| `signer`*_required_ | ```String``` | The signer of the Static Field. | | -| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this static field. | | -| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this static field. | | -| `width`*_required_ | ```Integer``` | The width in pixels of this static field. | | -| `height`*_required_ | ```Integer``` | The height in pixels of this static field. | | -| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `apiId` | ```String``` | A unique id for the static field. | | +| `name` | ```String``` | The name of the static field. | | +| `signer` | ```String``` | The signer of the Static Field. | | +| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | | +| `y` | ```Integer``` | The vertical offset in pixels for this static field. | | +| `width` | ```Integer``` | The width in pixels of this static field. | | +| `height` | ```Integer``` | The height in pixels of this static field. | | +| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md b/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md index f0d2106b0..bb66f3057 100644 --- a/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md @@ -8,8 +8,8 @@ Average text length in this field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `numLines`*_required_ | ```Integer``` | Number of lines. | | -| `numCharsPerLine`*_required_ | ```Integer``` | Number of characters per line. | | +| `numLines` | ```Integer``` | Number of lines. | | +| `numCharsPerLine` | ```Integer``` | Number of characters per line. | | diff --git a/sdks/java-v1/docs/TemplateResponseSignerRole.md b/sdks/java-v1/docs/TemplateResponseSignerRole.md index 08458f4e0..15b48cf17 100644 --- a/sdks/java-v1/docs/TemplateResponseSignerRole.md +++ b/sdks/java-v1/docs/TemplateResponseSignerRole.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name`*_required_ | ```String``` | The name of the Role. | | +| `name` | ```String``` | The name of the Role. | | | `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this role. | | diff --git a/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md index 7acdbb340..6289a9953 100644 --- a/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md @@ -8,7 +8,7 @@ Contains template id | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId`*_required_ | ```String``` | The id of the Template. | | +| `templateId` | ```String``` | The id of the Template. | | | `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponse.java index 434a38779..9e5b0073d 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponse.java @@ -27,15 +27,15 @@ /** Contains information about an API App. */ @JsonPropertyOrder({ + ApiAppResponse.JSON_PROPERTY_CALLBACK_URL, ApiAppResponse.JSON_PROPERTY_CLIENT_ID, ApiAppResponse.JSON_PROPERTY_CREATED_AT, ApiAppResponse.JSON_PROPERTY_DOMAINS, ApiAppResponse.JSON_PROPERTY_NAME, ApiAppResponse.JSON_PROPERTY_IS_APPROVED, + ApiAppResponse.JSON_PROPERTY_OAUTH, ApiAppResponse.JSON_PROPERTY_OPTIONS, ApiAppResponse.JSON_PROPERTY_OWNER_ACCOUNT, - ApiAppResponse.JSON_PROPERTY_CALLBACK_URL, - ApiAppResponse.JSON_PROPERTY_OAUTH, ApiAppResponse.JSON_PROPERTY_WHITE_LABELING_OPTIONS }) @javax.annotation.Generated( @@ -43,6 +43,9 @@ comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown = true) public class ApiAppResponse { + public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; + private String callbackUrl; + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; private String clientId; @@ -50,7 +53,7 @@ public class ApiAppResponse { private Integer createdAt; public static final String JSON_PROPERTY_DOMAINS = "domains"; - private List domains = new ArrayList<>(); + private List domains = null; public static final String JSON_PROPERTY_NAME = "name"; private String name; @@ -58,18 +61,15 @@ public class ApiAppResponse { public static final String JSON_PROPERTY_IS_APPROVED = "is_approved"; private Boolean isApproved; + public static final String JSON_PROPERTY_OAUTH = "oauth"; + private ApiAppResponseOAuth oauth; + public static final String JSON_PROPERTY_OPTIONS = "options"; private ApiAppResponseOptions options; public static final String JSON_PROPERTY_OWNER_ACCOUNT = "owner_account"; private ApiAppResponseOwnerAccount ownerAccount; - public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; - private String callbackUrl; - - public static final String JSON_PROPERTY_OAUTH = "oauth"; - private ApiAppResponseOAuth oauth; - public static final String JSON_PROPERTY_WHITE_LABELING_OPTIONS = "white_labeling_options"; private ApiAppResponseWhiteLabelingOptions whiteLabelingOptions; @@ -89,6 +89,28 @@ public static ApiAppResponse init(HashMap data) throws Exception { .readValue(new ObjectMapper().writeValueAsString(data), ApiAppResponse.class); } + public ApiAppResponse callbackUrl(String callbackUrl) { + this.callbackUrl = callbackUrl; + return this; + } + + /** + * The app's callback URL (for events) + * + * @return callbackUrl + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CALLBACK_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getCallbackUrl() { + return callbackUrl; + } + + @JsonProperty(JSON_PROPERTY_CALLBACK_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCallbackUrl(String callbackUrl) { + this.callbackUrl = callbackUrl; + } + public ApiAppResponse clientId(String clientId) { this.clientId = clientId; return this; @@ -99,15 +121,14 @@ public ApiAppResponse clientId(String clientId) { * * @return clientId */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getClientId() { return clientId; } @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClientId(String clientId) { this.clientId = clientId; } @@ -122,15 +143,14 @@ public ApiAppResponse createdAt(Integer createdAt) { * * @return createdAt */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CREATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getCreatedAt() { return createdAt; } @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(Integer createdAt) { this.createdAt = createdAt; } @@ -153,15 +173,14 @@ public ApiAppResponse addDomainsItem(String domainsItem) { * * @return domains */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_DOMAINS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_DOMAINS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getDomains() { return domains; } @JsonProperty(JSON_PROPERTY_DOMAINS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDomains(List domains) { this.domains = domains; } @@ -176,15 +195,14 @@ public ApiAppResponse name(String name) { * * @return name */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } @@ -199,19 +217,40 @@ public ApiAppResponse isApproved(Boolean isApproved) { * * @return isApproved */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_IS_APPROVED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_APPROVED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsApproved() { return isApproved; } @JsonProperty(JSON_PROPERTY_IS_APPROVED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsApproved(Boolean isApproved) { this.isApproved = isApproved; } + public ApiAppResponse oauth(ApiAppResponseOAuth oauth) { + this.oauth = oauth; + return this; + } + + /** + * Get oauth + * + * @return oauth + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_OAUTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public ApiAppResponseOAuth getOauth() { + return oauth; + } + + @JsonProperty(JSON_PROPERTY_OAUTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setOauth(ApiAppResponseOAuth oauth) { + this.oauth = oauth; + } + public ApiAppResponse options(ApiAppResponseOptions options) { this.options = options; return this; @@ -222,15 +261,14 @@ public ApiAppResponse options(ApiAppResponseOptions options) { * * @return options */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_OPTIONS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public ApiAppResponseOptions getOptions() { return options; } @JsonProperty(JSON_PROPERTY_OPTIONS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOptions(ApiAppResponseOptions options) { this.options = options; } @@ -245,63 +283,18 @@ public ApiAppResponse ownerAccount(ApiAppResponseOwnerAccount ownerAccount) { * * @return ownerAccount */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_OWNER_ACCOUNT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_OWNER_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public ApiAppResponseOwnerAccount getOwnerAccount() { return ownerAccount; } @JsonProperty(JSON_PROPERTY_OWNER_ACCOUNT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwnerAccount(ApiAppResponseOwnerAccount ownerAccount) { this.ownerAccount = ownerAccount; } - public ApiAppResponse callbackUrl(String callbackUrl) { - this.callbackUrl = callbackUrl; - return this; - } - - /** - * The app's callback URL (for events) - * - * @return callbackUrl - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getCallbackUrl() { - return callbackUrl; - } - - @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCallbackUrl(String callbackUrl) { - this.callbackUrl = callbackUrl; - } - - public ApiAppResponse oauth(ApiAppResponseOAuth oauth) { - this.oauth = oauth; - return this; - } - - /** - * Get oauth - * - * @return oauth - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_OAUTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public ApiAppResponseOAuth getOauth() { - return oauth; - } - - @JsonProperty(JSON_PROPERTY_OAUTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauth(ApiAppResponseOAuth oauth) { - this.oauth = oauth; - } - public ApiAppResponse whiteLabelingOptions( ApiAppResponseWhiteLabelingOptions whiteLabelingOptions) { this.whiteLabelingOptions = whiteLabelingOptions; @@ -335,30 +328,30 @@ public boolean equals(Object o) { return false; } ApiAppResponse apiAppResponse = (ApiAppResponse) o; - return Objects.equals(this.clientId, apiAppResponse.clientId) + return Objects.equals(this.callbackUrl, apiAppResponse.callbackUrl) + && Objects.equals(this.clientId, apiAppResponse.clientId) && Objects.equals(this.createdAt, apiAppResponse.createdAt) && Objects.equals(this.domains, apiAppResponse.domains) && Objects.equals(this.name, apiAppResponse.name) && Objects.equals(this.isApproved, apiAppResponse.isApproved) + && Objects.equals(this.oauth, apiAppResponse.oauth) && Objects.equals(this.options, apiAppResponse.options) && Objects.equals(this.ownerAccount, apiAppResponse.ownerAccount) - && Objects.equals(this.callbackUrl, apiAppResponse.callbackUrl) - && Objects.equals(this.oauth, apiAppResponse.oauth) && Objects.equals(this.whiteLabelingOptions, apiAppResponse.whiteLabelingOptions); } @Override public int hashCode() { return Objects.hash( + callbackUrl, clientId, createdAt, domains, name, isApproved, + oauth, options, ownerAccount, - callbackUrl, - oauth, whiteLabelingOptions); } @@ -366,15 +359,15 @@ public int hashCode() { public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ApiAppResponse {\n"); + sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n"); sb.append(" domains: ").append(toIndentedString(domains)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" isApproved: ").append(toIndentedString(isApproved)).append("\n"); + sb.append(" oauth: ").append(toIndentedString(oauth)).append("\n"); sb.append(" options: ").append(toIndentedString(options)).append("\n"); sb.append(" ownerAccount: ").append(toIndentedString(ownerAccount)).append("\n"); - sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); - sb.append(" oauth: ").append(toIndentedString(oauth)).append("\n"); sb.append(" whiteLabelingOptions: ") .append(toIndentedString(whiteLabelingOptions)) .append("\n"); @@ -386,6 +379,26 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { + if (callbackUrl != null) { + if (isFileTypeOrListOfFiles(callbackUrl)) { + fileTypeFound = true; + } + + if (callbackUrl.getClass().equals(java.io.File.class) + || callbackUrl.getClass().equals(Integer.class) + || callbackUrl.getClass().equals(String.class) + || callbackUrl.getClass().isEnum()) { + map.put("callback_url", callbackUrl); + } else if (isListOfFile(callbackUrl)) { + for (int i = 0; i < getListSize(callbackUrl); i++) { + map.put("callback_url[" + i + "]", getFromList(callbackUrl, i)); + } + } else { + map.put( + "callback_url", + JSON.getDefault().getMapper().writeValueAsString(callbackUrl)); + } + } if (clientId != null) { if (isFileTypeOrListOfFiles(clientId)) { fileTypeFound = true; @@ -482,6 +495,24 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(isApproved)); } } + if (oauth != null) { + if (isFileTypeOrListOfFiles(oauth)) { + fileTypeFound = true; + } + + if (oauth.getClass().equals(java.io.File.class) + || oauth.getClass().equals(Integer.class) + || oauth.getClass().equals(String.class) + || oauth.getClass().isEnum()) { + map.put("oauth", oauth); + } else if (isListOfFile(oauth)) { + for (int i = 0; i < getListSize(oauth); i++) { + map.put("oauth[" + i + "]", getFromList(oauth, i)); + } + } else { + map.put("oauth", JSON.getDefault().getMapper().writeValueAsString(oauth)); + } + } if (options != null) { if (isFileTypeOrListOfFiles(options)) { fileTypeFound = true; @@ -520,44 +551,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(ownerAccount)); } } - if (callbackUrl != null) { - if (isFileTypeOrListOfFiles(callbackUrl)) { - fileTypeFound = true; - } - - if (callbackUrl.getClass().equals(java.io.File.class) - || callbackUrl.getClass().equals(Integer.class) - || callbackUrl.getClass().equals(String.class) - || callbackUrl.getClass().isEnum()) { - map.put("callback_url", callbackUrl); - } else if (isListOfFile(callbackUrl)) { - for (int i = 0; i < getListSize(callbackUrl); i++) { - map.put("callback_url[" + i + "]", getFromList(callbackUrl, i)); - } - } else { - map.put( - "callback_url", - JSON.getDefault().getMapper().writeValueAsString(callbackUrl)); - } - } - if (oauth != null) { - if (isFileTypeOrListOfFiles(oauth)) { - fileTypeFound = true; - } - - if (oauth.getClass().equals(java.io.File.class) - || oauth.getClass().equals(Integer.class) - || oauth.getClass().equals(String.class) - || oauth.getClass().isEnum()) { - map.put("oauth", oauth); - } else if (isListOfFile(oauth)) { - for (int i = 0; i < getListSize(oauth); i++) { - map.put("oauth[" + i + "]", getFromList(oauth, i)); - } - } else { - map.put("oauth", JSON.getDefault().getMapper().writeValueAsString(oauth)); - } - } if (whiteLabelingOptions != null) { if (isFileTypeOrListOfFiles(whiteLabelingOptions)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java index 71e53d84c..74ba41e86 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java @@ -31,9 +31,9 @@ */ @JsonPropertyOrder({ ApiAppResponseOAuth.JSON_PROPERTY_CALLBACK_URL, + ApiAppResponseOAuth.JSON_PROPERTY_SECRET, ApiAppResponseOAuth.JSON_PROPERTY_SCOPES, - ApiAppResponseOAuth.JSON_PROPERTY_CHARGES_USERS, - ApiAppResponseOAuth.JSON_PROPERTY_SECRET + ApiAppResponseOAuth.JSON_PROPERTY_CHARGES_USERS }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -43,15 +43,15 @@ public class ApiAppResponseOAuth { public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; private String callbackUrl; + public static final String JSON_PROPERTY_SECRET = "secret"; + private String secret; + public static final String JSON_PROPERTY_SCOPES = "scopes"; - private List scopes = new ArrayList<>(); + private List scopes = null; public static final String JSON_PROPERTY_CHARGES_USERS = "charges_users"; private Boolean chargesUsers; - public static final String JSON_PROPERTY_SECRET = "secret"; - private String secret; - public ApiAppResponseOAuth() {} /** @@ -78,19 +78,40 @@ public ApiAppResponseOAuth callbackUrl(String callbackUrl) { * * @return callbackUrl */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CALLBACK_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getCallbackUrl() { return callbackUrl; } @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCallbackUrl(String callbackUrl) { this.callbackUrl = callbackUrl; } + public ApiAppResponseOAuth secret(String secret) { + this.secret = secret; + return this; + } + + /** + * The app's OAuth secret, or null if the app does not belong to user. + * + * @return secret + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getSecret() { + return secret; + } + + @JsonProperty(JSON_PROPERTY_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSecret(String secret) { + this.secret = secret; + } + public ApiAppResponseOAuth scopes(List scopes) { this.scopes = scopes; return this; @@ -109,15 +130,14 @@ public ApiAppResponseOAuth addScopesItem(String scopesItem) { * * @return scopes */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_SCOPES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SCOPES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getScopes() { return scopes; } @JsonProperty(JSON_PROPERTY_SCOPES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScopes(List scopes) { this.scopes = scopes; } @@ -133,41 +153,18 @@ public ApiAppResponseOAuth chargesUsers(Boolean chargesUsers) { * * @return chargesUsers */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_CHARGES_USERS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CHARGES_USERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getChargesUsers() { return chargesUsers; } @JsonProperty(JSON_PROPERTY_CHARGES_USERS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChargesUsers(Boolean chargesUsers) { this.chargesUsers = chargesUsers; } - public ApiAppResponseOAuth secret(String secret) { - this.secret = secret; - return this; - } - - /** - * The app's OAuth secret, or null if the app does not belong to user. - * - * @return secret - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getSecret() { - return secret; - } - - @JsonProperty(JSON_PROPERTY_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSecret(String secret) { - this.secret = secret; - } - /** Return true if this ApiAppResponseOAuth object is equal to o. */ @Override public boolean equals(Object o) { @@ -179,14 +176,14 @@ public boolean equals(Object o) { } ApiAppResponseOAuth apiAppResponseOAuth = (ApiAppResponseOAuth) o; return Objects.equals(this.callbackUrl, apiAppResponseOAuth.callbackUrl) + && Objects.equals(this.secret, apiAppResponseOAuth.secret) && Objects.equals(this.scopes, apiAppResponseOAuth.scopes) - && Objects.equals(this.chargesUsers, apiAppResponseOAuth.chargesUsers) - && Objects.equals(this.secret, apiAppResponseOAuth.secret); + && Objects.equals(this.chargesUsers, apiAppResponseOAuth.chargesUsers); } @Override public int hashCode() { - return Objects.hash(callbackUrl, scopes, chargesUsers, secret); + return Objects.hash(callbackUrl, secret, scopes, chargesUsers); } @Override @@ -194,9 +191,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ApiAppResponseOAuth {\n"); sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); + sb.append(" secret: ").append(toIndentedString(secret)).append("\n"); sb.append(" scopes: ").append(toIndentedString(scopes)).append("\n"); sb.append(" chargesUsers: ").append(toIndentedString(chargesUsers)).append("\n"); - sb.append(" secret: ").append(toIndentedString(secret)).append("\n"); sb.append("}"); return sb.toString(); } @@ -225,6 +222,24 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(callbackUrl)); } } + if (secret != null) { + if (isFileTypeOrListOfFiles(secret)) { + fileTypeFound = true; + } + + if (secret.getClass().equals(java.io.File.class) + || secret.getClass().equals(Integer.class) + || secret.getClass().equals(String.class) + || secret.getClass().isEnum()) { + map.put("secret", secret); + } else if (isListOfFile(secret)) { + for (int i = 0; i < getListSize(secret); i++) { + map.put("secret[" + i + "]", getFromList(secret, i)); + } + } else { + map.put("secret", JSON.getDefault().getMapper().writeValueAsString(secret)); + } + } if (scopes != null) { if (isFileTypeOrListOfFiles(scopes)) { fileTypeFound = true; @@ -263,24 +278,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(chargesUsers)); } } - if (secret != null) { - if (isFileTypeOrListOfFiles(secret)) { - fileTypeFound = true; - } - - if (secret.getClass().equals(java.io.File.class) - || secret.getClass().equals(Integer.class) - || secret.getClass().equals(String.class) - || secret.getClass().isEnum()) { - map.put("secret", secret); - } else if (isListOfFile(secret)) { - for (int i = 0; i < getListSize(secret); i++) { - map.put("secret[" + i + "]", getFromList(secret, i)); - } - } else { - map.put("secret", JSON.getDefault().getMapper().writeValueAsString(secret)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java index 4ad1d6b51..e2d672dda 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java @@ -61,15 +61,14 @@ public ApiAppResponseOptions canInsertEverywhere(Boolean canInsertEverywhere) { * * @return canInsertEverywhere */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_CAN_INSERT_EVERYWHERE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CAN_INSERT_EVERYWHERE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getCanInsertEverywhere() { return canInsertEverywhere; } @JsonProperty(JSON_PROPERTY_CAN_INSERT_EVERYWHERE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCanInsertEverywhere(Boolean canInsertEverywhere) { this.canInsertEverywhere = canInsertEverywhere; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java index be257dcf7..7107a4329 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java @@ -67,15 +67,14 @@ public ApiAppResponseOwnerAccount 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; } @@ -90,15 +89,14 @@ public ApiAppResponseOwnerAccount emailAddress(String emailAddress) { * * @return emailAddress */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @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.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmailAddress(String emailAddress) { this.emailAddress = emailAddress; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java index a788eb405..6efd8fc40 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java @@ -121,15 +121,14 @@ public ApiAppResponseWhiteLabelingOptions headerBackgroundColor(String headerBac * * @return headerBackgroundColor */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_HEADER_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEADER_BACKGROUND_COLOR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getHeaderBackgroundColor() { return headerBackgroundColor; } @JsonProperty(JSON_PROPERTY_HEADER_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHeaderBackgroundColor(String headerBackgroundColor) { this.headerBackgroundColor = headerBackgroundColor; } @@ -144,15 +143,14 @@ public ApiAppResponseWhiteLabelingOptions legalVersion(String legalVersion) { * * @return legalVersion */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_LEGAL_VERSION) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_LEGAL_VERSION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getLegalVersion() { return legalVersion; } @JsonProperty(JSON_PROPERTY_LEGAL_VERSION) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalVersion(String legalVersion) { this.legalVersion = legalVersion; } @@ -167,15 +165,14 @@ public ApiAppResponseWhiteLabelingOptions linkColor(String linkColor) { * * @return linkColor */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_LINK_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_LINK_COLOR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getLinkColor() { return linkColor; } @JsonProperty(JSON_PROPERTY_LINK_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinkColor(String linkColor) { this.linkColor = linkColor; } @@ -190,15 +187,14 @@ public ApiAppResponseWhiteLabelingOptions pageBackgroundColor(String pageBackgro * * @return pageBackgroundColor */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_PAGE_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_PAGE_BACKGROUND_COLOR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getPageBackgroundColor() { return pageBackgroundColor; } @JsonProperty(JSON_PROPERTY_PAGE_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPageBackgroundColor(String pageBackgroundColor) { this.pageBackgroundColor = pageBackgroundColor; } @@ -213,15 +209,14 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonColor(String primaryButto * * @return primaryButtonColor */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getPrimaryButtonColor() { return primaryButtonColor; } @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrimaryButtonColor(String primaryButtonColor) { this.primaryButtonColor = primaryButtonColor; } @@ -237,15 +232,14 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonColorHover( * * @return primaryButtonColorHover */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getPrimaryButtonColorHover() { return primaryButtonColorHover; } @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrimaryButtonColorHover(String primaryButtonColorHover) { this.primaryButtonColorHover = primaryButtonColorHover; } @@ -261,15 +255,14 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonTextColor( * * @return primaryButtonTextColor */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getPrimaryButtonTextColor() { return primaryButtonTextColor; } @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrimaryButtonTextColor(String primaryButtonTextColor) { this.primaryButtonTextColor = primaryButtonTextColor; } @@ -285,15 +278,14 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonTextColorHover( * * @return primaryButtonTextColorHover */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getPrimaryButtonTextColorHover() { return primaryButtonTextColorHover; } @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrimaryButtonTextColorHover(String primaryButtonTextColorHover) { this.primaryButtonTextColorHover = primaryButtonTextColorHover; } @@ -308,15 +300,14 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonColor(String secondaryB * * @return secondaryButtonColor */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getSecondaryButtonColor() { return secondaryButtonColor; } @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSecondaryButtonColor(String secondaryButtonColor) { this.secondaryButtonColor = secondaryButtonColor; } @@ -332,15 +323,14 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonColorHover( * * @return secondaryButtonColorHover */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getSecondaryButtonColorHover() { return secondaryButtonColorHover; } @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSecondaryButtonColorHover(String secondaryButtonColorHover) { this.secondaryButtonColorHover = secondaryButtonColorHover; } @@ -356,15 +346,14 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonTextColor( * * @return secondaryButtonTextColor */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getSecondaryButtonTextColor() { return secondaryButtonTextColor; } @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSecondaryButtonTextColor(String secondaryButtonTextColor) { this.secondaryButtonTextColor = secondaryButtonTextColor; } @@ -380,15 +369,14 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonTextColorHover( * * @return secondaryButtonTextColorHover */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getSecondaryButtonTextColorHover() { return secondaryButtonTextColorHover; } @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSecondaryButtonTextColorHover(String secondaryButtonTextColorHover) { this.secondaryButtonTextColorHover = secondaryButtonTextColorHover; } @@ -403,15 +391,14 @@ public ApiAppResponseWhiteLabelingOptions textColor1(String textColor1) { * * @return textColor1 */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TEXT_COLOR1) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEXT_COLOR1) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getTextColor1() { return textColor1; } @JsonProperty(JSON_PROPERTY_TEXT_COLOR1) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTextColor1(String textColor1) { this.textColor1 = textColor1; } @@ -426,15 +413,14 @@ public ApiAppResponseWhiteLabelingOptions textColor2(String textColor2) { * * @return textColor2 */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TEXT_COLOR2) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEXT_COLOR2) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getTextColor2() { return textColor2; } @JsonProperty(JSON_PROPERTY_TEXT_COLOR2) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTextColor2(String textColor2) { this.textColor2 = textColor2; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java index 3deb8070c..bc366fdce 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java @@ -76,15 +76,14 @@ public BulkSendJobResponse bulkSendJobId(String bulkSendJobId) { * * @return bulkSendJobId */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getBulkSendJobId() { return bulkSendJobId; } @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBulkSendJobId(String bulkSendJobId) { this.bulkSendJobId = bulkSendJobId; } @@ -99,15 +98,14 @@ public BulkSendJobResponse total(Integer total) { * * @return total */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TOTAL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TOTAL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getTotal() { return total; } @JsonProperty(JSON_PROPERTY_TOTAL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTotal(Integer total) { this.total = total; } @@ -123,15 +121,14 @@ public BulkSendJobResponse isCreator(Boolean isCreator) { * * @return isCreator */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_CREATOR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsCreator() { return isCreator; } @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsCreator(Boolean isCreator) { this.isCreator = isCreator; } @@ -146,15 +143,14 @@ public BulkSendJobResponse createdAt(Integer createdAt) { * * @return createdAt */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CREATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getCreatedAt() { return createdAt; } @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(Integer createdAt) { this.createdAt = createdAt; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java index a10a53a32..63ef50b37 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java @@ -47,7 +47,7 @@ public class FaxLineResponseFaxLine { private Integer updatedAt; public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private List accounts = new ArrayList<>(); + private List accounts = null; public FaxLineResponseFaxLine() {} @@ -76,15 +76,14 @@ public FaxLineResponseFaxLine number(String number) { * * @return number */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_NUMBER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NUMBER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getNumber() { return number; } @JsonProperty(JSON_PROPERTY_NUMBER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { this.number = number; } @@ -99,15 +98,14 @@ public FaxLineResponseFaxLine createdAt(Integer createdAt) { * * @return createdAt */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CREATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getCreatedAt() { return createdAt; } @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(Integer createdAt) { this.createdAt = createdAt; } @@ -122,15 +120,14 @@ public FaxLineResponseFaxLine updatedAt(Integer updatedAt) { * * @return updatedAt */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getUpdatedAt() { return updatedAt; } @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUpdatedAt(Integer updatedAt) { this.updatedAt = updatedAt; } @@ -153,15 +150,14 @@ public FaxLineResponseFaxLine addAccountsItem(AccountResponse accountsItem) { * * @return accounts */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getAccounts() { return accounts; } @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccounts(List accounts) { this.accounts = accounts; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java index 10d54cb32..2abc906c6 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java @@ -41,13 +41,13 @@ public class TeamResponse { private String name; public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private List accounts = new ArrayList<>(); + private List accounts = null; public static final String JSON_PROPERTY_INVITED_ACCOUNTS = "invited_accounts"; - private List invitedAccounts = new ArrayList<>(); + private List invitedAccounts = null; public static final String JSON_PROPERTY_INVITED_EMAILS = "invited_emails"; - private List invitedEmails = new ArrayList<>(); + private List invitedEmails = null; public TeamResponse() {} @@ -75,15 +75,14 @@ public TeamResponse name(String name) { * * @return name */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } @@ -106,15 +105,14 @@ public TeamResponse addAccountsItem(AccountResponse accountsItem) { * * @return accounts */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getAccounts() { return accounts; } @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccounts(List accounts) { this.accounts = accounts; } @@ -138,15 +136,14 @@ public TeamResponse addInvitedAccountsItem(AccountResponse invitedAccountsItem) * * @return invitedAccounts */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_INVITED_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_INVITED_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getInvitedAccounts() { return invitedAccounts; } @JsonProperty(JSON_PROPERTY_INVITED_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInvitedAccounts(List invitedAccounts) { this.invitedAccounts = invitedAccounts; } @@ -170,15 +167,14 @@ public TeamResponse addInvitedEmailsItem(String invitedEmailsItem) { * * @return invitedEmails */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_INVITED_EMAILS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_INVITED_EMAILS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getInvitedEmails() { return invitedEmails; } @JsonProperty(JSON_PROPERTY_INVITED_EMAILS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInvitedEmails(List invitedEmails) { this.invitedEmails = invitedEmails; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java index e82d6aa72..7e2fc0bc4 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java @@ -82,15 +82,14 @@ public TemplateCreateEmbeddedDraftResponseTemplate templateId(String templateId) * * @return templateId */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getTemplateId() { return templateId; } @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTemplateId(String templateId) { this.templateId = templateId; } @@ -105,15 +104,14 @@ public TemplateCreateEmbeddedDraftResponseTemplate editUrl(String editUrl) { * * @return editUrl */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_EDIT_URL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EDIT_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getEditUrl() { return editUrl; } @JsonProperty(JSON_PROPERTY_EDIT_URL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEditUrl(String editUrl) { this.editUrl = editUrl; } @@ -128,15 +126,14 @@ public TemplateCreateEmbeddedDraftResponseTemplate expiresAt(Integer expiresAt) * * @return expiresAt */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_EXPIRES_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getExpiresAt() { return expiresAt; } @JsonProperty(JSON_PROPERTY_EXPIRES_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java index cd3964ffb..017ed6e40 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java @@ -61,15 +61,14 @@ public TemplateCreateResponseTemplate templateId(String templateId) { * * @return templateId */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getTemplateId() { return templateId; } @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTemplateId(String templateId) { this.templateId = templateId; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java index 59f31e8af..6e50048e4 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -30,6 +30,8 @@ TemplateResponse.JSON_PROPERTY_TEMPLATE_ID, TemplateResponse.JSON_PROPERTY_TITLE, TemplateResponse.JSON_PROPERTY_MESSAGE, + TemplateResponse.JSON_PROPERTY_UPDATED_AT, + TemplateResponse.JSON_PROPERTY_IS_EMBEDDED, TemplateResponse.JSON_PROPERTY_IS_CREATOR, TemplateResponse.JSON_PROPERTY_CAN_EDIT, TemplateResponse.JSON_PROPERTY_IS_LOCKED, @@ -37,12 +39,10 @@ TemplateResponse.JSON_PROPERTY_SIGNER_ROLES, TemplateResponse.JSON_PROPERTY_CC_ROLES, TemplateResponse.JSON_PROPERTY_DOCUMENTS, - TemplateResponse.JSON_PROPERTY_ACCOUNTS, - TemplateResponse.JSON_PROPERTY_ATTACHMENTS, - TemplateResponse.JSON_PROPERTY_UPDATED_AT, - TemplateResponse.JSON_PROPERTY_IS_EMBEDDED, TemplateResponse.JSON_PROPERTY_CUSTOM_FIELDS, - TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS + TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS, + TemplateResponse.JSON_PROPERTY_ACCOUNTS, + TemplateResponse.JSON_PROPERTY_ATTACHMENTS }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -58,6 +58,12 @@ public class TemplateResponse { public static final String JSON_PROPERTY_MESSAGE = "message"; private String message; + public static final String JSON_PROPERTY_UPDATED_AT = "updated_at"; + private Integer updatedAt; + + public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; + private Boolean isEmbedded; + public static final String JSON_PROPERTY_IS_CREATOR = "is_creator"; private Boolean isCreator; @@ -71,25 +77,13 @@ public class TemplateResponse { private Object metadata; public static final String JSON_PROPERTY_SIGNER_ROLES = "signer_roles"; - private List signerRoles = new ArrayList<>(); + private List signerRoles = null; public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; - private List ccRoles = new ArrayList<>(); + private List ccRoles = null; public static final String JSON_PROPERTY_DOCUMENTS = "documents"; - private List documents = new ArrayList<>(); - - public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private List accounts = new ArrayList<>(); - - public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; - private List attachments = new ArrayList<>(); - - public static final String JSON_PROPERTY_UPDATED_AT = "updated_at"; - private Integer updatedAt; - - public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; - private Boolean isEmbedded; + private List documents = null; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; @Deprecated private List customFields = null; @@ -97,6 +91,12 @@ public class TemplateResponse { public static final String JSON_PROPERTY_NAMED_FORM_FIELDS = "named_form_fields"; @Deprecated private List namedFormFields = null; + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private List accounts = null; + + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + private List attachments = null; + public TemplateResponse() {} /** @@ -123,15 +123,14 @@ public TemplateResponse templateId(String templateId) { * * @return templateId */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getTemplateId() { return templateId; } @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTemplateId(String templateId) { this.templateId = templateId; } @@ -148,15 +147,14 @@ public TemplateResponse title(String title) { * * @return title */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TITLE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getTitle() { return title; } @JsonProperty(JSON_PROPERTY_TITLE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTitle(String title) { this.title = title; } @@ -172,19 +170,64 @@ public TemplateResponse message(String message) { * * @return message */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_MESSAGE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getMessage() { return message; } @JsonProperty(JSON_PROPERTY_MESSAGE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { this.message = message; } + public TemplateResponse updatedAt(Integer updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + * Time the template was last updated. + * + * @return updatedAt + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Integer getUpdatedAt() { + return updatedAt; + } + + @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setUpdatedAt(Integer updatedAt) { + this.updatedAt = updatedAt; + } + + public TemplateResponse isEmbedded(Boolean isEmbedded) { + this.isEmbedded = isEmbedded; + return this; + } + + /** + * `true` if this template was created using an embedded flow, `false` if it + * was created on our website. Will be `null` when you are not the creator of the + * Template. + * + * @return isEmbedded + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIsEmbedded() { + return isEmbedded; + } + + @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIsEmbedded(Boolean isEmbedded) { + this.isEmbedded = isEmbedded; + } + public TemplateResponse isCreator(Boolean isCreator) { this.isCreator = isCreator; return this; @@ -196,15 +239,14 @@ public TemplateResponse isCreator(Boolean isCreator) { * * @return isCreator */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_CREATOR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsCreator() { return isCreator; } @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsCreator(Boolean isCreator) { this.isCreator = isCreator; } @@ -220,15 +262,14 @@ public TemplateResponse canEdit(Boolean canEdit) { * * @return canEdit */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_CAN_EDIT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CAN_EDIT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getCanEdit() { return canEdit; } @JsonProperty(JSON_PROPERTY_CAN_EDIT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCanEdit(Boolean canEdit) { this.canEdit = canEdit; } @@ -245,15 +286,14 @@ public TemplateResponse 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; } @@ -268,15 +308,14 @@ public TemplateResponse metadata(Object metadata) { * * @return metadata */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_METADATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Object getMetadata() { return metadata; } @JsonProperty(JSON_PROPERTY_METADATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Object metadata) { this.metadata = metadata; } @@ -300,15 +339,14 @@ public TemplateResponse addSignerRolesItem(TemplateResponseSignerRole signerRole * * @return signerRoles */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getSignerRoles() { return signerRoles; } @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSignerRoles(List signerRoles) { this.signerRoles = signerRoles; } @@ -332,15 +370,14 @@ public TemplateResponse addCcRolesItem(TemplateResponseCCRole ccRolesItem) { * * @return ccRoles */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_CC_ROLES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CC_ROLES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getCcRoles() { return ccRoles; } @JsonProperty(JSON_PROPERTY_CC_ROLES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCcRoles(List ccRoles) { this.ccRoles = ccRoles; } @@ -364,127 +401,18 @@ public TemplateResponse addDocumentsItem(TemplateResponseDocument documentsItem) * * @return documents */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_DOCUMENTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_DOCUMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getDocuments() { return documents; } @JsonProperty(JSON_PROPERTY_DOCUMENTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocuments(List documents) { this.documents = documents; } - public TemplateResponse accounts(List accounts) { - this.accounts = accounts; - return this; - } - - public TemplateResponse addAccountsItem(TemplateResponseAccount accountsItem) { - if (this.accounts == null) { - this.accounts = new ArrayList<>(); - } - this.accounts.add(accountsItem); - return this; - } - - /** - * An array of the Accounts that can use this Template. - * - * @return accounts - */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public List getAccounts() { - return accounts; - } - - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setAccounts(List accounts) { - this.accounts = accounts; - } - - public TemplateResponse attachments(List attachments) { - this.attachments = attachments; - return this; - } - - public TemplateResponse addAttachmentsItem(SignatureRequestResponseAttachment attachmentsItem) { - if (this.attachments == null) { - this.attachments = new ArrayList<>(); - } - this.attachments.add(attachmentsItem); - return this; - } - - /** - * Signer attachments. - * - * @return attachments - */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_ATTACHMENTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public List getAttachments() { - return attachments; - } - - @JsonProperty(JSON_PROPERTY_ATTACHMENTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setAttachments(List attachments) { - this.attachments = attachments; - } - - public TemplateResponse updatedAt(Integer updatedAt) { - this.updatedAt = updatedAt; - return this; - } - - /** - * Time the template was last updated. - * - * @return updatedAt - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Integer getUpdatedAt() { - return updatedAt; - } - - @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUpdatedAt(Integer updatedAt) { - this.updatedAt = updatedAt; - } - - public TemplateResponse isEmbedded(Boolean isEmbedded) { - this.isEmbedded = isEmbedded; - return this; - } - - /** - * `true` if this template was created using an embedded flow, `false` if it - * was created on our website. Will be `null` when you are not the creator of the - * Template. - * - * @return isEmbedded - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getIsEmbedded() { - return isEmbedded; - } - - @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsEmbedded(Boolean isEmbedded) { - this.isEmbedded = isEmbedded; - } - @Deprecated public TemplateResponse customFields( List customFields) { @@ -561,6 +489,66 @@ public void setNamedFormFields(List named this.namedFormFields = namedFormFields; } + public TemplateResponse accounts(List accounts) { + this.accounts = accounts; + return this; + } + + public TemplateResponse addAccountsItem(TemplateResponseAccount accountsItem) { + if (this.accounts == null) { + this.accounts = new ArrayList<>(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * An array of the Accounts that can use this Template. + * + * @return accounts + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getAccounts() { + return accounts; + } + + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAccounts(List accounts) { + this.accounts = accounts; + } + + public TemplateResponse attachments(List attachments) { + this.attachments = attachments; + return this; + } + + public TemplateResponse addAttachmentsItem(SignatureRequestResponseAttachment attachmentsItem) { + if (this.attachments == null) { + this.attachments = new ArrayList<>(); + } + this.attachments.add(attachmentsItem); + return this; + } + + /** + * Signer attachments. + * + * @return attachments + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getAttachments() { + return attachments; + } + + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAttachments(List attachments) { + this.attachments = attachments; + } + /** Return true if this TemplateResponse object is equal to o. */ @Override public boolean equals(Object o) { @@ -574,6 +562,8 @@ public boolean equals(Object o) { return Objects.equals(this.templateId, templateResponse.templateId) && Objects.equals(this.title, templateResponse.title) && Objects.equals(this.message, templateResponse.message) + && Objects.equals(this.updatedAt, templateResponse.updatedAt) + && Objects.equals(this.isEmbedded, templateResponse.isEmbedded) && Objects.equals(this.isCreator, templateResponse.isCreator) && Objects.equals(this.canEdit, templateResponse.canEdit) && Objects.equals(this.isLocked, templateResponse.isLocked) @@ -581,12 +571,10 @@ public boolean equals(Object o) { && Objects.equals(this.signerRoles, templateResponse.signerRoles) && Objects.equals(this.ccRoles, templateResponse.ccRoles) && Objects.equals(this.documents, templateResponse.documents) - && Objects.equals(this.accounts, templateResponse.accounts) - && Objects.equals(this.attachments, templateResponse.attachments) - && Objects.equals(this.updatedAt, templateResponse.updatedAt) - && Objects.equals(this.isEmbedded, templateResponse.isEmbedded) && Objects.equals(this.customFields, templateResponse.customFields) - && Objects.equals(this.namedFormFields, templateResponse.namedFormFields); + && Objects.equals(this.namedFormFields, templateResponse.namedFormFields) + && Objects.equals(this.accounts, templateResponse.accounts) + && Objects.equals(this.attachments, templateResponse.attachments); } @Override @@ -595,6 +583,8 @@ public int hashCode() { templateId, title, message, + updatedAt, + isEmbedded, isCreator, canEdit, isLocked, @@ -602,12 +592,10 @@ public int hashCode() { signerRoles, ccRoles, documents, - accounts, - attachments, - updatedAt, - isEmbedded, customFields, - namedFormFields); + namedFormFields, + accounts, + attachments); } @Override @@ -617,6 +605,8 @@ public String toString() { sb.append(" templateId: ").append(toIndentedString(templateId)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); + sb.append(" isEmbedded: ").append(toIndentedString(isEmbedded)).append("\n"); sb.append(" isCreator: ").append(toIndentedString(isCreator)).append("\n"); sb.append(" canEdit: ").append(toIndentedString(canEdit)).append("\n"); sb.append(" isLocked: ").append(toIndentedString(isLocked)).append("\n"); @@ -624,12 +614,10 @@ public String toString() { sb.append(" signerRoles: ").append(toIndentedString(signerRoles)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" documents: ").append(toIndentedString(documents)).append("\n"); - sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); - sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); - sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); - sb.append(" isEmbedded: ").append(toIndentedString(isEmbedded)).append("\n"); sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); sb.append(" namedFormFields: ").append(toIndentedString(namedFormFields)).append("\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append("}"); return sb.toString(); } @@ -694,6 +682,46 @@ public Map createFormData() throws ApiException { map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); } } + if (updatedAt != null) { + if (isFileTypeOrListOfFiles(updatedAt)) { + fileTypeFound = true; + } + + if (updatedAt.getClass().equals(java.io.File.class) + || updatedAt.getClass().equals(Integer.class) + || updatedAt.getClass().equals(String.class) + || updatedAt.getClass().isEnum()) { + map.put("updated_at", updatedAt); + } else if (isListOfFile(updatedAt)) { + for (int i = 0; i < getListSize(updatedAt); i++) { + map.put("updated_at[" + i + "]", getFromList(updatedAt, i)); + } + } else { + map.put( + "updated_at", + JSON.getDefault().getMapper().writeValueAsString(updatedAt)); + } + } + if (isEmbedded != null) { + if (isFileTypeOrListOfFiles(isEmbedded)) { + fileTypeFound = true; + } + + if (isEmbedded.getClass().equals(java.io.File.class) + || isEmbedded.getClass().equals(Integer.class) + || isEmbedded.getClass().equals(String.class) + || isEmbedded.getClass().isEnum()) { + map.put("is_embedded", isEmbedded); + } else if (isListOfFile(isEmbedded)) { + for (int i = 0; i < getListSize(isEmbedded); i++) { + map.put("is_embedded[" + i + "]", getFromList(isEmbedded, i)); + } + } else { + map.put( + "is_embedded", + JSON.getDefault().getMapper().writeValueAsString(isEmbedded)); + } + } if (isCreator != null) { if (isFileTypeOrListOfFiles(isCreator)) { fileTypeFound = true; @@ -828,84 +856,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(documents)); } } - if (accounts != null) { - if (isFileTypeOrListOfFiles(accounts)) { - fileTypeFound = true; - } - - if (accounts.getClass().equals(java.io.File.class) - || accounts.getClass().equals(Integer.class) - || accounts.getClass().equals(String.class) - || accounts.getClass().isEnum()) { - map.put("accounts", accounts); - } else if (isListOfFile(accounts)) { - for (int i = 0; i < getListSize(accounts); i++) { - map.put("accounts[" + i + "]", getFromList(accounts, i)); - } - } else { - map.put("accounts", JSON.getDefault().getMapper().writeValueAsString(accounts)); - } - } - if (attachments != null) { - if (isFileTypeOrListOfFiles(attachments)) { - fileTypeFound = true; - } - - if (attachments.getClass().equals(java.io.File.class) - || attachments.getClass().equals(Integer.class) - || attachments.getClass().equals(String.class) - || attachments.getClass().isEnum()) { - map.put("attachments", attachments); - } else if (isListOfFile(attachments)) { - for (int i = 0; i < getListSize(attachments); i++) { - map.put("attachments[" + i + "]", getFromList(attachments, i)); - } - } else { - map.put( - "attachments", - JSON.getDefault().getMapper().writeValueAsString(attachments)); - } - } - if (updatedAt != null) { - if (isFileTypeOrListOfFiles(updatedAt)) { - fileTypeFound = true; - } - - if (updatedAt.getClass().equals(java.io.File.class) - || updatedAt.getClass().equals(Integer.class) - || updatedAt.getClass().equals(String.class) - || updatedAt.getClass().isEnum()) { - map.put("updated_at", updatedAt); - } else if (isListOfFile(updatedAt)) { - for (int i = 0; i < getListSize(updatedAt); i++) { - map.put("updated_at[" + i + "]", getFromList(updatedAt, i)); - } - } else { - map.put( - "updated_at", - JSON.getDefault().getMapper().writeValueAsString(updatedAt)); - } - } - if (isEmbedded != null) { - if (isFileTypeOrListOfFiles(isEmbedded)) { - fileTypeFound = true; - } - - if (isEmbedded.getClass().equals(java.io.File.class) - || isEmbedded.getClass().equals(Integer.class) - || isEmbedded.getClass().equals(String.class) - || isEmbedded.getClass().isEnum()) { - map.put("is_embedded", isEmbedded); - } else if (isListOfFile(isEmbedded)) { - for (int i = 0; i < getListSize(isEmbedded); i++) { - map.put("is_embedded[" + i + "]", getFromList(isEmbedded, i)); - } - } else { - map.put( - "is_embedded", - JSON.getDefault().getMapper().writeValueAsString(isEmbedded)); - } - } if (customFields != null) { if (isFileTypeOrListOfFiles(customFields)) { fileTypeFound = true; @@ -946,6 +896,44 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(namedFormFields)); } } + if (accounts != null) { + if (isFileTypeOrListOfFiles(accounts)) { + fileTypeFound = true; + } + + if (accounts.getClass().equals(java.io.File.class) + || accounts.getClass().equals(Integer.class) + || accounts.getClass().equals(String.class) + || accounts.getClass().isEnum()) { + map.put("accounts", accounts); + } else if (isListOfFile(accounts)) { + for (int i = 0; i < getListSize(accounts); i++) { + map.put("accounts[" + i + "]", getFromList(accounts, i)); + } + } else { + map.put("accounts", JSON.getDefault().getMapper().writeValueAsString(accounts)); + } + } + if (attachments != null) { + if (isFileTypeOrListOfFiles(attachments)) { + fileTypeFound = true; + } + + if (attachments.getClass().equals(java.io.File.class) + || attachments.getClass().equals(Integer.class) + || attachments.getClass().equals(String.class) + || attachments.getClass().isEnum()) { + map.put("attachments", attachments); + } else if (isListOfFile(attachments)) { + for (int i = 0; i < getListSize(attachments); i++) { + map.put("attachments[" + i + "]", getFromList(attachments, i)); + } + } else { + map.put( + "attachments", + JSON.getDefault().getMapper().writeValueAsString(attachments)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java index 8397c2dc6..901e4be34 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java @@ -26,11 +26,11 @@ /** TemplateResponseAccount */ @JsonPropertyOrder({ TemplateResponseAccount.JSON_PROPERTY_ACCOUNT_ID, + TemplateResponseAccount.JSON_PROPERTY_EMAIL_ADDRESS, TemplateResponseAccount.JSON_PROPERTY_IS_LOCKED, TemplateResponseAccount.JSON_PROPERTY_IS_PAID_HS, TemplateResponseAccount.JSON_PROPERTY_IS_PAID_HF, - TemplateResponseAccount.JSON_PROPERTY_QUOTAS, - TemplateResponseAccount.JSON_PROPERTY_EMAIL_ADDRESS + TemplateResponseAccount.JSON_PROPERTY_QUOTAS }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -40,6 +40,9 @@ public class TemplateResponseAccount { 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; @@ -52,9 +55,6 @@ public class TemplateResponseAccount { public static final String JSON_PROPERTY_QUOTAS = "quotas"; private TemplateResponseAccountQuota quotas; - public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; - private String emailAddress; - public TemplateResponseAccount() {} /** @@ -82,19 +82,40 @@ public TemplateResponseAccount 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 TemplateResponseAccount 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 TemplateResponseAccount isLocked(Boolean isLocked) { this.isLocked = isLocked; return this; @@ -105,15 +126,14 @@ public TemplateResponseAccount 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; } @@ -128,15 +148,14 @@ public TemplateResponseAccount 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; } @@ -151,15 +170,14 @@ public TemplateResponseAccount 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; } @@ -174,41 +192,18 @@ public TemplateResponseAccount quotas(TemplateResponseAccountQuota 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 TemplateResponseAccountQuota getQuotas() { return quotas; } @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setQuotas(TemplateResponseAccountQuota quotas) { this.quotas = quotas; } - public TemplateResponseAccount 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; - } - /** Return true if this TemplateResponseAccount object is equal to o. */ @Override public boolean equals(Object o) { @@ -220,16 +215,16 @@ public boolean equals(Object o) { } TemplateResponseAccount templateResponseAccount = (TemplateResponseAccount) o; return Objects.equals(this.accountId, templateResponseAccount.accountId) + && Objects.equals(this.emailAddress, templateResponseAccount.emailAddress) && Objects.equals(this.isLocked, templateResponseAccount.isLocked) && Objects.equals(this.isPaidHs, templateResponseAccount.isPaidHs) && Objects.equals(this.isPaidHf, templateResponseAccount.isPaidHf) - && Objects.equals(this.quotas, templateResponseAccount.quotas) - && Objects.equals(this.emailAddress, templateResponseAccount.emailAddress); + && Objects.equals(this.quotas, templateResponseAccount.quotas); } @Override public int hashCode() { - return Objects.hash(accountId, isLocked, isPaidHs, isPaidHf, quotas, emailAddress); + return Objects.hash(accountId, emailAddress, isLocked, isPaidHs, isPaidHf, quotas); } @Override @@ -237,11 +232,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseAccount {\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("}"); return sb.toString(); } @@ -270,6 +265,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; @@ -348,26 +363,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)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java index 37e680526..0ebdbe2a4 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java @@ -79,15 +79,14 @@ public TemplateResponseAccountQuota templatesLeft(Integer templatesLeft) { * * @return templatesLeft */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getTemplatesLeft() { return templatesLeft; } @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTemplatesLeft(Integer templatesLeft) { this.templatesLeft = templatesLeft; } @@ -102,15 +101,14 @@ public TemplateResponseAccountQuota apiSignatureRequestsLeft(Integer apiSignatur * * @return apiSignatureRequestsLeft */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getApiSignatureRequestsLeft() { return apiSignatureRequestsLeft; } @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApiSignatureRequestsLeft(Integer apiSignatureRequestsLeft) { this.apiSignatureRequestsLeft = apiSignatureRequestsLeft; } @@ -125,15 +123,14 @@ public TemplateResponseAccountQuota documentsLeft(Integer documentsLeft) { * * @return documentsLeft */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getDocumentsLeft() { return documentsLeft; } @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocumentsLeft(Integer documentsLeft) { this.documentsLeft = documentsLeft; } @@ -148,15 +145,14 @@ public TemplateResponseAccountQuota smsVerificationsLeft(Integer smsVerification * * @return smsVerificationsLeft */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getSmsVerificationsLeft() { return smsVerificationsLeft; } @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSmsVerificationsLeft(Integer smsVerificationsLeft) { this.smsVerificationsLeft = smsVerificationsLeft; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java index d360b16dc..e4a7d7377 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java @@ -60,15 +60,14 @@ public TemplateResponseCCRole name(String name) { * * @return name */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java index a76ceca5d..de32fb5ac 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java @@ -28,11 +28,11 @@ /** TemplateResponseDocument */ @JsonPropertyOrder({ TemplateResponseDocument.JSON_PROPERTY_NAME, + TemplateResponseDocument.JSON_PROPERTY_INDEX, TemplateResponseDocument.JSON_PROPERTY_FIELD_GROUPS, TemplateResponseDocument.JSON_PROPERTY_FORM_FIELDS, TemplateResponseDocument.JSON_PROPERTY_CUSTOM_FIELDS, - TemplateResponseDocument.JSON_PROPERTY_STATIC_FIELDS, - TemplateResponseDocument.JSON_PROPERTY_INDEX + TemplateResponseDocument.JSON_PROPERTY_STATIC_FIELDS }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -42,20 +42,20 @@ public class TemplateResponseDocument { public static final String JSON_PROPERTY_NAME = "name"; private String name; + public static final String JSON_PROPERTY_INDEX = "index"; + private Integer index; + public static final String JSON_PROPERTY_FIELD_GROUPS = "field_groups"; - private List fieldGroups = new ArrayList<>(); + private List fieldGroups = null; public static final String JSON_PROPERTY_FORM_FIELDS = "form_fields"; - private List formFields = new ArrayList<>(); + private List formFields = null; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; - private List customFields = new ArrayList<>(); + private List customFields = null; public static final String JSON_PROPERTY_STATIC_FIELDS = "static_fields"; - private List staticFields = new ArrayList<>(); - - public static final String JSON_PROPERTY_INDEX = "index"; - private Integer index; + private List staticFields = null; public TemplateResponseDocument() {} @@ -85,19 +85,41 @@ public TemplateResponseDocument name(String name) { * * @return name */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } + public TemplateResponseDocument index(Integer index) { + this.index = index; + return this; + } + + /** + * Document ordering, the lowest index is displayed first and the highest last (0-based + * indexing). + * + * @return index + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_INDEX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Integer getIndex() { + return index; + } + + @JsonProperty(JSON_PROPERTY_INDEX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIndex(Integer index) { + this.index = index; + } + public TemplateResponseDocument fieldGroups( List fieldGroups) { this.fieldGroups = fieldGroups; @@ -118,15 +140,14 @@ public TemplateResponseDocument addFieldGroupsItem( * * @return fieldGroups */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getFieldGroups() { return fieldGroups; } @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFieldGroups(List fieldGroups) { this.fieldGroups = fieldGroups; } @@ -151,15 +172,14 @@ public TemplateResponseDocument addFormFieldsItem( * * @return formFields */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_FORM_FIELDS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FORM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getFormFields() { return formFields; } @JsonProperty(JSON_PROPERTY_FORM_FIELDS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFormFields(List formFields) { this.formFields = formFields; } @@ -184,15 +204,14 @@ public TemplateResponseDocument addCustomFieldsItem( * * @return customFields */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getCustomFields() { return customFields; } @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCustomFields(List customFields) { this.customFields = customFields; } @@ -218,42 +237,18 @@ public TemplateResponseDocument addStaticFieldsItem( * * @return staticFields */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getStaticFields() { return staticFields; } @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStaticFields(List staticFields) { this.staticFields = staticFields; } - public TemplateResponseDocument index(Integer index) { - this.index = index; - return this; - } - - /** - * Document ordering, the lowest index is displayed first and the highest last (0-based - * indexing). - * - * @return index - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_INDEX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Integer getIndex() { - return index; - } - - @JsonProperty(JSON_PROPERTY_INDEX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIndex(Integer index) { - this.index = index; - } - /** Return true if this TemplateResponseDocument object is equal to o. */ @Override public boolean equals(Object o) { @@ -265,16 +260,16 @@ public boolean equals(Object o) { } TemplateResponseDocument templateResponseDocument = (TemplateResponseDocument) o; return Objects.equals(this.name, templateResponseDocument.name) + && Objects.equals(this.index, templateResponseDocument.index) && Objects.equals(this.fieldGroups, templateResponseDocument.fieldGroups) && Objects.equals(this.formFields, templateResponseDocument.formFields) && Objects.equals(this.customFields, templateResponseDocument.customFields) - && Objects.equals(this.staticFields, templateResponseDocument.staticFields) - && Objects.equals(this.index, templateResponseDocument.index); + && Objects.equals(this.staticFields, templateResponseDocument.staticFields); } @Override public int hashCode() { - return Objects.hash(name, fieldGroups, formFields, customFields, staticFields, index); + return Objects.hash(name, index, fieldGroups, formFields, customFields, staticFields); } @Override @@ -282,11 +277,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocument {\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" index: ").append(toIndentedString(index)).append("\n"); sb.append(" fieldGroups: ").append(toIndentedString(fieldGroups)).append("\n"); sb.append(" formFields: ").append(toIndentedString(formFields)).append("\n"); sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); sb.append(" staticFields: ").append(toIndentedString(staticFields)).append("\n"); - sb.append(" index: ").append(toIndentedString(index)).append("\n"); sb.append("}"); return sb.toString(); } @@ -313,6 +308,24 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } + if (index != null) { + if (isFileTypeOrListOfFiles(index)) { + fileTypeFound = true; + } + + if (index.getClass().equals(java.io.File.class) + || index.getClass().equals(Integer.class) + || index.getClass().equals(String.class) + || index.getClass().isEnum()) { + map.put("index", index); + } else if (isListOfFile(index)) { + for (int i = 0; i < getListSize(index); i++) { + map.put("index[" + i + "]", getFromList(index, i)); + } + } else { + map.put("index", JSON.getDefault().getMapper().writeValueAsString(index)); + } + } if (fieldGroups != null) { if (isFileTypeOrListOfFiles(fieldGroups)) { fileTypeFound = true; @@ -393,24 +406,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(staticFields)); } } - if (index != null) { - if (isFileTypeOrListOfFiles(index)) { - fileTypeFound = true; - } - - if (index.getClass().equals(java.io.File.class) - || index.getClass().equals(Integer.class) - || index.getClass().equals(String.class) - || index.getClass().isEnum()) { - map.put("index", index); - } else if (isListOfFile(index)) { - for (int i = 0; i < getListSize(index); i++) { - map.put("index[" + i + "]", getFromList(index, i)); - } - } else { - map.put("index", JSON.getDefault().getMapper().writeValueAsString(index)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java index 1458076c7..d6c0d010c 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java @@ -27,15 +27,15 @@ /** An array of Form Field objects containing the name and type of each named field. */ @JsonPropertyOrder({ + TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_NAME, - TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_TYPE, + TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_Y, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_WIDTH, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_HEIGHT, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_REQUIRED, - TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_GROUP }) @javax.annotation.Generated( @@ -56,14 +56,17 @@ @JsonSubTypes.Type(value = TemplateResponseDocumentCustomFieldText.class, name = "text"), }) public class TemplateResponseDocumentCustomFieldBase { + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; + public static final String JSON_PROPERTY_SIGNER = "signer"; + private String signer; public static final String JSON_PROPERTY_X = "x"; private Integer x; @@ -80,9 +83,6 @@ public class TemplateResponseDocumentCustomFieldBase { public static final String JSON_PROPERTY_REQUIRED = "required"; private Boolean required; - public static final String JSON_PROPERTY_SIGNER = "signer"; - private String signer; - public static final String JSON_PROPERTY_GROUP = "group"; private String group; @@ -105,6 +105,29 @@ public static TemplateResponseDocumentCustomFieldBase init(HashMap data) throws TemplateResponseDocumentCustomFieldBase.class); } + public TemplateResponseDocumentCustomFieldBase type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * + * @return type + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getType() { + return type; + } + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; + } + public TemplateResponseDocumentCustomFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -115,15 +138,14 @@ public TemplateResponseDocumentCustomFieldBase apiId(String apiId) { * * @return apiId */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getApiId() { return apiId; } @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -138,40 +160,48 @@ public TemplateResponseDocumentCustomFieldBase name(String name) { * * @return name */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } - public TemplateResponseDocumentCustomFieldBase type(String type) { - this.type = type; + public TemplateResponseDocumentCustomFieldBase signer(String signer) { + this.signer = signer; + return this; + } + + public TemplateResponseDocumentCustomFieldBase signer(Integer signer) { + this.signer = String.valueOf(signer); return this; } /** - * Get type + * The signer of the Custom Field. Can be `null` if field is a merge field (assigned + * to Sender). * - * @return type + * @return signer */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public String getType() { - return type; + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getSigner() { + return signer; } - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; + @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigner(String signer) { + this.signer = signer; + } + + public void setSigner(Integer signer) { + this.signer = String.valueOf(signer); } public TemplateResponseDocumentCustomFieldBase x(Integer x) { @@ -184,15 +214,14 @@ public TemplateResponseDocumentCustomFieldBase x(Integer x) { * * @return x */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_X) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getX() { return x; } @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setX(Integer x) { this.x = x; } @@ -207,15 +236,14 @@ public TemplateResponseDocumentCustomFieldBase y(Integer y) { * * @return y */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_Y) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getY() { return y; } @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setY(Integer y) { this.y = y; } @@ -230,15 +258,14 @@ public TemplateResponseDocumentCustomFieldBase width(Integer width) { * * @return width */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_WIDTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getWidth() { return width; } @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWidth(Integer width) { this.width = width; } @@ -253,15 +280,14 @@ public TemplateResponseDocumentCustomFieldBase height(Integer height) { * * @return height */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEIGHT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getHeight() { return height; } @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHeight(Integer height) { this.height = height; } @@ -276,51 +302,18 @@ public TemplateResponseDocumentCustomFieldBase required(Boolean required) { * * @return required */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIRED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getRequired() { return required; } @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequired(Boolean required) { this.required = required; } - public TemplateResponseDocumentCustomFieldBase signer(String signer) { - this.signer = signer; - return this; - } - - public TemplateResponseDocumentCustomFieldBase signer(Integer signer) { - this.signer = String.valueOf(signer); - return this; - } - - /** - * The signer of the Custom Field. Can be `null` if field is a merge field (assigned - * to Sender). - * - * @return signer - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getSigner() { - return signer; - } - - @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigner(String signer) { - this.signer = signer; - } - - public void setSigner(Integer signer) { - this.signer = String.valueOf(signer); - } - public TemplateResponseDocumentCustomFieldBase group(String group) { this.group = group; return this; @@ -355,36 +348,36 @@ public boolean equals(Object o) { } TemplateResponseDocumentCustomFieldBase templateResponseDocumentCustomFieldBase = (TemplateResponseDocumentCustomFieldBase) o; - return Objects.equals(this.apiId, templateResponseDocumentCustomFieldBase.apiId) + return Objects.equals(this.type, templateResponseDocumentCustomFieldBase.type) + && Objects.equals(this.apiId, templateResponseDocumentCustomFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentCustomFieldBase.name) - && Objects.equals(this.type, templateResponseDocumentCustomFieldBase.type) + && Objects.equals(this.signer, templateResponseDocumentCustomFieldBase.signer) && Objects.equals(this.x, templateResponseDocumentCustomFieldBase.x) && Objects.equals(this.y, templateResponseDocumentCustomFieldBase.y) && Objects.equals(this.width, templateResponseDocumentCustomFieldBase.width) && Objects.equals(this.height, templateResponseDocumentCustomFieldBase.height) && Objects.equals(this.required, templateResponseDocumentCustomFieldBase.required) - && Objects.equals(this.signer, templateResponseDocumentCustomFieldBase.signer) && Objects.equals(this.group, templateResponseDocumentCustomFieldBase.group); } @Override public int hashCode() { - return Objects.hash(apiId, name, type, x, y, width, height, required, signer, group); + return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentCustomFieldBase {\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); sb.append(" width: ").append(toIndentedString(width)).append("\n"); sb.append(" height: ").append(toIndentedString(height)).append("\n"); sb.append(" required: ").append(toIndentedString(required)).append("\n"); - sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); @@ -394,6 +387,24 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { + fileTypeFound = true; + } + + if (type.getClass().equals(java.io.File.class) + || type.getClass().equals(Integer.class) + || type.getClass().equals(String.class) + || type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for (int i = 0; i < getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); + } + } else { + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + } + } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -430,22 +441,22 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { + if (signer != null) { + if (isFileTypeOrListOfFiles(signer)) { fileTypeFound = true; } - if (type.getClass().equals(java.io.File.class) - || type.getClass().equals(Integer.class) - || type.getClass().equals(String.class) - || type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for (int i = 0; i < getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); + if (signer.getClass().equals(java.io.File.class) + || signer.getClass().equals(Integer.class) + || signer.getClass().equals(String.class) + || signer.getClass().isEnum()) { + map.put("signer", signer); + } else if (isListOfFile(signer)) { + for (int i = 0; i < getListSize(signer); i++) { + map.put("signer[" + i + "]", getFromList(signer, i)); } } else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + map.put("signer", JSON.getDefault().getMapper().writeValueAsString(signer)); } } if (x != null) { @@ -538,24 +549,6 @@ public Map createFormData() throws ApiException { map.put("required", JSON.getDefault().getMapper().writeValueAsString(required)); } } - if (signer != null) { - if (isFileTypeOrListOfFiles(signer)) { - fileTypeFound = true; - } - - if (signer.getClass().equals(java.io.File.class) - || signer.getClass().equals(Integer.class) - || signer.getClass().equals(String.class) - || signer.getClass().isEnum()) { - map.put("signer", signer); - } else if (isListOfFile(signer)) { - for (int i = 0; i < getListSize(signer); i++) { - map.put("signer[" + i + "]", getFromList(signer, i)); - } - } else { - map.put("signer", JSON.getDefault().getMapper().writeValueAsString(signer)); - } - } if (group != null) { if (isFileTypeOrListOfFiles(group)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java index 7fdf99be8..e915dc017 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java @@ -115,15 +115,14 @@ public TemplateResponseDocumentCustomFieldText avgTextLength( * * @return avgTextLength */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; } @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -138,15 +137,14 @@ public TemplateResponseDocumentCustomFieldText isMultiline(Boolean isMultiline) * * @return isMultiline */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_MULTILINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsMultiline() { return isMultiline; } @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -161,15 +159,14 @@ public TemplateResponseDocumentCustomFieldText originalFontSize(Integer original * * @return originalFontSize */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getOriginalFontSize() { return originalFontSize; } @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -184,15 +181,14 @@ public TemplateResponseDocumentCustomFieldText fontFamily(String fontFamily) { * * @return fontFamily */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FONT_FAMILY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getFontFamily() { return fontFamily; } @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java index b362998bf..27dd50e83 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java @@ -67,15 +67,14 @@ public TemplateResponseDocumentFieldGroup name(String name) { * * @return name */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } @@ -90,15 +89,14 @@ public TemplateResponseDocumentFieldGroup rule(TemplateResponseDocumentFieldGrou * * @return rule */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_RULE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_RULE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public TemplateResponseDocumentFieldGroupRule getRule() { return rule; } @JsonProperty(JSON_PROPERTY_RULE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRule(TemplateResponseDocumentFieldGroupRule rule) { this.rule = rule; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java index fd8e15836..0fa796c46 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java @@ -75,15 +75,14 @@ public TemplateResponseDocumentFieldGroupRule requirement(String requirement) { * * @return requirement */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_REQUIREMENT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIREMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getRequirement() { return requirement; } @JsonProperty(JSON_PROPERTY_REQUIREMENT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequirement(String requirement) { this.requirement = requirement; } @@ -98,15 +97,14 @@ public TemplateResponseDocumentFieldGroupRule groupLabel(String groupLabel) { * * @return groupLabel */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_GROUP_LABEL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP_LABEL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getGroupLabel() { return groupLabel; } @JsonProperty(JSON_PROPERTY_GROUP_LABEL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGroupLabel(String groupLabel) { this.groupLabel = groupLabel; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java index 56639bb69..36940640a 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java @@ -27,9 +27,9 @@ /** An array of Form Field objects containing the name and type of each named field. */ @JsonPropertyOrder({ + TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_NAME, - TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_Y, @@ -65,15 +65,15 @@ @JsonSubTypes.Type(value = TemplateResponseDocumentFormFieldText.class, name = "text"), }) public class TemplateResponseDocumentFormFieldBase { + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_SIGNER = "signer"; private String signer; @@ -110,6 +110,29 @@ public static TemplateResponseDocumentFormFieldBase init(HashMap data) throws Ex TemplateResponseDocumentFormFieldBase.class); } + public TemplateResponseDocumentFormFieldBase type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * + * @return type + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getType() { + return type; + } + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; + } + public TemplateResponseDocumentFormFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -120,15 +143,14 @@ public TemplateResponseDocumentFormFieldBase apiId(String apiId) { * * @return apiId */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getApiId() { return apiId; } @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -143,42 +165,18 @@ public TemplateResponseDocumentFormFieldBase name(String name) { * * @return name */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } - public TemplateResponseDocumentFormFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * - * @return type - */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public String getType() { - return type; - } - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - public TemplateResponseDocumentFormFieldBase signer(String signer) { this.signer = signer; return this; @@ -194,15 +192,14 @@ public TemplateResponseDocumentFormFieldBase signer(Integer signer) { * * @return signer */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getSigner() { return signer; } @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSigner(String signer) { this.signer = signer; } @@ -221,15 +218,14 @@ public TemplateResponseDocumentFormFieldBase x(Integer x) { * * @return x */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_X) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getX() { return x; } @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setX(Integer x) { this.x = x; } @@ -244,15 +240,14 @@ public TemplateResponseDocumentFormFieldBase y(Integer y) { * * @return y */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_Y) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getY() { return y; } @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setY(Integer y) { this.y = y; } @@ -267,15 +262,14 @@ public TemplateResponseDocumentFormFieldBase width(Integer width) { * * @return width */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_WIDTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getWidth() { return width; } @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWidth(Integer width) { this.width = width; } @@ -290,15 +284,14 @@ public TemplateResponseDocumentFormFieldBase height(Integer height) { * * @return height */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEIGHT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getHeight() { return height; } @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHeight(Integer height) { this.height = height; } @@ -313,15 +306,14 @@ public TemplateResponseDocumentFormFieldBase required(Boolean required) { * * @return required */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIRED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getRequired() { return required; } @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequired(Boolean required) { this.required = required; } @@ -337,9 +329,9 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldBase templateResponseDocumentFormFieldBase = (TemplateResponseDocumentFormFieldBase) o; - return Objects.equals(this.apiId, templateResponseDocumentFormFieldBase.apiId) + return Objects.equals(this.type, templateResponseDocumentFormFieldBase.type) + && Objects.equals(this.apiId, templateResponseDocumentFormFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentFormFieldBase.name) - && Objects.equals(this.type, templateResponseDocumentFormFieldBase.type) && Objects.equals(this.signer, templateResponseDocumentFormFieldBase.signer) && Objects.equals(this.x, templateResponseDocumentFormFieldBase.x) && Objects.equals(this.y, templateResponseDocumentFormFieldBase.y) @@ -350,16 +342,16 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(apiId, name, type, signer, x, y, width, height, required); + return Objects.hash(type, apiId, name, signer, x, y, width, height, required); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentFormFieldBase {\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); @@ -374,6 +366,24 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { + fileTypeFound = true; + } + + if (type.getClass().equals(java.io.File.class) + || type.getClass().equals(Integer.class) + || type.getClass().equals(String.class) + || type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for (int i = 0; i < getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); + } + } else { + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + } + } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -410,24 +420,6 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) - || type.getClass().equals(Integer.class) - || type.getClass().equals(String.class) - || type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for (int i = 0; i < getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (signer != null) { if (isFileTypeOrListOfFiles(signer)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java index c42b580b3..b2af4e8f9 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java @@ -126,15 +126,14 @@ public TemplateResponseDocumentFormFieldHyperlink avgTextLength( * * @return avgTextLength */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; } @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -149,15 +148,14 @@ public TemplateResponseDocumentFormFieldHyperlink isMultiline(Boolean isMultilin * * @return isMultiline */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_MULTILINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsMultiline() { return isMultiline; } @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -172,15 +170,14 @@ public TemplateResponseDocumentFormFieldHyperlink originalFontSize(Integer origi * * @return originalFontSize */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getOriginalFontSize() { return originalFontSize; } @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -195,15 +192,14 @@ public TemplateResponseDocumentFormFieldHyperlink fontFamily(String fontFamily) * * @return fontFamily */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FONT_FAMILY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getFontFamily() { return fontFamily; } @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java index e7176f5ea..dbb22a6d1 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java @@ -182,15 +182,14 @@ public TemplateResponseDocumentFormFieldText avgTextLength( * * @return avgTextLength */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; } @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -205,15 +204,14 @@ public TemplateResponseDocumentFormFieldText isMultiline(Boolean isMultiline) { * * @return isMultiline */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_MULTILINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsMultiline() { return isMultiline; } @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -228,15 +226,14 @@ public TemplateResponseDocumentFormFieldText originalFontSize(Integer originalFo * * @return originalFontSize */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getOriginalFontSize() { return originalFontSize; } @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -251,15 +248,14 @@ public TemplateResponseDocumentFormFieldText fontFamily(String fontFamily) { * * @return fontFamily */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FONT_FAMILY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getFontFamily() { return fontFamily; } @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java index 6595dccd8..164ee218b 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java @@ -29,9 +29,9 @@ * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. */ @JsonPropertyOrder({ + TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_NAME, - TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_Y, @@ -74,15 +74,15 @@ @JsonSubTypes.Type(value = TemplateResponseDocumentStaticFieldText.class, name = "text"), }) public class TemplateResponseDocumentStaticFieldBase { + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_SIGNER = "signer"; private String signer = "me_now"; @@ -123,6 +123,29 @@ public static TemplateResponseDocumentStaticFieldBase init(HashMap data) throws TemplateResponseDocumentStaticFieldBase.class); } + public TemplateResponseDocumentStaticFieldBase type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * + * @return type + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getType() { + return type; + } + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; + } + public TemplateResponseDocumentStaticFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -133,15 +156,14 @@ public TemplateResponseDocumentStaticFieldBase apiId(String apiId) { * * @return apiId */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getApiId() { return apiId; } @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -156,42 +178,18 @@ public TemplateResponseDocumentStaticFieldBase name(String name) { * * @return name */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } - public TemplateResponseDocumentStaticFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * - * @return type - */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public String getType() { - return type; - } - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - public TemplateResponseDocumentStaticFieldBase signer(String signer) { this.signer = signer; return this; @@ -202,15 +200,14 @@ public TemplateResponseDocumentStaticFieldBase signer(String signer) { * * @return signer */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getSigner() { return signer; } @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSigner(String signer) { this.signer = signer; } @@ -225,15 +222,14 @@ public TemplateResponseDocumentStaticFieldBase x(Integer x) { * * @return x */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_X) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getX() { return x; } @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setX(Integer x) { this.x = x; } @@ -248,15 +244,14 @@ public TemplateResponseDocumentStaticFieldBase y(Integer y) { * * @return y */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_Y) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getY() { return y; } @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setY(Integer y) { this.y = y; } @@ -271,15 +266,14 @@ public TemplateResponseDocumentStaticFieldBase width(Integer width) { * * @return width */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_WIDTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getWidth() { return width; } @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWidth(Integer width) { this.width = width; } @@ -294,15 +288,14 @@ public TemplateResponseDocumentStaticFieldBase height(Integer height) { * * @return height */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEIGHT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getHeight() { return height; } @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHeight(Integer height) { this.height = height; } @@ -317,15 +310,14 @@ public TemplateResponseDocumentStaticFieldBase required(Boolean required) { * * @return required */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIRED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getRequired() { return required; } @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequired(Boolean required) { this.required = required; } @@ -364,9 +356,9 @@ public boolean equals(Object o) { } TemplateResponseDocumentStaticFieldBase templateResponseDocumentStaticFieldBase = (TemplateResponseDocumentStaticFieldBase) o; - return Objects.equals(this.apiId, templateResponseDocumentStaticFieldBase.apiId) + return Objects.equals(this.type, templateResponseDocumentStaticFieldBase.type) + && Objects.equals(this.apiId, templateResponseDocumentStaticFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentStaticFieldBase.name) - && Objects.equals(this.type, templateResponseDocumentStaticFieldBase.type) && Objects.equals(this.signer, templateResponseDocumentStaticFieldBase.signer) && Objects.equals(this.x, templateResponseDocumentStaticFieldBase.x) && Objects.equals(this.y, templateResponseDocumentStaticFieldBase.y) @@ -378,16 +370,16 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(apiId, name, type, signer, x, y, width, height, required, group); + return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentStaticFieldBase {\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); @@ -403,6 +395,24 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { + fileTypeFound = true; + } + + if (type.getClass().equals(java.io.File.class) + || type.getClass().equals(Integer.class) + || type.getClass().equals(String.class) + || type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for (int i = 0; i < getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); + } + } else { + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + } + } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -439,24 +449,6 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) - || type.getClass().equals(Integer.class) - || type.getClass().equals(String.class) - || type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for (int i = 0; i < getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (signer != null) { if (isFileTypeOrListOfFiles(signer)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java index 375fc0737..b5a9afb52 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java @@ -67,15 +67,14 @@ public TemplateResponseFieldAvgTextLength numLines(Integer numLines) { * * @return numLines */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_NUM_LINES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NUM_LINES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getNumLines() { return numLines; } @JsonProperty(JSON_PROPERTY_NUM_LINES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumLines(Integer numLines) { this.numLines = numLines; } @@ -90,15 +89,14 @@ public TemplateResponseFieldAvgTextLength numCharsPerLine(Integer numCharsPerLin * * @return numCharsPerLine */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getNumCharsPerLine() { return numCharsPerLine; } @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumCharsPerLine(Integer numCharsPerLine) { this.numCharsPerLine = numCharsPerLine; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java index d6697fef8..4724f47e5 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java @@ -67,15 +67,14 @@ public TemplateResponseSignerRole name(String name) { * * @return name */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java index 66a058873..08f0784e7 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java @@ -69,15 +69,14 @@ public TemplateUpdateFilesResponseTemplate templateId(String templateId) { * * @return templateId */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getTemplateId() { return templateId; } @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTemplateId(String templateId) { this.templateId = templateId; } diff --git a/sdks/java-v2/docs/ApiAppResponse.md b/sdks/java-v2/docs/ApiAppResponse.md index 7eb6e967d..afe95c850 100644 --- a/sdks/java-v2/docs/ApiAppResponse.md +++ b/sdks/java-v2/docs/ApiAppResponse.md @@ -8,15 +8,15 @@ Contains information about an API App. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `clientId`*_required_ | ```String``` | The app's client id | | -| `createdAt`*_required_ | ```Integer``` | The time that the app was created | | -| `domains`*_required_ | ```List``` | The domain name(s) associated with the app | | -| `name`*_required_ | ```String``` | The name of the app | | -| `isApproved`*_required_ | ```Boolean``` | Boolean to indicate if the app has been approved | | -| `options`*_required_ | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | -| `ownerAccount`*_required_ | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `callbackUrl` | ```String``` | The app's callback URL (for events) | | +| `clientId` | ```String``` | The app's client id | | +| `createdAt` | ```Integer``` | The time that the app was created | | +| `domains` | ```List``` | The domain name(s) associated with the app | | +| `name` | ```String``` | The name of the app | | +| `isApproved` | ```Boolean``` | Boolean to indicate if the app has been approved | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | +| `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | +| `ownerAccount` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `whiteLabelingOptions` | [```ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | | diff --git a/sdks/java-v2/docs/ApiAppResponseOAuth.md b/sdks/java-v2/docs/ApiAppResponseOAuth.md index 93f22d3cc..c2f705c7a 100644 --- a/sdks/java-v2/docs/ApiAppResponseOAuth.md +++ b/sdks/java-v2/docs/ApiAppResponseOAuth.md @@ -8,10 +8,10 @@ An object describing the app's OAuth properties, or null if OAuth is not con | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `callbackUrl`*_required_ | ```String``` | The app's OAuth callback URL. | | -| `scopes`*_required_ | ```List``` | Array of OAuth scopes used by the app. | | -| `chargesUsers`*_required_ | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | +| `callbackUrl` | ```String``` | The app's OAuth callback URL. | | | `secret` | ```String``` | The app's OAuth secret, or null if the app does not belong to user. | | +| `scopes` | ```List``` | Array of OAuth scopes used by the app. | | +| `chargesUsers` | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | diff --git a/sdks/java-v2/docs/ApiAppResponseOptions.md b/sdks/java-v2/docs/ApiAppResponseOptions.md index e6694664d..07979f387 100644 --- a/sdks/java-v2/docs/ApiAppResponseOptions.md +++ b/sdks/java-v2/docs/ApiAppResponseOptions.md @@ -8,7 +8,7 @@ An object with options that override account settings. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `canInsertEverywhere`*_required_ | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `canInsertEverywhere` | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | diff --git a/sdks/java-v2/docs/ApiAppResponseOwnerAccount.md b/sdks/java-v2/docs/ApiAppResponseOwnerAccount.md index a9c5142b3..b4d6d4249 100644 --- a/sdks/java-v2/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/java-v2/docs/ApiAppResponseOwnerAccount.md @@ -8,8 +8,8 @@ An object describing the app's owner | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId`*_required_ | ```String``` | The owner account's ID | | -| `emailAddress`*_required_ | ```String``` | The owner account's email address | | +| `accountId` | ```String``` | The owner account's ID | | +| `emailAddress` | ```String``` | The owner account's email address | | diff --git a/sdks/java-v2/docs/ApiAppResponseWhiteLabelingOptions.md b/sdks/java-v2/docs/ApiAppResponseWhiteLabelingOptions.md index f26b0591e..be6d022fd 100644 --- a/sdks/java-v2/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/java-v2/docs/ApiAppResponseWhiteLabelingOptions.md @@ -8,20 +8,20 @@ An object with options to customize the app's signer page | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `headerBackgroundColor`*_required_ | ```String``` | | | -| `legalVersion`*_required_ | ```String``` | | | -| `linkColor`*_required_ | ```String``` | | | -| `pageBackgroundColor`*_required_ | ```String``` | | | -| `primaryButtonColor`*_required_ | ```String``` | | | -| `primaryButtonColorHover`*_required_ | ```String``` | | | -| `primaryButtonTextColor`*_required_ | ```String``` | | | -| `primaryButtonTextColorHover`*_required_ | ```String``` | | | -| `secondaryButtonColor`*_required_ | ```String``` | | | -| `secondaryButtonColorHover`*_required_ | ```String``` | | | -| `secondaryButtonTextColor`*_required_ | ```String``` | | | -| `secondaryButtonTextColorHover`*_required_ | ```String``` | | | -| `textColor1`*_required_ | ```String``` | | | -| `textColor2`*_required_ | ```String``` | | | +| `headerBackgroundColor` | ```String``` | | | +| `legalVersion` | ```String``` | | | +| `linkColor` | ```String``` | | | +| `pageBackgroundColor` | ```String``` | | | +| `primaryButtonColor` | ```String``` | | | +| `primaryButtonColorHover` | ```String``` | | | +| `primaryButtonTextColor` | ```String``` | | | +| `primaryButtonTextColorHover` | ```String``` | | | +| `secondaryButtonColor` | ```String``` | | | +| `secondaryButtonColorHover` | ```String``` | | | +| `secondaryButtonTextColor` | ```String``` | | | +| `secondaryButtonTextColorHover` | ```String``` | | | +| `textColor1` | ```String``` | | | +| `textColor2` | ```String``` | | | diff --git a/sdks/java-v2/docs/BulkSendJobResponse.md b/sdks/java-v2/docs/BulkSendJobResponse.md index e177a023a..eb2278a34 100644 --- a/sdks/java-v2/docs/BulkSendJobResponse.md +++ b/sdks/java-v2/docs/BulkSendJobResponse.md @@ -8,10 +8,10 @@ Contains information about the BulkSendJob such as when it was created and how m | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `bulkSendJobId`*_required_ | ```String``` | The id of the BulkSendJob. | | -| `total`*_required_ | ```Integer``` | The total amount of Signature Requests queued for sending. | | -| `isCreator`*_required_ | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `createdAt`*_required_ | ```Integer``` | Time that the BulkSendJob was created. | | +| `bulkSendJobId` | ```String``` | The id of the BulkSendJob. | | +| `total` | ```Integer``` | The total amount of Signature Requests queued for sending. | | +| `isCreator` | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | +| `createdAt` | ```Integer``` | Time that the BulkSendJob was created. | | diff --git a/sdks/java-v2/docs/FaxLineResponseFaxLine.md b/sdks/java-v2/docs/FaxLineResponseFaxLine.md index eac0a881f..daf0d206a 100644 --- a/sdks/java-v2/docs/FaxLineResponseFaxLine.md +++ b/sdks/java-v2/docs/FaxLineResponseFaxLine.md @@ -8,10 +8,10 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | Number | | -| `createdAt`*_required_ | ```Integer``` | Created at | | -| `updatedAt`*_required_ | ```Integer``` | Updated at | | -| `accounts`*_required_ | [```List```](AccountResponse.md) | | | +| `number` | ```String``` | Number | | +| `createdAt` | ```Integer``` | Created at | | +| `updatedAt` | ```Integer``` | Updated at | | +| `accounts` | [```List```](AccountResponse.md) | | | diff --git a/sdks/java-v2/docs/TeamResponse.md b/sdks/java-v2/docs/TeamResponse.md index 6dfe49923..ca6344cfc 100644 --- a/sdks/java-v2/docs/TeamResponse.md +++ b/sdks/java-v2/docs/TeamResponse.md @@ -8,10 +8,10 @@ Contains information about your team and its members | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name`*_required_ | ```String``` | The name of your Team | | -| `accounts`*_required_ | [```List```](AccountResponse.md) | | | -| `invitedAccounts`*_required_ | [```List```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | -| `invitedEmails`*_required_ | ```List``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `name` | ```String``` | The name of your Team | | +| `accounts` | [```List```](AccountResponse.md) | | | +| `invitedAccounts` | [```List```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | +| `invitedEmails` | ```List``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | diff --git a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 224ec6c71..770cce434 100644 --- a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -8,9 +8,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId`*_required_ | ```String``` | The id of the Template. | | -| `editUrl`*_required_ | ```String``` | Link to edit the template. | | -| `expiresAt`*_required_ | ```Integer``` | When the link expires. | | +| `templateId` | ```String``` | The id of the Template. | | +| `editUrl` | ```String``` | Link to edit the template. | | +| `expiresAt` | ```Integer``` | When the link expires. | | | `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/java-v2/docs/TemplateCreateResponseTemplate.md b/sdks/java-v2/docs/TemplateCreateResponseTemplate.md index 79801d898..1dcd4bd79 100644 --- a/sdks/java-v2/docs/TemplateCreateResponseTemplate.md +++ b/sdks/java-v2/docs/TemplateCreateResponseTemplate.md @@ -8,7 +8,7 @@ Template object with parameters: `template_id`. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId`*_required_ | ```String``` | The id of the Template. | | +| `templateId` | ```String``` | The id of the Template. | | diff --git a/sdks/java-v2/docs/TemplateResponse.md b/sdks/java-v2/docs/TemplateResponse.md index 87d844276..27673e39b 100644 --- a/sdks/java-v2/docs/TemplateResponse.md +++ b/sdks/java-v2/docs/TemplateResponse.md @@ -8,22 +8,22 @@ Contains information about the templates you and your team have created. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId`*_required_ | ```String``` | The id of the Template. | | -| `title`*_required_ | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message`*_required_ | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `isCreator`*_required_ | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `canEdit`*_required_ | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `isLocked`*_required_ | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata`*_required_ | ```Object``` | The metadata attached to the template. | | -| `signerRoles`*_required_ | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `ccRoles`*_required_ | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents`*_required_ | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | -| `accounts`*_required_ | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | -| `attachments`*_required_ | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `templateId` | ```String``` | The id of the Template. | | +| `title` | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message` | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | | `updatedAt` | ```Integer``` | Time the template was last updated. | | | `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | +| `isCreator` | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `canEdit` | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `isLocked` | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata` | ```Object``` | The metadata attached to the template. | | +| `signerRoles` | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `ccRoles` | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | +| `documents` | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | +| `accounts` | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments` | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | diff --git a/sdks/java-v2/docs/TemplateResponseAccount.md b/sdks/java-v2/docs/TemplateResponseAccount.md index dd8ebce7f..10c996408 100644 --- a/sdks/java-v2/docs/TemplateResponseAccount.md +++ b/sdks/java-v2/docs/TemplateResponseAccount.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_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.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` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | diff --git a/sdks/java-v2/docs/TemplateResponseAccountQuota.md b/sdks/java-v2/docs/TemplateResponseAccountQuota.md index 72160ca8f..ad94c2493 100644 --- a/sdks/java-v2/docs/TemplateResponseAccountQuota.md +++ b/sdks/java-v2/docs/TemplateResponseAccountQuota.md @@ -8,10 +8,10 @@ An array of the designated CC roles that must be specified when sending a Signat | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templatesLeft`*_required_ | ```Integer``` | API templates remaining. | | -| `apiSignatureRequestsLeft`*_required_ | ```Integer``` | API signature requests remaining. | | -| `documentsLeft`*_required_ | ```Integer``` | Signature requests remaining. | | -| `smsVerificationsLeft`*_required_ | ```Integer``` | SMS verifications remaining. | | +| `templatesLeft` | ```Integer``` | API templates remaining. | | +| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | | +| `documentsLeft` | ```Integer``` | Signature requests remaining. | | +| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | diff --git a/sdks/java-v2/docs/TemplateResponseCCRole.md b/sdks/java-v2/docs/TemplateResponseCCRole.md index 06e61bff4..64069b826 100644 --- a/sdks/java-v2/docs/TemplateResponseCCRole.md +++ b/sdks/java-v2/docs/TemplateResponseCCRole.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name`*_required_ | ```String``` | The name of the Role. | | +| `name` | ```String``` | The name of the Role. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocument.md b/sdks/java-v2/docs/TemplateResponseDocument.md index cb69a481f..65da85d42 100644 --- a/sdks/java-v2/docs/TemplateResponseDocument.md +++ b/sdks/java-v2/docs/TemplateResponseDocument.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name`*_required_ | ```String``` | Name of the associated file. | | -| `fieldGroups`*_required_ | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `formFields`*_required_ | [```List```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `customFields`*_required_ | [```List```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `staticFields`*_required_ | [```List```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | +| `name` | ```String``` | Name of the associated file. | | | `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | +| `fieldGroups` | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `formFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `staticFields` | [```List```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md index c7c7f8264..edd461727 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md @@ -8,15 +8,15 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiId`*_required_ | ```String``` | The unique ID for this field. | | -| `name`*_required_ | ```String``` | The name of the Custom Field. | | | `type`*_required_ | ```String``` | | | -| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | -| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | -| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `apiId` | ```String``` | The unique ID for this field. | | +| `name` | ```String``` | The name of the Custom Field. | | | `signer` | ```String``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | +| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width` | ```Integer``` | The width in pixels of this form field. | | +| `height` | ```Integer``` | The height in pixels of this form field. | | +| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md index 70c991777..ccaf19394 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md @@ -9,10 +9,10 @@ This class extends `TemplateResponseDocumentCustomFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | | -| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | +| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily` | ```String``` | Font family used in this form field's text. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md index 7dd066f54..03b5ffbb8 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name`*_required_ | ```String``` | The name of the form field group. | | -| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name` | ```String``` | The name of the form field group. | | +| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md index 59d4e5e06..e0f4dcc8a 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md @@ -8,8 +8,8 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `requirement`*_required_ | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `groupLabel`*_required_ | ```String``` | Name of the group | | +| `requirement` | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `groupLabel` | ```String``` | Name of the group | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md index 8d8766339..6ff896074 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md @@ -8,15 +8,15 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiId`*_required_ | ```String``` | A unique id for the form field. | | -| `name`*_required_ | ```String``` | The name of the form field. | | | `type`*_required_ | ```String``` | | | -| `signer`*_required_ | ```String``` | The signer of the Form Field. | | -| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | -| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | -| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `apiId` | ```String``` | A unique id for the form field. | | +| `name` | ```String``` | The name of the form field. | | +| `signer` | ```String``` | The signer of the Form Field. | | +| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width` | ```Integer``` | The width in pixels of this form field. | | +| `height` | ```Integer``` | The height in pixels of this form field. | | +| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md index 104029730..e8efcf2d7 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -9,10 +9,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | +| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily` | ```String``` | Font family used in this form field's text. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md index 31520bd6f..49cdfaad6 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md @@ -9,10 +9,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | +| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily` | ```String``` | Font family used in this form field's text. | | | `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md index f52329b04..4be3cf070 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md @@ -8,15 +8,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiId`*_required_ | ```String``` | A unique id for the static field. | | -| `name`*_required_ | ```String``` | The name of the static field. | | | `type`*_required_ | ```String``` | | | -| `signer`*_required_ | ```String``` | The signer of the Static Field. | | -| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this static field. | | -| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this static field. | | -| `width`*_required_ | ```Integer``` | The width in pixels of this static field. | | -| `height`*_required_ | ```Integer``` | The height in pixels of this static field. | | -| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `apiId` | ```String``` | A unique id for the static field. | | +| `name` | ```String``` | The name of the static field. | | +| `signer` | ```String``` | The signer of the Static Field. | | +| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | | +| `y` | ```Integer``` | The vertical offset in pixels for this static field. | | +| `width` | ```Integer``` | The width in pixels of this static field. | | +| `height` | ```Integer``` | The height in pixels of this static field. | | +| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md b/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md index f0d2106b0..bb66f3057 100644 --- a/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md @@ -8,8 +8,8 @@ Average text length in this field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `numLines`*_required_ | ```Integer``` | Number of lines. | | -| `numCharsPerLine`*_required_ | ```Integer``` | Number of characters per line. | | +| `numLines` | ```Integer``` | Number of lines. | | +| `numCharsPerLine` | ```Integer``` | Number of characters per line. | | diff --git a/sdks/java-v2/docs/TemplateResponseSignerRole.md b/sdks/java-v2/docs/TemplateResponseSignerRole.md index 08458f4e0..15b48cf17 100644 --- a/sdks/java-v2/docs/TemplateResponseSignerRole.md +++ b/sdks/java-v2/docs/TemplateResponseSignerRole.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name`*_required_ | ```String``` | The name of the Role. | | +| `name` | ```String``` | The name of the Role. | | | `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this role. | | diff --git a/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md index 7acdbb340..6289a9953 100644 --- a/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md @@ -8,7 +8,7 @@ Contains template id | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId`*_required_ | ```String``` | The id of the Template. | | +| `templateId` | ```String``` | The id of the Template. | | | `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponse.java index a77dd8745..ee5f12eaf 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponse.java @@ -39,20 +39,23 @@ * Contains information about an API App. */ @JsonPropertyOrder({ + ApiAppResponse.JSON_PROPERTY_CALLBACK_URL, ApiAppResponse.JSON_PROPERTY_CLIENT_ID, ApiAppResponse.JSON_PROPERTY_CREATED_AT, ApiAppResponse.JSON_PROPERTY_DOMAINS, ApiAppResponse.JSON_PROPERTY_NAME, ApiAppResponse.JSON_PROPERTY_IS_APPROVED, + ApiAppResponse.JSON_PROPERTY_OAUTH, ApiAppResponse.JSON_PROPERTY_OPTIONS, ApiAppResponse.JSON_PROPERTY_OWNER_ACCOUNT, - ApiAppResponse.JSON_PROPERTY_CALLBACK_URL, - ApiAppResponse.JSON_PROPERTY_OAUTH, ApiAppResponse.JSON_PROPERTY_WHITE_LABELING_OPTIONS }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ApiAppResponse { + public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; + private String callbackUrl; + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; private String clientId; @@ -60,7 +63,7 @@ public class ApiAppResponse { private Integer createdAt; public static final String JSON_PROPERTY_DOMAINS = "domains"; - private List domains = new ArrayList<>(); + private List domains = null; public static final String JSON_PROPERTY_NAME = "name"; private String name; @@ -68,18 +71,15 @@ public class ApiAppResponse { public static final String JSON_PROPERTY_IS_APPROVED = "is_approved"; private Boolean isApproved; + public static final String JSON_PROPERTY_OAUTH = "oauth"; + private ApiAppResponseOAuth oauth; + public static final String JSON_PROPERTY_OPTIONS = "options"; private ApiAppResponseOptions options; public static final String JSON_PROPERTY_OWNER_ACCOUNT = "owner_account"; private ApiAppResponseOwnerAccount ownerAccount; - public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; - private String callbackUrl; - - public static final String JSON_PROPERTY_OAUTH = "oauth"; - private ApiAppResponseOAuth oauth; - public static final String JSON_PROPERTY_WHITE_LABELING_OPTIONS = "white_labeling_options"; private ApiAppResponseWhiteLabelingOptions whiteLabelingOptions; @@ -101,6 +101,31 @@ static public ApiAppResponse init(HashMap data) throws Exception { ); } + public ApiAppResponse callbackUrl(String callbackUrl) { + this.callbackUrl = callbackUrl; + return this; + } + + /** + * The app's callback URL (for events) + * @return callbackUrl + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CALLBACK_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCallbackUrl() { + return callbackUrl; + } + + + @JsonProperty(JSON_PROPERTY_CALLBACK_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCallbackUrl(String callbackUrl) { + this.callbackUrl = callbackUrl; + } + + public ApiAppResponse clientId(String clientId) { this.clientId = clientId; return this; @@ -110,9 +135,9 @@ public ApiAppResponse clientId(String clientId) { * The app's client id * @return clientId */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getClientId() { return clientId; @@ -120,7 +145,7 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClientId(String clientId) { this.clientId = clientId; } @@ -135,9 +160,9 @@ public ApiAppResponse createdAt(Integer createdAt) { * The time that the app was created * @return createdAt */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getCreatedAt() { return createdAt; @@ -145,7 +170,7 @@ public Integer getCreatedAt() { @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(Integer createdAt) { this.createdAt = createdAt; } @@ -168,9 +193,9 @@ public ApiAppResponse addDomainsItem(String domainsItem) { * The domain name(s) associated with the app * @return domains */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_DOMAINS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getDomains() { return domains; @@ -178,7 +203,7 @@ public List getDomains() { @JsonProperty(JSON_PROPERTY_DOMAINS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDomains(List domains) { this.domains = domains; } @@ -193,9 +218,9 @@ public ApiAppResponse name(String name) { * The name of the app * @return name */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; @@ -203,7 +228,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } @@ -218,9 +243,9 @@ public ApiAppResponse isApproved(Boolean isApproved) { * Boolean to indicate if the app has been approved * @return isApproved */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_APPROVED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsApproved() { return isApproved; @@ -228,12 +253,37 @@ public Boolean getIsApproved() { @JsonProperty(JSON_PROPERTY_IS_APPROVED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsApproved(Boolean isApproved) { this.isApproved = isApproved; } + public ApiAppResponse oauth(ApiAppResponseOAuth oauth) { + this.oauth = oauth; + return this; + } + + /** + * Get oauth + * @return oauth + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_OAUTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public ApiAppResponseOAuth getOauth() { + return oauth; + } + + + @JsonProperty(JSON_PROPERTY_OAUTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setOauth(ApiAppResponseOAuth oauth) { + this.oauth = oauth; + } + + public ApiAppResponse options(ApiAppResponseOptions options) { this.options = options; return this; @@ -243,9 +293,9 @@ public ApiAppResponse options(ApiAppResponseOptions options) { * Get options * @return options */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_OPTIONS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public ApiAppResponseOptions getOptions() { return options; @@ -253,7 +303,7 @@ public ApiAppResponseOptions getOptions() { @JsonProperty(JSON_PROPERTY_OPTIONS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOptions(ApiAppResponseOptions options) { this.options = options; } @@ -268,9 +318,9 @@ public ApiAppResponse ownerAccount(ApiAppResponseOwnerAccount ownerAccount) { * Get ownerAccount * @return ownerAccount */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_OWNER_ACCOUNT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public ApiAppResponseOwnerAccount getOwnerAccount() { return ownerAccount; @@ -278,62 +328,12 @@ public ApiAppResponseOwnerAccount getOwnerAccount() { @JsonProperty(JSON_PROPERTY_OWNER_ACCOUNT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwnerAccount(ApiAppResponseOwnerAccount ownerAccount) { this.ownerAccount = ownerAccount; } - public ApiAppResponse callbackUrl(String callbackUrl) { - this.callbackUrl = callbackUrl; - return this; - } - - /** - * The app's callback URL (for events) - * @return callbackUrl - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getCallbackUrl() { - return callbackUrl; - } - - - @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCallbackUrl(String callbackUrl) { - this.callbackUrl = callbackUrl; - } - - - public ApiAppResponse oauth(ApiAppResponseOAuth oauth) { - this.oauth = oauth; - return this; - } - - /** - * Get oauth - * @return oauth - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_OAUTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public ApiAppResponseOAuth getOauth() { - return oauth; - } - - - @JsonProperty(JSON_PROPERTY_OAUTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauth(ApiAppResponseOAuth oauth) { - this.oauth = oauth; - } - - public ApiAppResponse whiteLabelingOptions(ApiAppResponseWhiteLabelingOptions whiteLabelingOptions) { this.whiteLabelingOptions = whiteLabelingOptions; return this; @@ -371,36 +371,36 @@ public boolean equals(Object o) { return false; } ApiAppResponse apiAppResponse = (ApiAppResponse) o; - return Objects.equals(this.clientId, apiAppResponse.clientId) && + return Objects.equals(this.callbackUrl, apiAppResponse.callbackUrl) && + Objects.equals(this.clientId, apiAppResponse.clientId) && Objects.equals(this.createdAt, apiAppResponse.createdAt) && Objects.equals(this.domains, apiAppResponse.domains) && Objects.equals(this.name, apiAppResponse.name) && Objects.equals(this.isApproved, apiAppResponse.isApproved) && + Objects.equals(this.oauth, apiAppResponse.oauth) && Objects.equals(this.options, apiAppResponse.options) && Objects.equals(this.ownerAccount, apiAppResponse.ownerAccount) && - Objects.equals(this.callbackUrl, apiAppResponse.callbackUrl) && - Objects.equals(this.oauth, apiAppResponse.oauth) && Objects.equals(this.whiteLabelingOptions, apiAppResponse.whiteLabelingOptions); } @Override public int hashCode() { - return Objects.hash(clientId, createdAt, domains, name, isApproved, options, ownerAccount, callbackUrl, oauth, whiteLabelingOptions); + return Objects.hash(callbackUrl, clientId, createdAt, domains, name, isApproved, oauth, options, ownerAccount, whiteLabelingOptions); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ApiAppResponse {\n"); + sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n"); sb.append(" domains: ").append(toIndentedString(domains)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" isApproved: ").append(toIndentedString(isApproved)).append("\n"); + sb.append(" oauth: ").append(toIndentedString(oauth)).append("\n"); sb.append(" options: ").append(toIndentedString(options)).append("\n"); sb.append(" ownerAccount: ").append(toIndentedString(ownerAccount)).append("\n"); - sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); - sb.append(" oauth: ").append(toIndentedString(oauth)).append("\n"); sb.append(" whiteLabelingOptions: ").append(toIndentedString(whiteLabelingOptions)).append("\n"); sb.append("}"); return sb.toString(); @@ -410,6 +410,25 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { + if (callbackUrl != null) { + if (isFileTypeOrListOfFiles(callbackUrl)) { + fileTypeFound = true; + } + + if (callbackUrl.getClass().equals(java.io.File.class) || + callbackUrl.getClass().equals(Integer.class) || + callbackUrl.getClass().equals(String.class) || + callbackUrl.getClass().isEnum()) { + map.put("callback_url", callbackUrl); + } else if (isListOfFile(callbackUrl)) { + for(int i = 0; i< getListSize(callbackUrl); i++) { + map.put("callback_url[" + i + "]", getFromList(callbackUrl, i)); + } + } + else { + map.put("callback_url", JSON.getDefault().getMapper().writeValueAsString(callbackUrl)); + } + } if (clientId != null) { if (isFileTypeOrListOfFiles(clientId)) { fileTypeFound = true; @@ -505,6 +524,25 @@ public Map createFormData() throws ApiException { map.put("is_approved", JSON.getDefault().getMapper().writeValueAsString(isApproved)); } } + if (oauth != null) { + if (isFileTypeOrListOfFiles(oauth)) { + fileTypeFound = true; + } + + if (oauth.getClass().equals(java.io.File.class) || + oauth.getClass().equals(Integer.class) || + oauth.getClass().equals(String.class) || + oauth.getClass().isEnum()) { + map.put("oauth", oauth); + } else if (isListOfFile(oauth)) { + for(int i = 0; i< getListSize(oauth); i++) { + map.put("oauth[" + i + "]", getFromList(oauth, i)); + } + } + else { + map.put("oauth", JSON.getDefault().getMapper().writeValueAsString(oauth)); + } + } if (options != null) { if (isFileTypeOrListOfFiles(options)) { fileTypeFound = true; @@ -543,44 +581,6 @@ public Map createFormData() throws ApiException { map.put("owner_account", JSON.getDefault().getMapper().writeValueAsString(ownerAccount)); } } - if (callbackUrl != null) { - if (isFileTypeOrListOfFiles(callbackUrl)) { - fileTypeFound = true; - } - - if (callbackUrl.getClass().equals(java.io.File.class) || - callbackUrl.getClass().equals(Integer.class) || - callbackUrl.getClass().equals(String.class) || - callbackUrl.getClass().isEnum()) { - map.put("callback_url", callbackUrl); - } else if (isListOfFile(callbackUrl)) { - for(int i = 0; i< getListSize(callbackUrl); i++) { - map.put("callback_url[" + i + "]", getFromList(callbackUrl, i)); - } - } - else { - map.put("callback_url", JSON.getDefault().getMapper().writeValueAsString(callbackUrl)); - } - } - if (oauth != null) { - if (isFileTypeOrListOfFiles(oauth)) { - fileTypeFound = true; - } - - if (oauth.getClass().equals(java.io.File.class) || - oauth.getClass().equals(Integer.class) || - oauth.getClass().equals(String.class) || - oauth.getClass().isEnum()) { - map.put("oauth", oauth); - } else if (isListOfFile(oauth)) { - for(int i = 0; i< getListSize(oauth); i++) { - map.put("oauth[" + i + "]", getFromList(oauth, i)); - } - } - else { - map.put("oauth", JSON.getDefault().getMapper().writeValueAsString(oauth)); - } - } if (whiteLabelingOptions != null) { if (isFileTypeOrListOfFiles(whiteLabelingOptions)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java index ae0ebedbd..b071e4067 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java @@ -36,9 +36,9 @@ */ @JsonPropertyOrder({ ApiAppResponseOAuth.JSON_PROPERTY_CALLBACK_URL, + ApiAppResponseOAuth.JSON_PROPERTY_SECRET, ApiAppResponseOAuth.JSON_PROPERTY_SCOPES, - ApiAppResponseOAuth.JSON_PROPERTY_CHARGES_USERS, - ApiAppResponseOAuth.JSON_PROPERTY_SECRET + ApiAppResponseOAuth.JSON_PROPERTY_CHARGES_USERS }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -46,15 +46,15 @@ public class ApiAppResponseOAuth { public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; private String callbackUrl; + public static final String JSON_PROPERTY_SECRET = "secret"; + private String secret; + public static final String JSON_PROPERTY_SCOPES = "scopes"; - private List scopes = new ArrayList<>(); + private List scopes = null; public static final String JSON_PROPERTY_CHARGES_USERS = "charges_users"; private Boolean chargesUsers; - public static final String JSON_PROPERTY_SECRET = "secret"; - private String secret; - public ApiAppResponseOAuth() { } @@ -82,9 +82,9 @@ public ApiAppResponseOAuth callbackUrl(String callbackUrl) { * The app's OAuth callback URL. * @return callbackUrl */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getCallbackUrl() { return callbackUrl; @@ -92,12 +92,37 @@ public String getCallbackUrl() { @JsonProperty(JSON_PROPERTY_CALLBACK_URL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCallbackUrl(String callbackUrl) { this.callbackUrl = callbackUrl; } + public ApiAppResponseOAuth secret(String secret) { + this.secret = secret; + return this; + } + + /** + * The app's OAuth secret, or null if the app does not belong to user. + * @return secret + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSecret() { + return secret; + } + + + @JsonProperty(JSON_PROPERTY_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSecret(String secret) { + this.secret = secret; + } + + public ApiAppResponseOAuth scopes(List scopes) { this.scopes = scopes; return this; @@ -115,9 +140,9 @@ public ApiAppResponseOAuth addScopesItem(String scopesItem) { * Array of OAuth scopes used by the app. * @return scopes */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_SCOPES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getScopes() { return scopes; @@ -125,7 +150,7 @@ public List getScopes() { @JsonProperty(JSON_PROPERTY_SCOPES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScopes(List scopes) { this.scopes = scopes; } @@ -140,9 +165,9 @@ public ApiAppResponseOAuth chargesUsers(Boolean chargesUsers) { * Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. * @return chargesUsers */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_CHARGES_USERS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getChargesUsers() { return chargesUsers; @@ -150,37 +175,12 @@ public Boolean getChargesUsers() { @JsonProperty(JSON_PROPERTY_CHARGES_USERS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChargesUsers(Boolean chargesUsers) { this.chargesUsers = chargesUsers; } - public ApiAppResponseOAuth secret(String secret) { - this.secret = secret; - return this; - } - - /** - * The app's OAuth secret, or null if the app does not belong to user. - * @return secret - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSecret() { - return secret; - } - - - @JsonProperty(JSON_PROPERTY_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSecret(String secret) { - this.secret = secret; - } - - /** * Return true if this ApiAppResponseOAuth object is equal to o. */ @@ -194,14 +194,14 @@ public boolean equals(Object o) { } ApiAppResponseOAuth apiAppResponseOAuth = (ApiAppResponseOAuth) o; return Objects.equals(this.callbackUrl, apiAppResponseOAuth.callbackUrl) && + Objects.equals(this.secret, apiAppResponseOAuth.secret) && Objects.equals(this.scopes, apiAppResponseOAuth.scopes) && - Objects.equals(this.chargesUsers, apiAppResponseOAuth.chargesUsers) && - Objects.equals(this.secret, apiAppResponseOAuth.secret); + Objects.equals(this.chargesUsers, apiAppResponseOAuth.chargesUsers); } @Override public int hashCode() { - return Objects.hash(callbackUrl, scopes, chargesUsers, secret); + return Objects.hash(callbackUrl, secret, scopes, chargesUsers); } @Override @@ -209,9 +209,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ApiAppResponseOAuth {\n"); sb.append(" callbackUrl: ").append(toIndentedString(callbackUrl)).append("\n"); + sb.append(" secret: ").append(toIndentedString(secret)).append("\n"); sb.append(" scopes: ").append(toIndentedString(scopes)).append("\n"); sb.append(" chargesUsers: ").append(toIndentedString(chargesUsers)).append("\n"); - sb.append(" secret: ").append(toIndentedString(secret)).append("\n"); sb.append("}"); return sb.toString(); } @@ -239,6 +239,25 @@ public Map createFormData() throws ApiException { map.put("callback_url", JSON.getDefault().getMapper().writeValueAsString(callbackUrl)); } } + if (secret != null) { + if (isFileTypeOrListOfFiles(secret)) { + fileTypeFound = true; + } + + if (secret.getClass().equals(java.io.File.class) || + secret.getClass().equals(Integer.class) || + secret.getClass().equals(String.class) || + secret.getClass().isEnum()) { + map.put("secret", secret); + } else if (isListOfFile(secret)) { + for(int i = 0; i< getListSize(secret); i++) { + map.put("secret[" + i + "]", getFromList(secret, i)); + } + } + else { + map.put("secret", JSON.getDefault().getMapper().writeValueAsString(secret)); + } + } if (scopes != null) { if (isFileTypeOrListOfFiles(scopes)) { fileTypeFound = true; @@ -277,25 +296,6 @@ public Map createFormData() throws ApiException { map.put("charges_users", JSON.getDefault().getMapper().writeValueAsString(chargesUsers)); } } - if (secret != null) { - if (isFileTypeOrListOfFiles(secret)) { - fileTypeFound = true; - } - - if (secret.getClass().equals(java.io.File.class) || - secret.getClass().equals(Integer.class) || - secret.getClass().equals(String.class) || - secret.getClass().isEnum()) { - map.put("secret", secret); - } else if (isListOfFile(secret)) { - for(int i = 0; i< getListSize(secret); i++) { - map.put("secret[" + i + "]", getFromList(secret, i)); - } - } - else { - map.put("secret", JSON.getDefault().getMapper().writeValueAsString(secret)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java index 8ef6ba51f..2cffd69d5 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java @@ -68,9 +68,9 @@ public ApiAppResponseOptions canInsertEverywhere(Boolean canInsertEverywhere) { * Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document * @return canInsertEverywhere */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_CAN_INSERT_EVERYWHERE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getCanInsertEverywhere() { return canInsertEverywhere; @@ -78,7 +78,7 @@ public Boolean getCanInsertEverywhere() { @JsonProperty(JSON_PROPERTY_CAN_INSERT_EVERYWHERE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCanInsertEverywhere(Boolean canInsertEverywhere) { this.canInsertEverywhere = canInsertEverywhere; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java index f1e350634..80f95b50a 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java @@ -72,9 +72,9 @@ public ApiAppResponseOwnerAccount accountId(String accountId) { * The owner account's ID * @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; @@ -82,7 +82,7 @@ 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; } @@ -97,9 +97,9 @@ public ApiAppResponseOwnerAccount emailAddress(String emailAddress) { * The owner account's email address * @return emailAddress */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getEmailAddress() { return emailAddress; @@ -107,7 +107,7 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmailAddress(String emailAddress) { this.emailAddress = emailAddress; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java index 9f0fb11d3..44b6f6e1e 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java @@ -120,9 +120,9 @@ public ApiAppResponseWhiteLabelingOptions headerBackgroundColor(String headerBac * Get headerBackgroundColor * @return headerBackgroundColor */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEADER_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getHeaderBackgroundColor() { return headerBackgroundColor; @@ -130,7 +130,7 @@ public String getHeaderBackgroundColor() { @JsonProperty(JSON_PROPERTY_HEADER_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHeaderBackgroundColor(String headerBackgroundColor) { this.headerBackgroundColor = headerBackgroundColor; } @@ -145,9 +145,9 @@ public ApiAppResponseWhiteLabelingOptions legalVersion(String legalVersion) { * Get legalVersion * @return legalVersion */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_LEGAL_VERSION) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getLegalVersion() { return legalVersion; @@ -155,7 +155,7 @@ public String getLegalVersion() { @JsonProperty(JSON_PROPERTY_LEGAL_VERSION) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalVersion(String legalVersion) { this.legalVersion = legalVersion; } @@ -170,9 +170,9 @@ public ApiAppResponseWhiteLabelingOptions linkColor(String linkColor) { * Get linkColor * @return linkColor */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_LINK_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getLinkColor() { return linkColor; @@ -180,7 +180,7 @@ public String getLinkColor() { @JsonProperty(JSON_PROPERTY_LINK_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinkColor(String linkColor) { this.linkColor = linkColor; } @@ -195,9 +195,9 @@ public ApiAppResponseWhiteLabelingOptions pageBackgroundColor(String pageBackgro * Get pageBackgroundColor * @return pageBackgroundColor */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_PAGE_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getPageBackgroundColor() { return pageBackgroundColor; @@ -205,7 +205,7 @@ public String getPageBackgroundColor() { @JsonProperty(JSON_PROPERTY_PAGE_BACKGROUND_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPageBackgroundColor(String pageBackgroundColor) { this.pageBackgroundColor = pageBackgroundColor; } @@ -220,9 +220,9 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonColor(String primaryButto * Get primaryButtonColor * @return primaryButtonColor */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getPrimaryButtonColor() { return primaryButtonColor; @@ -230,7 +230,7 @@ public String getPrimaryButtonColor() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrimaryButtonColor(String primaryButtonColor) { this.primaryButtonColor = primaryButtonColor; } @@ -245,9 +245,9 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonColorHover(String primary * Get primaryButtonColorHover * @return primaryButtonColorHover */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getPrimaryButtonColorHover() { return primaryButtonColorHover; @@ -255,7 +255,7 @@ public String getPrimaryButtonColorHover() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrimaryButtonColorHover(String primaryButtonColorHover) { this.primaryButtonColorHover = primaryButtonColorHover; } @@ -270,9 +270,9 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonTextColor(String primaryB * Get primaryButtonTextColor * @return primaryButtonTextColor */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getPrimaryButtonTextColor() { return primaryButtonTextColor; @@ -280,7 +280,7 @@ public String getPrimaryButtonTextColor() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrimaryButtonTextColor(String primaryButtonTextColor) { this.primaryButtonTextColor = primaryButtonTextColor; } @@ -295,9 +295,9 @@ public ApiAppResponseWhiteLabelingOptions primaryButtonTextColorHover(String pri * Get primaryButtonTextColorHover * @return primaryButtonTextColorHover */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getPrimaryButtonTextColorHover() { return primaryButtonTextColorHover; @@ -305,7 +305,7 @@ public String getPrimaryButtonTextColorHover() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrimaryButtonTextColorHover(String primaryButtonTextColorHover) { this.primaryButtonTextColorHover = primaryButtonTextColorHover; } @@ -320,9 +320,9 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonColor(String secondaryB * Get secondaryButtonColor * @return secondaryButtonColor */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getSecondaryButtonColor() { return secondaryButtonColor; @@ -330,7 +330,7 @@ public String getSecondaryButtonColor() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSecondaryButtonColor(String secondaryButtonColor) { this.secondaryButtonColor = secondaryButtonColor; } @@ -345,9 +345,9 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonColorHover(String secon * Get secondaryButtonColorHover * @return secondaryButtonColorHover */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getSecondaryButtonColorHover() { return secondaryButtonColorHover; @@ -355,7 +355,7 @@ public String getSecondaryButtonColorHover() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSecondaryButtonColorHover(String secondaryButtonColorHover) { this.secondaryButtonColorHover = secondaryButtonColorHover; } @@ -370,9 +370,9 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonTextColor(String second * Get secondaryButtonTextColor * @return secondaryButtonTextColor */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getSecondaryButtonTextColor() { return secondaryButtonTextColor; @@ -380,7 +380,7 @@ public String getSecondaryButtonTextColor() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSecondaryButtonTextColor(String secondaryButtonTextColor) { this.secondaryButtonTextColor = secondaryButtonTextColor; } @@ -395,9 +395,9 @@ public ApiAppResponseWhiteLabelingOptions secondaryButtonTextColorHover(String s * Get secondaryButtonTextColorHover * @return secondaryButtonTextColorHover */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getSecondaryButtonTextColorHover() { return secondaryButtonTextColorHover; @@ -405,7 +405,7 @@ public String getSecondaryButtonTextColorHover() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSecondaryButtonTextColorHover(String secondaryButtonTextColorHover) { this.secondaryButtonTextColorHover = secondaryButtonTextColorHover; } @@ -420,9 +420,9 @@ public ApiAppResponseWhiteLabelingOptions textColor1(String textColor1) { * Get textColor1 * @return textColor1 */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEXT_COLOR1) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getTextColor1() { return textColor1; @@ -430,7 +430,7 @@ public String getTextColor1() { @JsonProperty(JSON_PROPERTY_TEXT_COLOR1) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTextColor1(String textColor1) { this.textColor1 = textColor1; } @@ -445,9 +445,9 @@ public ApiAppResponseWhiteLabelingOptions textColor2(String textColor2) { * Get textColor2 * @return textColor2 */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEXT_COLOR2) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getTextColor2() { return textColor2; @@ -455,7 +455,7 @@ public String getTextColor2() { @JsonProperty(JSON_PROPERTY_TEXT_COLOR2) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTextColor2(String textColor2) { this.textColor2 = textColor2; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java index 864eeb183..88f0eec99 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java @@ -80,9 +80,9 @@ public BulkSendJobResponse bulkSendJobId(String bulkSendJobId) { * The id of the BulkSendJob. * @return bulkSendJobId */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getBulkSendJobId() { return bulkSendJobId; @@ -90,7 +90,7 @@ public String getBulkSendJobId() { @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBulkSendJobId(String bulkSendJobId) { this.bulkSendJobId = bulkSendJobId; } @@ -105,9 +105,9 @@ public BulkSendJobResponse total(Integer total) { * The total amount of Signature Requests queued for sending. * @return total */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_TOTAL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getTotal() { return total; @@ -115,7 +115,7 @@ public Integer getTotal() { @JsonProperty(JSON_PROPERTY_TOTAL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTotal(Integer total) { this.total = total; } @@ -130,9 +130,9 @@ public BulkSendJobResponse isCreator(Boolean isCreator) { * True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. * @return isCreator */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsCreator() { return isCreator; @@ -140,7 +140,7 @@ public Boolean getIsCreator() { @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsCreator(Boolean isCreator) { this.isCreator = isCreator; } @@ -155,9 +155,9 @@ public BulkSendJobResponse createdAt(Integer createdAt) { * Time that the BulkSendJob was created. * @return createdAt */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getCreatedAt() { return createdAt; @@ -165,7 +165,7 @@ public Integer getCreatedAt() { @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(Integer createdAt) { this.createdAt = createdAt; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java index 3dfe4de09..9b6b8c893 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java @@ -54,7 +54,7 @@ public class FaxLineResponseFaxLine { private Integer updatedAt; public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private List accounts = new ArrayList<>(); + private List accounts = null; public FaxLineResponseFaxLine() { } @@ -83,9 +83,9 @@ public FaxLineResponseFaxLine number(String number) { * Number * @return number */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_NUMBER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getNumber() { return number; @@ -93,7 +93,7 @@ public String getNumber() { @JsonProperty(JSON_PROPERTY_NUMBER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { this.number = number; } @@ -108,9 +108,9 @@ public FaxLineResponseFaxLine createdAt(Integer createdAt) { * Created at * @return createdAt */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getCreatedAt() { return createdAt; @@ -118,7 +118,7 @@ public Integer getCreatedAt() { @JsonProperty(JSON_PROPERTY_CREATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(Integer createdAt) { this.createdAt = createdAt; } @@ -133,9 +133,9 @@ public FaxLineResponseFaxLine updatedAt(Integer updatedAt) { * Updated at * @return updatedAt */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getUpdatedAt() { return updatedAt; @@ -143,7 +143,7 @@ public Integer getUpdatedAt() { @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUpdatedAt(Integer updatedAt) { this.updatedAt = updatedAt; } @@ -166,9 +166,9 @@ public FaxLineResponseFaxLine addAccountsItem(AccountResponse accountsItem) { * Get accounts * @return accounts */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getAccounts() { return accounts; @@ -176,7 +176,7 @@ public List getAccounts() { @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccounts(List accounts) { this.accounts = accounts; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java index 2460f8a72..39a93c476 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java @@ -48,13 +48,13 @@ public class TeamResponse { private String name; public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private List accounts = new ArrayList<>(); + private List accounts = null; public static final String JSON_PROPERTY_INVITED_ACCOUNTS = "invited_accounts"; - private List invitedAccounts = new ArrayList<>(); + private List invitedAccounts = null; public static final String JSON_PROPERTY_INVITED_EMAILS = "invited_emails"; - private List invitedEmails = new ArrayList<>(); + private List invitedEmails = null; public TeamResponse() { } @@ -83,9 +83,9 @@ public TeamResponse name(String name) { * The name of your Team * @return name */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; @@ -93,7 +93,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } @@ -116,9 +116,9 @@ public TeamResponse addAccountsItem(AccountResponse accountsItem) { * Get accounts * @return accounts */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getAccounts() { return accounts; @@ -126,7 +126,7 @@ public List getAccounts() { @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccounts(List accounts) { this.accounts = accounts; } @@ -149,9 +149,9 @@ public TeamResponse addInvitedAccountsItem(AccountResponse invitedAccountsItem) * A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. * @return invitedAccounts */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_INVITED_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getInvitedAccounts() { return invitedAccounts; @@ -159,7 +159,7 @@ public List getInvitedAccounts() { @JsonProperty(JSON_PROPERTY_INVITED_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInvitedAccounts(List invitedAccounts) { this.invitedAccounts = invitedAccounts; } @@ -182,9 +182,9 @@ public TeamResponse addInvitedEmailsItem(String invitedEmailsItem) { * A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. * @return invitedEmails */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_INVITED_EMAILS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getInvitedEmails() { return invitedEmails; @@ -192,7 +192,7 @@ public List getInvitedEmails() { @JsonProperty(JSON_PROPERTY_INVITED_EMAILS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInvitedEmails(List invitedEmails) { this.invitedEmails = invitedEmails; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java index d0d6ca141..f9c0286ac 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java @@ -84,9 +84,9 @@ public TemplateCreateEmbeddedDraftResponseTemplate templateId(String templateId) * The id of the Template. * @return templateId */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getTemplateId() { return templateId; @@ -94,7 +94,7 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTemplateId(String templateId) { this.templateId = templateId; } @@ -109,9 +109,9 @@ public TemplateCreateEmbeddedDraftResponseTemplate editUrl(String editUrl) { * Link to edit the template. * @return editUrl */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_EDIT_URL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getEditUrl() { return editUrl; @@ -119,7 +119,7 @@ public String getEditUrl() { @JsonProperty(JSON_PROPERTY_EDIT_URL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEditUrl(String editUrl) { this.editUrl = editUrl; } @@ -134,9 +134,9 @@ public TemplateCreateEmbeddedDraftResponseTemplate expiresAt(Integer expiresAt) * When the link expires. * @return expiresAt */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_EXPIRES_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getExpiresAt() { return expiresAt; @@ -144,7 +144,7 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java index d070cfa45..6d668fd69 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java @@ -68,9 +68,9 @@ public TemplateCreateResponseTemplate templateId(String templateId) { * The id of the Template. * @return templateId */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getTemplateId() { return templateId; @@ -78,7 +78,7 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTemplateId(String templateId) { this.templateId = templateId; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java index 7f664e0d1..5924befa8 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -45,6 +45,8 @@ TemplateResponse.JSON_PROPERTY_TEMPLATE_ID, TemplateResponse.JSON_PROPERTY_TITLE, TemplateResponse.JSON_PROPERTY_MESSAGE, + TemplateResponse.JSON_PROPERTY_UPDATED_AT, + TemplateResponse.JSON_PROPERTY_IS_EMBEDDED, TemplateResponse.JSON_PROPERTY_IS_CREATOR, TemplateResponse.JSON_PROPERTY_CAN_EDIT, TemplateResponse.JSON_PROPERTY_IS_LOCKED, @@ -52,12 +54,10 @@ TemplateResponse.JSON_PROPERTY_SIGNER_ROLES, TemplateResponse.JSON_PROPERTY_CC_ROLES, TemplateResponse.JSON_PROPERTY_DOCUMENTS, - TemplateResponse.JSON_PROPERTY_ACCOUNTS, - TemplateResponse.JSON_PROPERTY_ATTACHMENTS, - TemplateResponse.JSON_PROPERTY_UPDATED_AT, - TemplateResponse.JSON_PROPERTY_IS_EMBEDDED, TemplateResponse.JSON_PROPERTY_CUSTOM_FIELDS, - TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS + TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS, + TemplateResponse.JSON_PROPERTY_ACCOUNTS, + TemplateResponse.JSON_PROPERTY_ATTACHMENTS }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -71,6 +71,12 @@ public class TemplateResponse { public static final String JSON_PROPERTY_MESSAGE = "message"; private String message; + public static final String JSON_PROPERTY_UPDATED_AT = "updated_at"; + private Integer updatedAt; + + public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; + private Boolean isEmbedded; + public static final String JSON_PROPERTY_IS_CREATOR = "is_creator"; private Boolean isCreator; @@ -84,25 +90,13 @@ public class TemplateResponse { private Object metadata; public static final String JSON_PROPERTY_SIGNER_ROLES = "signer_roles"; - private List signerRoles = new ArrayList<>(); + private List signerRoles = null; public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; - private List ccRoles = new ArrayList<>(); + private List ccRoles = null; public static final String JSON_PROPERTY_DOCUMENTS = "documents"; - private List documents = new ArrayList<>(); - - public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private List accounts = new ArrayList<>(); - - public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; - private List attachments = new ArrayList<>(); - - public static final String JSON_PROPERTY_UPDATED_AT = "updated_at"; - private Integer updatedAt; - - public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; - private Boolean isEmbedded; + private List documents = null; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; @Deprecated @@ -112,6 +106,12 @@ public class TemplateResponse { @Deprecated private List namedFormFields = null; + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private List accounts = null; + + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + private List attachments = null; + public TemplateResponse() { } @@ -139,9 +139,9 @@ public TemplateResponse templateId(String templateId) { * The id of the Template. * @return templateId */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getTemplateId() { return templateId; @@ -149,7 +149,7 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTemplateId(String templateId) { this.templateId = templateId; } @@ -164,9 +164,9 @@ public TemplateResponse title(String title) { * The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. * @return title */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_TITLE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getTitle() { return title; @@ -174,7 +174,7 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTitle(String title) { this.title = title; } @@ -189,9 +189,9 @@ public TemplateResponse message(String message) { * The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. * @return message */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_MESSAGE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getMessage() { return message; @@ -199,12 +199,62 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { this.message = message; } + public TemplateResponse updatedAt(Integer updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + * Time the template was last updated. + * @return updatedAt + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getUpdatedAt() { + return updatedAt; + } + + + @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setUpdatedAt(Integer updatedAt) { + this.updatedAt = updatedAt; + } + + + public TemplateResponse isEmbedded(Boolean isEmbedded) { + this.isEmbedded = isEmbedded; + return this; + } + + /** + * `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + * @return isEmbedded + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIsEmbedded() { + return isEmbedded; + } + + + @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIsEmbedded(Boolean isEmbedded) { + this.isEmbedded = isEmbedded; + } + + public TemplateResponse isCreator(Boolean isCreator) { this.isCreator = isCreator; return this; @@ -214,9 +264,9 @@ public TemplateResponse isCreator(Boolean isCreator) { * `true` if you are the owner of this template, `false` if it's been shared with you by a team member. * @return isCreator */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsCreator() { return isCreator; @@ -224,7 +274,7 @@ public Boolean getIsCreator() { @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsCreator(Boolean isCreator) { this.isCreator = isCreator; } @@ -239,9 +289,9 @@ public TemplateResponse canEdit(Boolean canEdit) { * Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). * @return canEdit */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_CAN_EDIT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getCanEdit() { return canEdit; @@ -249,7 +299,7 @@ public Boolean getCanEdit() { @JsonProperty(JSON_PROPERTY_CAN_EDIT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCanEdit(Boolean canEdit) { this.canEdit = canEdit; } @@ -264,9 +314,9 @@ public TemplateResponse isLocked(Boolean isLocked) { * Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. * @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; @@ -274,7 +324,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; } @@ -289,9 +339,9 @@ public TemplateResponse metadata(Object metadata) { * The metadata attached to the template. * @return metadata */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_METADATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Object getMetadata() { return metadata; @@ -299,7 +349,7 @@ public Object getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Object metadata) { this.metadata = metadata; } @@ -322,9 +372,9 @@ public TemplateResponse addSignerRolesItem(TemplateResponseSignerRole signerRole * An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. * @return signerRoles */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getSignerRoles() { return signerRoles; @@ -332,7 +382,7 @@ public List getSignerRoles() { @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSignerRoles(List signerRoles) { this.signerRoles = signerRoles; } @@ -355,9 +405,9 @@ public TemplateResponse addCcRolesItem(TemplateResponseCCRole ccRolesItem) { * An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. * @return ccRoles */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_CC_ROLES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getCcRoles() { return ccRoles; @@ -365,7 +415,7 @@ public List getCcRoles() { @JsonProperty(JSON_PROPERTY_CC_ROLES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCcRoles(List ccRoles) { this.ccRoles = ccRoles; } @@ -388,9 +438,9 @@ public TemplateResponse addDocumentsItem(TemplateResponseDocument documentsItem) * An array describing each document associated with this Template. Includes form field data for each document. * @return documents */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_DOCUMENTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getDocuments() { return documents; @@ -398,128 +448,12 @@ public List getDocuments() { @JsonProperty(JSON_PROPERTY_DOCUMENTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocuments(List documents) { this.documents = documents; } - public TemplateResponse accounts(List accounts) { - this.accounts = accounts; - return this; - } - - public TemplateResponse addAccountsItem(TemplateResponseAccount accountsItem) { - if (this.accounts == null) { - this.accounts = new ArrayList<>(); - } - this.accounts.add(accountsItem); - return this; - } - - /** - * An array of the Accounts that can use this Template. - * @return accounts - */ - @jakarta.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public List getAccounts() { - return accounts; - } - - - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setAccounts(List accounts) { - this.accounts = accounts; - } - - - public TemplateResponse attachments(List attachments) { - this.attachments = attachments; - return this; - } - - public TemplateResponse addAttachmentsItem(SignatureRequestResponseAttachment attachmentsItem) { - if (this.attachments == null) { - this.attachments = new ArrayList<>(); - } - this.attachments.add(attachmentsItem); - return this; - } - - /** - * Signer attachments. - * @return attachments - */ - @jakarta.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_ATTACHMENTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public List getAttachments() { - return attachments; - } - - - @JsonProperty(JSON_PROPERTY_ATTACHMENTS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setAttachments(List attachments) { - this.attachments = attachments; - } - - - public TemplateResponse updatedAt(Integer updatedAt) { - this.updatedAt = updatedAt; - return this; - } - - /** - * Time the template was last updated. - * @return updatedAt - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getUpdatedAt() { - return updatedAt; - } - - - @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUpdatedAt(Integer updatedAt) { - this.updatedAt = updatedAt; - } - - - public TemplateResponse isEmbedded(Boolean isEmbedded) { - this.isEmbedded = isEmbedded; - return this; - } - - /** - * `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. - * @return isEmbedded - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getIsEmbedded() { - return isEmbedded; - } - - - @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsEmbedded(Boolean isEmbedded) { - this.isEmbedded = isEmbedded; - } - - @Deprecated public TemplateResponse customFields(List customFields) { this.customFields = customFields; @@ -594,6 +528,72 @@ public void setNamedFormFields(List named } + public TemplateResponse accounts(List accounts) { + this.accounts = accounts; + return this; + } + + public TemplateResponse addAccountsItem(TemplateResponseAccount accountsItem) { + if (this.accounts == null) { + this.accounts = new ArrayList<>(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * An array of the Accounts that can use this Template. + * @return accounts + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getAccounts() { + return accounts; + } + + + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAccounts(List accounts) { + this.accounts = accounts; + } + + + public TemplateResponse attachments(List attachments) { + this.attachments = attachments; + return this; + } + + public TemplateResponse addAttachmentsItem(SignatureRequestResponseAttachment attachmentsItem) { + if (this.attachments == null) { + this.attachments = new ArrayList<>(); + } + this.attachments.add(attachmentsItem); + return this; + } + + /** + * Signer attachments. + * @return attachments + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getAttachments() { + return attachments; + } + + + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAttachments(List attachments) { + this.attachments = attachments; + } + + /** * Return true if this TemplateResponse object is equal to o. */ @@ -609,6 +609,8 @@ public boolean equals(Object o) { return Objects.equals(this.templateId, templateResponse.templateId) && Objects.equals(this.title, templateResponse.title) && Objects.equals(this.message, templateResponse.message) && + Objects.equals(this.updatedAt, templateResponse.updatedAt) && + Objects.equals(this.isEmbedded, templateResponse.isEmbedded) && Objects.equals(this.isCreator, templateResponse.isCreator) && Objects.equals(this.canEdit, templateResponse.canEdit) && Objects.equals(this.isLocked, templateResponse.isLocked) && @@ -616,17 +618,15 @@ public boolean equals(Object o) { Objects.equals(this.signerRoles, templateResponse.signerRoles) && Objects.equals(this.ccRoles, templateResponse.ccRoles) && Objects.equals(this.documents, templateResponse.documents) && - Objects.equals(this.accounts, templateResponse.accounts) && - Objects.equals(this.attachments, templateResponse.attachments) && - Objects.equals(this.updatedAt, templateResponse.updatedAt) && - Objects.equals(this.isEmbedded, templateResponse.isEmbedded) && Objects.equals(this.customFields, templateResponse.customFields) && - Objects.equals(this.namedFormFields, templateResponse.namedFormFields); + Objects.equals(this.namedFormFields, templateResponse.namedFormFields) && + Objects.equals(this.accounts, templateResponse.accounts) && + Objects.equals(this.attachments, templateResponse.attachments); } @Override public int hashCode() { - return Objects.hash(templateId, title, message, isCreator, canEdit, isLocked, metadata, signerRoles, ccRoles, documents, accounts, attachments, updatedAt, isEmbedded, customFields, namedFormFields); + return Objects.hash(templateId, title, message, updatedAt, isEmbedded, isCreator, canEdit, isLocked, metadata, signerRoles, ccRoles, documents, customFields, namedFormFields, accounts, attachments); } @Override @@ -636,6 +636,8 @@ public String toString() { sb.append(" templateId: ").append(toIndentedString(templateId)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); + sb.append(" isEmbedded: ").append(toIndentedString(isEmbedded)).append("\n"); sb.append(" isCreator: ").append(toIndentedString(isCreator)).append("\n"); sb.append(" canEdit: ").append(toIndentedString(canEdit)).append("\n"); sb.append(" isLocked: ").append(toIndentedString(isLocked)).append("\n"); @@ -643,12 +645,10 @@ public String toString() { sb.append(" signerRoles: ").append(toIndentedString(signerRoles)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" documents: ").append(toIndentedString(documents)).append("\n"); - sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); - sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); - sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); - sb.append(" isEmbedded: ").append(toIndentedString(isEmbedded)).append("\n"); sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); sb.append(" namedFormFields: ").append(toIndentedString(namedFormFields)).append("\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append("}"); return sb.toString(); } @@ -714,6 +714,44 @@ public Map createFormData() throws ApiException { map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); } } + if (updatedAt != null) { + if (isFileTypeOrListOfFiles(updatedAt)) { + fileTypeFound = true; + } + + if (updatedAt.getClass().equals(java.io.File.class) || + updatedAt.getClass().equals(Integer.class) || + updatedAt.getClass().equals(String.class) || + updatedAt.getClass().isEnum()) { + map.put("updated_at", updatedAt); + } else if (isListOfFile(updatedAt)) { + for(int i = 0; i< getListSize(updatedAt); i++) { + map.put("updated_at[" + i + "]", getFromList(updatedAt, i)); + } + } + else { + map.put("updated_at", JSON.getDefault().getMapper().writeValueAsString(updatedAt)); + } + } + if (isEmbedded != null) { + if (isFileTypeOrListOfFiles(isEmbedded)) { + fileTypeFound = true; + } + + if (isEmbedded.getClass().equals(java.io.File.class) || + isEmbedded.getClass().equals(Integer.class) || + isEmbedded.getClass().equals(String.class) || + isEmbedded.getClass().isEnum()) { + map.put("is_embedded", isEmbedded); + } else if (isListOfFile(isEmbedded)) { + for(int i = 0; i< getListSize(isEmbedded); i++) { + map.put("is_embedded[" + i + "]", getFromList(isEmbedded, i)); + } + } + else { + map.put("is_embedded", JSON.getDefault().getMapper().writeValueAsString(isEmbedded)); + } + } if (isCreator != null) { if (isFileTypeOrListOfFiles(isCreator)) { fileTypeFound = true; @@ -847,82 +885,6 @@ public Map createFormData() throws ApiException { map.put("documents", JSON.getDefault().getMapper().writeValueAsString(documents)); } } - if (accounts != null) { - if (isFileTypeOrListOfFiles(accounts)) { - fileTypeFound = true; - } - - if (accounts.getClass().equals(java.io.File.class) || - accounts.getClass().equals(Integer.class) || - accounts.getClass().equals(String.class) || - accounts.getClass().isEnum()) { - map.put("accounts", accounts); - } else if (isListOfFile(accounts)) { - for(int i = 0; i< getListSize(accounts); i++) { - map.put("accounts[" + i + "]", getFromList(accounts, i)); - } - } - else { - map.put("accounts", JSON.getDefault().getMapper().writeValueAsString(accounts)); - } - } - if (attachments != null) { - if (isFileTypeOrListOfFiles(attachments)) { - fileTypeFound = true; - } - - if (attachments.getClass().equals(java.io.File.class) || - attachments.getClass().equals(Integer.class) || - attachments.getClass().equals(String.class) || - attachments.getClass().isEnum()) { - map.put("attachments", attachments); - } else if (isListOfFile(attachments)) { - for(int i = 0; i< getListSize(attachments); i++) { - map.put("attachments[" + i + "]", getFromList(attachments, i)); - } - } - else { - map.put("attachments", JSON.getDefault().getMapper().writeValueAsString(attachments)); - } - } - if (updatedAt != null) { - if (isFileTypeOrListOfFiles(updatedAt)) { - fileTypeFound = true; - } - - if (updatedAt.getClass().equals(java.io.File.class) || - updatedAt.getClass().equals(Integer.class) || - updatedAt.getClass().equals(String.class) || - updatedAt.getClass().isEnum()) { - map.put("updated_at", updatedAt); - } else if (isListOfFile(updatedAt)) { - for(int i = 0; i< getListSize(updatedAt); i++) { - map.put("updated_at[" + i + "]", getFromList(updatedAt, i)); - } - } - else { - map.put("updated_at", JSON.getDefault().getMapper().writeValueAsString(updatedAt)); - } - } - if (isEmbedded != null) { - if (isFileTypeOrListOfFiles(isEmbedded)) { - fileTypeFound = true; - } - - if (isEmbedded.getClass().equals(java.io.File.class) || - isEmbedded.getClass().equals(Integer.class) || - isEmbedded.getClass().equals(String.class) || - isEmbedded.getClass().isEnum()) { - map.put("is_embedded", isEmbedded); - } else if (isListOfFile(isEmbedded)) { - for(int i = 0; i< getListSize(isEmbedded); i++) { - map.put("is_embedded[" + i + "]", getFromList(isEmbedded, i)); - } - } - else { - map.put("is_embedded", JSON.getDefault().getMapper().writeValueAsString(isEmbedded)); - } - } if (customFields != null) { if (isFileTypeOrListOfFiles(customFields)) { fileTypeFound = true; @@ -961,6 +923,44 @@ public Map createFormData() throws ApiException { map.put("named_form_fields", JSON.getDefault().getMapper().writeValueAsString(namedFormFields)); } } + if (accounts != null) { + if (isFileTypeOrListOfFiles(accounts)) { + fileTypeFound = true; + } + + if (accounts.getClass().equals(java.io.File.class) || + accounts.getClass().equals(Integer.class) || + accounts.getClass().equals(String.class) || + accounts.getClass().isEnum()) { + map.put("accounts", accounts); + } else if (isListOfFile(accounts)) { + for(int i = 0; i< getListSize(accounts); i++) { + map.put("accounts[" + i + "]", getFromList(accounts, i)); + } + } + else { + map.put("accounts", JSON.getDefault().getMapper().writeValueAsString(accounts)); + } + } + if (attachments != null) { + if (isFileTypeOrListOfFiles(attachments)) { + fileTypeFound = true; + } + + if (attachments.getClass().equals(java.io.File.class) || + attachments.getClass().equals(Integer.class) || + attachments.getClass().equals(String.class) || + attachments.getClass().isEnum()) { + map.put("attachments", attachments); + } else if (isListOfFile(attachments)) { + for(int i = 0; i< getListSize(attachments); i++) { + map.put("attachments[" + i + "]", getFromList(attachments, i)); + } + } + else { + map.put("attachments", JSON.getDefault().getMapper().writeValueAsString(attachments)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java index ae6b9cdc6..53f50dd8a 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java @@ -35,11 +35,11 @@ */ @JsonPropertyOrder({ TemplateResponseAccount.JSON_PROPERTY_ACCOUNT_ID, + TemplateResponseAccount.JSON_PROPERTY_EMAIL_ADDRESS, TemplateResponseAccount.JSON_PROPERTY_IS_LOCKED, TemplateResponseAccount.JSON_PROPERTY_IS_PAID_HS, TemplateResponseAccount.JSON_PROPERTY_IS_PAID_HF, - TemplateResponseAccount.JSON_PROPERTY_QUOTAS, - TemplateResponseAccount.JSON_PROPERTY_EMAIL_ADDRESS + TemplateResponseAccount.JSON_PROPERTY_QUOTAS }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -47,6 +47,9 @@ public class TemplateResponseAccount { 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; @@ -59,9 +62,6 @@ public class TemplateResponseAccount { public static final String JSON_PROPERTY_QUOTAS = "quotas"; private TemplateResponseAccountQuota quotas; - public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; - private String emailAddress; - public TemplateResponseAccount() { } @@ -89,9 +89,9 @@ public TemplateResponseAccount 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; @@ -99,12 +99,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 TemplateResponseAccount 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 TemplateResponseAccount isLocked(Boolean isLocked) { this.isLocked = isLocked; return this; @@ -114,9 +139,9 @@ public TemplateResponseAccount 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; @@ -124,7 +149,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; } @@ -139,9 +164,9 @@ public TemplateResponseAccount 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; @@ -149,7 +174,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; } @@ -164,9 +189,9 @@ public TemplateResponseAccount 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; @@ -174,7 +199,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; } @@ -189,9 +214,9 @@ public TemplateResponseAccount quotas(TemplateResponseAccountQuota 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 TemplateResponseAccountQuota getQuotas() { return quotas; @@ -199,37 +224,12 @@ public TemplateResponseAccountQuota getQuotas() { @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setQuotas(TemplateResponseAccountQuota quotas) { this.quotas = quotas; } - public TemplateResponseAccount 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; - } - - /** * Return true if this TemplateResponseAccount object is equal to o. */ @@ -243,16 +243,16 @@ public boolean equals(Object o) { } TemplateResponseAccount templateResponseAccount = (TemplateResponseAccount) o; return Objects.equals(this.accountId, templateResponseAccount.accountId) && + Objects.equals(this.emailAddress, templateResponseAccount.emailAddress) && Objects.equals(this.isLocked, templateResponseAccount.isLocked) && Objects.equals(this.isPaidHs, templateResponseAccount.isPaidHs) && Objects.equals(this.isPaidHf, templateResponseAccount.isPaidHf) && - Objects.equals(this.quotas, templateResponseAccount.quotas) && - Objects.equals(this.emailAddress, templateResponseAccount.emailAddress); + Objects.equals(this.quotas, templateResponseAccount.quotas); } @Override public int hashCode() { - return Objects.hash(accountId, isLocked, isPaidHs, isPaidHf, quotas, emailAddress); + return Objects.hash(accountId, emailAddress, isLocked, isPaidHs, isPaidHf, quotas); } @Override @@ -260,11 +260,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseAccount {\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("}"); return sb.toString(); } @@ -292,6 +292,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; @@ -368,25 +387,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)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java index 0b1e7e66f..78b1f583d 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java @@ -80,9 +80,9 @@ public TemplateResponseAccountQuota templatesLeft(Integer templatesLeft) { * API templates remaining. * @return templatesLeft */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getTemplatesLeft() { return templatesLeft; @@ -90,7 +90,7 @@ public Integer getTemplatesLeft() { @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTemplatesLeft(Integer templatesLeft) { this.templatesLeft = templatesLeft; } @@ -105,9 +105,9 @@ public TemplateResponseAccountQuota apiSignatureRequestsLeft(Integer apiSignatur * API signature requests remaining. * @return apiSignatureRequestsLeft */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getApiSignatureRequestsLeft() { return apiSignatureRequestsLeft; @@ -115,7 +115,7 @@ public Integer getApiSignatureRequestsLeft() { @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApiSignatureRequestsLeft(Integer apiSignatureRequestsLeft) { this.apiSignatureRequestsLeft = apiSignatureRequestsLeft; } @@ -130,9 +130,9 @@ public TemplateResponseAccountQuota documentsLeft(Integer documentsLeft) { * Signature requests remaining. * @return documentsLeft */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getDocumentsLeft() { return documentsLeft; @@ -140,7 +140,7 @@ public Integer getDocumentsLeft() { @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocumentsLeft(Integer documentsLeft) { this.documentsLeft = documentsLeft; } @@ -155,9 +155,9 @@ public TemplateResponseAccountQuota smsVerificationsLeft(Integer smsVerification * SMS verifications remaining. * @return smsVerificationsLeft */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getSmsVerificationsLeft() { return smsVerificationsLeft; @@ -165,7 +165,7 @@ public Integer getSmsVerificationsLeft() { @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSmsVerificationsLeft(Integer smsVerificationsLeft) { this.smsVerificationsLeft = smsVerificationsLeft; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java index 5a9461f44..4ed3eb946 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java @@ -68,9 +68,9 @@ public TemplateResponseCCRole name(String name) { * The name of the Role. * @return name */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; @@ -78,7 +78,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java index 2dbcbfee0..040c68ccc 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java @@ -40,11 +40,11 @@ */ @JsonPropertyOrder({ TemplateResponseDocument.JSON_PROPERTY_NAME, + TemplateResponseDocument.JSON_PROPERTY_INDEX, TemplateResponseDocument.JSON_PROPERTY_FIELD_GROUPS, TemplateResponseDocument.JSON_PROPERTY_FORM_FIELDS, TemplateResponseDocument.JSON_PROPERTY_CUSTOM_FIELDS, - TemplateResponseDocument.JSON_PROPERTY_STATIC_FIELDS, - TemplateResponseDocument.JSON_PROPERTY_INDEX + TemplateResponseDocument.JSON_PROPERTY_STATIC_FIELDS }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -52,20 +52,20 @@ public class TemplateResponseDocument { public static final String JSON_PROPERTY_NAME = "name"; private String name; + public static final String JSON_PROPERTY_INDEX = "index"; + private Integer index; + public static final String JSON_PROPERTY_FIELD_GROUPS = "field_groups"; - private List fieldGroups = new ArrayList<>(); + private List fieldGroups = null; public static final String JSON_PROPERTY_FORM_FIELDS = "form_fields"; - private List formFields = new ArrayList<>(); + private List formFields = null; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; - private List customFields = new ArrayList<>(); + private List customFields = null; public static final String JSON_PROPERTY_STATIC_FIELDS = "static_fields"; - private List staticFields = new ArrayList<>(); - - public static final String JSON_PROPERTY_INDEX = "index"; - private Integer index; + private List staticFields = null; public TemplateResponseDocument() { } @@ -94,9 +94,9 @@ public TemplateResponseDocument name(String name) { * Name of the associated file. * @return name */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; @@ -104,12 +104,37 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } + public TemplateResponseDocument index(Integer index) { + this.index = index; + return this; + } + + /** + * Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + * @return index + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_INDEX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getIndex() { + return index; + } + + + @JsonProperty(JSON_PROPERTY_INDEX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIndex(Integer index) { + this.index = index; + } + + public TemplateResponseDocument fieldGroups(List fieldGroups) { this.fieldGroups = fieldGroups; return this; @@ -127,9 +152,9 @@ public TemplateResponseDocument addFieldGroupsItem(TemplateResponseDocumentField * An array of Form Field Group objects. * @return fieldGroups */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getFieldGroups() { return fieldGroups; @@ -137,7 +162,7 @@ public List getFieldGroups() { @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFieldGroups(List fieldGroups) { this.fieldGroups = fieldGroups; } @@ -160,9 +185,9 @@ public TemplateResponseDocument addFormFieldsItem(TemplateResponseDocumentFormFi * An array of Form Field objects containing the name and type of each named field. * @return formFields */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_FORM_FIELDS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getFormFields() { return formFields; @@ -170,7 +195,7 @@ public List getFormFields() { @JsonProperty(JSON_PROPERTY_FORM_FIELDS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFormFields(List formFields) { this.formFields = formFields; } @@ -193,9 +218,9 @@ public TemplateResponseDocument addCustomFieldsItem(TemplateResponseDocumentCust * An array of Form Field objects containing the name and type of each named field. * @return customFields */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getCustomFields() { return customFields; @@ -203,7 +228,7 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCustomFields(List customFields) { this.customFields = customFields; } @@ -226,9 +251,9 @@ public TemplateResponseDocument addStaticFieldsItem(TemplateResponseDocumentStat * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. * @return staticFields */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public List getStaticFields() { return staticFields; @@ -236,37 +261,12 @@ public List getStaticFields() { @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStaticFields(List staticFields) { this.staticFields = staticFields; } - public TemplateResponseDocument index(Integer index) { - this.index = index; - return this; - } - - /** - * Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - * @return index - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_INDEX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getIndex() { - return index; - } - - - @JsonProperty(JSON_PROPERTY_INDEX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIndex(Integer index) { - this.index = index; - } - - /** * Return true if this TemplateResponseDocument object is equal to o. */ @@ -280,16 +280,16 @@ public boolean equals(Object o) { } TemplateResponseDocument templateResponseDocument = (TemplateResponseDocument) o; return Objects.equals(this.name, templateResponseDocument.name) && + Objects.equals(this.index, templateResponseDocument.index) && Objects.equals(this.fieldGroups, templateResponseDocument.fieldGroups) && Objects.equals(this.formFields, templateResponseDocument.formFields) && Objects.equals(this.customFields, templateResponseDocument.customFields) && - Objects.equals(this.staticFields, templateResponseDocument.staticFields) && - Objects.equals(this.index, templateResponseDocument.index); + Objects.equals(this.staticFields, templateResponseDocument.staticFields); } @Override public int hashCode() { - return Objects.hash(name, fieldGroups, formFields, customFields, staticFields, index); + return Objects.hash(name, index, fieldGroups, formFields, customFields, staticFields); } @Override @@ -297,11 +297,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocument {\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" index: ").append(toIndentedString(index)).append("\n"); sb.append(" fieldGroups: ").append(toIndentedString(fieldGroups)).append("\n"); sb.append(" formFields: ").append(toIndentedString(formFields)).append("\n"); sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); sb.append(" staticFields: ").append(toIndentedString(staticFields)).append("\n"); - sb.append(" index: ").append(toIndentedString(index)).append("\n"); sb.append("}"); return sb.toString(); } @@ -329,6 +329,25 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } + if (index != null) { + if (isFileTypeOrListOfFiles(index)) { + fileTypeFound = true; + } + + if (index.getClass().equals(java.io.File.class) || + index.getClass().equals(Integer.class) || + index.getClass().equals(String.class) || + index.getClass().isEnum()) { + map.put("index", index); + } else if (isListOfFile(index)) { + for(int i = 0; i< getListSize(index); i++) { + map.put("index[" + i + "]", getFromList(index, i)); + } + } + else { + map.put("index", JSON.getDefault().getMapper().writeValueAsString(index)); + } + } if (fieldGroups != null) { if (isFileTypeOrListOfFiles(fieldGroups)) { fileTypeFound = true; @@ -405,25 +424,6 @@ public Map createFormData() throws ApiException { map.put("static_fields", JSON.getDefault().getMapper().writeValueAsString(staticFields)); } } - if (index != null) { - if (isFileTypeOrListOfFiles(index)) { - fileTypeFound = true; - } - - if (index.getClass().equals(java.io.File.class) || - index.getClass().equals(Integer.class) || - index.getClass().equals(String.class) || - index.getClass().isEnum()) { - map.put("index", index); - } else if (isListOfFile(index)) { - for(int i = 0; i< getListSize(index); i++) { - map.put("index[" + i + "]", getFromList(index, i)); - } - } - else { - map.put("index", JSON.getDefault().getMapper().writeValueAsString(index)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java index e5cf7fa77..4797afd91 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java @@ -36,15 +36,15 @@ * An array of Form Field objects containing the name and type of each named field. */ @JsonPropertyOrder({ + TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_NAME, - TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_TYPE, + TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_Y, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_WIDTH, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_HEIGHT, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_REQUIRED, - TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -59,14 +59,17 @@ }) public class TemplateResponseDocumentCustomFieldBase { + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; + public static final String JSON_PROPERTY_SIGNER = "signer"; + private String signer; public static final String JSON_PROPERTY_X = "x"; private Integer x; @@ -83,9 +86,6 @@ public class TemplateResponseDocumentCustomFieldBase { public static final String JSON_PROPERTY_REQUIRED = "required"; private Boolean required; - public static final String JSON_PROPERTY_SIGNER = "signer"; - private String signer; - public static final String JSON_PROPERTY_GROUP = "group"; private String group; @@ -107,6 +107,31 @@ static public TemplateResponseDocumentCustomFieldBase init(HashMap data) throws ); } + public TemplateResponseDocumentCustomFieldBase type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getType() { + return type; + } + + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; + } + + public TemplateResponseDocumentCustomFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -116,9 +141,9 @@ public TemplateResponseDocumentCustomFieldBase apiId(String apiId) { * The unique ID for this field. * @return apiId */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getApiId() { return apiId; @@ -126,7 +151,7 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -141,9 +166,9 @@ public TemplateResponseDocumentCustomFieldBase name(String name) { * The name of the Custom Field. * @return name */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; @@ -151,34 +176,42 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } - public TemplateResponseDocumentCustomFieldBase type(String type) { - this.type = type; + public TemplateResponseDocumentCustomFieldBase signer(String signer) { + this.signer = signer; + return this; + } + public TemplateResponseDocumentCustomFieldBase signer(Integer signer) { + this.signer = String.valueOf(signer); return this; } /** - * Get type - * @return type + * The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + * @return signer */ - @jakarta.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getType() { - return type; + public String getSigner() { + return signer; } - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; + @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigner(String signer) { + this.signer = signer; + } + + public void setSigner(Integer signer) { + this.signer = String.valueOf(signer); } @@ -191,9 +224,9 @@ public TemplateResponseDocumentCustomFieldBase x(Integer x) { * The horizontal offset in pixels for this form field. * @return x */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getX() { return x; @@ -201,7 +234,7 @@ public Integer getX() { @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setX(Integer x) { this.x = x; } @@ -216,9 +249,9 @@ public TemplateResponseDocumentCustomFieldBase y(Integer y) { * The vertical offset in pixels for this form field. * @return y */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getY() { return y; @@ -226,7 +259,7 @@ public Integer getY() { @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setY(Integer y) { this.y = y; } @@ -241,9 +274,9 @@ public TemplateResponseDocumentCustomFieldBase width(Integer width) { * The width in pixels of this form field. * @return width */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getWidth() { return width; @@ -251,7 +284,7 @@ public Integer getWidth() { @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWidth(Integer width) { this.width = width; } @@ -266,9 +299,9 @@ public TemplateResponseDocumentCustomFieldBase height(Integer height) { * The height in pixels of this form field. * @return height */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getHeight() { return height; @@ -276,7 +309,7 @@ public Integer getHeight() { @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHeight(Integer height) { this.height = height; } @@ -291,9 +324,9 @@ public TemplateResponseDocumentCustomFieldBase required(Boolean required) { * Boolean showing whether or not this field is required. * @return required */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getRequired() { return required; @@ -301,45 +334,12 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequired(Boolean required) { this.required = required; } - public TemplateResponseDocumentCustomFieldBase signer(String signer) { - this.signer = signer; - return this; - } - public TemplateResponseDocumentCustomFieldBase signer(Integer signer) { - this.signer = String.valueOf(signer); - return this; - } - - /** - * The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). - * @return signer - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSigner() { - return signer; - } - - - @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigner(String signer) { - this.signer = signer; - } - - public void setSigner(Integer signer) { - this.signer = String.valueOf(signer); - } - - public TemplateResponseDocumentCustomFieldBase group(String group) { this.group = group; return this; @@ -377,36 +377,36 @@ public boolean equals(Object o) { return false; } TemplateResponseDocumentCustomFieldBase templateResponseDocumentCustomFieldBase = (TemplateResponseDocumentCustomFieldBase) o; - return Objects.equals(this.apiId, templateResponseDocumentCustomFieldBase.apiId) && + return Objects.equals(this.type, templateResponseDocumentCustomFieldBase.type) && + Objects.equals(this.apiId, templateResponseDocumentCustomFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentCustomFieldBase.name) && - Objects.equals(this.type, templateResponseDocumentCustomFieldBase.type) && + Objects.equals(this.signer, templateResponseDocumentCustomFieldBase.signer) && Objects.equals(this.x, templateResponseDocumentCustomFieldBase.x) && Objects.equals(this.y, templateResponseDocumentCustomFieldBase.y) && Objects.equals(this.width, templateResponseDocumentCustomFieldBase.width) && Objects.equals(this.height, templateResponseDocumentCustomFieldBase.height) && Objects.equals(this.required, templateResponseDocumentCustomFieldBase.required) && - Objects.equals(this.signer, templateResponseDocumentCustomFieldBase.signer) && Objects.equals(this.group, templateResponseDocumentCustomFieldBase.group); } @Override public int hashCode() { - return Objects.hash(apiId, name, type, x, y, width, height, required, signer, group); + return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentCustomFieldBase {\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); sb.append(" width: ").append(toIndentedString(width)).append("\n"); sb.append(" height: ").append(toIndentedString(height)).append("\n"); sb.append(" required: ").append(toIndentedString(required)).append("\n"); - sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); @@ -416,6 +416,25 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { + fileTypeFound = true; + } + + if (type.getClass().equals(java.io.File.class) || + type.getClass().equals(Integer.class) || + type.getClass().equals(String.class) || + type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for(int i = 0; i< getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); + } + } + else { + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + } + } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -454,23 +473,23 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { + if (signer != null) { + if (isFileTypeOrListOfFiles(signer)) { fileTypeFound = true; } - if (type.getClass().equals(java.io.File.class) || - type.getClass().equals(Integer.class) || - type.getClass().equals(String.class) || - type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for(int i = 0; i< getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); + if (signer.getClass().equals(java.io.File.class) || + signer.getClass().equals(Integer.class) || + signer.getClass().equals(String.class) || + signer.getClass().isEnum()) { + map.put("signer", signer); + } else if (isListOfFile(signer)) { + for(int i = 0; i< getListSize(signer); i++) { + map.put("signer[" + i + "]", getFromList(signer, i)); } } else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + map.put("signer", JSON.getDefault().getMapper().writeValueAsString(signer)); } } if (x != null) { @@ -568,25 +587,6 @@ public Map createFormData() throws ApiException { map.put("required", JSON.getDefault().getMapper().writeValueAsString(required)); } } - if (signer != null) { - if (isFileTypeOrListOfFiles(signer)) { - fileTypeFound = true; - } - - if (signer.getClass().equals(java.io.File.class) || - signer.getClass().equals(Integer.class) || - signer.getClass().equals(String.class) || - signer.getClass().isEnum()) { - map.put("signer", signer); - } else if (isListOfFile(signer)) { - for(int i = 0; i< getListSize(signer); i++) { - map.put("signer[" + i + "]", getFromList(signer, i)); - } - } - else { - map.put("signer", JSON.getDefault().getMapper().writeValueAsString(signer)); - } - } if (group != null) { if (isFileTypeOrListOfFiles(group)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java index 5aba1a567..e9c2932d6 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java @@ -119,9 +119,9 @@ public TemplateResponseDocumentCustomFieldText avgTextLength(TemplateResponseFie * Get avgTextLength * @return avgTextLength */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; @@ -129,7 +129,7 @@ public TemplateResponseFieldAvgTextLength getAvgTextLength() { @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -144,9 +144,9 @@ public TemplateResponseDocumentCustomFieldText isMultiline(Boolean isMultiline) * Whether this form field is multiline text. * @return isMultiline */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsMultiline() { return isMultiline; @@ -154,7 +154,7 @@ public Boolean getIsMultiline() { @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -169,9 +169,9 @@ public TemplateResponseDocumentCustomFieldText originalFontSize(Integer original * Original font size used in this form field's text. * @return originalFontSize */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getOriginalFontSize() { return originalFontSize; @@ -179,7 +179,7 @@ public Integer getOriginalFontSize() { @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -194,9 +194,9 @@ public TemplateResponseDocumentCustomFieldText fontFamily(String fontFamily) { * Font family used in this form field's text. * @return fontFamily */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getFontFamily() { return fontFamily; @@ -204,7 +204,7 @@ public String getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java index d02f5f5ec..3e724af45 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java @@ -73,9 +73,9 @@ public TemplateResponseDocumentFieldGroup name(String name) { * The name of the form field group. * @return name */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; @@ -83,7 +83,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } @@ -98,9 +98,9 @@ public TemplateResponseDocumentFieldGroup rule(TemplateResponseDocumentFieldGrou * Get rule * @return rule */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_RULE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public TemplateResponseDocumentFieldGroupRule getRule() { return rule; @@ -108,7 +108,7 @@ public TemplateResponseDocumentFieldGroupRule getRule() { @JsonProperty(JSON_PROPERTY_RULE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRule(TemplateResponseDocumentFieldGroupRule rule) { this.rule = rule; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java index d92998793..65aa63b0f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java @@ -72,9 +72,9 @@ public TemplateResponseDocumentFieldGroupRule requirement(String requirement) { * Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. * @return requirement */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIREMENT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getRequirement() { return requirement; @@ -82,7 +82,7 @@ public String getRequirement() { @JsonProperty(JSON_PROPERTY_REQUIREMENT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequirement(String requirement) { this.requirement = requirement; } @@ -97,9 +97,9 @@ public TemplateResponseDocumentFieldGroupRule groupLabel(String groupLabel) { * Name of the group * @return groupLabel */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP_LABEL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getGroupLabel() { return groupLabel; @@ -107,7 +107,7 @@ public String getGroupLabel() { @JsonProperty(JSON_PROPERTY_GROUP_LABEL) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGroupLabel(String groupLabel) { this.groupLabel = groupLabel; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java index 5a62be6c8..25ee2dc73 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java @@ -36,9 +36,9 @@ * An array of Form Field objects containing the name and type of each named field. */ @JsonPropertyOrder({ + TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_NAME, - TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_Y, @@ -64,15 +64,15 @@ }) public class TemplateResponseDocumentFormFieldBase { + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_SIGNER = "signer"; private String signer; @@ -109,6 +109,31 @@ static public TemplateResponseDocumentFormFieldBase init(HashMap data) throws Ex ); } + public TemplateResponseDocumentFormFieldBase type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getType() { + return type; + } + + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; + } + + public TemplateResponseDocumentFormFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -118,9 +143,9 @@ public TemplateResponseDocumentFormFieldBase apiId(String apiId) { * A unique id for the form field. * @return apiId */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getApiId() { return apiId; @@ -128,7 +153,7 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -143,9 +168,9 @@ public TemplateResponseDocumentFormFieldBase name(String name) { * The name of the form field. * @return name */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; @@ -153,37 +178,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } - public TemplateResponseDocumentFormFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * @return type - */ - @jakarta.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getType() { - return type; - } - - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - - public TemplateResponseDocumentFormFieldBase signer(String signer) { this.signer = signer; return this; @@ -197,9 +197,9 @@ public TemplateResponseDocumentFormFieldBase signer(Integer signer) { * The signer of the Form Field. * @return signer */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getSigner() { return signer; @@ -207,7 +207,7 @@ public String getSigner() { @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSigner(String signer) { this.signer = signer; } @@ -226,9 +226,9 @@ public TemplateResponseDocumentFormFieldBase x(Integer x) { * The horizontal offset in pixels for this form field. * @return x */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getX() { return x; @@ -236,7 +236,7 @@ public Integer getX() { @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setX(Integer x) { this.x = x; } @@ -251,9 +251,9 @@ public TemplateResponseDocumentFormFieldBase y(Integer y) { * The vertical offset in pixels for this form field. * @return y */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getY() { return y; @@ -261,7 +261,7 @@ public Integer getY() { @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setY(Integer y) { this.y = y; } @@ -276,9 +276,9 @@ public TemplateResponseDocumentFormFieldBase width(Integer width) { * The width in pixels of this form field. * @return width */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getWidth() { return width; @@ -286,7 +286,7 @@ public Integer getWidth() { @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWidth(Integer width) { this.width = width; } @@ -301,9 +301,9 @@ public TemplateResponseDocumentFormFieldBase height(Integer height) { * The height in pixels of this form field. * @return height */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getHeight() { return height; @@ -311,7 +311,7 @@ public Integer getHeight() { @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHeight(Integer height) { this.height = height; } @@ -326,9 +326,9 @@ public TemplateResponseDocumentFormFieldBase required(Boolean required) { * Boolean showing whether or not this field is required. * @return required */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getRequired() { return required; @@ -336,7 +336,7 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequired(Boolean required) { this.required = required; } @@ -354,9 +354,9 @@ public boolean equals(Object o) { return false; } TemplateResponseDocumentFormFieldBase templateResponseDocumentFormFieldBase = (TemplateResponseDocumentFormFieldBase) o; - return Objects.equals(this.apiId, templateResponseDocumentFormFieldBase.apiId) && + return Objects.equals(this.type, templateResponseDocumentFormFieldBase.type) && + Objects.equals(this.apiId, templateResponseDocumentFormFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentFormFieldBase.name) && - Objects.equals(this.type, templateResponseDocumentFormFieldBase.type) && Objects.equals(this.signer, templateResponseDocumentFormFieldBase.signer) && Objects.equals(this.x, templateResponseDocumentFormFieldBase.x) && Objects.equals(this.y, templateResponseDocumentFormFieldBase.y) && @@ -367,16 +367,16 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(apiId, name, type, signer, x, y, width, height, required); + return Objects.hash(type, apiId, name, signer, x, y, width, height, required); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentFormFieldBase {\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); @@ -391,6 +391,25 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { + fileTypeFound = true; + } + + if (type.getClass().equals(java.io.File.class) || + type.getClass().equals(Integer.class) || + type.getClass().equals(String.class) || + type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for(int i = 0; i< getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); + } + } + else { + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + } + } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -429,25 +448,6 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) || - type.getClass().equals(Integer.class) || - type.getClass().equals(String.class) || - type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for(int i = 0; i< getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } - else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (signer != null) { if (isFileTypeOrListOfFiles(signer)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java index 3db1348fb..6ce907e55 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java @@ -123,9 +123,9 @@ public TemplateResponseDocumentFormFieldHyperlink avgTextLength(TemplateResponse * Get avgTextLength * @return avgTextLength */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; @@ -133,7 +133,7 @@ public TemplateResponseFieldAvgTextLength getAvgTextLength() { @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -148,9 +148,9 @@ public TemplateResponseDocumentFormFieldHyperlink isMultiline(Boolean isMultilin * Whether this form field is multiline text. * @return isMultiline */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsMultiline() { return isMultiline; @@ -158,7 +158,7 @@ public Boolean getIsMultiline() { @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -173,9 +173,9 @@ public TemplateResponseDocumentFormFieldHyperlink originalFontSize(Integer origi * Original font size used in this form field's text. * @return originalFontSize */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getOriginalFontSize() { return originalFontSize; @@ -183,7 +183,7 @@ public Integer getOriginalFontSize() { @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -198,9 +198,9 @@ public TemplateResponseDocumentFormFieldHyperlink fontFamily(String fontFamily) * Font family used in this form field's text. * @return fontFamily */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getFontFamily() { return fontFamily; @@ -208,7 +208,7 @@ public String getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java index 2474e5298..db5fce4c8 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java @@ -178,9 +178,9 @@ public TemplateResponseDocumentFormFieldText avgTextLength(TemplateResponseField * Get avgTextLength * @return avgTextLength */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; @@ -188,7 +188,7 @@ public TemplateResponseFieldAvgTextLength getAvgTextLength() { @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -203,9 +203,9 @@ public TemplateResponseDocumentFormFieldText isMultiline(Boolean isMultiline) { * Whether this form field is multiline text. * @return isMultiline */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getIsMultiline() { return isMultiline; @@ -213,7 +213,7 @@ public Boolean getIsMultiline() { @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -228,9 +228,9 @@ public TemplateResponseDocumentFormFieldText originalFontSize(Integer originalFo * Original font size used in this form field's text. * @return originalFontSize */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getOriginalFontSize() { return originalFontSize; @@ -238,7 +238,7 @@ public Integer getOriginalFontSize() { @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -253,9 +253,9 @@ public TemplateResponseDocumentFormFieldText fontFamily(String fontFamily) { * Font family used in this form field's text. * @return fontFamily */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getFontFamily() { return fontFamily; @@ -263,7 +263,7 @@ public String getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java index 96a4e8d85..4e1e98229 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java @@ -36,9 +36,9 @@ * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. */ @JsonPropertyOrder({ + TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_NAME, - TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_Y, @@ -65,15 +65,15 @@ }) public class TemplateResponseDocumentStaticFieldBase { + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_SIGNER = "signer"; private String signer = "me_now"; @@ -113,6 +113,31 @@ static public TemplateResponseDocumentStaticFieldBase init(HashMap data) throws ); } + public TemplateResponseDocumentStaticFieldBase type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getType() { + return type; + } + + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; + } + + public TemplateResponseDocumentStaticFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -122,9 +147,9 @@ public TemplateResponseDocumentStaticFieldBase apiId(String apiId) { * A unique id for the static field. * @return apiId */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getApiId() { return apiId; @@ -132,7 +157,7 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -147,9 +172,9 @@ public TemplateResponseDocumentStaticFieldBase name(String name) { * The name of the static field. * @return name */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; @@ -157,37 +182,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } - public TemplateResponseDocumentStaticFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * @return type - */ - @jakarta.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getType() { - return type; - } - - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - - public TemplateResponseDocumentStaticFieldBase signer(String signer) { this.signer = signer; return this; @@ -197,9 +197,9 @@ public TemplateResponseDocumentStaticFieldBase signer(String signer) { * The signer of the Static Field. * @return signer */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getSigner() { return signer; @@ -207,7 +207,7 @@ public String getSigner() { @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSigner(String signer) { this.signer = signer; } @@ -222,9 +222,9 @@ public TemplateResponseDocumentStaticFieldBase x(Integer x) { * The horizontal offset in pixels for this static field. * @return x */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getX() { return x; @@ -232,7 +232,7 @@ public Integer getX() { @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setX(Integer x) { this.x = x; } @@ -247,9 +247,9 @@ public TemplateResponseDocumentStaticFieldBase y(Integer y) { * The vertical offset in pixels for this static field. * @return y */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getY() { return y; @@ -257,7 +257,7 @@ public Integer getY() { @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setY(Integer y) { this.y = y; } @@ -272,9 +272,9 @@ public TemplateResponseDocumentStaticFieldBase width(Integer width) { * The width in pixels of this static field. * @return width */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getWidth() { return width; @@ -282,7 +282,7 @@ public Integer getWidth() { @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWidth(Integer width) { this.width = width; } @@ -297,9 +297,9 @@ public TemplateResponseDocumentStaticFieldBase height(Integer height) { * The height in pixels of this static field. * @return height */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getHeight() { return height; @@ -307,7 +307,7 @@ public Integer getHeight() { @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHeight(Integer height) { this.height = height; } @@ -322,9 +322,9 @@ public TemplateResponseDocumentStaticFieldBase required(Boolean required) { * Boolean showing whether or not this field is required. * @return required */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Boolean getRequired() { return required; @@ -332,7 +332,7 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequired(Boolean required) { this.required = required; } @@ -375,9 +375,9 @@ public boolean equals(Object o) { return false; } TemplateResponseDocumentStaticFieldBase templateResponseDocumentStaticFieldBase = (TemplateResponseDocumentStaticFieldBase) o; - return Objects.equals(this.apiId, templateResponseDocumentStaticFieldBase.apiId) && + return Objects.equals(this.type, templateResponseDocumentStaticFieldBase.type) && + Objects.equals(this.apiId, templateResponseDocumentStaticFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentStaticFieldBase.name) && - Objects.equals(this.type, templateResponseDocumentStaticFieldBase.type) && Objects.equals(this.signer, templateResponseDocumentStaticFieldBase.signer) && Objects.equals(this.x, templateResponseDocumentStaticFieldBase.x) && Objects.equals(this.y, templateResponseDocumentStaticFieldBase.y) && @@ -389,16 +389,16 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(apiId, name, type, signer, x, y, width, height, required, group); + return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentStaticFieldBase {\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); @@ -414,6 +414,25 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { + fileTypeFound = true; + } + + if (type.getClass().equals(java.io.File.class) || + type.getClass().equals(Integer.class) || + type.getClass().equals(String.class) || + type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for(int i = 0; i< getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); + } + } + else { + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + } + } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -452,25 +471,6 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) || - type.getClass().equals(Integer.class) || - type.getClass().equals(String.class) || - type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for(int i = 0; i< getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } - else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (signer != null) { if (isFileTypeOrListOfFiles(signer)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java index fc46699ac..38f5acd25 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java @@ -72,9 +72,9 @@ public TemplateResponseFieldAvgTextLength numLines(Integer numLines) { * Number of lines. * @return numLines */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_NUM_LINES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getNumLines() { return numLines; @@ -82,7 +82,7 @@ public Integer getNumLines() { @JsonProperty(JSON_PROPERTY_NUM_LINES) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumLines(Integer numLines) { this.numLines = numLines; } @@ -97,9 +97,9 @@ public TemplateResponseFieldAvgTextLength numCharsPerLine(Integer numCharsPerLin * Number of characters per line. * @return numCharsPerLine */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public Integer getNumCharsPerLine() { return numCharsPerLine; @@ -107,7 +107,7 @@ public Integer getNumCharsPerLine() { @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumCharsPerLine(Integer numCharsPerLine) { this.numCharsPerLine = numCharsPerLine; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java index d1463cbd8..45d786a89 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java @@ -72,9 +72,9 @@ public TemplateResponseSignerRole name(String name) { * The name of the Role. * @return name */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getName() { return name; @@ -82,7 +82,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { this.name = name; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java index fb4c17ded..19dea91bd 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java @@ -76,9 +76,9 @@ public TemplateUpdateFilesResponseTemplate templateId(String templateId) { * The id of the Template. * @return templateId */ - @jakarta.annotation.Nonnull + @jakarta.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public String getTemplateId() { return templateId; @@ -86,7 +86,7 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.ALWAYS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTemplateId(String templateId) { this.templateId = templateId; } diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 27094d35b..812088395 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -16784,6 +16784,11 @@ var _ApiAppResponse = class { var ApiAppResponse = _ApiAppResponse; ApiAppResponse.discriminator = void 0; ApiAppResponse.attributeTypeMap = [ + { + name: "callbackUrl", + baseName: "callback_url", + type: "string" + }, { name: "clientId", baseName: "client_id", @@ -16809,6 +16814,11 @@ ApiAppResponse.attributeTypeMap = [ baseName: "is_approved", type: "boolean" }, + { + name: "oauth", + baseName: "oauth", + type: "ApiAppResponseOAuth" + }, { name: "options", baseName: "options", @@ -16819,16 +16829,6 @@ ApiAppResponse.attributeTypeMap = [ baseName: "owner_account", type: "ApiAppResponseOwnerAccount" }, - { - name: "callbackUrl", - baseName: "callback_url", - type: "string" - }, - { - name: "oauth", - baseName: "oauth", - type: "ApiAppResponseOAuth" - }, { name: "whiteLabelingOptions", baseName: "white_labeling_options", @@ -16853,6 +16853,11 @@ ApiAppResponseOAuth.attributeTypeMap = [ baseName: "callback_url", type: "string" }, + { + name: "secret", + baseName: "secret", + type: "string" + }, { name: "scopes", baseName: "scopes", @@ -16862,11 +16867,6 @@ ApiAppResponseOAuth.attributeTypeMap = [ name: "chargesUsers", baseName: "charges_users", type: "boolean" - }, - { - name: "secret", - baseName: "secret", - type: "string" } ]; @@ -22503,6 +22503,16 @@ TemplateResponse.attributeTypeMap = [ baseName: "message", type: "string" }, + { + name: "updatedAt", + baseName: "updated_at", + type: "number" + }, + { + name: "isEmbedded", + baseName: "is_embedded", + type: "boolean" + }, { name: "isCreator", baseName: "is_creator", @@ -22538,26 +22548,6 @@ TemplateResponse.attributeTypeMap = [ baseName: "documents", type: "Array" }, - { - name: "accounts", - baseName: "accounts", - type: "Array" - }, - { - name: "attachments", - baseName: "attachments", - type: "Array" - }, - { - name: "updatedAt", - baseName: "updated_at", - type: "number" - }, - { - name: "isEmbedded", - baseName: "is_embedded", - type: "boolean" - }, { name: "customFields", baseName: "custom_fields", @@ -22567,6 +22557,16 @@ TemplateResponse.attributeTypeMap = [ name: "namedFormFields", baseName: "named_form_fields", type: "Array" + }, + { + name: "accounts", + baseName: "accounts", + type: "Array" + }, + { + name: "attachments", + baseName: "attachments", + type: "Array" } ]; @@ -22587,6 +22587,11 @@ TemplateResponseAccount.attributeTypeMap = [ baseName: "account_id", type: "string" }, + { + name: "emailAddress", + baseName: "email_address", + type: "string" + }, { name: "isLocked", baseName: "is_locked", @@ -22606,11 +22611,6 @@ TemplateResponseAccount.attributeTypeMap = [ name: "quotas", baseName: "quotas", type: "TemplateResponseAccountQuota" - }, - { - name: "emailAddress", - baseName: "email_address", - type: "string" } ]; @@ -22684,6 +22684,11 @@ TemplateResponseDocument.attributeTypeMap = [ baseName: "name", type: "string" }, + { + name: "index", + baseName: "index", + type: "number" + }, { name: "fieldGroups", baseName: "field_groups", @@ -22703,11 +22708,6 @@ TemplateResponseDocument.attributeTypeMap = [ name: "staticFields", baseName: "static_fields", type: "Array" - }, - { - name: "index", - baseName: "index", - type: "number" } ]; @@ -22732,6 +22732,11 @@ var _TemplateResponseDocumentCustomFieldBase = class { var TemplateResponseDocumentCustomFieldBase = _TemplateResponseDocumentCustomFieldBase; TemplateResponseDocumentCustomFieldBase.discriminator = "type"; TemplateResponseDocumentCustomFieldBase.attributeTypeMap = [ + { + name: "type", + baseName: "type", + type: "string" + }, { name: "apiId", baseName: "api_id", @@ -22743,8 +22748,8 @@ TemplateResponseDocumentCustomFieldBase.attributeTypeMap = [ type: "string" }, { - name: "type", - baseName: "type", + name: "signer", + baseName: "signer", type: "string" }, { @@ -22772,11 +22777,6 @@ TemplateResponseDocumentCustomFieldBase.attributeTypeMap = [ baseName: "required", type: "boolean" }, - { - name: "signer", - baseName: "signer", - type: "string" - }, { name: "group", baseName: "group", @@ -22949,6 +22949,11 @@ var _TemplateResponseDocumentFormFieldBase = class { var TemplateResponseDocumentFormFieldBase = _TemplateResponseDocumentFormFieldBase; TemplateResponseDocumentFormFieldBase.discriminator = "type"; TemplateResponseDocumentFormFieldBase.attributeTypeMap = [ + { + name: "type", + baseName: "type", + type: "string" + }, { name: "apiId", baseName: "api_id", @@ -22959,11 +22964,6 @@ TemplateResponseDocumentFormFieldBase.attributeTypeMap = [ baseName: "name", type: "string" }, - { - name: "type", - baseName: "type", - type: "string" - }, { name: "signer", baseName: "signer", @@ -23346,6 +23346,11 @@ var _TemplateResponseDocumentStaticFieldBase = class { var TemplateResponseDocumentStaticFieldBase = _TemplateResponseDocumentStaticFieldBase; TemplateResponseDocumentStaticFieldBase.discriminator = "type"; TemplateResponseDocumentStaticFieldBase.attributeTypeMap = [ + { + name: "type", + baseName: "type", + type: "string" + }, { name: "apiId", baseName: "api_id", @@ -23356,11 +23361,6 @@ TemplateResponseDocumentStaticFieldBase.attributeTypeMap = [ baseName: "name", type: "string" }, - { - name: "type", - baseName: "type", - type: "string" - }, { name: "signer", baseName: "signer", diff --git a/sdks/node/docs/model/ApiAppResponse.md b/sdks/node/docs/model/ApiAppResponse.md index 19ff0fc6c..4c0e4a9ca 100644 --- a/sdks/node/docs/model/ApiAppResponse.md +++ b/sdks/node/docs/model/ApiAppResponse.md @@ -6,15 +6,15 @@ Contains information about an API App. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `clientId`*_required_ | ```string``` | The app's client id | | -| `createdAt`*_required_ | ```number``` | The time that the app was created | | -| `domains`*_required_ | ```Array``` | The domain name(s) associated with the app | | -| `name`*_required_ | ```string``` | The name of the app | | -| `isApproved`*_required_ | ```boolean``` | Boolean to indicate if the app has been approved | | -| `options`*_required_ | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | -| `ownerAccount`*_required_ | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `callbackUrl` | ```string``` | The app's callback URL (for events) | | +| `clientId` | ```string``` | The app's client id | | +| `createdAt` | ```number``` | The time that the app was created | | +| `domains` | ```Array``` | The domain name(s) associated with the app | | +| `name` | ```string``` | The name of the app | | +| `isApproved` | ```boolean``` | Boolean to indicate if the app has been approved | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | +| `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | +| `ownerAccount` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `whiteLabelingOptions` | [```ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | | [[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/ApiAppResponseOAuth.md b/sdks/node/docs/model/ApiAppResponseOAuth.md index f0ecb2872..5f3376c3e 100644 --- a/sdks/node/docs/model/ApiAppResponseOAuth.md +++ b/sdks/node/docs/model/ApiAppResponseOAuth.md @@ -6,9 +6,9 @@ An object describing the app's OAuth properties, or null if OAuth is not con Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callbackUrl`*_required_ | ```string``` | The app's OAuth callback URL. | | -| `scopes`*_required_ | ```Array``` | Array of OAuth scopes used by the app. | | -| `chargesUsers`*_required_ | ```boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | +| `callbackUrl` | ```string``` | The app's OAuth callback URL. | | | `secret` | ```string``` | The app's OAuth secret, or null if the app does not belong to user. | | +| `scopes` | ```Array``` | Array of OAuth scopes used by the app. | | +| `chargesUsers` | ```boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | [[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/ApiAppResponseOptions.md b/sdks/node/docs/model/ApiAppResponseOptions.md index 28dde9c26..2a3fcbabc 100644 --- a/sdks/node/docs/model/ApiAppResponseOptions.md +++ b/sdks/node/docs/model/ApiAppResponseOptions.md @@ -6,6 +6,6 @@ An object with options that override account settings. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `canInsertEverywhere`*_required_ | ```boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `canInsertEverywhere` | ```boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | [[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/ApiAppResponseOwnerAccount.md b/sdks/node/docs/model/ApiAppResponseOwnerAccount.md index 8d25a2b50..5d1001008 100644 --- a/sdks/node/docs/model/ApiAppResponseOwnerAccount.md +++ b/sdks/node/docs/model/ApiAppResponseOwnerAccount.md @@ -6,7 +6,7 @@ An object describing the app's owner Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `accountId`*_required_ | ```string``` | The owner account's ID | | -| `emailAddress`*_required_ | ```string``` | The owner account's email address | | +| `accountId` | ```string``` | The owner account's ID | | +| `emailAddress` | ```string``` | The owner account's email address | | [[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/ApiAppResponseWhiteLabelingOptions.md b/sdks/node/docs/model/ApiAppResponseWhiteLabelingOptions.md index fc420ef4c..927f4521e 100644 --- a/sdks/node/docs/model/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/node/docs/model/ApiAppResponseWhiteLabelingOptions.md @@ -6,19 +6,19 @@ An object with options to customize the app's signer page Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `headerBackgroundColor`*_required_ | ```string``` | | | -| `legalVersion`*_required_ | ```string``` | | | -| `linkColor`*_required_ | ```string``` | | | -| `pageBackgroundColor`*_required_ | ```string``` | | | -| `primaryButtonColor`*_required_ | ```string``` | | | -| `primaryButtonColorHover`*_required_ | ```string``` | | | -| `primaryButtonTextColor`*_required_ | ```string``` | | | -| `primaryButtonTextColorHover`*_required_ | ```string``` | | | -| `secondaryButtonColor`*_required_ | ```string``` | | | -| `secondaryButtonColorHover`*_required_ | ```string``` | | | -| `secondaryButtonTextColor`*_required_ | ```string``` | | | -| `secondaryButtonTextColorHover`*_required_ | ```string``` | | | -| `textColor1`*_required_ | ```string``` | | | -| `textColor2`*_required_ | ```string``` | | | +| `headerBackgroundColor` | ```string``` | | | +| `legalVersion` | ```string``` | | | +| `linkColor` | ```string``` | | | +| `pageBackgroundColor` | ```string``` | | | +| `primaryButtonColor` | ```string``` | | | +| `primaryButtonColorHover` | ```string``` | | | +| `primaryButtonTextColor` | ```string``` | | | +| `primaryButtonTextColorHover` | ```string``` | | | +| `secondaryButtonColor` | ```string``` | | | +| `secondaryButtonColorHover` | ```string``` | | | +| `secondaryButtonTextColor` | ```string``` | | | +| `secondaryButtonTextColorHover` | ```string``` | | | +| `textColor1` | ```string``` | | | +| `textColor2` | ```string``` | | | [[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/BulkSendJobResponse.md b/sdks/node/docs/model/BulkSendJobResponse.md index 90b59a339..ecafe7ede 100644 --- a/sdks/node/docs/model/BulkSendJobResponse.md +++ b/sdks/node/docs/model/BulkSendJobResponse.md @@ -6,9 +6,9 @@ Contains information about the BulkSendJob such as when it was created and how m Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulkSendJobId`*_required_ | ```string``` | The id of the BulkSendJob. | | -| `total`*_required_ | ```number``` | The total amount of Signature Requests queued for sending. | | -| `isCreator`*_required_ | ```boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `createdAt`*_required_ | ```number``` | Time that the BulkSendJob was created. | | +| `bulkSendJobId` | ```string``` | The id of the BulkSendJob. | | +| `total` | ```number``` | The total amount of Signature Requests queued for sending. | | +| `isCreator` | ```boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | +| `createdAt` | ```number``` | Time that the BulkSendJob was created. | | [[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/FaxLineResponseFaxLine.md b/sdks/node/docs/model/FaxLineResponseFaxLine.md index c3b4d6cb8..aaf5b0f21 100644 --- a/sdks/node/docs/model/FaxLineResponseFaxLine.md +++ b/sdks/node/docs/model/FaxLineResponseFaxLine.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | Number | | -| `createdAt`*_required_ | ```number``` | Created at | | -| `updatedAt`*_required_ | ```number``` | Updated at | | -| `accounts`*_required_ | [```Array```](AccountResponse.md) | | | +| `number` | ```string``` | Number | | +| `createdAt` | ```number``` | Created at | | +| `updatedAt` | ```number``` | Updated at | | +| `accounts` | [```Array```](AccountResponse.md) | | | [[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/TeamResponse.md b/sdks/node/docs/model/TeamResponse.md index db6303351..39f6ae7fb 100644 --- a/sdks/node/docs/model/TeamResponse.md +++ b/sdks/node/docs/model/TeamResponse.md @@ -6,9 +6,9 @@ Contains information about your team and its members Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of your Team | | -| `accounts`*_required_ | [```Array```](AccountResponse.md) | | | -| `invitedAccounts`*_required_ | [```Array```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | -| `invitedEmails`*_required_ | ```Array``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `name` | ```string``` | The name of your Team | | +| `accounts` | [```Array```](AccountResponse.md) | | | +| `invitedAccounts` | [```Array```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | +| `invitedEmails` | ```Array``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | [[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/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md index 0a13c1f8e..05c82cd71 100644 --- a/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -6,9 +6,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId`*_required_ | ```string``` | The id of the Template. | | -| `editUrl`*_required_ | ```string``` | Link to edit the template. | | -| `expiresAt`*_required_ | ```number``` | When the link expires. | | +| `templateId` | ```string``` | The id of the Template. | | +| `editUrl` | ```string``` | Link to edit the template. | | +| `expiresAt` | ```number``` | When the link expires. | | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | [[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/TemplateCreateResponseTemplate.md b/sdks/node/docs/model/TemplateCreateResponseTemplate.md index f96ba4cd2..3b4e62005 100644 --- a/sdks/node/docs/model/TemplateCreateResponseTemplate.md +++ b/sdks/node/docs/model/TemplateCreateResponseTemplate.md @@ -6,6 +6,6 @@ Template object with parameters: `template_id`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId`*_required_ | ```string``` | The id of the Template. | | +| `templateId` | ```string``` | The id of the Template. | | [[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/TemplateResponse.md b/sdks/node/docs/model/TemplateResponse.md index 868e86155..90ed7af2e 100644 --- a/sdks/node/docs/model/TemplateResponse.md +++ b/sdks/node/docs/model/TemplateResponse.md @@ -6,21 +6,21 @@ Contains information about the templates you and your team have created. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId`*_required_ | ```string``` | The id of the Template. | | -| `title`*_required_ | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message`*_required_ | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `isCreator`*_required_ | ```boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `canEdit`*_required_ | ```boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `isLocked`*_required_ | ```boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata`*_required_ | ```object``` | The metadata attached to the template. | | -| `signerRoles`*_required_ | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `ccRoles`*_required_ | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents`*_required_ | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | -| `accounts`*_required_ | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | -| `attachments`*_required_ | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `templateId` | ```string``` | The id of the Template. | | +| `title` | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message` | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | | `updatedAt` | ```number``` | Time the template was last updated. | | | `isEmbedded` | ```boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | +| `isCreator` | ```boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `canEdit` | ```boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `isLocked` | ```boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata` | ```object``` | The metadata attached to the template. | | +| `signerRoles` | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `ccRoles` | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | +| `documents` | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `customFields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | +| `accounts` | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | [[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/TemplateResponseAccount.md b/sdks/node/docs/model/TemplateResponseAccount.md index eb890053e..524109d96 100644 --- a/sdks/node/docs/model/TemplateResponseAccount.md +++ b/sdks/node/docs/model/TemplateResponseAccount.md @@ -6,11 +6,11 @@ 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_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.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` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | [[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/TemplateResponseAccountQuota.md b/sdks/node/docs/model/TemplateResponseAccountQuota.md index ff782d764..587c6dab3 100644 --- a/sdks/node/docs/model/TemplateResponseAccountQuota.md +++ b/sdks/node/docs/model/TemplateResponseAccountQuota.md @@ -6,9 +6,9 @@ An array of the designated CC roles that must be specified when sending a Signat Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templatesLeft`*_required_ | ```number``` | API templates remaining. | | -| `apiSignatureRequestsLeft`*_required_ | ```number``` | API signature requests remaining. | | -| `documentsLeft`*_required_ | ```number``` | Signature requests remaining. | | -| `smsVerificationsLeft`*_required_ | ```number``` | SMS verifications remaining. | | +| `templatesLeft` | ```number``` | API templates remaining. | | +| `apiSignatureRequestsLeft` | ```number``` | API signature requests remaining. | | +| `documentsLeft` | ```number``` | Signature requests remaining. | | +| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | | [[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/TemplateResponseCCRole.md b/sdks/node/docs/model/TemplateResponseCCRole.md index 74c81b18d..32ad82ef9 100644 --- a/sdks/node/docs/model/TemplateResponseCCRole.md +++ b/sdks/node/docs/model/TemplateResponseCCRole.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of the Role. | | +| `name` | ```string``` | The name of the Role. | | [[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/TemplateResponseDocument.md b/sdks/node/docs/model/TemplateResponseDocument.md index 50fa698f4..5f3f0d214 100644 --- a/sdks/node/docs/model/TemplateResponseDocument.md +++ b/sdks/node/docs/model/TemplateResponseDocument.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | Name of the associated file. | | -| `fieldGroups`*_required_ | [```Array```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `formFields`*_required_ | [```Array```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `customFields`*_required_ | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `staticFields`*_required_ | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | +| `name` | ```string``` | Name of the associated file. | | | `index` | ```number``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | +| `fieldGroups` | [```Array```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `formFields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `customFields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `staticFields` | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | [[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/TemplateResponseDocumentCustomFieldBase.md b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldBase.md index 4a9b70f2a..81418366f 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldBase.md @@ -6,15 +6,15 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `apiId`*_required_ | ```string``` | The unique ID for this field. | | -| `name`*_required_ | ```string``` | The name of the Custom Field. | | | `type`*_required_ | ```string``` | | | -| `x`*_required_ | ```number``` | The horizontal offset in pixels for this form field. | | -| `y`*_required_ | ```number``` | The vertical offset in pixels for this form field. | | -| `width`*_required_ | ```number``` | The width in pixels of this form field. | | -| `height`*_required_ | ```number``` | The height in pixels of this form field. | | -| `required`*_required_ | ```boolean``` | Boolean showing whether or not this field is required. | | +| `apiId` | ```string``` | The unique ID for this field. | | +| `name` | ```string``` | The name of the Custom Field. | | | `signer` | ```string``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | +| `x` | ```number``` | The horizontal offset in pixels for this form field. | | +| `y` | ```number``` | The vertical offset in pixels for this form field. | | +| `width` | ```number``` | The width in pixels of this form field. | | +| `height` | ```number``` | The height in pixels of this form field. | | +| `required` | ```boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseDocumentCustomFieldText.md b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldText.md index 84a007361..035c69583 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldText.md @@ -7,9 +7,9 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | -| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline`*_required_ | ```boolean``` | Whether this form field is multiline text. | | -| `originalFontSize`*_required_ | ```number``` | Original font size used in this form field's text. | | -| `fontFamily`*_required_ | ```string``` | Font family used in this form field's text. | | +| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline` | ```boolean``` | Whether this form field is multiline text. | | +| `originalFontSize` | ```number``` | Original font size used in this form field's text. | | +| `fontFamily` | ```string``` | Font family used in this form field's text. | | [[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/TemplateResponseDocumentFieldGroup.md b/sdks/node/docs/model/TemplateResponseDocumentFieldGroup.md index b60f4eb75..51f7c3369 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFieldGroup.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFieldGroup.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of the form field group. | | -| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name` | ```string``` | The name of the form field group. | | +| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | [[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/TemplateResponseDocumentFieldGroupRule.md b/sdks/node/docs/model/TemplateResponseDocumentFieldGroupRule.md index 965bc8c08..95e4fa470 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFieldGroupRule.md @@ -6,7 +6,7 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `requirement`*_required_ | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `groupLabel`*_required_ | ```string``` | Name of the group | | +| `requirement` | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `groupLabel` | ```string``` | Name of the group | | [[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/TemplateResponseDocumentFormFieldBase.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldBase.md index bdae5de92..648b7fd5d 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldBase.md @@ -6,14 +6,14 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `apiId`*_required_ | ```string``` | A unique id for the form field. | | -| `name`*_required_ | ```string``` | The name of the form field. | | | `type`*_required_ | ```string``` | | | -| `signer`*_required_ | ```string``` | The signer of the Form Field. | | -| `x`*_required_ | ```number``` | The horizontal offset in pixels for this form field. | | -| `y`*_required_ | ```number``` | The vertical offset in pixels for this form field. | | -| `width`*_required_ | ```number``` | The width in pixels of this form field. | | -| `height`*_required_ | ```number``` | The height in pixels of this form field. | | -| `required`*_required_ | ```boolean``` | Boolean showing whether or not this field is required. | | +| `apiId` | ```string``` | A unique id for the form field. | | +| `name` | ```string``` | The name of the form field. | | +| `signer` | ```string``` | The signer of the Form Field. | | +| `x` | ```number``` | The horizontal offset in pixels for this form field. | | +| `y` | ```number``` | The vertical offset in pixels for this form field. | | +| `width` | ```number``` | The width in pixels of this form field. | | +| `height` | ```number``` | The height in pixels of this form field. | | +| `required` | ```boolean``` | Boolean showing whether or not this field is required. | | [[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/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldHyperlink.md index ec72f7901..6ba74dff4 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldHyperlink.md @@ -7,10 +7,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | -| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline`*_required_ | ```boolean``` | Whether this form field is multiline text. | | -| `originalFontSize`*_required_ | ```number``` | Original font size used in this form field's text. | | -| `fontFamily`*_required_ | ```string``` | Font family used in this form field's text. | | +| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline` | ```boolean``` | Whether this form field is multiline text. | | +| `originalFontSize` | ```number``` | Original font size used in this form field's text. | | +| `fontFamily` | ```string``` | Font family used in this form field's text. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldText.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldText.md index c2769f4fc..25a86e871 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldText.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldText.md @@ -7,10 +7,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | -| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline`*_required_ | ```boolean``` | Whether this form field is multiline text. | | -| `originalFontSize`*_required_ | ```number``` | Original font size used in this form field's text. | | -| `fontFamily`*_required_ | ```string``` | Font family used in this form field's text. | | +| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline` | ```boolean``` | Whether this form field is multiline text. | | +| `originalFontSize` | ```number``` | Original font size used in this form field's text. | | +| `fontFamily` | ```string``` | Font family used in this form field's text. | | | `validationType` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldBase.md b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldBase.md index a5fe1b0f6..243c1d108 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldBase.md @@ -6,15 +6,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `apiId`*_required_ | ```string``` | A unique id for the static field. | | -| `name`*_required_ | ```string``` | The name of the static field. | | | `type`*_required_ | ```string``` | | | -| `signer`*_required_ | ```string``` | The signer of the Static Field. | [default to 'me_now'] | -| `x`*_required_ | ```number``` | The horizontal offset in pixels for this static field. | | -| `y`*_required_ | ```number``` | The vertical offset in pixels for this static field. | | -| `width`*_required_ | ```number``` | The width in pixels of this static field. | | -| `height`*_required_ | ```number``` | The height in pixels of this static field. | | -| `required`*_required_ | ```boolean``` | Boolean showing whether or not this field is required. | | +| `apiId` | ```string``` | A unique id for the static field. | | +| `name` | ```string``` | The name of the static field. | | +| `signer` | ```string``` | The signer of the Static Field. | [default to 'me_now'] | +| `x` | ```number``` | The horizontal offset in pixels for this static field. | | +| `y` | ```number``` | The vertical offset in pixels for this static field. | | +| `width` | ```number``` | The width in pixels of this static field. | | +| `height` | ```number``` | The height in pixels of this static field. | | +| `required` | ```boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseFieldAvgTextLength.md b/sdks/node/docs/model/TemplateResponseFieldAvgTextLength.md index 585551694..45daf9dae 100644 --- a/sdks/node/docs/model/TemplateResponseFieldAvgTextLength.md +++ b/sdks/node/docs/model/TemplateResponseFieldAvgTextLength.md @@ -6,7 +6,7 @@ Average text length in this field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `numLines`*_required_ | ```number``` | Number of lines. | | -| `numCharsPerLine`*_required_ | ```number``` | Number of characters per line. | | +| `numLines` | ```number``` | Number of lines. | | +| `numCharsPerLine` | ```number``` | Number of characters per line. | | [[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/TemplateResponseSignerRole.md b/sdks/node/docs/model/TemplateResponseSignerRole.md index d3456d9cf..e33fced3c 100644 --- a/sdks/node/docs/model/TemplateResponseSignerRole.md +++ b/sdks/node/docs/model/TemplateResponseSignerRole.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of the Role. | | +| `name` | ```string``` | The name of the Role. | | | `order` | ```number``` | If signer order is assigned this is the 0-based index for this role. | | [[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/TemplateUpdateFilesResponseTemplate.md b/sdks/node/docs/model/TemplateUpdateFilesResponseTemplate.md index 90feb3f29..aea14ab0c 100644 --- a/sdks/node/docs/model/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/node/docs/model/TemplateUpdateFilesResponseTemplate.md @@ -6,7 +6,7 @@ Contains template id Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId`*_required_ | ```string``` | The id of the Template. | | +| `templateId` | ```string``` | The id of the Template. | | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | [[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/apiAppResponse.ts b/sdks/node/model/apiAppResponse.ts index 848cab40a..167b3eb15 100644 --- a/sdks/node/model/apiAppResponse.ts +++ b/sdks/node/model/apiAppResponse.ts @@ -32,38 +32,43 @@ import { ApiAppResponseWhiteLabelingOptions } from "./apiAppResponseWhiteLabelin * Contains information about an API App. */ export class ApiAppResponse { + /** + * The app\'s callback URL (for events) + */ + "callbackUrl"?: string | null; /** * The app\'s client id */ - "clientId": string; + "clientId"?: string; /** * The time that the app was created */ - "createdAt": number; + "createdAt"?: number; /** * The domain name(s) associated with the app */ - "domains": Array; + "domains"?: Array; /** * The name of the app */ - "name": string; + "name"?: string; /** * Boolean to indicate if the app has been approved */ - "isApproved": boolean; - "options": ApiAppResponseOptions; - "ownerAccount": ApiAppResponseOwnerAccount; - /** - * The app\'s callback URL (for events) - */ - "callbackUrl"?: string | null; + "isApproved"?: boolean; "oauth"?: ApiAppResponseOAuth | null; + "options"?: ApiAppResponseOptions | null; + "ownerAccount"?: ApiAppResponseOwnerAccount; "whiteLabelingOptions"?: ApiAppResponseWhiteLabelingOptions | null; static discriminator: string | undefined = undefined; static attributeTypeMap: AttributeTypeMap = [ + { + name: "callbackUrl", + baseName: "callback_url", + type: "string", + }, { name: "clientId", baseName: "client_id", @@ -89,6 +94,11 @@ export class ApiAppResponse { baseName: "is_approved", type: "boolean", }, + { + name: "oauth", + baseName: "oauth", + type: "ApiAppResponseOAuth", + }, { name: "options", baseName: "options", @@ -99,16 +109,6 @@ export class ApiAppResponse { baseName: "owner_account", type: "ApiAppResponseOwnerAccount", }, - { - name: "callbackUrl", - baseName: "callback_url", - type: "string", - }, - { - name: "oauth", - baseName: "oauth", - type: "ApiAppResponseOAuth", - }, { name: "whiteLabelingOptions", baseName: "white_labeling_options", diff --git a/sdks/node/model/apiAppResponseOAuth.ts b/sdks/node/model/apiAppResponseOAuth.ts index 9399bad82..cefb71be1 100644 --- a/sdks/node/model/apiAppResponseOAuth.ts +++ b/sdks/node/model/apiAppResponseOAuth.ts @@ -31,19 +31,19 @@ export class ApiAppResponseOAuth { /** * The app\'s OAuth callback URL. */ - "callbackUrl": string; + "callbackUrl"?: string; /** - * Array of OAuth scopes used by the app. + * The app\'s OAuth secret, or null if the app does not belong to user. */ - "scopes": Array; + "secret"?: string | null; /** - * Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. + * Array of OAuth scopes used by the app. */ - "chargesUsers": boolean; + "scopes"?: Array; /** - * The app\'s OAuth secret, or null if the app does not belong to user. + * Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. */ - "secret"?: string | null; + "chargesUsers"?: boolean; static discriminator: string | undefined = undefined; @@ -53,6 +53,11 @@ export class ApiAppResponseOAuth { baseName: "callback_url", type: "string", }, + { + name: "secret", + baseName: "secret", + type: "string", + }, { name: "scopes", baseName: "scopes", @@ -63,11 +68,6 @@ export class ApiAppResponseOAuth { baseName: "charges_users", type: "boolean", }, - { - name: "secret", - baseName: "secret", - type: "string", - }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/apiAppResponseOptions.ts b/sdks/node/model/apiAppResponseOptions.ts index 8f121b054..3d36cd672 100644 --- a/sdks/node/model/apiAppResponseOptions.ts +++ b/sdks/node/model/apiAppResponseOptions.ts @@ -31,7 +31,7 @@ export class ApiAppResponseOptions { /** * Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document */ - "canInsertEverywhere": boolean; + "canInsertEverywhere"?: boolean; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/apiAppResponseOwnerAccount.ts b/sdks/node/model/apiAppResponseOwnerAccount.ts index 89d0a6735..8abfae818 100644 --- a/sdks/node/model/apiAppResponseOwnerAccount.ts +++ b/sdks/node/model/apiAppResponseOwnerAccount.ts @@ -31,11 +31,11 @@ export class ApiAppResponseOwnerAccount { /** * The owner account\'s ID */ - "accountId": string; + "accountId"?: string; /** * The owner account\'s email address */ - "emailAddress": string; + "emailAddress"?: string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/apiAppResponseWhiteLabelingOptions.ts b/sdks/node/model/apiAppResponseWhiteLabelingOptions.ts index 0ee36f0aa..6c4beeebe 100644 --- a/sdks/node/model/apiAppResponseWhiteLabelingOptions.ts +++ b/sdks/node/model/apiAppResponseWhiteLabelingOptions.ts @@ -28,20 +28,20 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; * An object with options to customize the app\'s signer page */ export class ApiAppResponseWhiteLabelingOptions { - "headerBackgroundColor": string; - "legalVersion": string; - "linkColor": string; - "pageBackgroundColor": string; - "primaryButtonColor": string; - "primaryButtonColorHover": string; - "primaryButtonTextColor": string; - "primaryButtonTextColorHover": string; - "secondaryButtonColor": string; - "secondaryButtonColorHover": string; - "secondaryButtonTextColor": string; - "secondaryButtonTextColorHover": string; - "textColor1": string; - "textColor2": string; + "headerBackgroundColor"?: string; + "legalVersion"?: string; + "linkColor"?: string; + "pageBackgroundColor"?: string; + "primaryButtonColor"?: string; + "primaryButtonColorHover"?: string; + "primaryButtonTextColor"?: string; + "primaryButtonTextColorHover"?: string; + "secondaryButtonColor"?: string; + "secondaryButtonColorHover"?: string; + "secondaryButtonTextColor"?: string; + "secondaryButtonTextColorHover"?: string; + "textColor1"?: string; + "textColor2"?: string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/bulkSendJobResponse.ts b/sdks/node/model/bulkSendJobResponse.ts index a7e1c5d0d..115d7fb01 100644 --- a/sdks/node/model/bulkSendJobResponse.ts +++ b/sdks/node/model/bulkSendJobResponse.ts @@ -31,19 +31,19 @@ export class BulkSendJobResponse { /** * The id of the BulkSendJob. */ - "bulkSendJobId": string; + "bulkSendJobId"?: string | null; /** * The total amount of Signature Requests queued for sending. */ - "total": number; + "total"?: number; /** * True if you are the owner of this BulkSendJob, false if it\'s been shared with you by a team member. */ - "isCreator": boolean; + "isCreator"?: boolean; /** * Time that the BulkSendJob was created. */ - "createdAt": number; + "createdAt"?: number; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/faxLineResponseFaxLine.ts b/sdks/node/model/faxLineResponseFaxLine.ts index 4aa2b965d..aeefe37e2 100644 --- a/sdks/node/model/faxLineResponseFaxLine.ts +++ b/sdks/node/model/faxLineResponseFaxLine.ts @@ -29,16 +29,16 @@ export class FaxLineResponseFaxLine { /** * Number */ - "number": string; + "number"?: string; /** * Created at */ - "createdAt": number; + "createdAt"?: number; /** * Updated at */ - "updatedAt": number; - "accounts": Array; + "updatedAt"?: number; + "accounts"?: Array; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/teamResponse.ts b/sdks/node/model/teamResponse.ts index 3cefae27f..4d0a233d0 100644 --- a/sdks/node/model/teamResponse.ts +++ b/sdks/node/model/teamResponse.ts @@ -32,16 +32,16 @@ export class TeamResponse { /** * The name of your Team */ - "name": string; - "accounts": Array; + "name"?: string; + "accounts"?: Array; /** * A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. */ - "invitedAccounts": Array; + "invitedAccounts"?: Array; /** * A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. */ - "invitedEmails": Array; + "invitedEmails"?: Array; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts b/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts index 259954445..af7f9a71b 100644 --- a/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts +++ b/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts @@ -32,15 +32,15 @@ export class TemplateCreateEmbeddedDraftResponseTemplate { /** * The id of the Template. */ - "templateId": string; + "templateId"?: string; /** * Link to edit the template. */ - "editUrl": string; + "editUrl"?: string; /** * When the link expires. */ - "expiresAt": number; + "expiresAt"?: number; /** * A list of warnings. */ diff --git a/sdks/node/model/templateCreateResponseTemplate.ts b/sdks/node/model/templateCreateResponseTemplate.ts index e6e8a7ea6..cdcd61167 100644 --- a/sdks/node/model/templateCreateResponseTemplate.ts +++ b/sdks/node/model/templateCreateResponseTemplate.ts @@ -31,7 +31,7 @@ export class TemplateCreateResponseTemplate { /** * The id of the Template. */ - "templateId": string; + "templateId"?: string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponse.ts b/sdks/node/model/templateResponse.ts index c115a359c..81dc1a4a3 100644 --- a/sdks/node/model/templateResponse.ts +++ b/sdks/node/model/templateResponse.ts @@ -38,59 +38,51 @@ export class TemplateResponse { /** * The id of the Template. */ - "templateId": string; + "templateId"?: string; /** * The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. */ - "title": string; + "title"?: string; /** * The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. */ - "message": string; + "message"?: string; + /** + * Time the template was last updated. + */ + "updatedAt"?: number; + /** + * `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + */ + "isEmbedded"?: boolean | null; /** * `true` if you are the owner of this template, `false` if it\'s been shared with you by a team member. */ - "isCreator": boolean; + "isCreator"?: boolean; /** * Indicates whether edit rights have been granted to you by the owner (always `true` if that\'s you). */ - "canEdit": boolean; + "canEdit"?: boolean; /** * Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. */ - "isLocked": boolean; + "isLocked"?: boolean; /** * The metadata attached to the template. */ - "metadata": object; + "metadata"?: object; /** * An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. */ - "signerRoles": Array; + "signerRoles"?: Array; /** * An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. */ - "ccRoles": Array; + "ccRoles"?: Array; /** * An array describing each document associated with this Template. Includes form field data for each document. */ - "documents": Array; - /** - * An array of the Accounts that can use this Template. - */ - "accounts": Array; - /** - * Signer attachments. - */ - "attachments": Array; - /** - * Time the template was last updated. - */ - "updatedAt"?: number; - /** - * `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. - */ - "isEmbedded"?: boolean | null; + "documents"?: Array; /** * Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. */ @@ -99,6 +91,14 @@ export class TemplateResponse { * Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. */ "namedFormFields"?: Array | null; + /** + * An array of the Accounts that can use this Template. + */ + "accounts"?: Array; + /** + * Signer attachments. + */ + "attachments"?: Array; static discriminator: string | undefined = undefined; @@ -118,6 +118,16 @@ export class TemplateResponse { baseName: "message", type: "string", }, + { + name: "updatedAt", + baseName: "updated_at", + type: "number", + }, + { + name: "isEmbedded", + baseName: "is_embedded", + type: "boolean", + }, { name: "isCreator", baseName: "is_creator", @@ -153,26 +163,6 @@ export class TemplateResponse { baseName: "documents", type: "Array", }, - { - name: "accounts", - baseName: "accounts", - type: "Array", - }, - { - name: "attachments", - baseName: "attachments", - type: "Array", - }, - { - name: "updatedAt", - baseName: "updated_at", - type: "number", - }, - { - name: "isEmbedded", - baseName: "is_embedded", - type: "boolean", - }, { name: "customFields", baseName: "custom_fields", @@ -183,6 +173,16 @@ export class TemplateResponse { baseName: "named_form_fields", type: "Array", }, + { + name: "accounts", + baseName: "accounts", + type: "Array", + }, + { + name: "attachments", + baseName: "attachments", + type: "Array", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseAccount.ts b/sdks/node/model/templateResponseAccount.ts index 86f230130..3b43d9351 100644 --- a/sdks/node/model/templateResponseAccount.ts +++ b/sdks/node/model/templateResponseAccount.ts @@ -29,24 +29,24 @@ export class TemplateResponseAccount { /** * 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": TemplateResponseAccountQuota; - /** - * The email address associated with the Account. - */ - "emailAddress"?: string; + "isPaidHf"?: boolean; + "quotas"?: TemplateResponseAccountQuota; static discriminator: string | undefined = undefined; @@ -56,6 +56,11 @@ export class TemplateResponseAccount { baseName: "account_id", type: "string", }, + { + name: "emailAddress", + baseName: "email_address", + type: "string", + }, { name: "isLocked", baseName: "is_locked", @@ -76,11 +81,6 @@ export class TemplateResponseAccount { baseName: "quotas", type: "TemplateResponseAccountQuota", }, - { - name: "emailAddress", - baseName: "email_address", - type: "string", - }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseAccountQuota.ts b/sdks/node/model/templateResponseAccountQuota.ts index fbb4547ac..e2d6669b6 100644 --- a/sdks/node/model/templateResponseAccountQuota.ts +++ b/sdks/node/model/templateResponseAccountQuota.ts @@ -31,19 +31,19 @@ export class TemplateResponseAccountQuota { /** * API templates remaining. */ - "templatesLeft": number; + "templatesLeft"?: number; /** * API signature requests remaining. */ - "apiSignatureRequestsLeft": number; + "apiSignatureRequestsLeft"?: number; /** * Signature requests remaining. */ - "documentsLeft": number; + "documentsLeft"?: number; /** * SMS verifications remaining. */ - "smsVerificationsLeft": number; + "smsVerificationsLeft"?: number; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseCCRole.ts b/sdks/node/model/templateResponseCCRole.ts index 442fe1f89..b3b7a2fd7 100644 --- a/sdks/node/model/templateResponseCCRole.ts +++ b/sdks/node/model/templateResponseCCRole.ts @@ -28,7 +28,7 @@ export class TemplateResponseCCRole { /** * The name of the Role. */ - "name": string; + "name"?: string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseDocument.ts b/sdks/node/model/templateResponseDocument.ts index 4b55dfe81..681736701 100644 --- a/sdks/node/model/templateResponseDocument.ts +++ b/sdks/node/model/templateResponseDocument.ts @@ -32,27 +32,27 @@ export class TemplateResponseDocument { /** * Name of the associated file. */ - "name": string; + "name"?: string; + /** + * Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + */ + "index"?: number; /** * An array of Form Field Group objects. */ - "fieldGroups": Array; + "fieldGroups"?: Array; /** * An array of Form Field objects containing the name and type of each named field. */ - "formFields": Array; + "formFields"?: Array; /** * An array of Form Field objects containing the name and type of each named field. */ - "customFields": Array; + "customFields"?: Array; /** * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. */ - "staticFields": Array; - /** - * Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - */ - "index"?: number; + "staticFields"?: Array; static discriminator: string | undefined = undefined; @@ -62,6 +62,11 @@ export class TemplateResponseDocument { baseName: "name", type: "string", }, + { + name: "index", + baseName: "index", + type: "number", + }, { name: "fieldGroups", baseName: "field_groups", @@ -82,11 +87,6 @@ export class TemplateResponseDocument { baseName: "static_fields", type: "Array", }, - { - name: "index", - baseName: "index", - type: "number", - }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentCustomFieldBase.ts b/sdks/node/model/templateResponseDocumentCustomFieldBase.ts index 340f9200d..a0ed43965 100644 --- a/sdks/node/model/templateResponseDocumentCustomFieldBase.ts +++ b/sdks/node/model/templateResponseDocumentCustomFieldBase.ts @@ -28,39 +28,39 @@ import { AttributeTypeMap } from "./"; * An array of Form Field objects containing the name and type of each named field. */ export abstract class TemplateResponseDocumentCustomFieldBase { + "type": string; /** * The unique ID for this field. */ - "apiId": string; + "apiId"?: string; /** * The name of the Custom Field. */ - "name": string; - "type": string; + "name"?: string; + /** + * The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + */ + "signer"?: number | string | null; /** * The horizontal offset in pixels for this form field. */ - "x": number; + "x"?: number; /** * The vertical offset in pixels for this form field. */ - "y": number; + "y"?: number; /** * The width in pixels of this form field. */ - "width": number; + "width"?: number; /** * The height in pixels of this form field. */ - "height": number; + "height"?: number; /** * Boolean showing whether or not this field is required. */ - "required": boolean; - /** - * The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). - */ - "signer"?: number | string | null; + "required"?: boolean; /** * The name of the group this field is in. If this field is not a group, this defaults to `null`. */ @@ -69,6 +69,11 @@ export abstract class TemplateResponseDocumentCustomFieldBase { static discriminator: string | undefined = "type"; static attributeTypeMap: AttributeTypeMap = [ + { + name: "type", + baseName: "type", + type: "string", + }, { name: "apiId", baseName: "api_id", @@ -80,8 +85,8 @@ export abstract class TemplateResponseDocumentCustomFieldBase { type: "string", }, { - name: "type", - baseName: "type", + name: "signer", + baseName: "signer", type: "string", }, { @@ -109,11 +114,6 @@ export abstract class TemplateResponseDocumentCustomFieldBase { baseName: "required", type: "boolean", }, - { - name: "signer", - baseName: "signer", - type: "string", - }, { name: "group", baseName: "group", diff --git a/sdks/node/model/templateResponseDocumentCustomFieldText.ts b/sdks/node/model/templateResponseDocumentCustomFieldText.ts index f07ba6b45..3f59efc19 100644 --- a/sdks/node/model/templateResponseDocumentCustomFieldText.ts +++ b/sdks/node/model/templateResponseDocumentCustomFieldText.ts @@ -34,19 +34,19 @@ export class TemplateResponseDocumentCustomFieldText extends TemplateResponseDoc * The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` */ "type": string = "text"; - "avgTextLength": TemplateResponseFieldAvgTextLength; + "avgTextLength"?: TemplateResponseFieldAvgTextLength; /** * Whether this form field is multiline text. */ - "isMultiline": boolean; + "isMultiline"?: boolean; /** * Original font size used in this form field\'s text. */ - "originalFontSize": number; + "originalFontSize"?: number; /** * Font family used in this form field\'s text. */ - "fontFamily": string; + "fontFamily"?: string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseDocumentFieldGroup.ts b/sdks/node/model/templateResponseDocumentFieldGroup.ts index 820863174..4d2f9c695 100644 --- a/sdks/node/model/templateResponseDocumentFieldGroup.ts +++ b/sdks/node/model/templateResponseDocumentFieldGroup.ts @@ -29,8 +29,8 @@ export class TemplateResponseDocumentFieldGroup { /** * The name of the form field group. */ - "name": string; - "rule": TemplateResponseDocumentFieldGroupRule; + "name"?: string; + "rule"?: TemplateResponseDocumentFieldGroupRule; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseDocumentFieldGroupRule.ts b/sdks/node/model/templateResponseDocumentFieldGroupRule.ts index 4e8f93b10..f5ad93cf4 100644 --- a/sdks/node/model/templateResponseDocumentFieldGroupRule.ts +++ b/sdks/node/model/templateResponseDocumentFieldGroupRule.ts @@ -31,11 +31,11 @@ export class TemplateResponseDocumentFieldGroupRule { /** * Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. */ - "requirement": string; + "requirement"?: string; /** * Name of the group */ - "groupLabel": string; + "groupLabel"?: string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseDocumentFormFieldBase.ts b/sdks/node/model/templateResponseDocumentFormFieldBase.ts index e7aa32f85..e28159b30 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldBase.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldBase.ts @@ -28,43 +28,48 @@ import { AttributeTypeMap } from "./"; * An array of Form Field objects containing the name and type of each named field. */ export abstract class TemplateResponseDocumentFormFieldBase { + "type": string; /** * A unique id for the form field. */ - "apiId": string; + "apiId"?: string; /** * The name of the form field. */ - "name": string; - "type": string; + "name"?: string; /** * The signer of the Form Field. */ - "signer": number | string; + "signer"?: number | string; /** * The horizontal offset in pixels for this form field. */ - "x": number; + "x"?: number; /** * The vertical offset in pixels for this form field. */ - "y": number; + "y"?: number; /** * The width in pixels of this form field. */ - "width": number; + "width"?: number; /** * The height in pixels of this form field. */ - "height": number; + "height"?: number; /** * Boolean showing whether or not this field is required. */ - "required": boolean; + "required"?: boolean; static discriminator: string | undefined = "type"; static attributeTypeMap: AttributeTypeMap = [ + { + name: "type", + baseName: "type", + type: "string", + }, { name: "apiId", baseName: "api_id", @@ -75,11 +80,6 @@ export abstract class TemplateResponseDocumentFormFieldBase { baseName: "name", type: "string", }, - { - name: "type", - baseName: "type", - type: "string", - }, { name: "signer", baseName: "signer", diff --git a/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts b/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts index 2c2113493..a3693ec83 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts @@ -34,19 +34,19 @@ export class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponse * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "hyperlink"; - "avgTextLength": TemplateResponseFieldAvgTextLength; + "avgTextLength"?: TemplateResponseFieldAvgTextLength; /** * Whether this form field is multiline text. */ - "isMultiline": boolean; + "isMultiline"?: boolean; /** * Original font size used in this form field\'s text. */ - "originalFontSize": number; + "originalFontSize"?: number; /** * Font family used in this form field\'s text. */ - "fontFamily": string; + "fontFamily"?: string; /** * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. */ diff --git a/sdks/node/model/templateResponseDocumentFormFieldText.ts b/sdks/node/model/templateResponseDocumentFormFieldText.ts index 9f8ebcc91..e758496f8 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldText.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldText.ts @@ -34,19 +34,19 @@ export class TemplateResponseDocumentFormFieldText extends TemplateResponseDocum * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "text"; - "avgTextLength": TemplateResponseFieldAvgTextLength; + "avgTextLength"?: TemplateResponseFieldAvgTextLength; /** * Whether this form field is multiline text. */ - "isMultiline": boolean; + "isMultiline"?: boolean; /** * Original font size used in this form field\'s text. */ - "originalFontSize": number; + "originalFontSize"?: number; /** * Font family used in this form field\'s text. */ - "fontFamily": string; + "fontFamily"?: string; /** * Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. */ diff --git a/sdks/node/model/templateResponseDocumentStaticFieldBase.ts b/sdks/node/model/templateResponseDocumentStaticFieldBase.ts index 6640046d7..04d3275ef 100644 --- a/sdks/node/model/templateResponseDocumentStaticFieldBase.ts +++ b/sdks/node/model/templateResponseDocumentStaticFieldBase.ts @@ -28,39 +28,39 @@ import { AttributeTypeMap } from "./"; * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. */ export abstract class TemplateResponseDocumentStaticFieldBase { + "type": string; /** * A unique id for the static field. */ - "apiId": string; + "apiId"?: string; /** * The name of the static field. */ - "name": string; - "type": string; + "name"?: string; /** * The signer of the Static Field. */ - "signer": string = "me_now"; + "signer"?: string = "me_now"; /** * The horizontal offset in pixels for this static field. */ - "x": number; + "x"?: number; /** * The vertical offset in pixels for this static field. */ - "y": number; + "y"?: number; /** * The width in pixels of this static field. */ - "width": number; + "width"?: number; /** * The height in pixels of this static field. */ - "height": number; + "height"?: number; /** * Boolean showing whether or not this field is required. */ - "required": boolean; + "required"?: boolean; /** * The name of the group this field is in. If this field is not a group, this defaults to `null`. */ @@ -69,6 +69,11 @@ export abstract class TemplateResponseDocumentStaticFieldBase { static discriminator: string | undefined = "type"; static attributeTypeMap: AttributeTypeMap = [ + { + name: "type", + baseName: "type", + type: "string", + }, { name: "apiId", baseName: "api_id", @@ -79,11 +84,6 @@ export abstract class TemplateResponseDocumentStaticFieldBase { baseName: "name", type: "string", }, - { - name: "type", - baseName: "type", - type: "string", - }, { name: "signer", baseName: "signer", diff --git a/sdks/node/model/templateResponseFieldAvgTextLength.ts b/sdks/node/model/templateResponseFieldAvgTextLength.ts index c95ebfbdd..d0a4fc396 100644 --- a/sdks/node/model/templateResponseFieldAvgTextLength.ts +++ b/sdks/node/model/templateResponseFieldAvgTextLength.ts @@ -31,11 +31,11 @@ export class TemplateResponseFieldAvgTextLength { /** * Number of lines. */ - "numLines": number; + "numLines"?: number; /** * Number of characters per line. */ - "numCharsPerLine": number; + "numCharsPerLine"?: number; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseSignerRole.ts b/sdks/node/model/templateResponseSignerRole.ts index a4950641a..9bebd958f 100644 --- a/sdks/node/model/templateResponseSignerRole.ts +++ b/sdks/node/model/templateResponseSignerRole.ts @@ -28,7 +28,7 @@ export class TemplateResponseSignerRole { /** * The name of the Role. */ - "name": string; + "name"?: string; /** * If signer order is assigned this is the 0-based index for this role. */ diff --git a/sdks/node/model/templateUpdateFilesResponseTemplate.ts b/sdks/node/model/templateUpdateFilesResponseTemplate.ts index 8d49e2d1b..98e18dabc 100644 --- a/sdks/node/model/templateUpdateFilesResponseTemplate.ts +++ b/sdks/node/model/templateUpdateFilesResponseTemplate.ts @@ -32,7 +32,7 @@ export class TemplateUpdateFilesResponseTemplate { /** * The id of the Template. */ - "templateId": string; + "templateId"?: string; /** * A list of warnings. */ diff --git a/sdks/node/types/model/apiAppResponse.d.ts b/sdks/node/types/model/apiAppResponse.d.ts index a85692e95..f0646b2c4 100644 --- a/sdks/node/types/model/apiAppResponse.d.ts +++ b/sdks/node/types/model/apiAppResponse.d.ts @@ -4,15 +4,15 @@ import { ApiAppResponseOptions } from "./apiAppResponseOptions"; import { ApiAppResponseOwnerAccount } from "./apiAppResponseOwnerAccount"; import { ApiAppResponseWhiteLabelingOptions } from "./apiAppResponseWhiteLabelingOptions"; export declare class ApiAppResponse { - "clientId": string; - "createdAt": number; - "domains": Array; - "name": string; - "isApproved": boolean; - "options": ApiAppResponseOptions; - "ownerAccount": ApiAppResponseOwnerAccount; "callbackUrl"?: string | null; + "clientId"?: string; + "createdAt"?: number; + "domains"?: Array; + "name"?: string; + "isApproved"?: boolean; "oauth"?: ApiAppResponseOAuth | null; + "options"?: ApiAppResponseOptions | null; + "ownerAccount"?: ApiAppResponseOwnerAccount; "whiteLabelingOptions"?: ApiAppResponseWhiteLabelingOptions | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/apiAppResponseOAuth.d.ts b/sdks/node/types/model/apiAppResponseOAuth.d.ts index 23a7e12b1..cd298f6fb 100644 --- a/sdks/node/types/model/apiAppResponseOAuth.d.ts +++ b/sdks/node/types/model/apiAppResponseOAuth.d.ts @@ -1,9 +1,9 @@ import { AttributeTypeMap } from "./"; export declare class ApiAppResponseOAuth { - "callbackUrl": string; - "scopes": Array; - "chargesUsers": boolean; + "callbackUrl"?: string; "secret"?: string | null; + "scopes"?: Array; + "chargesUsers"?: boolean; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/apiAppResponseOptions.d.ts b/sdks/node/types/model/apiAppResponseOptions.d.ts index 19814cffe..2b869e068 100644 --- a/sdks/node/types/model/apiAppResponseOptions.d.ts +++ b/sdks/node/types/model/apiAppResponseOptions.d.ts @@ -1,6 +1,6 @@ import { AttributeTypeMap } from "./"; export declare class ApiAppResponseOptions { - "canInsertEverywhere": boolean; + "canInsertEverywhere"?: boolean; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/apiAppResponseOwnerAccount.d.ts b/sdks/node/types/model/apiAppResponseOwnerAccount.d.ts index 4a415c72d..a1e4d7c5f 100644 --- a/sdks/node/types/model/apiAppResponseOwnerAccount.d.ts +++ b/sdks/node/types/model/apiAppResponseOwnerAccount.d.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "./"; export declare class ApiAppResponseOwnerAccount { - "accountId": string; - "emailAddress": string; + "accountId"?: string; + "emailAddress"?: string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/apiAppResponseWhiteLabelingOptions.d.ts b/sdks/node/types/model/apiAppResponseWhiteLabelingOptions.d.ts index ada78a6bc..67ce3d5e8 100644 --- a/sdks/node/types/model/apiAppResponseWhiteLabelingOptions.d.ts +++ b/sdks/node/types/model/apiAppResponseWhiteLabelingOptions.d.ts @@ -1,19 +1,19 @@ import { AttributeTypeMap } from "./"; export declare class ApiAppResponseWhiteLabelingOptions { - "headerBackgroundColor": string; - "legalVersion": string; - "linkColor": string; - "pageBackgroundColor": string; - "primaryButtonColor": string; - "primaryButtonColorHover": string; - "primaryButtonTextColor": string; - "primaryButtonTextColorHover": string; - "secondaryButtonColor": string; - "secondaryButtonColorHover": string; - "secondaryButtonTextColor": string; - "secondaryButtonTextColorHover": string; - "textColor1": string; - "textColor2": string; + "headerBackgroundColor"?: string; + "legalVersion"?: string; + "linkColor"?: string; + "pageBackgroundColor"?: string; + "primaryButtonColor"?: string; + "primaryButtonColorHover"?: string; + "primaryButtonTextColor"?: string; + "primaryButtonTextColorHover"?: string; + "secondaryButtonColor"?: string; + "secondaryButtonColorHover"?: string; + "secondaryButtonTextColor"?: string; + "secondaryButtonTextColorHover"?: string; + "textColor1"?: string; + "textColor2"?: string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/bulkSendJobResponse.d.ts b/sdks/node/types/model/bulkSendJobResponse.d.ts index 54ac0f889..11fa231bb 100644 --- a/sdks/node/types/model/bulkSendJobResponse.d.ts +++ b/sdks/node/types/model/bulkSendJobResponse.d.ts @@ -1,9 +1,9 @@ import { AttributeTypeMap } from "./"; export declare class BulkSendJobResponse { - "bulkSendJobId": string; - "total": number; - "isCreator": boolean; - "createdAt": number; + "bulkSendJobId"?: string | null; + "total"?: number; + "isCreator"?: boolean; + "createdAt"?: number; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/faxLineResponseFaxLine.d.ts b/sdks/node/types/model/faxLineResponseFaxLine.d.ts index 0a7f43ef1..d5f8c4aa7 100644 --- a/sdks/node/types/model/faxLineResponseFaxLine.d.ts +++ b/sdks/node/types/model/faxLineResponseFaxLine.d.ts @@ -1,10 +1,10 @@ import { AttributeTypeMap } from "./"; import { AccountResponse } from "./accountResponse"; export declare class FaxLineResponseFaxLine { - "number": string; - "createdAt": number; - "updatedAt": number; - "accounts": Array; + "number"?: string; + "createdAt"?: number; + "updatedAt"?: number; + "accounts"?: Array; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/teamResponse.d.ts b/sdks/node/types/model/teamResponse.d.ts index 40b654a8b..cb7861bd9 100644 --- a/sdks/node/types/model/teamResponse.d.ts +++ b/sdks/node/types/model/teamResponse.d.ts @@ -1,10 +1,10 @@ import { AttributeTypeMap } from "./"; import { AccountResponse } from "./accountResponse"; export declare class TeamResponse { - "name": string; - "accounts": Array; - "invitedAccounts": Array; - "invitedEmails": Array; + "name"?: string; + "accounts"?: Array; + "invitedAccounts"?: Array; + "invitedEmails"?: Array; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateCreateEmbeddedDraftResponseTemplate.d.ts b/sdks/node/types/model/templateCreateEmbeddedDraftResponseTemplate.d.ts index 124051aa9..7287dbec2 100644 --- a/sdks/node/types/model/templateCreateEmbeddedDraftResponseTemplate.d.ts +++ b/sdks/node/types/model/templateCreateEmbeddedDraftResponseTemplate.d.ts @@ -1,9 +1,9 @@ import { AttributeTypeMap } from "./"; import { WarningResponse } from "./warningResponse"; export declare class TemplateCreateEmbeddedDraftResponseTemplate { - "templateId": string; - "editUrl": string; - "expiresAt": number; + "templateId"?: string; + "editUrl"?: string; + "expiresAt"?: number; "warnings"?: Array; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/templateCreateResponseTemplate.d.ts b/sdks/node/types/model/templateCreateResponseTemplate.d.ts index 272ddeec1..cc5c4e9a6 100644 --- a/sdks/node/types/model/templateCreateResponseTemplate.d.ts +++ b/sdks/node/types/model/templateCreateResponseTemplate.d.ts @@ -1,6 +1,6 @@ import { AttributeTypeMap } from "./"; export declare class TemplateCreateResponseTemplate { - "templateId": string; + "templateId"?: string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponse.d.ts b/sdks/node/types/model/templateResponse.d.ts index a53df471b..b063aef16 100644 --- a/sdks/node/types/model/templateResponse.d.ts +++ b/sdks/node/types/model/templateResponse.d.ts @@ -7,22 +7,22 @@ import { TemplateResponseDocumentCustomFieldBase } from "./templateResponseDocum import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; import { TemplateResponseSignerRole } from "./templateResponseSignerRole"; export declare class TemplateResponse { - "templateId": string; - "title": string; - "message": string; - "isCreator": boolean; - "canEdit": boolean; - "isLocked": boolean; - "metadata": object; - "signerRoles": Array; - "ccRoles": Array; - "documents": Array; - "accounts": Array; - "attachments": Array; + "templateId"?: string; + "title"?: string; + "message"?: string; "updatedAt"?: number; "isEmbedded"?: boolean | null; + "isCreator"?: boolean; + "canEdit"?: boolean; + "isLocked"?: boolean; + "metadata"?: object; + "signerRoles"?: Array; + "ccRoles"?: Array; + "documents"?: Array; "customFields"?: Array | null; "namedFormFields"?: Array | null; + "accounts"?: Array; + "attachments"?: Array; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseAccount.d.ts b/sdks/node/types/model/templateResponseAccount.d.ts index e8995a23f..514cb2550 100644 --- a/sdks/node/types/model/templateResponseAccount.d.ts +++ b/sdks/node/types/model/templateResponseAccount.d.ts @@ -1,12 +1,12 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseAccountQuota } from "./templateResponseAccountQuota"; export declare class TemplateResponseAccount { - "accountId": string; - "isLocked": boolean; - "isPaidHs": boolean; - "isPaidHf": boolean; - "quotas": TemplateResponseAccountQuota; + "accountId"?: string; "emailAddress"?: string; + "isLocked"?: boolean; + "isPaidHs"?: boolean; + "isPaidHf"?: boolean; + "quotas"?: TemplateResponseAccountQuota; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseAccountQuota.d.ts b/sdks/node/types/model/templateResponseAccountQuota.d.ts index c5ae8ac28..e8ef0162f 100644 --- a/sdks/node/types/model/templateResponseAccountQuota.d.ts +++ b/sdks/node/types/model/templateResponseAccountQuota.d.ts @@ -1,9 +1,9 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseAccountQuota { - "templatesLeft": number; - "apiSignatureRequestsLeft": number; - "documentsLeft": number; - "smsVerificationsLeft": number; + "templatesLeft"?: number; + "apiSignatureRequestsLeft"?: number; + "documentsLeft"?: number; + "smsVerificationsLeft"?: number; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseCCRole.d.ts b/sdks/node/types/model/templateResponseCCRole.d.ts index a96c9497c..ebb6cd371 100644 --- a/sdks/node/types/model/templateResponseCCRole.d.ts +++ b/sdks/node/types/model/templateResponseCCRole.d.ts @@ -1,6 +1,6 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseCCRole { - "name": string; + "name"?: string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocument.d.ts b/sdks/node/types/model/templateResponseDocument.d.ts index 211537e77..c16b393ed 100644 --- a/sdks/node/types/model/templateResponseDocument.d.ts +++ b/sdks/node/types/model/templateResponseDocument.d.ts @@ -4,12 +4,12 @@ import { TemplateResponseDocumentFieldGroup } from "./templateResponseDocumentFi import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; export declare class TemplateResponseDocument { - "name": string; - "fieldGroups": Array; - "formFields": Array; - "customFields": Array; - "staticFields": Array; + "name"?: string; "index"?: number; + "fieldGroups"?: Array; + "formFields"?: Array; + "customFields"?: Array; + "staticFields"?: Array; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentCustomFieldBase.d.ts b/sdks/node/types/model/templateResponseDocumentCustomFieldBase.d.ts index b3acf15af..fa313114d 100644 --- a/sdks/node/types/model/templateResponseDocumentCustomFieldBase.d.ts +++ b/sdks/node/types/model/templateResponseDocumentCustomFieldBase.d.ts @@ -1,14 +1,14 @@ import { AttributeTypeMap } from "./"; export declare abstract class TemplateResponseDocumentCustomFieldBase { - "apiId": string; - "name": string; "type": string; - "x": number; - "y": number; - "width": number; - "height": number; - "required": boolean; + "apiId"?: string; + "name"?: string; "signer"?: number | string | null; + "x"?: number; + "y"?: number; + "width"?: number; + "height"?: number; + "required"?: boolean; "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentCustomFieldText.d.ts b/sdks/node/types/model/templateResponseDocumentCustomFieldText.d.ts index f7d28ac9e..b2d499e48 100644 --- a/sdks/node/types/model/templateResponseDocumentCustomFieldText.d.ts +++ b/sdks/node/types/model/templateResponseDocumentCustomFieldText.d.ts @@ -3,10 +3,10 @@ import { TemplateResponseDocumentCustomFieldBase } from "./templateResponseDocum import { TemplateResponseFieldAvgTextLength } from "./templateResponseFieldAvgTextLength"; export declare class TemplateResponseDocumentCustomFieldText extends TemplateResponseDocumentCustomFieldBase { "type": string; - "avgTextLength": TemplateResponseFieldAvgTextLength; - "isMultiline": boolean; - "originalFontSize": number; - "fontFamily": string; + "avgTextLength"?: TemplateResponseFieldAvgTextLength; + "isMultiline"?: boolean; + "originalFontSize"?: number; + "fontFamily"?: string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFieldGroup.d.ts b/sdks/node/types/model/templateResponseDocumentFieldGroup.d.ts index da714dbd4..d71655df9 100644 --- a/sdks/node/types/model/templateResponseDocumentFieldGroup.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFieldGroup.d.ts @@ -1,8 +1,8 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFieldGroupRule } from "./templateResponseDocumentFieldGroupRule"; export declare class TemplateResponseDocumentFieldGroup { - "name": string; - "rule": TemplateResponseDocumentFieldGroupRule; + "name"?: string; + "rule"?: TemplateResponseDocumentFieldGroupRule; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFieldGroupRule.d.ts b/sdks/node/types/model/templateResponseDocumentFieldGroupRule.d.ts index c3d444ca4..7f23a63d0 100644 --- a/sdks/node/types/model/templateResponseDocumentFieldGroupRule.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFieldGroupRule.d.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseDocumentFieldGroupRule { - "requirement": string; - "groupLabel": string; + "requirement"?: string; + "groupLabel"?: string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldBase.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldBase.d.ts index 935a559d8..f2ae3c899 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldBase.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldBase.d.ts @@ -1,14 +1,14 @@ import { AttributeTypeMap } from "./"; export declare abstract class TemplateResponseDocumentFormFieldBase { - "apiId": string; - "name": string; "type": string; - "signer": number | string; - "x": number; - "y": number; - "width": number; - "height": number; - "required": boolean; + "apiId"?: string; + "name"?: string; + "signer"?: number | string; + "x"?: number; + "y"?: number; + "width"?: number; + "height"?: number; + "required"?: boolean; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldHyperlink.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldHyperlink.d.ts index 26c826911..856574e09 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldHyperlink.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldHyperlink.d.ts @@ -3,10 +3,10 @@ import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumen import { TemplateResponseFieldAvgTextLength } from "./templateResponseFieldAvgTextLength"; export declare class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumentFormFieldBase { "type": string; - "avgTextLength": TemplateResponseFieldAvgTextLength; - "isMultiline": boolean; - "originalFontSize": number; - "fontFamily": string; + "avgTextLength"?: TemplateResponseFieldAvgTextLength; + "isMultiline"?: boolean; + "originalFontSize"?: number; + "fontFamily"?: string; "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldText.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldText.d.ts index aa1ab468b..5f6dcb4f1 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldText.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldText.d.ts @@ -3,10 +3,10 @@ import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumen import { TemplateResponseFieldAvgTextLength } from "./templateResponseFieldAvgTextLength"; export declare class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentFormFieldBase { "type": string; - "avgTextLength": TemplateResponseFieldAvgTextLength; - "isMultiline": boolean; - "originalFontSize": number; - "fontFamily": string; + "avgTextLength"?: TemplateResponseFieldAvgTextLength; + "isMultiline"?: boolean; + "originalFontSize"?: number; + "fontFamily"?: string; "validationType"?: TemplateResponseDocumentFormFieldText.ValidationTypeEnum; "group"?: string | null; static discriminator: string | undefined; diff --git a/sdks/node/types/model/templateResponseDocumentStaticFieldBase.d.ts b/sdks/node/types/model/templateResponseDocumentStaticFieldBase.d.ts index 2c38e129d..8120739cd 100644 --- a/sdks/node/types/model/templateResponseDocumentStaticFieldBase.d.ts +++ b/sdks/node/types/model/templateResponseDocumentStaticFieldBase.d.ts @@ -1,14 +1,14 @@ import { AttributeTypeMap } from "./"; export declare abstract class TemplateResponseDocumentStaticFieldBase { - "apiId": string; - "name": string; "type": string; - "signer": string; - "x": number; - "y": number; - "width": number; - "height": number; - "required": boolean; + "apiId"?: string; + "name"?: string; + "signer"?: string; + "x"?: number; + "y"?: number; + "width"?: number; + "height"?: number; + "required"?: boolean; "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseFieldAvgTextLength.d.ts b/sdks/node/types/model/templateResponseFieldAvgTextLength.d.ts index af926d77f..811eebeb5 100644 --- a/sdks/node/types/model/templateResponseFieldAvgTextLength.d.ts +++ b/sdks/node/types/model/templateResponseFieldAvgTextLength.d.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseFieldAvgTextLength { - "numLines": number; - "numCharsPerLine": number; + "numLines"?: number; + "numCharsPerLine"?: number; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseSignerRole.d.ts b/sdks/node/types/model/templateResponseSignerRole.d.ts index 27ca5435b..ce2cf439d 100644 --- a/sdks/node/types/model/templateResponseSignerRole.d.ts +++ b/sdks/node/types/model/templateResponseSignerRole.d.ts @@ -1,6 +1,6 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseSignerRole { - "name": string; + "name"?: string; "order"?: number; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/templateUpdateFilesResponseTemplate.d.ts b/sdks/node/types/model/templateUpdateFilesResponseTemplate.d.ts index 978f5030c..b7852797c 100644 --- a/sdks/node/types/model/templateUpdateFilesResponseTemplate.d.ts +++ b/sdks/node/types/model/templateUpdateFilesResponseTemplate.d.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "./"; import { WarningResponse } from "./warningResponse"; export declare class TemplateUpdateFilesResponseTemplate { - "templateId": string; + "templateId"?: string; "warnings"?: Array; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/php/docs/Model/ApiAppResponse.md b/sdks/php/docs/Model/ApiAppResponse.md index 389d4f22d..975df4b5c 100644 --- a/sdks/php/docs/Model/ApiAppResponse.md +++ b/sdks/php/docs/Model/ApiAppResponse.md @@ -6,15 +6,15 @@ Contains information about an API App. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id`*_required_ | ```string``` | The app's client id | | -| `created_at`*_required_ | ```int``` | The time that the app was created | | -| `domains`*_required_ | ```string[]``` | The domain name(s) associated with the app | | -| `name`*_required_ | ```string``` | The name of the app | | -| `is_approved`*_required_ | ```bool``` | Boolean to indicate if the app has been approved | | -| `options`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | -| `owner_account`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `callback_url` | ```string``` | The app's callback URL (for events) | | +| `client_id` | ```string``` | The app's client id | | +| `created_at` | ```int``` | The time that the app was created | | +| `domains` | ```string[]``` | The domain name(s) associated with the app | | +| `name` | ```string``` | The name of the app | | +| `is_approved` | ```bool``` | Boolean to indicate if the app has been approved | | | `oauth` | [```\Dropbox\Sign\Model\ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | +| `options` | [```\Dropbox\Sign\Model\ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | +| `owner_account` | [```\Dropbox\Sign\Model\ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `white_labeling_options` | [```\Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | | [[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/ApiAppResponseOAuth.md b/sdks/php/docs/Model/ApiAppResponseOAuth.md index b6b938d1f..f6010fe20 100644 --- a/sdks/php/docs/Model/ApiAppResponseOAuth.md +++ b/sdks/php/docs/Model/ApiAppResponseOAuth.md @@ -6,9 +6,9 @@ An object describing the app's OAuth properties, or null if OAuth is not con Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url`*_required_ | ```string``` | The app's OAuth callback URL. | | -| `scopes`*_required_ | ```string[]``` | Array of OAuth scopes used by the app. | | -| `charges_users`*_required_ | ```bool``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | +| `callback_url` | ```string``` | The app's OAuth callback URL. | | | `secret` | ```string``` | The app's OAuth secret, or null if the app does not belong to user. | | +| `scopes` | ```string[]``` | Array of OAuth scopes used by the app. | | +| `charges_users` | ```bool``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | [[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/ApiAppResponseOptions.md b/sdks/php/docs/Model/ApiAppResponseOptions.md index 7aa892f36..872e8ed0f 100644 --- a/sdks/php/docs/Model/ApiAppResponseOptions.md +++ b/sdks/php/docs/Model/ApiAppResponseOptions.md @@ -6,6 +6,6 @@ An object with options that override account settings. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `can_insert_everywhere`*_required_ | ```bool``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `can_insert_everywhere` | ```bool``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | [[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/ApiAppResponseOwnerAccount.md b/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md index 2d3a9256d..8f1ce1963 100644 --- a/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md +++ b/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md @@ -6,7 +6,7 @@ An object describing the app's owner Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id`*_required_ | ```string``` | The owner account's ID | | -| `email_address`*_required_ | ```string``` | The owner account's email address | | +| `account_id` | ```string``` | The owner account's ID | | +| `email_address` | ```string``` | The owner account's email address | | [[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/ApiAppResponseWhiteLabelingOptions.md b/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md index 49b3472b6..6e963383c 100644 --- a/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md @@ -6,19 +6,19 @@ An object with options to customize the app's signer page Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `header_background_color`*_required_ | ```string``` | | | -| `legal_version`*_required_ | ```string``` | | | -| `link_color`*_required_ | ```string``` | | | -| `page_background_color`*_required_ | ```string``` | | | -| `primary_button_color`*_required_ | ```string``` | | | -| `primary_button_color_hover`*_required_ | ```string``` | | | -| `primary_button_text_color`*_required_ | ```string``` | | | -| `primary_button_text_color_hover`*_required_ | ```string``` | | | -| `secondary_button_color`*_required_ | ```string``` | | | -| `secondary_button_color_hover`*_required_ | ```string``` | | | -| `secondary_button_text_color`*_required_ | ```string``` | | | -| `secondary_button_text_color_hover`*_required_ | ```string``` | | | -| `text_color1`*_required_ | ```string``` | | | -| `text_color2`*_required_ | ```string``` | | | +| `header_background_color` | ```string``` | | | +| `legal_version` | ```string``` | | | +| `link_color` | ```string``` | | | +| `page_background_color` | ```string``` | | | +| `primary_button_color` | ```string``` | | | +| `primary_button_color_hover` | ```string``` | | | +| `primary_button_text_color` | ```string``` | | | +| `primary_button_text_color_hover` | ```string``` | | | +| `secondary_button_color` | ```string``` | | | +| `secondary_button_color_hover` | ```string``` | | | +| `secondary_button_text_color` | ```string``` | | | +| `secondary_button_text_color_hover` | ```string``` | | | +| `text_color1` | ```string``` | | | +| `text_color2` | ```string``` | | | [[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/BulkSendJobResponse.md b/sdks/php/docs/Model/BulkSendJobResponse.md index 068d98bad..16194fdd3 100644 --- a/sdks/php/docs/Model/BulkSendJobResponse.md +++ b/sdks/php/docs/Model/BulkSendJobResponse.md @@ -6,9 +6,9 @@ Contains information about the BulkSendJob such as when it was created and how m Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_job_id`*_required_ | ```string``` | The id of the BulkSendJob. | | -| `total`*_required_ | ```int``` | The total amount of Signature Requests queued for sending. | | -| `is_creator`*_required_ | ```bool``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `created_at`*_required_ | ```int``` | Time that the BulkSendJob was created. | | +| `bulk_send_job_id` | ```string``` | The id of the BulkSendJob. | | +| `total` | ```int``` | The total amount of Signature Requests queued for sending. | | +| `is_creator` | ```bool``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | +| `created_at` | ```int``` | Time that the BulkSendJob was created. | | [[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/FaxLineResponseFaxLine.md b/sdks/php/docs/Model/FaxLineResponseFaxLine.md index b9865f1fd..51f479adc 100644 --- a/sdks/php/docs/Model/FaxLineResponseFaxLine.md +++ b/sdks/php/docs/Model/FaxLineResponseFaxLine.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | Number | | -| `created_at`*_required_ | ```int``` | Created at | | -| `updated_at`*_required_ | ```int``` | Updated at | | -| `accounts`*_required_ | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | | +| `number` | ```string``` | Number | | +| `created_at` | ```int``` | Created at | | +| `updated_at` | ```int``` | Updated at | | +| `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | | [[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/TeamResponse.md b/sdks/php/docs/Model/TeamResponse.md index 926e6e00c..4aea582c9 100644 --- a/sdks/php/docs/Model/TeamResponse.md +++ b/sdks/php/docs/Model/TeamResponse.md @@ -6,9 +6,9 @@ Contains information about your team and its members Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of your Team | | -| `accounts`*_required_ | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | | -| `invited_accounts`*_required_ | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | -| `invited_emails`*_required_ | ```string[]``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `name` | ```string``` | The name of your Team | | +| `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | | +| `invited_accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | +| `invited_emails` | ```string[]``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | [[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/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md index 0f30e6698..7604fd299 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -6,9 +6,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id`*_required_ | ```string``` | The id of the Template. | | -| `edit_url`*_required_ | ```string``` | Link to edit the template. | | -| `expires_at`*_required_ | ```int``` | When the link expires. | | +| `template_id` | ```string``` | The id of the Template. | | +| `edit_url` | ```string``` | Link to edit the template. | | +| `expires_at` | ```int``` | When the link expires. | | | `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[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/TemplateCreateResponseTemplate.md b/sdks/php/docs/Model/TemplateCreateResponseTemplate.md index 5942ecc07..0f25586c5 100644 --- a/sdks/php/docs/Model/TemplateCreateResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateCreateResponseTemplate.md @@ -6,6 +6,6 @@ Template object with parameters: `template_id`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id`*_required_ | ```string``` | The id of the Template. | | +| `template_id` | ```string``` | The id of the Template. | | [[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/TemplateResponse.md b/sdks/php/docs/Model/TemplateResponse.md index 69ea1cc2b..39a8ed303 100644 --- a/sdks/php/docs/Model/TemplateResponse.md +++ b/sdks/php/docs/Model/TemplateResponse.md @@ -6,21 +6,21 @@ Contains information about the templates you and your team have created. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id`*_required_ | ```string``` | The id of the Template. | | -| `title`*_required_ | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message`*_required_ | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `is_creator`*_required_ | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `can_edit`*_required_ | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `is_locked`*_required_ | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata`*_required_ | ```array``` | The metadata attached to the template. | | -| `signer_roles`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseSignerRole[]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `cc_roles`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseCCRole[]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocument[]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | -| `accounts`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | -| `attachments`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `template_id` | ```string``` | The id of the Template. | | +| `title` | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message` | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | | `updated_at` | ```int``` | Time the template was last updated. | | | `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | +| `is_creator` | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `can_edit` | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `is_locked` | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata` | ```array``` | The metadata attached to the template. | | +| `signer_roles` | [```\Dropbox\Sign\Model\TemplateResponseSignerRole[]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `cc_roles` | [```\Dropbox\Sign\Model\TemplateResponseCCRole[]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | +| `documents` | [```\Dropbox\Sign\Model\TemplateResponseDocument[]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | +| `accounts` | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | [[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/TemplateResponseAccount.md b/sdks/php/docs/Model/TemplateResponseAccount.md index 4b7e24197..fb9563bbc 100644 --- a/sdks/php/docs/Model/TemplateResponseAccount.md +++ b/sdks/php/docs/Model/TemplateResponseAccount.md @@ -6,11 +6,11 @@ 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\TemplateResponseAccountQuota```](TemplateResponseAccountQuota.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\TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | [[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/TemplateResponseAccountQuota.md b/sdks/php/docs/Model/TemplateResponseAccountQuota.md index 9002f1f57..7b106a9ac 100644 --- a/sdks/php/docs/Model/TemplateResponseAccountQuota.md +++ b/sdks/php/docs/Model/TemplateResponseAccountQuota.md @@ -6,9 +6,9 @@ An array of the designated CC roles that must be specified when sending a Signat Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates_left`*_required_ | ```int``` | API templates remaining. | | -| `api_signature_requests_left`*_required_ | ```int``` | API signature requests remaining. | | -| `documents_left`*_required_ | ```int``` | Signature requests remaining. | | -| `sms_verifications_left`*_required_ | ```int``` | SMS verifications remaining. | | +| `templates_left` | ```int``` | API templates remaining. | | +| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | +| `documents_left` | ```int``` | Signature requests remaining. | | +| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | [[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/TemplateResponseCCRole.md b/sdks/php/docs/Model/TemplateResponseCCRole.md index 74c81b18d..32ad82ef9 100644 --- a/sdks/php/docs/Model/TemplateResponseCCRole.md +++ b/sdks/php/docs/Model/TemplateResponseCCRole.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of the Role. | | +| `name` | ```string``` | The name of the Role. | | [[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/TemplateResponseDocument.md b/sdks/php/docs/Model/TemplateResponseDocument.md index 0d8420597..ab0518d3a 100644 --- a/sdks/php/docs/Model/TemplateResponseDocument.md +++ b/sdks/php/docs/Model/TemplateResponseDocument.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | Name of the associated file. | | -| `field_groups`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `form_fields`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `custom_fields`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `static_fields`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | +| `name` | ```string``` | Name of the associated file. | | | `index` | ```int``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | +| `field_groups` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `static_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | [[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/TemplateResponseDocumentCustomFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md index 2217892e4..47b5bad52 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md @@ -6,15 +6,15 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_id`*_required_ | ```string``` | The unique ID for this field. | | -| `name`*_required_ | ```string``` | The name of the Custom Field. | | | `type`*_required_ | ```string``` | | | -| `x`*_required_ | ```int``` | The horizontal offset in pixels for this form field. | | -| `y`*_required_ | ```int``` | The vertical offset in pixels for this form field. | | -| `width`*_required_ | ```int``` | The width in pixels of this form field. | | -| `height`*_required_ | ```int``` | The height in pixels of this form field. | | -| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | +| `api_id` | ```string``` | The unique ID for this field. | | +| `name` | ```string``` | The name of the Custom Field. | | | `signer` | ```string``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | +| `x` | ```int``` | The horizontal offset in pixels for this form field. | | +| `y` | ```int``` | The vertical offset in pixels for this form field. | | +| `width` | ```int``` | The width in pixels of this form field. | | +| `height` | ```int``` | The height in pixels of this form field. | | +| `required` | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseDocumentCustomFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md index 147490139..68e40af6b 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md @@ -7,9 +7,9 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | -| `avg_text_length`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | -| `font_family`*_required_ | ```string``` | Font family used in this form field's text. | | +| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size` | ```int``` | Original font size used in this form field's text. | | +| `font_family` | ```string``` | Font family used in this form field's text. | | [[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/TemplateResponseDocumentFieldGroup.md b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md index 4f74407c5..233352654 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of the form field group. | | -| `rule`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name` | ```string``` | The name of the form field group. | | +| `rule` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | [[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/TemplateResponseDocumentFieldGroupRule.md b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md index b105c7ae2..ad79e834e 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md @@ -6,7 +6,7 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `requirement`*_required_ | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `group_label`*_required_ | ```string``` | Name of the group | | +| `requirement` | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `group_label` | ```string``` | Name of the group | | [[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/TemplateResponseDocumentFormFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md index 867ed2bef..f792fdfed 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md @@ -6,14 +6,14 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_id`*_required_ | ```string``` | A unique id for the form field. | | -| `name`*_required_ | ```string``` | The name of the form field. | | | `type`*_required_ | ```string``` | | | -| `signer`*_required_ | ```string``` | The signer of the Form Field. | | -| `x`*_required_ | ```int``` | The horizontal offset in pixels for this form field. | | -| `y`*_required_ | ```int``` | The vertical offset in pixels for this form field. | | -| `width`*_required_ | ```int``` | The width in pixels of this form field. | | -| `height`*_required_ | ```int``` | The height in pixels of this form field. | | -| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | +| `api_id` | ```string``` | A unique id for the form field. | | +| `name` | ```string``` | The name of the form field. | | +| `signer` | ```string``` | The signer of the Form Field. | | +| `x` | ```int``` | The horizontal offset in pixels for this form field. | | +| `y` | ```int``` | The vertical offset in pixels for this form field. | | +| `width` | ```int``` | The width in pixels of this form field. | | +| `height` | ```int``` | The height in pixels of this form field. | | +| `required` | ```bool``` | Boolean showing whether or not this field is required. | | [[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/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md index c009374a8..ce0ff23b5 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md @@ -7,10 +7,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | -| `avg_text_length`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | -| `font_family`*_required_ | ```string``` | Font family used in this form field's text. | | +| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size` | ```int``` | Original font size used in this form field's text. | | +| `font_family` | ```string``` | Font family used in this form field's text. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md index 1bef226d5..e6af0e041 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md @@ -7,10 +7,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | -| `avg_text_length`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | -| `font_family`*_required_ | ```string``` | Font family used in this form field's text. | | +| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size` | ```int``` | Original font size used in this form field's text. | | +| `font_family` | ```string``` | Font family used in this form field's text. | | | `validation_type` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md index 3e681c640..3a7a044a4 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md @@ -6,15 +6,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_id`*_required_ | ```string``` | A unique id for the static field. | | -| `name`*_required_ | ```string``` | The name of the static field. | | | `type`*_required_ | ```string``` | | | -| `signer`*_required_ | ```string``` | The signer of the Static Field. | [default to 'me_now'] | -| `x`*_required_ | ```int``` | The horizontal offset in pixels for this static field. | | -| `y`*_required_ | ```int``` | The vertical offset in pixels for this static field. | | -| `width`*_required_ | ```int``` | The width in pixels of this static field. | | -| `height`*_required_ | ```int``` | The height in pixels of this static field. | | -| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | +| `api_id` | ```string``` | A unique id for the static field. | | +| `name` | ```string``` | The name of the static field. | | +| `signer` | ```string``` | The signer of the Static Field. | [default to 'me_now'] | +| `x` | ```int``` | The horizontal offset in pixels for this static field. | | +| `y` | ```int``` | The vertical offset in pixels for this static field. | | +| `width` | ```int``` | The width in pixels of this static field. | | +| `height` | ```int``` | The height in pixels of this static field. | | +| `required` | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseFieldAvgTextLength.md b/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md index a1fbc0898..b9db83c57 100644 --- a/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md +++ b/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md @@ -6,7 +6,7 @@ Average text length in this field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `num_lines`*_required_ | ```int``` | Number of lines. | | -| `num_chars_per_line`*_required_ | ```int``` | Number of characters per line. | | +| `num_lines` | ```int``` | Number of lines. | | +| `num_chars_per_line` | ```int``` | Number of characters per line. | | [[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/TemplateResponseSignerRole.md b/sdks/php/docs/Model/TemplateResponseSignerRole.md index 1881eb0b3..fdf2f15d0 100644 --- a/sdks/php/docs/Model/TemplateResponseSignerRole.md +++ b/sdks/php/docs/Model/TemplateResponseSignerRole.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of the Role. | | +| `name` | ```string``` | The name of the Role. | | | `order` | ```int``` | If signer order is assigned this is the 0-based index for this role. | | [[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/TemplateUpdateFilesResponseTemplate.md b/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md index ec5f1db4b..b8fb3f5c2 100644 --- a/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md @@ -6,7 +6,7 @@ Contains template id Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id`*_required_ | ```string``` | The id of the Template. | | +| `template_id` | ```string``` | The id of the Template. | | | `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[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/ApiAppResponse.php b/sdks/php/src/Model/ApiAppResponse.php index 886069fcf..3e214031d 100644 --- a/sdks/php/src/Model/ApiAppResponse.php +++ b/sdks/php/src/Model/ApiAppResponse.php @@ -58,15 +58,15 @@ class ApiAppResponse implements ModelInterface, ArrayAccess, JsonSerializable * @var string[] */ protected static $openAPITypes = [ + 'callback_url' => 'string', 'client_id' => 'string', 'created_at' => 'int', 'domains' => 'string[]', 'name' => 'string', 'is_approved' => 'bool', + 'oauth' => '\Dropbox\Sign\Model\ApiAppResponseOAuth', 'options' => '\Dropbox\Sign\Model\ApiAppResponseOptions', 'owner_account' => '\Dropbox\Sign\Model\ApiAppResponseOwnerAccount', - 'callback_url' => 'string', - 'oauth' => '\Dropbox\Sign\Model\ApiAppResponseOAuth', 'white_labeling_options' => '\Dropbox\Sign\Model\ApiAppResponseWhiteLabelingOptions', ]; @@ -78,15 +78,15 @@ class ApiAppResponse implements ModelInterface, ArrayAccess, JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ + 'callback_url' => null, 'client_id' => null, 'created_at' => null, 'domains' => null, 'name' => null, 'is_approved' => null, + 'oauth' => null, 'options' => null, 'owner_account' => null, - 'callback_url' => null, - 'oauth' => null, 'white_labeling_options' => null, ]; @@ -96,15 +96,15 @@ class ApiAppResponse implements ModelInterface, ArrayAccess, JsonSerializable * @var bool[] */ protected static array $openAPINullables = [ + 'callback_url' => true, 'client_id' => false, 'created_at' => false, 'domains' => false, 'name' => false, 'is_approved' => false, - 'options' => false, - 'owner_account' => false, - 'callback_url' => true, 'oauth' => true, + 'options' => true, + 'owner_account' => false, 'white_labeling_options' => true, ]; @@ -186,15 +186,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ + 'callback_url' => 'callback_url', 'client_id' => 'client_id', 'created_at' => 'created_at', 'domains' => 'domains', 'name' => 'name', 'is_approved' => 'is_approved', + 'oauth' => 'oauth', 'options' => 'options', 'owner_account' => 'owner_account', - 'callback_url' => 'callback_url', - 'oauth' => 'oauth', 'white_labeling_options' => 'white_labeling_options', ]; @@ -204,15 +204,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ + 'callback_url' => 'setCallbackUrl', 'client_id' => 'setClientId', 'created_at' => 'setCreatedAt', 'domains' => 'setDomains', 'name' => 'setName', 'is_approved' => 'setIsApproved', + 'oauth' => 'setOauth', 'options' => 'setOptions', 'owner_account' => 'setOwnerAccount', - 'callback_url' => 'setCallbackUrl', - 'oauth' => 'setOauth', 'white_labeling_options' => 'setWhiteLabelingOptions', ]; @@ -222,15 +222,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ + 'callback_url' => 'getCallbackUrl', 'client_id' => 'getClientId', 'created_at' => 'getCreatedAt', 'domains' => 'getDomains', 'name' => 'getName', 'is_approved' => 'getIsApproved', + 'oauth' => 'getOauth', 'options' => 'getOptions', 'owner_account' => 'getOwnerAccount', - 'callback_url' => 'getCallbackUrl', - 'oauth' => 'getOauth', 'white_labeling_options' => 'getWhiteLabelingOptions', ]; @@ -290,15 +290,15 @@ public function getModelName() */ public function __construct(array $data = null) { + $this->setIfExists('callback_url', $data ?? [], null); $this->setIfExists('client_id', $data ?? [], null); $this->setIfExists('created_at', $data ?? [], null); $this->setIfExists('domains', $data ?? [], null); $this->setIfExists('name', $data ?? [], null); $this->setIfExists('is_approved', $data ?? [], null); + $this->setIfExists('oauth', $data ?? [], null); $this->setIfExists('options', $data ?? [], null); $this->setIfExists('owner_account', $data ?? [], null); - $this->setIfExists('callback_url', $data ?? [], null); - $this->setIfExists('oauth', $data ?? [], null); $this->setIfExists('white_labeling_options', $data ?? [], null); } @@ -345,30 +345,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['client_id'] === null) { - $invalidProperties[] = "'client_id' can't be null"; - } - if ($this->container['created_at'] === null) { - $invalidProperties[] = "'created_at' can't be null"; - } - if ($this->container['domains'] === null) { - $invalidProperties[] = "'domains' can't be null"; - } - if ($this->container['name'] === null) { - $invalidProperties[] = "'name' can't be null"; - } - if ($this->container['is_approved'] === null) { - $invalidProperties[] = "'is_approved' can't be null"; - } - if ($this->container['options'] === null) { - $invalidProperties[] = "'options' can't be null"; - } - if ($this->container['owner_account'] === null) { - $invalidProperties[] = "'owner_account' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -382,10 +359,44 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** + * Gets callback_url + * + * @return string|null + */ + public function getCallbackUrl() + { + return $this->container['callback_url']; + } + + /** + * Sets callback_url + * + * @param string|null $callback_url The app's callback URL (for events) + * + * @return self + */ + public function setCallbackUrl(?string $callback_url) + { + if (is_null($callback_url)) { + array_push($this->openAPINullablesSetToNull, 'callback_url'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('callback_url', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['callback_url'] = $callback_url; + + return $this; + } + /** * Gets client_id * - * @return string + * @return string|null */ public function getClientId() { @@ -395,11 +406,11 @@ public function getClientId() /** * Sets client_id * - * @param string $client_id The app's client id + * @param string|null $client_id The app's client id * * @return self */ - public function setClientId(string $client_id) + public function setClientId(?string $client_id) { if (is_null($client_id)) { throw new InvalidArgumentException('non-nullable client_id cannot be null'); @@ -412,7 +423,7 @@ public function setClientId(string $client_id) /** * Gets created_at * - * @return int + * @return int|null */ public function getCreatedAt() { @@ -422,11 +433,11 @@ public function getCreatedAt() /** * Sets created_at * - * @param int $created_at The time that the app was created + * @param int|null $created_at The time that the app was created * * @return self */ - public function setCreatedAt(int $created_at) + public function setCreatedAt(?int $created_at) { if (is_null($created_at)) { throw new InvalidArgumentException('non-nullable created_at cannot be null'); @@ -439,7 +450,7 @@ public function setCreatedAt(int $created_at) /** * Gets domains * - * @return string[] + * @return string[]|null */ public function getDomains() { @@ -449,11 +460,11 @@ public function getDomains() /** * Sets domains * - * @param string[] $domains The domain name(s) associated with the app + * @param string[]|null $domains The domain name(s) associated with the app * * @return self */ - public function setDomains(array $domains) + public function setDomains(?array $domains) { if (is_null($domains)) { throw new InvalidArgumentException('non-nullable domains cannot be null'); @@ -466,7 +477,7 @@ public function setDomains(array $domains) /** * Gets name * - * @return string + * @return string|null */ public function getName() { @@ -476,11 +487,11 @@ public function getName() /** * Sets name * - * @param string $name The name of the app + * @param string|null $name The name of the app * * @return self */ - public function setName(string $name) + public function setName(?string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); @@ -493,7 +504,7 @@ public function setName(string $name) /** * Gets is_approved * - * @return bool + * @return bool|null */ public function getIsApproved() { @@ -503,11 +514,11 @@ public function getIsApproved() /** * Sets is_approved * - * @param bool $is_approved Boolean to indicate if the app has been approved + * @param bool|null $is_approved Boolean to indicate if the app has been approved * * @return self */ - public function setIsApproved(bool $is_approved) + public function setIsApproved(?bool $is_approved) { if (is_null($is_approved)) { throw new InvalidArgumentException('non-nullable is_approved cannot be null'); @@ -518,123 +529,96 @@ public function setIsApproved(bool $is_approved) } /** - * Gets options - * - * @return ApiAppResponseOptions - */ - public function getOptions() - { - return $this->container['options']; - } - - /** - * Sets options - * - * @param ApiAppResponseOptions $options options - * - * @return self - */ - public function setOptions(ApiAppResponseOptions $options) - { - if (is_null($options)) { - throw new InvalidArgumentException('non-nullable options cannot be null'); - } - $this->container['options'] = $options; - - return $this; - } - - /** - * Gets owner_account + * Gets oauth * - * @return ApiAppResponseOwnerAccount + * @return ApiAppResponseOAuth|null */ - public function getOwnerAccount() + public function getOauth() { - return $this->container['owner_account']; + return $this->container['oauth']; } /** - * Sets owner_account + * Sets oauth * - * @param ApiAppResponseOwnerAccount $owner_account owner_account + * @param ApiAppResponseOAuth|null $oauth oauth * * @return self */ - public function setOwnerAccount(ApiAppResponseOwnerAccount $owner_account) + public function setOauth(?ApiAppResponseOAuth $oauth) { - if (is_null($owner_account)) { - throw new InvalidArgumentException('non-nullable owner_account cannot be null'); + if (is_null($oauth)) { + array_push($this->openAPINullablesSetToNull, 'oauth'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('oauth', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } } - $this->container['owner_account'] = $owner_account; + $this->container['oauth'] = $oauth; return $this; } /** - * Gets callback_url + * Gets options * - * @return string|null + * @return ApiAppResponseOptions|null */ - public function getCallbackUrl() + public function getOptions() { - return $this->container['callback_url']; + return $this->container['options']; } /** - * Sets callback_url + * Sets options * - * @param string|null $callback_url The app's callback URL (for events) + * @param ApiAppResponseOptions|null $options options * * @return self */ - public function setCallbackUrl(?string $callback_url) + public function setOptions(?ApiAppResponseOptions $options) { - if (is_null($callback_url)) { - array_push($this->openAPINullablesSetToNull, 'callback_url'); + if (is_null($options)) { + array_push($this->openAPINullablesSetToNull, 'options'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('callback_url', $nullablesSetToNull); + $index = array_search('options', $nullablesSetToNull); if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } } - $this->container['callback_url'] = $callback_url; + $this->container['options'] = $options; return $this; } /** - * Gets oauth + * Gets owner_account * - * @return ApiAppResponseOAuth|null + * @return ApiAppResponseOwnerAccount|null */ - public function getOauth() + public function getOwnerAccount() { - return $this->container['oauth']; + return $this->container['owner_account']; } /** - * Sets oauth + * Sets owner_account * - * @param ApiAppResponseOAuth|null $oauth oauth + * @param ApiAppResponseOwnerAccount|null $owner_account owner_account * * @return self */ - public function setOauth(?ApiAppResponseOAuth $oauth) + public function setOwnerAccount(?ApiAppResponseOwnerAccount $owner_account) { - if (is_null($oauth)) { - array_push($this->openAPINullablesSetToNull, 'oauth'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('oauth', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + if (is_null($owner_account)) { + throw new InvalidArgumentException('non-nullable owner_account cannot be null'); } - $this->container['oauth'] = $oauth; + $this->container['owner_account'] = $owner_account; return $this; } diff --git a/sdks/php/src/Model/ApiAppResponseOAuth.php b/sdks/php/src/Model/ApiAppResponseOAuth.php index 0c7a3a08e..ac2ecf08b 100644 --- a/sdks/php/src/Model/ApiAppResponseOAuth.php +++ b/sdks/php/src/Model/ApiAppResponseOAuth.php @@ -59,9 +59,9 @@ class ApiAppResponseOAuth implements ModelInterface, ArrayAccess, JsonSerializab */ protected static $openAPITypes = [ 'callback_url' => 'string', + 'secret' => 'string', 'scopes' => 'string[]', 'charges_users' => 'bool', - 'secret' => 'string', ]; /** @@ -73,9 +73,9 @@ class ApiAppResponseOAuth implements ModelInterface, ArrayAccess, JsonSerializab */ protected static $openAPIFormats = [ 'callback_url' => null, + 'secret' => null, 'scopes' => null, 'charges_users' => null, - 'secret' => null, ]; /** @@ -85,9 +85,9 @@ class ApiAppResponseOAuth implements ModelInterface, ArrayAccess, JsonSerializab */ protected static array $openAPINullables = [ 'callback_url' => false, + 'secret' => true, 'scopes' => false, 'charges_users' => false, - 'secret' => true, ]; /** @@ -169,9 +169,9 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'callback_url' => 'callback_url', + 'secret' => 'secret', 'scopes' => 'scopes', 'charges_users' => 'charges_users', - 'secret' => 'secret', ]; /** @@ -181,9 +181,9 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'callback_url' => 'setCallbackUrl', + 'secret' => 'setSecret', 'scopes' => 'setScopes', 'charges_users' => 'setChargesUsers', - 'secret' => 'setSecret', ]; /** @@ -193,9 +193,9 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'callback_url' => 'getCallbackUrl', + 'secret' => 'getSecret', 'scopes' => 'getScopes', 'charges_users' => 'getChargesUsers', - 'secret' => 'getSecret', ]; /** @@ -255,9 +255,9 @@ public function getModelName() public function __construct(array $data = null) { $this->setIfExists('callback_url', $data ?? [], null); + $this->setIfExists('secret', $data ?? [], null); $this->setIfExists('scopes', $data ?? [], null); $this->setIfExists('charges_users', $data ?? [], null); - $this->setIfExists('secret', $data ?? [], null); } /** @@ -303,18 +303,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['callback_url'] === null) { - $invalidProperties[] = "'callback_url' can't be null"; - } - if ($this->container['scopes'] === null) { - $invalidProperties[] = "'scopes' can't be null"; - } - if ($this->container['charges_users'] === null) { - $invalidProperties[] = "'charges_users' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -331,7 +320,7 @@ public function valid() /** * Gets callback_url * - * @return string + * @return string|null */ public function getCallbackUrl() { @@ -341,11 +330,11 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string $callback_url the app's OAuth callback URL + * @param string|null $callback_url the app's OAuth callback URL * * @return self */ - public function setCallbackUrl(string $callback_url) + public function setCallbackUrl(?string $callback_url) { if (is_null($callback_url)) { throw new InvalidArgumentException('non-nullable callback_url cannot be null'); @@ -356,89 +345,89 @@ public function setCallbackUrl(string $callback_url) } /** - * Gets scopes + * Gets secret * - * @return string[] + * @return string|null */ - public function getScopes() + public function getSecret() { - return $this->container['scopes']; + return $this->container['secret']; } /** - * Sets scopes + * Sets secret * - * @param string[] $scopes array of OAuth scopes used by the app + * @param string|null $secret the app's OAuth secret, or null if the app does not belong to user * * @return self */ - public function setScopes(array $scopes) + public function setSecret(?string $secret) { - if (is_null($scopes)) { - throw new InvalidArgumentException('non-nullable scopes cannot be null'); + if (is_null($secret)) { + array_push($this->openAPINullablesSetToNull, 'secret'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('secret', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } } - $this->container['scopes'] = $scopes; + $this->container['secret'] = $secret; return $this; } /** - * Gets charges_users + * Gets scopes * - * @return bool + * @return string[]|null */ - public function getChargesUsers() + public function getScopes() { - return $this->container['charges_users']; + return $this->container['scopes']; } /** - * Sets charges_users + * Sets scopes * - * @param bool $charges_users boolean indicating whether the app owner or the account granting permission is billed for OAuth requests + * @param string[]|null $scopes array of OAuth scopes used by the app * * @return self */ - public function setChargesUsers(bool $charges_users) + public function setScopes(?array $scopes) { - if (is_null($charges_users)) { - throw new InvalidArgumentException('non-nullable charges_users cannot be null'); + if (is_null($scopes)) { + throw new InvalidArgumentException('non-nullable scopes cannot be null'); } - $this->container['charges_users'] = $charges_users; + $this->container['scopes'] = $scopes; return $this; } /** - * Gets secret + * Gets charges_users * - * @return string|null + * @return bool|null */ - public function getSecret() + public function getChargesUsers() { - return $this->container['secret']; + return $this->container['charges_users']; } /** - * Sets secret + * Sets charges_users * - * @param string|null $secret the app's OAuth secret, or null if the app does not belong to user + * @param bool|null $charges_users boolean indicating whether the app owner or the account granting permission is billed for OAuth requests * * @return self */ - public function setSecret(?string $secret) + public function setChargesUsers(?bool $charges_users) { - if (is_null($secret)) { - array_push($this->openAPINullablesSetToNull, 'secret'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('secret', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + if (is_null($charges_users)) { + throw new InvalidArgumentException('non-nullable charges_users cannot be null'); } - $this->container['secret'] = $secret; + $this->container['charges_users'] = $charges_users; return $this; } diff --git a/sdks/php/src/Model/ApiAppResponseOptions.php b/sdks/php/src/Model/ApiAppResponseOptions.php index af4718a13..99c11f02a 100644 --- a/sdks/php/src/Model/ApiAppResponseOptions.php +++ b/sdks/php/src/Model/ApiAppResponseOptions.php @@ -282,12 +282,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['can_insert_everywhere'] === null) { - $invalidProperties[] = "'can_insert_everywhere' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -304,7 +299,7 @@ public function valid() /** * Gets can_insert_everywhere * - * @return bool + * @return bool|null */ public function getCanInsertEverywhere() { @@ -314,11 +309,11 @@ public function getCanInsertEverywhere() /** * Sets can_insert_everywhere * - * @param bool $can_insert_everywhere Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document + * @param bool|null $can_insert_everywhere Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document * * @return self */ - public function setCanInsertEverywhere(bool $can_insert_everywhere) + public function setCanInsertEverywhere(?bool $can_insert_everywhere) { if (is_null($can_insert_everywhere)) { throw new InvalidArgumentException('non-nullable can_insert_everywhere cannot be null'); diff --git a/sdks/php/src/Model/ApiAppResponseOwnerAccount.php b/sdks/php/src/Model/ApiAppResponseOwnerAccount.php index 02f1f44d8..ffc120960 100644 --- a/sdks/php/src/Model/ApiAppResponseOwnerAccount.php +++ b/sdks/php/src/Model/ApiAppResponseOwnerAccount.php @@ -289,15 +289,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['email_address'] === null) { - $invalidProperties[] = "'email_address' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -314,7 +306,7 @@ public function valid() /** * Gets account_id * - * @return string + * @return string|null */ public function getAccountId() { @@ -324,11 +316,11 @@ public function getAccountId() /** * Sets account_id * - * @param string $account_id The owner account's ID + * @param string|null $account_id The owner account's ID * * @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'); @@ -341,7 +333,7 @@ public function setAccountId(string $account_id) /** * Gets email_address * - * @return string + * @return string|null */ public function getEmailAddress() { @@ -351,11 +343,11 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address The owner account's email address + * @param string|null $email_address The owner account's email address * * @return self */ - public function setEmailAddress(string $email_address) + public function setEmailAddress(?string $email_address) { if (is_null($email_address)) { throw new InvalidArgumentException('non-nullable email_address cannot be null'); diff --git a/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php b/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php index 185d3782c..95f29f5f4 100644 --- a/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php +++ b/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php @@ -373,51 +373,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['header_background_color'] === null) { - $invalidProperties[] = "'header_background_color' can't be null"; - } - if ($this->container['legal_version'] === null) { - $invalidProperties[] = "'legal_version' can't be null"; - } - if ($this->container['link_color'] === null) { - $invalidProperties[] = "'link_color' can't be null"; - } - if ($this->container['page_background_color'] === null) { - $invalidProperties[] = "'page_background_color' can't be null"; - } - if ($this->container['primary_button_color'] === null) { - $invalidProperties[] = "'primary_button_color' can't be null"; - } - if ($this->container['primary_button_color_hover'] === null) { - $invalidProperties[] = "'primary_button_color_hover' can't be null"; - } - if ($this->container['primary_button_text_color'] === null) { - $invalidProperties[] = "'primary_button_text_color' can't be null"; - } - if ($this->container['primary_button_text_color_hover'] === null) { - $invalidProperties[] = "'primary_button_text_color_hover' can't be null"; - } - if ($this->container['secondary_button_color'] === null) { - $invalidProperties[] = "'secondary_button_color' can't be null"; - } - if ($this->container['secondary_button_color_hover'] === null) { - $invalidProperties[] = "'secondary_button_color_hover' can't be null"; - } - if ($this->container['secondary_button_text_color'] === null) { - $invalidProperties[] = "'secondary_button_text_color' can't be null"; - } - if ($this->container['secondary_button_text_color_hover'] === null) { - $invalidProperties[] = "'secondary_button_text_color_hover' can't be null"; - } - if ($this->container['text_color1'] === null) { - $invalidProperties[] = "'text_color1' can't be null"; - } - if ($this->container['text_color2'] === null) { - $invalidProperties[] = "'text_color2' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -434,7 +390,7 @@ public function valid() /** * Gets header_background_color * - * @return string + * @return string|null */ public function getHeaderBackgroundColor() { @@ -444,11 +400,11 @@ public function getHeaderBackgroundColor() /** * Sets header_background_color * - * @param string $header_background_color header_background_color + * @param string|null $header_background_color header_background_color * * @return self */ - public function setHeaderBackgroundColor(string $header_background_color) + public function setHeaderBackgroundColor(?string $header_background_color) { if (is_null($header_background_color)) { throw new InvalidArgumentException('non-nullable header_background_color cannot be null'); @@ -461,7 +417,7 @@ public function setHeaderBackgroundColor(string $header_background_color) /** * Gets legal_version * - * @return string + * @return string|null */ public function getLegalVersion() { @@ -471,11 +427,11 @@ public function getLegalVersion() /** * Sets legal_version * - * @param string $legal_version legal_version + * @param string|null $legal_version legal_version * * @return self */ - public function setLegalVersion(string $legal_version) + public function setLegalVersion(?string $legal_version) { if (is_null($legal_version)) { throw new InvalidArgumentException('non-nullable legal_version cannot be null'); @@ -488,7 +444,7 @@ public function setLegalVersion(string $legal_version) /** * Gets link_color * - * @return string + * @return string|null */ public function getLinkColor() { @@ -498,11 +454,11 @@ public function getLinkColor() /** * Sets link_color * - * @param string $link_color link_color + * @param string|null $link_color link_color * * @return self */ - public function setLinkColor(string $link_color) + public function setLinkColor(?string $link_color) { if (is_null($link_color)) { throw new InvalidArgumentException('non-nullable link_color cannot be null'); @@ -515,7 +471,7 @@ public function setLinkColor(string $link_color) /** * Gets page_background_color * - * @return string + * @return string|null */ public function getPageBackgroundColor() { @@ -525,11 +481,11 @@ public function getPageBackgroundColor() /** * Sets page_background_color * - * @param string $page_background_color page_background_color + * @param string|null $page_background_color page_background_color * * @return self */ - public function setPageBackgroundColor(string $page_background_color) + public function setPageBackgroundColor(?string $page_background_color) { if (is_null($page_background_color)) { throw new InvalidArgumentException('non-nullable page_background_color cannot be null'); @@ -542,7 +498,7 @@ public function setPageBackgroundColor(string $page_background_color) /** * Gets primary_button_color * - * @return string + * @return string|null */ public function getPrimaryButtonColor() { @@ -552,11 +508,11 @@ public function getPrimaryButtonColor() /** * Sets primary_button_color * - * @param string $primary_button_color primary_button_color + * @param string|null $primary_button_color primary_button_color * * @return self */ - public function setPrimaryButtonColor(string $primary_button_color) + public function setPrimaryButtonColor(?string $primary_button_color) { if (is_null($primary_button_color)) { throw new InvalidArgumentException('non-nullable primary_button_color cannot be null'); @@ -569,7 +525,7 @@ public function setPrimaryButtonColor(string $primary_button_color) /** * Gets primary_button_color_hover * - * @return string + * @return string|null */ public function getPrimaryButtonColorHover() { @@ -579,11 +535,11 @@ public function getPrimaryButtonColorHover() /** * Sets primary_button_color_hover * - * @param string $primary_button_color_hover primary_button_color_hover + * @param string|null $primary_button_color_hover primary_button_color_hover * * @return self */ - public function setPrimaryButtonColorHover(string $primary_button_color_hover) + public function setPrimaryButtonColorHover(?string $primary_button_color_hover) { if (is_null($primary_button_color_hover)) { throw new InvalidArgumentException('non-nullable primary_button_color_hover cannot be null'); @@ -596,7 +552,7 @@ public function setPrimaryButtonColorHover(string $primary_button_color_hover) /** * Gets primary_button_text_color * - * @return string + * @return string|null */ public function getPrimaryButtonTextColor() { @@ -606,11 +562,11 @@ public function getPrimaryButtonTextColor() /** * Sets primary_button_text_color * - * @param string $primary_button_text_color primary_button_text_color + * @param string|null $primary_button_text_color primary_button_text_color * * @return self */ - public function setPrimaryButtonTextColor(string $primary_button_text_color) + public function setPrimaryButtonTextColor(?string $primary_button_text_color) { if (is_null($primary_button_text_color)) { throw new InvalidArgumentException('non-nullable primary_button_text_color cannot be null'); @@ -623,7 +579,7 @@ public function setPrimaryButtonTextColor(string $primary_button_text_color) /** * Gets primary_button_text_color_hover * - * @return string + * @return string|null */ public function getPrimaryButtonTextColorHover() { @@ -633,11 +589,11 @@ public function getPrimaryButtonTextColorHover() /** * Sets primary_button_text_color_hover * - * @param string $primary_button_text_color_hover primary_button_text_color_hover + * @param string|null $primary_button_text_color_hover primary_button_text_color_hover * * @return self */ - public function setPrimaryButtonTextColorHover(string $primary_button_text_color_hover) + public function setPrimaryButtonTextColorHover(?string $primary_button_text_color_hover) { if (is_null($primary_button_text_color_hover)) { throw new InvalidArgumentException('non-nullable primary_button_text_color_hover cannot be null'); @@ -650,7 +606,7 @@ public function setPrimaryButtonTextColorHover(string $primary_button_text_color /** * Gets secondary_button_color * - * @return string + * @return string|null */ public function getSecondaryButtonColor() { @@ -660,11 +616,11 @@ public function getSecondaryButtonColor() /** * Sets secondary_button_color * - * @param string $secondary_button_color secondary_button_color + * @param string|null $secondary_button_color secondary_button_color * * @return self */ - public function setSecondaryButtonColor(string $secondary_button_color) + public function setSecondaryButtonColor(?string $secondary_button_color) { if (is_null($secondary_button_color)) { throw new InvalidArgumentException('non-nullable secondary_button_color cannot be null'); @@ -677,7 +633,7 @@ public function setSecondaryButtonColor(string $secondary_button_color) /** * Gets secondary_button_color_hover * - * @return string + * @return string|null */ public function getSecondaryButtonColorHover() { @@ -687,11 +643,11 @@ public function getSecondaryButtonColorHover() /** * Sets secondary_button_color_hover * - * @param string $secondary_button_color_hover secondary_button_color_hover + * @param string|null $secondary_button_color_hover secondary_button_color_hover * * @return self */ - public function setSecondaryButtonColorHover(string $secondary_button_color_hover) + public function setSecondaryButtonColorHover(?string $secondary_button_color_hover) { if (is_null($secondary_button_color_hover)) { throw new InvalidArgumentException('non-nullable secondary_button_color_hover cannot be null'); @@ -704,7 +660,7 @@ public function setSecondaryButtonColorHover(string $secondary_button_color_hove /** * Gets secondary_button_text_color * - * @return string + * @return string|null */ public function getSecondaryButtonTextColor() { @@ -714,11 +670,11 @@ public function getSecondaryButtonTextColor() /** * Sets secondary_button_text_color * - * @param string $secondary_button_text_color secondary_button_text_color + * @param string|null $secondary_button_text_color secondary_button_text_color * * @return self */ - public function setSecondaryButtonTextColor(string $secondary_button_text_color) + public function setSecondaryButtonTextColor(?string $secondary_button_text_color) { if (is_null($secondary_button_text_color)) { throw new InvalidArgumentException('non-nullable secondary_button_text_color cannot be null'); @@ -731,7 +687,7 @@ public function setSecondaryButtonTextColor(string $secondary_button_text_color) /** * Gets secondary_button_text_color_hover * - * @return string + * @return string|null */ public function getSecondaryButtonTextColorHover() { @@ -741,11 +697,11 @@ public function getSecondaryButtonTextColorHover() /** * Sets secondary_button_text_color_hover * - * @param string $secondary_button_text_color_hover secondary_button_text_color_hover + * @param string|null $secondary_button_text_color_hover secondary_button_text_color_hover * * @return self */ - public function setSecondaryButtonTextColorHover(string $secondary_button_text_color_hover) + public function setSecondaryButtonTextColorHover(?string $secondary_button_text_color_hover) { if (is_null($secondary_button_text_color_hover)) { throw new InvalidArgumentException('non-nullable secondary_button_text_color_hover cannot be null'); @@ -758,7 +714,7 @@ public function setSecondaryButtonTextColorHover(string $secondary_button_text_c /** * Gets text_color1 * - * @return string + * @return string|null */ public function getTextColor1() { @@ -768,11 +724,11 @@ public function getTextColor1() /** * Sets text_color1 * - * @param string $text_color1 text_color1 + * @param string|null $text_color1 text_color1 * * @return self */ - public function setTextColor1(string $text_color1) + public function setTextColor1(?string $text_color1) { if (is_null($text_color1)) { throw new InvalidArgumentException('non-nullable text_color1 cannot be null'); @@ -785,7 +741,7 @@ public function setTextColor1(string $text_color1) /** * Gets text_color2 * - * @return string + * @return string|null */ public function getTextColor2() { @@ -795,11 +751,11 @@ public function getTextColor2() /** * Sets text_color2 * - * @param string $text_color2 text_color2 + * @param string|null $text_color2 text_color2 * * @return self */ - public function setTextColor2(string $text_color2) + public function setTextColor2(?string $text_color2) { if (is_null($text_color2)) { throw new InvalidArgumentException('non-nullable text_color2 cannot be null'); diff --git a/sdks/php/src/Model/BulkSendJobResponse.php b/sdks/php/src/Model/BulkSendJobResponse.php index 35578b8c8..fcd66e120 100644 --- a/sdks/php/src/Model/BulkSendJobResponse.php +++ b/sdks/php/src/Model/BulkSendJobResponse.php @@ -84,7 +84,7 @@ class BulkSendJobResponse implements ModelInterface, ArrayAccess, JsonSerializab * @var bool[] */ protected static array $openAPINullables = [ - 'bulk_send_job_id' => false, + 'bulk_send_job_id' => true, 'total' => false, 'is_creator' => false, 'created_at' => false, @@ -303,21 +303,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['bulk_send_job_id'] === null) { - $invalidProperties[] = "'bulk_send_job_id' can't be null"; - } - if ($this->container['total'] === null) { - $invalidProperties[] = "'total' can't be null"; - } - if ($this->container['is_creator'] === null) { - $invalidProperties[] = "'is_creator' can't be null"; - } - if ($this->container['created_at'] === null) { - $invalidProperties[] = "'created_at' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -334,7 +320,7 @@ public function valid() /** * Gets bulk_send_job_id * - * @return string + * @return string|null */ public function getBulkSendJobId() { @@ -344,14 +330,21 @@ public function getBulkSendJobId() /** * Sets bulk_send_job_id * - * @param string $bulk_send_job_id the id of the BulkSendJob + * @param string|null $bulk_send_job_id the id of the BulkSendJob * * @return self */ - public function setBulkSendJobId(string $bulk_send_job_id) + public function setBulkSendJobId(?string $bulk_send_job_id) { if (is_null($bulk_send_job_id)) { - throw new InvalidArgumentException('non-nullable bulk_send_job_id cannot be null'); + array_push($this->openAPINullablesSetToNull, 'bulk_send_job_id'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('bulk_send_job_id', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } } $this->container['bulk_send_job_id'] = $bulk_send_job_id; @@ -361,7 +354,7 @@ public function setBulkSendJobId(string $bulk_send_job_id) /** * Gets total * - * @return int + * @return int|null */ public function getTotal() { @@ -371,11 +364,11 @@ public function getTotal() /** * Sets total * - * @param int $total the total amount of Signature Requests queued for sending + * @param int|null $total the total amount of Signature Requests queued for sending * * @return self */ - public function setTotal(int $total) + public function setTotal(?int $total) { if (is_null($total)) { throw new InvalidArgumentException('non-nullable total cannot be null'); @@ -388,7 +381,7 @@ public function setTotal(int $total) /** * Gets is_creator * - * @return bool + * @return bool|null */ public function getIsCreator() { @@ -398,11 +391,11 @@ public function getIsCreator() /** * Sets is_creator * - * @param bool $is_creator true if you are the owner of this BulkSendJob, false if it's been shared with you by a team member + * @param bool|null $is_creator true if you are the owner of this BulkSendJob, false if it's been shared with you by a team member * * @return self */ - public function setIsCreator(bool $is_creator) + public function setIsCreator(?bool $is_creator) { if (is_null($is_creator)) { throw new InvalidArgumentException('non-nullable is_creator cannot be null'); @@ -415,7 +408,7 @@ public function setIsCreator(bool $is_creator) /** * Gets created_at * - * @return int + * @return int|null */ public function getCreatedAt() { @@ -425,11 +418,11 @@ public function getCreatedAt() /** * Sets created_at * - * @param int $created_at time that the BulkSendJob was created + * @param int|null $created_at time that the BulkSendJob was created * * @return self */ - public function setCreatedAt(int $created_at) + public function setCreatedAt(?int $created_at) { if (is_null($created_at)) { throw new InvalidArgumentException('non-nullable created_at cannot be null'); diff --git a/sdks/php/src/Model/FaxLineResponseFaxLine.php b/sdks/php/src/Model/FaxLineResponseFaxLine.php index be4353981..4a3fe8fa7 100644 --- a/sdks/php/src/Model/FaxLineResponseFaxLine.php +++ b/sdks/php/src/Model/FaxLineResponseFaxLine.php @@ -302,21 +302,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['number'] === null) { - $invalidProperties[] = "'number' can't be null"; - } - if ($this->container['created_at'] === null) { - $invalidProperties[] = "'created_at' can't be null"; - } - if ($this->container['updated_at'] === null) { - $invalidProperties[] = "'updated_at' can't be null"; - } - if ($this->container['accounts'] === null) { - $invalidProperties[] = "'accounts' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -333,7 +319,7 @@ public function valid() /** * Gets number * - * @return string + * @return string|null */ public function getNumber() { @@ -343,11 +329,11 @@ public function getNumber() /** * Sets number * - * @param string $number Number + * @param string|null $number Number * * @return self */ - public function setNumber(string $number) + public function setNumber(?string $number) { if (is_null($number)) { throw new InvalidArgumentException('non-nullable number cannot be null'); @@ -360,7 +346,7 @@ public function setNumber(string $number) /** * Gets created_at * - * @return int + * @return int|null */ public function getCreatedAt() { @@ -370,11 +356,11 @@ public function getCreatedAt() /** * Sets created_at * - * @param int $created_at Created at + * @param int|null $created_at Created at * * @return self */ - public function setCreatedAt(int $created_at) + public function setCreatedAt(?int $created_at) { if (is_null($created_at)) { throw new InvalidArgumentException('non-nullable created_at cannot be null'); @@ -387,7 +373,7 @@ public function setCreatedAt(int $created_at) /** * Gets updated_at * - * @return int + * @return int|null */ public function getUpdatedAt() { @@ -397,11 +383,11 @@ public function getUpdatedAt() /** * Sets updated_at * - * @param int $updated_at Updated at + * @param int|null $updated_at Updated at * * @return self */ - public function setUpdatedAt(int $updated_at) + public function setUpdatedAt(?int $updated_at) { if (is_null($updated_at)) { throw new InvalidArgumentException('non-nullable updated_at cannot be null'); @@ -414,7 +400,7 @@ public function setUpdatedAt(int $updated_at) /** * Gets accounts * - * @return AccountResponse[] + * @return AccountResponse[]|null */ public function getAccounts() { @@ -424,11 +410,11 @@ public function getAccounts() /** * Sets accounts * - * @param AccountResponse[] $accounts accounts + * @param AccountResponse[]|null $accounts accounts * * @return self */ - public function setAccounts(array $accounts) + public function setAccounts(?array $accounts) { if (is_null($accounts)) { throw new InvalidArgumentException('non-nullable accounts cannot be null'); diff --git a/sdks/php/src/Model/TeamResponse.php b/sdks/php/src/Model/TeamResponse.php index e2b2be949..402916a49 100644 --- a/sdks/php/src/Model/TeamResponse.php +++ b/sdks/php/src/Model/TeamResponse.php @@ -303,21 +303,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['name'] === null) { - $invalidProperties[] = "'name' can't be null"; - } - if ($this->container['accounts'] === null) { - $invalidProperties[] = "'accounts' can't be null"; - } - if ($this->container['invited_accounts'] === null) { - $invalidProperties[] = "'invited_accounts' can't be null"; - } - if ($this->container['invited_emails'] === null) { - $invalidProperties[] = "'invited_emails' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -334,7 +320,7 @@ public function valid() /** * Gets name * - * @return string + * @return string|null */ public function getName() { @@ -344,11 +330,11 @@ public function getName() /** * Sets name * - * @param string $name The name of your Team + * @param string|null $name The name of your Team * * @return self */ - public function setName(string $name) + public function setName(?string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); @@ -361,7 +347,7 @@ public function setName(string $name) /** * Gets accounts * - * @return AccountResponse[] + * @return AccountResponse[]|null */ public function getAccounts() { @@ -371,11 +357,11 @@ public function getAccounts() /** * Sets accounts * - * @param AccountResponse[] $accounts accounts + * @param AccountResponse[]|null $accounts accounts * * @return self */ - public function setAccounts(array $accounts) + public function setAccounts(?array $accounts) { if (is_null($accounts)) { throw new InvalidArgumentException('non-nullable accounts cannot be null'); @@ -388,7 +374,7 @@ public function setAccounts(array $accounts) /** * Gets invited_accounts * - * @return AccountResponse[] + * @return AccountResponse[]|null */ public function getInvitedAccounts() { @@ -398,11 +384,11 @@ public function getInvitedAccounts() /** * Sets invited_accounts * - * @param AccountResponse[] $invited_accounts A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. + * @param AccountResponse[]|null $invited_accounts A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. * * @return self */ - public function setInvitedAccounts(array $invited_accounts) + public function setInvitedAccounts(?array $invited_accounts) { if (is_null($invited_accounts)) { throw new InvalidArgumentException('non-nullable invited_accounts cannot be null'); @@ -415,7 +401,7 @@ public function setInvitedAccounts(array $invited_accounts) /** * Gets invited_emails * - * @return string[] + * @return string[]|null */ public function getInvitedEmails() { @@ -425,11 +411,11 @@ public function getInvitedEmails() /** * Sets invited_emails * - * @param string[] $invited_emails a list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account + * @param string[]|null $invited_emails a list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account * * @return self */ - public function setInvitedEmails(array $invited_emails) + public function setInvitedEmails(?array $invited_emails) { if (is_null($invited_emails)) { throw new InvalidArgumentException('non-nullable invited_emails cannot be null'); diff --git a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php index 05073d3c9..44031ce16 100644 --- a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php +++ b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php @@ -303,18 +303,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['template_id'] === null) { - $invalidProperties[] = "'template_id' can't be null"; - } - if ($this->container['edit_url'] === null) { - $invalidProperties[] = "'edit_url' can't be null"; - } - if ($this->container['expires_at'] === null) { - $invalidProperties[] = "'expires_at' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -331,7 +320,7 @@ public function valid() /** * Gets template_id * - * @return string + * @return string|null */ public function getTemplateId() { @@ -341,11 +330,11 @@ public function getTemplateId() /** * Sets template_id * - * @param string $template_id the id of the Template + * @param string|null $template_id the id of the Template * * @return self */ - public function setTemplateId(string $template_id) + public function setTemplateId(?string $template_id) { if (is_null($template_id)) { throw new InvalidArgumentException('non-nullable template_id cannot be null'); @@ -358,7 +347,7 @@ public function setTemplateId(string $template_id) /** * Gets edit_url * - * @return string + * @return string|null */ public function getEditUrl() { @@ -368,11 +357,11 @@ public function getEditUrl() /** * Sets edit_url * - * @param string $edit_url link to edit the template + * @param string|null $edit_url link to edit the template * * @return self */ - public function setEditUrl(string $edit_url) + public function setEditUrl(?string $edit_url) { if (is_null($edit_url)) { throw new InvalidArgumentException('non-nullable edit_url cannot be null'); @@ -385,7 +374,7 @@ public function setEditUrl(string $edit_url) /** * Gets expires_at * - * @return int + * @return int|null */ public function getExpiresAt() { @@ -395,11 +384,11 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int $expires_at when the link expires + * @param int|null $expires_at when the link expires * * @return self */ - public function setExpiresAt(int $expires_at) + public function setExpiresAt(?int $expires_at) { if (is_null($expires_at)) { throw new InvalidArgumentException('non-nullable expires_at cannot be null'); diff --git a/sdks/php/src/Model/TemplateCreateResponseTemplate.php b/sdks/php/src/Model/TemplateCreateResponseTemplate.php index d2bed5824..199aa3f74 100644 --- a/sdks/php/src/Model/TemplateCreateResponseTemplate.php +++ b/sdks/php/src/Model/TemplateCreateResponseTemplate.php @@ -282,12 +282,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['template_id'] === null) { - $invalidProperties[] = "'template_id' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -304,7 +299,7 @@ public function valid() /** * Gets template_id * - * @return string + * @return string|null */ public function getTemplateId() { @@ -314,11 +309,11 @@ public function getTemplateId() /** * Sets template_id * - * @param string $template_id the id of the Template + * @param string|null $template_id the id of the Template * * @return self */ - public function setTemplateId(string $template_id) + public function setTemplateId(?string $template_id) { if (is_null($template_id)) { throw new InvalidArgumentException('non-nullable template_id cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponse.php b/sdks/php/src/Model/TemplateResponse.php index 7116ea2a7..fb8417b98 100644 --- a/sdks/php/src/Model/TemplateResponse.php +++ b/sdks/php/src/Model/TemplateResponse.php @@ -61,6 +61,8 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'template_id' => 'string', 'title' => 'string', 'message' => 'string', + 'updated_at' => 'int', + 'is_embedded' => 'bool', 'is_creator' => 'bool', 'can_edit' => 'bool', 'is_locked' => 'bool', @@ -68,12 +70,10 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'signer_roles' => '\Dropbox\Sign\Model\TemplateResponseSignerRole[]', 'cc_roles' => '\Dropbox\Sign\Model\TemplateResponseCCRole[]', 'documents' => '\Dropbox\Sign\Model\TemplateResponseDocument[]', - 'accounts' => '\Dropbox\Sign\Model\TemplateResponseAccount[]', - 'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]', - 'updated_at' => 'int', - 'is_embedded' => 'bool', 'custom_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]', 'named_form_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]', + 'accounts' => '\Dropbox\Sign\Model\TemplateResponseAccount[]', + 'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]', ]; /** @@ -87,6 +87,8 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'template_id' => null, 'title' => null, 'message' => null, + 'updated_at' => null, + 'is_embedded' => null, 'is_creator' => null, 'can_edit' => null, 'is_locked' => null, @@ -94,12 +96,10 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'signer_roles' => null, 'cc_roles' => null, 'documents' => null, - 'accounts' => null, - 'attachments' => null, - 'updated_at' => null, - 'is_embedded' => null, 'custom_fields' => null, 'named_form_fields' => null, + 'accounts' => null, + 'attachments' => null, ]; /** @@ -111,6 +111,8 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'template_id' => false, 'title' => false, 'message' => false, + 'updated_at' => false, + 'is_embedded' => true, 'is_creator' => false, 'can_edit' => false, 'is_locked' => false, @@ -118,12 +120,10 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'signer_roles' => false, 'cc_roles' => false, 'documents' => false, - 'accounts' => false, - 'attachments' => false, - 'updated_at' => false, - 'is_embedded' => true, 'custom_fields' => true, 'named_form_fields' => true, + 'accounts' => false, + 'attachments' => false, ]; /** @@ -207,6 +207,8 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'template_id', 'title' => 'title', 'message' => 'message', + 'updated_at' => 'updated_at', + 'is_embedded' => 'is_embedded', 'is_creator' => 'is_creator', 'can_edit' => 'can_edit', 'is_locked' => 'is_locked', @@ -214,12 +216,10 @@ public function isNullableSetToNull(string $property): bool 'signer_roles' => 'signer_roles', 'cc_roles' => 'cc_roles', 'documents' => 'documents', - 'accounts' => 'accounts', - 'attachments' => 'attachments', - 'updated_at' => 'updated_at', - 'is_embedded' => 'is_embedded', 'custom_fields' => 'custom_fields', 'named_form_fields' => 'named_form_fields', + 'accounts' => 'accounts', + 'attachments' => 'attachments', ]; /** @@ -231,6 +231,8 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'setTemplateId', 'title' => 'setTitle', 'message' => 'setMessage', + 'updated_at' => 'setUpdatedAt', + 'is_embedded' => 'setIsEmbedded', 'is_creator' => 'setIsCreator', 'can_edit' => 'setCanEdit', 'is_locked' => 'setIsLocked', @@ -238,12 +240,10 @@ public function isNullableSetToNull(string $property): bool 'signer_roles' => 'setSignerRoles', 'cc_roles' => 'setCcRoles', 'documents' => 'setDocuments', - 'accounts' => 'setAccounts', - 'attachments' => 'setAttachments', - 'updated_at' => 'setUpdatedAt', - 'is_embedded' => 'setIsEmbedded', 'custom_fields' => 'setCustomFields', 'named_form_fields' => 'setNamedFormFields', + 'accounts' => 'setAccounts', + 'attachments' => 'setAttachments', ]; /** @@ -255,6 +255,8 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'getTemplateId', 'title' => 'getTitle', 'message' => 'getMessage', + 'updated_at' => 'getUpdatedAt', + 'is_embedded' => 'getIsEmbedded', 'is_creator' => 'getIsCreator', 'can_edit' => 'getCanEdit', 'is_locked' => 'getIsLocked', @@ -262,12 +264,10 @@ public function isNullableSetToNull(string $property): bool 'signer_roles' => 'getSignerRoles', 'cc_roles' => 'getCcRoles', 'documents' => 'getDocuments', - 'accounts' => 'getAccounts', - 'attachments' => 'getAttachments', - 'updated_at' => 'getUpdatedAt', - 'is_embedded' => 'getIsEmbedded', 'custom_fields' => 'getCustomFields', 'named_form_fields' => 'getNamedFormFields', + 'accounts' => 'getAccounts', + 'attachments' => 'getAttachments', ]; /** @@ -329,6 +329,8 @@ public function __construct(array $data = null) $this->setIfExists('template_id', $data ?? [], null); $this->setIfExists('title', $data ?? [], null); $this->setIfExists('message', $data ?? [], null); + $this->setIfExists('updated_at', $data ?? [], null); + $this->setIfExists('is_embedded', $data ?? [], null); $this->setIfExists('is_creator', $data ?? [], null); $this->setIfExists('can_edit', $data ?? [], null); $this->setIfExists('is_locked', $data ?? [], null); @@ -336,12 +338,10 @@ public function __construct(array $data = null) $this->setIfExists('signer_roles', $data ?? [], null); $this->setIfExists('cc_roles', $data ?? [], null); $this->setIfExists('documents', $data ?? [], null); - $this->setIfExists('accounts', $data ?? [], null); - $this->setIfExists('attachments', $data ?? [], null); - $this->setIfExists('updated_at', $data ?? [], null); - $this->setIfExists('is_embedded', $data ?? [], null); $this->setIfExists('custom_fields', $data ?? [], null); $this->setIfExists('named_form_fields', $data ?? [], null); + $this->setIfExists('accounts', $data ?? [], null); + $this->setIfExists('attachments', $data ?? [], null); } /** @@ -387,45 +387,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['template_id'] === null) { - $invalidProperties[] = "'template_id' can't be null"; - } - if ($this->container['title'] === null) { - $invalidProperties[] = "'title' can't be null"; - } - if ($this->container['message'] === null) { - $invalidProperties[] = "'message' can't be null"; - } - if ($this->container['is_creator'] === null) { - $invalidProperties[] = "'is_creator' can't be null"; - } - if ($this->container['can_edit'] === null) { - $invalidProperties[] = "'can_edit' can't be null"; - } - if ($this->container['is_locked'] === null) { - $invalidProperties[] = "'is_locked' can't be null"; - } - if ($this->container['metadata'] === null) { - $invalidProperties[] = "'metadata' can't be null"; - } - if ($this->container['signer_roles'] === null) { - $invalidProperties[] = "'signer_roles' can't be null"; - } - if ($this->container['cc_roles'] === null) { - $invalidProperties[] = "'cc_roles' can't be null"; - } - if ($this->container['documents'] === null) { - $invalidProperties[] = "'documents' can't be null"; - } - if ($this->container['accounts'] === null) { - $invalidProperties[] = "'accounts' can't be null"; - } - if ($this->container['attachments'] === null) { - $invalidProperties[] = "'attachments' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -442,7 +404,7 @@ public function valid() /** * Gets template_id * - * @return string + * @return string|null */ public function getTemplateId() { @@ -452,11 +414,11 @@ public function getTemplateId() /** * Sets template_id * - * @param string $template_id the id of the Template + * @param string|null $template_id the id of the Template * * @return self */ - public function setTemplateId(string $template_id) + public function setTemplateId(?string $template_id) { if (is_null($template_id)) { throw new InvalidArgumentException('non-nullable template_id cannot be null'); @@ -469,7 +431,7 @@ public function setTemplateId(string $template_id) /** * Gets title * - * @return string + * @return string|null */ public function getTitle() { @@ -479,11 +441,11 @@ public function getTitle() /** * Sets title * - * @param string $title The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + * @param string|null $title The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. * * @return self */ - public function setTitle(string $title) + public function setTitle(?string $title) { if (is_null($title)) { throw new InvalidArgumentException('non-nullable title cannot be null'); @@ -496,7 +458,7 @@ public function setTitle(string $title) /** * Gets message * - * @return string + * @return string|null */ public function getMessage() { @@ -506,11 +468,11 @@ public function getMessage() /** * Sets message * - * @param string $message The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + * @param string|null $message The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. * * @return self */ - public function setMessage(string $message) + public function setMessage(?string $message) { if (is_null($message)) { throw new InvalidArgumentException('non-nullable message cannot be null'); @@ -520,10 +482,71 @@ public function setMessage(string $message) return $this; } + /** + * Gets updated_at + * + * @return int|null + */ + public function getUpdatedAt() + { + return $this->container['updated_at']; + } + + /** + * Sets updated_at + * + * @param int|null $updated_at time the template was last updated + * + * @return self + */ + public function setUpdatedAt(?int $updated_at) + { + if (is_null($updated_at)) { + throw new InvalidArgumentException('non-nullable updated_at cannot be null'); + } + $this->container['updated_at'] = $updated_at; + + return $this; + } + + /** + * Gets is_embedded + * + * @return bool|null + */ + public function getIsEmbedded() + { + return $this->container['is_embedded']; + } + + /** + * Sets is_embedded + * + * @param bool|null $is_embedded `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + * + * @return self + */ + public function setIsEmbedded(?bool $is_embedded) + { + if (is_null($is_embedded)) { + array_push($this->openAPINullablesSetToNull, 'is_embedded'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('is_embedded', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['is_embedded'] = $is_embedded; + + return $this; + } + /** * Gets is_creator * - * @return bool + * @return bool|null */ public function getIsCreator() { @@ -533,11 +556,11 @@ public function getIsCreator() /** * Sets is_creator * - * @param bool $is_creator `true` if you are the owner of this template, `false` if it's been shared with you by a team member + * @param bool|null $is_creator `true` if you are the owner of this template, `false` if it's been shared with you by a team member * * @return self */ - public function setIsCreator(bool $is_creator) + public function setIsCreator(?bool $is_creator) { if (is_null($is_creator)) { throw new InvalidArgumentException('non-nullable is_creator cannot be null'); @@ -550,7 +573,7 @@ public function setIsCreator(bool $is_creator) /** * Gets can_edit * - * @return bool + * @return bool|null */ public function getCanEdit() { @@ -560,11 +583,11 @@ public function getCanEdit() /** * Sets can_edit * - * @param bool $can_edit indicates whether edit rights have been granted to you by the owner (always `true` if that's you) + * @param bool|null $can_edit indicates whether edit rights have been granted to you by the owner (always `true` if that's you) * * @return self */ - public function setCanEdit(bool $can_edit) + public function setCanEdit(?bool $can_edit) { if (is_null($can_edit)) { throw new InvalidArgumentException('non-nullable can_edit cannot be null'); @@ -577,7 +600,7 @@ public function setCanEdit(bool $can_edit) /** * Gets is_locked * - * @return bool + * @return bool|null */ public function getIsLocked() { @@ -587,11 +610,11 @@ public function getIsLocked() /** * Sets is_locked * - * @param bool $is_locked Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. + * @param bool|null $is_locked Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. * * @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'); @@ -604,7 +627,7 @@ public function setIsLocked(bool $is_locked) /** * Gets metadata * - * @return array + * @return array|null */ public function getMetadata() { @@ -614,11 +637,11 @@ public function getMetadata() /** * Sets metadata * - * @param array $metadata the metadata attached to the template + * @param array|null $metadata the metadata attached to the template * * @return self */ - public function setMetadata(array $metadata) + public function setMetadata(?array $metadata) { if (is_null($metadata)) { throw new InvalidArgumentException('non-nullable metadata cannot be null'); @@ -631,7 +654,7 @@ public function setMetadata(array $metadata) /** * Gets signer_roles * - * @return TemplateResponseSignerRole[] + * @return TemplateResponseSignerRole[]|null */ public function getSignerRoles() { @@ -641,11 +664,11 @@ public function getSignerRoles() /** * Sets signer_roles * - * @param TemplateResponseSignerRole[] $signer_roles an array of the designated signer roles that must be specified when sending a SignatureRequest using this Template + * @param TemplateResponseSignerRole[]|null $signer_roles an array of the designated signer roles that must be specified when sending a SignatureRequest using this Template * * @return self */ - public function setSignerRoles(array $signer_roles) + public function setSignerRoles(?array $signer_roles) { if (is_null($signer_roles)) { throw new InvalidArgumentException('non-nullable signer_roles cannot be null'); @@ -658,7 +681,7 @@ public function setSignerRoles(array $signer_roles) /** * Gets cc_roles * - * @return TemplateResponseCCRole[] + * @return TemplateResponseCCRole[]|null */ public function getCcRoles() { @@ -668,11 +691,11 @@ public function getCcRoles() /** * Sets cc_roles * - * @param TemplateResponseCCRole[] $cc_roles an array of the designated CC roles that must be specified when sending a SignatureRequest using this Template + * @param TemplateResponseCCRole[]|null $cc_roles an array of the designated CC roles that must be specified when sending a SignatureRequest using this Template * * @return self */ - public function setCcRoles(array $cc_roles) + public function setCcRoles(?array $cc_roles) { if (is_null($cc_roles)) { throw new InvalidArgumentException('non-nullable cc_roles cannot be null'); @@ -685,7 +708,7 @@ public function setCcRoles(array $cc_roles) /** * Gets documents * - * @return TemplateResponseDocument[] + * @return TemplateResponseDocument[]|null */ public function getDocuments() { @@ -695,11 +718,11 @@ public function getDocuments() /** * Sets documents * - * @param TemplateResponseDocument[] $documents An array describing each document associated with this Template. Includes form field data for each document. + * @param TemplateResponseDocument[]|null $documents An array describing each document associated with this Template. Includes form field data for each document. * * @return self */ - public function setDocuments(array $documents) + public function setDocuments(?array $documents) { if (is_null($documents)) { throw new InvalidArgumentException('non-nullable documents cannot be null'); @@ -710,188 +733,127 @@ public function setDocuments(array $documents) } /** - * Gets accounts - * - * @return TemplateResponseAccount[] - */ - public function getAccounts() - { - return $this->container['accounts']; - } - - /** - * Sets accounts - * - * @param TemplateResponseAccount[] $accounts an array of the Accounts that can use this Template - * - * @return self - */ - public function setAccounts(array $accounts) - { - if (is_null($accounts)) { - throw new InvalidArgumentException('non-nullable accounts cannot be null'); - } - $this->container['accounts'] = $accounts; - - return $this; - } - - /** - * Gets attachments - * - * @return SignatureRequestResponseAttachment[] - */ - public function getAttachments() - { - return $this->container['attachments']; - } - - /** - * Sets attachments - * - * @param SignatureRequestResponseAttachment[] $attachments signer attachments - * - * @return self - */ - public function setAttachments(array $attachments) - { - if (is_null($attachments)) { - throw new InvalidArgumentException('non-nullable attachments cannot be null'); - } - $this->container['attachments'] = $attachments; - - return $this; - } - - /** - * Gets updated_at + * Gets custom_fields * - * @return int|null + * @return TemplateResponseDocumentCustomFieldBase[]|null + * @deprecated */ - public function getUpdatedAt() + public function getCustomFields() { - return $this->container['updated_at']; + return $this->container['custom_fields']; } /** - * Sets updated_at + * Sets custom_fields * - * @param int|null $updated_at time the template was last updated + * @param TemplateResponseDocumentCustomFieldBase[]|null $custom_fields Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. * * @return self + * @deprecated */ - public function setUpdatedAt(?int $updated_at) + public function setCustomFields(?array $custom_fields) { - if (is_null($updated_at)) { - throw new InvalidArgumentException('non-nullable updated_at cannot be null'); + if (is_null($custom_fields)) { + array_push($this->openAPINullablesSetToNull, 'custom_fields'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('custom_fields', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } } - $this->container['updated_at'] = $updated_at; + $this->container['custom_fields'] = $custom_fields; return $this; } /** - * Gets is_embedded + * Gets named_form_fields * - * @return bool|null + * @return TemplateResponseDocumentFormFieldBase[]|null + * @deprecated */ - public function getIsEmbedded() + public function getNamedFormFields() { - return $this->container['is_embedded']; + return $this->container['named_form_fields']; } /** - * Sets is_embedded + * Sets named_form_fields * - * @param bool|null $is_embedded `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + * @param TemplateResponseDocumentFormFieldBase[]|null $named_form_fields Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. * * @return self + * @deprecated */ - public function setIsEmbedded(?bool $is_embedded) + public function setNamedFormFields(?array $named_form_fields) { - if (is_null($is_embedded)) { - array_push($this->openAPINullablesSetToNull, 'is_embedded'); + if (is_null($named_form_fields)) { + array_push($this->openAPINullablesSetToNull, 'named_form_fields'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('is_embedded', $nullablesSetToNull); + $index = array_search('named_form_fields', $nullablesSetToNull); if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } } - $this->container['is_embedded'] = $is_embedded; + $this->container['named_form_fields'] = $named_form_fields; return $this; } /** - * Gets custom_fields + * Gets accounts * - * @return TemplateResponseDocumentCustomFieldBase[]|null - * @deprecated + * @return TemplateResponseAccount[]|null */ - public function getCustomFields() + public function getAccounts() { - return $this->container['custom_fields']; + return $this->container['accounts']; } /** - * Sets custom_fields + * Sets accounts * - * @param TemplateResponseDocumentCustomFieldBase[]|null $custom_fields Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + * @param TemplateResponseAccount[]|null $accounts an array of the Accounts that can use this Template * * @return self - * @deprecated */ - public function setCustomFields(?array $custom_fields) + public function setAccounts(?array $accounts) { - if (is_null($custom_fields)) { - array_push($this->openAPINullablesSetToNull, 'custom_fields'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('custom_fields', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + if (is_null($accounts)) { + throw new InvalidArgumentException('non-nullable accounts cannot be null'); } - $this->container['custom_fields'] = $custom_fields; + $this->container['accounts'] = $accounts; return $this; } /** - * Gets named_form_fields + * Gets attachments * - * @return TemplateResponseDocumentFormFieldBase[]|null - * @deprecated + * @return SignatureRequestResponseAttachment[]|null */ - public function getNamedFormFields() + public function getAttachments() { - return $this->container['named_form_fields']; + return $this->container['attachments']; } /** - * Sets named_form_fields + * Sets attachments * - * @param TemplateResponseDocumentFormFieldBase[]|null $named_form_fields Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + * @param SignatureRequestResponseAttachment[]|null $attachments signer attachments * * @return self - * @deprecated */ - public function setNamedFormFields(?array $named_form_fields) + public function setAttachments(?array $attachments) { - if (is_null($named_form_fields)) { - array_push($this->openAPINullablesSetToNull, 'named_form_fields'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('named_form_fields', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + if (is_null($attachments)) { + throw new InvalidArgumentException('non-nullable attachments cannot be null'); } - $this->container['named_form_fields'] = $named_form_fields; + $this->container['attachments'] = $attachments; return $this; } diff --git a/sdks/php/src/Model/TemplateResponseAccount.php b/sdks/php/src/Model/TemplateResponseAccount.php index 538aed394..47ddefabe 100644 --- a/sdks/php/src/Model/TemplateResponseAccount.php +++ b/sdks/php/src/Model/TemplateResponseAccount.php @@ -58,11 +58,11 @@ class TemplateResponseAccount implements ModelInterface, ArrayAccess, JsonSerial */ protected static $openAPITypes = [ 'account_id' => 'string', + 'email_address' => 'string', 'is_locked' => 'bool', 'is_paid_hs' => 'bool', 'is_paid_hf' => 'bool', 'quotas' => '\Dropbox\Sign\Model\TemplateResponseAccountQuota', - 'email_address' => 'string', ]; /** @@ -74,11 +74,11 @@ class TemplateResponseAccount implements ModelInterface, ArrayAccess, JsonSerial */ 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, ]; /** @@ -88,11 +88,11 @@ class TemplateResponseAccount implements ModelInterface, ArrayAccess, JsonSerial */ 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, ]; /** @@ -174,11 +174,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', ]; /** @@ -188,11 +188,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', ]; /** @@ -202,11 +202,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', ]; /** @@ -266,11 +266,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); } /** @@ -316,24 +316,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 []; } /** @@ -350,7 +333,7 @@ public function valid() /** * Gets account_id * - * @return string + * @return string|null */ public function getAccountId() { @@ -360,11 +343,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'); @@ -374,10 +357,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() { @@ -387,11 +397,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'); @@ -404,7 +414,7 @@ public function setIsLocked(bool $is_locked) /** * Gets is_paid_hs * - * @return bool + * @return bool|null */ public function getIsPaidHs() { @@ -414,11 +424,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'); @@ -431,7 +441,7 @@ public function setIsPaidHs(bool $is_paid_hs) /** * Gets is_paid_hf * - * @return bool + * @return bool|null */ public function getIsPaidHf() { @@ -441,11 +451,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'); @@ -458,7 +468,7 @@ public function setIsPaidHf(bool $is_paid_hf) /** * Gets quotas * - * @return TemplateResponseAccountQuota + * @return TemplateResponseAccountQuota|null */ public function getQuotas() { @@ -468,11 +478,11 @@ public function getQuotas() /** * Sets quotas * - * @param TemplateResponseAccountQuota $quotas quotas + * @param TemplateResponseAccountQuota|null $quotas quotas * * @return self */ - public function setQuotas(TemplateResponseAccountQuota $quotas) + public function setQuotas(?TemplateResponseAccountQuota $quotas) { if (is_null($quotas)) { throw new InvalidArgumentException('non-nullable quotas cannot be null'); @@ -482,33 +492,6 @@ public function setQuotas(TemplateResponseAccountQuota $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; - } - /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseAccountQuota.php b/sdks/php/src/Model/TemplateResponseAccountQuota.php index e27a97325..46386d6ec 100644 --- a/sdks/php/src/Model/TemplateResponseAccountQuota.php +++ b/sdks/php/src/Model/TemplateResponseAccountQuota.php @@ -303,21 +303,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['templates_left'] === null) { - $invalidProperties[] = "'templates_left' can't be null"; - } - if ($this->container['api_signature_requests_left'] === null) { - $invalidProperties[] = "'api_signature_requests_left' can't be null"; - } - if ($this->container['documents_left'] === null) { - $invalidProperties[] = "'documents_left' can't be null"; - } - if ($this->container['sms_verifications_left'] === null) { - $invalidProperties[] = "'sms_verifications_left' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -334,7 +320,7 @@ public function valid() /** * Gets templates_left * - * @return int + * @return int|null */ public function getTemplatesLeft() { @@ -344,11 +330,11 @@ public function getTemplatesLeft() /** * Sets templates_left * - * @param int $templates_left API templates remaining + * @param int|null $templates_left API templates remaining * * @return self */ - public function setTemplatesLeft(int $templates_left) + public function setTemplatesLeft(?int $templates_left) { if (is_null($templates_left)) { throw new InvalidArgumentException('non-nullable templates_left cannot be null'); @@ -361,7 +347,7 @@ public function setTemplatesLeft(int $templates_left) /** * Gets api_signature_requests_left * - * @return int + * @return int|null */ public function getApiSignatureRequestsLeft() { @@ -371,11 +357,11 @@ public function getApiSignatureRequestsLeft() /** * Sets api_signature_requests_left * - * @param int $api_signature_requests_left API signature requests remaining + * @param int|null $api_signature_requests_left API signature requests remaining * * @return self */ - public function setApiSignatureRequestsLeft(int $api_signature_requests_left) + public function setApiSignatureRequestsLeft(?int $api_signature_requests_left) { if (is_null($api_signature_requests_left)) { throw new InvalidArgumentException('non-nullable api_signature_requests_left cannot be null'); @@ -388,7 +374,7 @@ public function setApiSignatureRequestsLeft(int $api_signature_requests_left) /** * Gets documents_left * - * @return int + * @return int|null */ public function getDocumentsLeft() { @@ -398,11 +384,11 @@ public function getDocumentsLeft() /** * Sets documents_left * - * @param int $documents_left signature requests remaining + * @param int|null $documents_left signature requests remaining * * @return self */ - public function setDocumentsLeft(int $documents_left) + public function setDocumentsLeft(?int $documents_left) { if (is_null($documents_left)) { throw new InvalidArgumentException('non-nullable documents_left cannot be null'); @@ -415,7 +401,7 @@ public function setDocumentsLeft(int $documents_left) /** * Gets sms_verifications_left * - * @return int + * @return int|null */ public function getSmsVerificationsLeft() { @@ -425,11 +411,11 @@ public function getSmsVerificationsLeft() /** * Sets sms_verifications_left * - * @param int $sms_verifications_left SMS verifications remaining + * @param int|null $sms_verifications_left SMS verifications remaining * * @return self */ - public function setSmsVerificationsLeft(int $sms_verifications_left) + public function setSmsVerificationsLeft(?int $sms_verifications_left) { if (is_null($sms_verifications_left)) { throw new InvalidArgumentException('non-nullable sms_verifications_left cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseCCRole.php b/sdks/php/src/Model/TemplateResponseCCRole.php index 28044c0ea..06ee33219 100644 --- a/sdks/php/src/Model/TemplateResponseCCRole.php +++ b/sdks/php/src/Model/TemplateResponseCCRole.php @@ -281,12 +281,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['name'] === null) { - $invalidProperties[] = "'name' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -303,7 +298,7 @@ public function valid() /** * Gets name * - * @return string + * @return string|null */ public function getName() { @@ -313,11 +308,11 @@ public function getName() /** * Sets name * - * @param string $name the name of the Role + * @param string|null $name the name of the Role * * @return self */ - public function setName(string $name) + public function setName(?string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocument.php b/sdks/php/src/Model/TemplateResponseDocument.php index 6bf7ba8e8..02a88387d 100644 --- a/sdks/php/src/Model/TemplateResponseDocument.php +++ b/sdks/php/src/Model/TemplateResponseDocument.php @@ -58,11 +58,11 @@ class TemplateResponseDocument implements ModelInterface, ArrayAccess, JsonSeria */ protected static $openAPITypes = [ 'name' => 'string', + 'index' => 'int', 'field_groups' => '\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]', 'form_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]', 'custom_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]', 'static_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]', - 'index' => 'int', ]; /** @@ -74,11 +74,11 @@ class TemplateResponseDocument implements ModelInterface, ArrayAccess, JsonSeria */ protected static $openAPIFormats = [ 'name' => null, + 'index' => null, 'field_groups' => null, 'form_fields' => null, 'custom_fields' => null, 'static_fields' => null, - 'index' => null, ]; /** @@ -88,11 +88,11 @@ class TemplateResponseDocument implements ModelInterface, ArrayAccess, JsonSeria */ protected static array $openAPINullables = [ 'name' => false, + 'index' => false, 'field_groups' => false, 'form_fields' => false, 'custom_fields' => false, 'static_fields' => false, - 'index' => false, ]; /** @@ -174,11 +174,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'name' => 'name', + 'index' => 'index', 'field_groups' => 'field_groups', 'form_fields' => 'form_fields', 'custom_fields' => 'custom_fields', 'static_fields' => 'static_fields', - 'index' => 'index', ]; /** @@ -188,11 +188,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'name' => 'setName', + 'index' => 'setIndex', 'field_groups' => 'setFieldGroups', 'form_fields' => 'setFormFields', 'custom_fields' => 'setCustomFields', 'static_fields' => 'setStaticFields', - 'index' => 'setIndex', ]; /** @@ -202,11 +202,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'name' => 'getName', + 'index' => 'getIndex', 'field_groups' => 'getFieldGroups', 'form_fields' => 'getFormFields', 'custom_fields' => 'getCustomFields', 'static_fields' => 'getStaticFields', - 'index' => 'getIndex', ]; /** @@ -266,11 +266,11 @@ public function getModelName() public function __construct(array $data = null) { $this->setIfExists('name', $data ?? [], null); + $this->setIfExists('index', $data ?? [], null); $this->setIfExists('field_groups', $data ?? [], null); $this->setIfExists('form_fields', $data ?? [], null); $this->setIfExists('custom_fields', $data ?? [], null); $this->setIfExists('static_fields', $data ?? [], null); - $this->setIfExists('index', $data ?? [], null); } /** @@ -316,24 +316,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['name'] === null) { - $invalidProperties[] = "'name' can't be null"; - } - if ($this->container['field_groups'] === null) { - $invalidProperties[] = "'field_groups' can't be null"; - } - if ($this->container['form_fields'] === null) { - $invalidProperties[] = "'form_fields' can't be null"; - } - if ($this->container['custom_fields'] === null) { - $invalidProperties[] = "'custom_fields' can't be null"; - } - if ($this->container['static_fields'] === null) { - $invalidProperties[] = "'static_fields' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -350,7 +333,7 @@ public function valid() /** * Gets name * - * @return string + * @return string|null */ public function getName() { @@ -360,11 +343,11 @@ public function getName() /** * Sets name * - * @param string $name name of the associated file + * @param string|null $name name of the associated file * * @return self */ - public function setName(string $name) + public function setName(?string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); @@ -374,10 +357,37 @@ public function setName(string $name) return $this; } + /** + * Gets index + * + * @return int|null + */ + public function getIndex() + { + return $this->container['index']; + } + + /** + * Sets index + * + * @param int|null $index document ordering, the lowest index is displayed first and the highest last (0-based indexing) + * + * @return self + */ + public function setIndex(?int $index) + { + if (is_null($index)) { + throw new InvalidArgumentException('non-nullable index cannot be null'); + } + $this->container['index'] = $index; + + return $this; + } + /** * Gets field_groups * - * @return TemplateResponseDocumentFieldGroup[] + * @return TemplateResponseDocumentFieldGroup[]|null */ public function getFieldGroups() { @@ -387,11 +397,11 @@ public function getFieldGroups() /** * Sets field_groups * - * @param TemplateResponseDocumentFieldGroup[] $field_groups an array of Form Field Group objects + * @param TemplateResponseDocumentFieldGroup[]|null $field_groups an array of Form Field Group objects * * @return self */ - public function setFieldGroups(array $field_groups) + public function setFieldGroups(?array $field_groups) { if (is_null($field_groups)) { throw new InvalidArgumentException('non-nullable field_groups cannot be null'); @@ -404,7 +414,7 @@ public function setFieldGroups(array $field_groups) /** * Gets form_fields * - * @return TemplateResponseDocumentFormFieldBase[] + * @return TemplateResponseDocumentFormFieldBase[]|null */ public function getFormFields() { @@ -414,11 +424,11 @@ public function getFormFields() /** * Sets form_fields * - * @param TemplateResponseDocumentFormFieldBase[] $form_fields an array of Form Field objects containing the name and type of each named field + * @param TemplateResponseDocumentFormFieldBase[]|null $form_fields an array of Form Field objects containing the name and type of each named field * * @return self */ - public function setFormFields(array $form_fields) + public function setFormFields(?array $form_fields) { if (is_null($form_fields)) { throw new InvalidArgumentException('non-nullable form_fields cannot be null'); @@ -431,7 +441,7 @@ public function setFormFields(array $form_fields) /** * Gets custom_fields * - * @return TemplateResponseDocumentCustomFieldBase[] + * @return TemplateResponseDocumentCustomFieldBase[]|null */ public function getCustomFields() { @@ -441,11 +451,11 @@ public function getCustomFields() /** * Sets custom_fields * - * @param TemplateResponseDocumentCustomFieldBase[] $custom_fields an array of Form Field objects containing the name and type of each named field + * @param TemplateResponseDocumentCustomFieldBase[]|null $custom_fields an array of Form Field objects containing the name and type of each named field * * @return self */ - public function setCustomFields(array $custom_fields) + public function setCustomFields(?array $custom_fields) { if (is_null($custom_fields)) { throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); @@ -458,7 +468,7 @@ public function setCustomFields(array $custom_fields) /** * Gets static_fields * - * @return TemplateResponseDocumentStaticFieldBase[] + * @return TemplateResponseDocumentStaticFieldBase[]|null */ public function getStaticFields() { @@ -468,11 +478,11 @@ public function getStaticFields() /** * Sets static_fields * - * @param TemplateResponseDocumentStaticFieldBase[] $static_fields An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + * @param TemplateResponseDocumentStaticFieldBase[]|null $static_fields An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. * * @return self */ - public function setStaticFields(array $static_fields) + public function setStaticFields(?array $static_fields) { if (is_null($static_fields)) { throw new InvalidArgumentException('non-nullable static_fields cannot be null'); @@ -482,33 +492,6 @@ public function setStaticFields(array $static_fields) return $this; } - /** - * Gets index - * - * @return int|null - */ - public function getIndex() - { - return $this->container['index']; - } - - /** - * Sets index - * - * @param int|null $index document ordering, the lowest index is displayed first and the highest last (0-based indexing) - * - * @return self - */ - public function setIndex(?int $index) - { - if (is_null($index)) { - throw new InvalidArgumentException('non-nullable index cannot be null'); - } - $this->container['index'] = $index; - - return $this; - } - /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php index 0d5f29451..011502522 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php @@ -58,15 +58,15 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc * @var string[] */ protected static $openAPITypes = [ + 'type' => 'string', 'api_id' => 'string', 'name' => 'string', - 'type' => 'string', + 'signer' => 'string', 'x' => 'int', 'y' => 'int', 'width' => 'int', 'height' => 'int', 'required' => 'bool', - 'signer' => 'string', 'group' => 'string', ]; @@ -78,15 +78,15 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc * @psalm-var array */ protected static $openAPIFormats = [ + 'type' => null, 'api_id' => null, 'name' => null, - 'type' => null, + 'signer' => null, 'x' => null, 'y' => null, 'width' => null, 'height' => null, 'required' => null, - 'signer' => null, 'group' => null, ]; @@ -96,15 +96,15 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc * @var bool[] */ protected static array $openAPINullables = [ + 'type' => false, 'api_id' => false, 'name' => false, - 'type' => false, + 'signer' => true, 'x' => false, 'y' => false, 'width' => false, 'height' => false, 'required' => false, - 'signer' => true, 'group' => true, ]; @@ -186,15 +186,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ + 'type' => 'type', 'api_id' => 'api_id', 'name' => 'name', - 'type' => 'type', + 'signer' => 'signer', 'x' => 'x', 'y' => 'y', 'width' => 'width', 'height' => 'height', 'required' => 'required', - 'signer' => 'signer', 'group' => 'group', ]; @@ -204,15 +204,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ + 'type' => 'setType', 'api_id' => 'setApiId', 'name' => 'setName', - 'type' => 'setType', + 'signer' => 'setSigner', 'x' => 'setX', 'y' => 'setY', 'width' => 'setWidth', 'height' => 'setHeight', 'required' => 'setRequired', - 'signer' => 'setSigner', 'group' => 'setGroup', ]; @@ -222,15 +222,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ + 'type' => 'getType', 'api_id' => 'getApiId', 'name' => 'getName', - 'type' => 'getType', + 'signer' => 'getSigner', 'x' => 'getX', 'y' => 'getY', 'width' => 'getWidth', 'height' => 'getHeight', 'required' => 'getRequired', - 'signer' => 'getSigner', 'group' => 'getGroup', ]; @@ -290,15 +290,15 @@ public function getModelName() */ public function __construct(array $data = null) { + $this->setIfExists('type', $data ?? [], null); $this->setIfExists('api_id', $data ?? [], null); $this->setIfExists('name', $data ?? [], null); - $this->setIfExists('type', $data ?? [], null); + $this->setIfExists('signer', $data ?? [], null); $this->setIfExists('x', $data ?? [], null); $this->setIfExists('y', $data ?? [], null); $this->setIfExists('width', $data ?? [], null); $this->setIfExists('height', $data ?? [], null); $this->setIfExists('required', $data ?? [], null); - $this->setIfExists('signer', $data ?? [], null); $this->setIfExists('group', $data ?? [], null); // Initialize discriminator property with the model name. @@ -346,30 +346,9 @@ public function listInvalidProperties() { $invalidProperties = []; - if ($this->container['api_id'] === null) { - $invalidProperties[] = "'api_id' can't be null"; - } - if ($this->container['name'] === null) { - $invalidProperties[] = "'name' can't be null"; - } if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } - if ($this->container['x'] === null) { - $invalidProperties[] = "'x' can't be null"; - } - if ($this->container['y'] === null) { - $invalidProperties[] = "'y' can't be null"; - } - if ($this->container['width'] === null) { - $invalidProperties[] = "'width' can't be null"; - } - if ($this->container['height'] === null) { - $invalidProperties[] = "'height' can't be null"; - } - if ($this->container['required'] === null) { - $invalidProperties[] = "'required' can't be null"; - } return $invalidProperties; } @@ -385,10 +364,37 @@ public function valid() } /** - * Gets api_id + * Gets type * * @return string */ + public function getType() + { + return $this->container['type']; + } + + /** + * Sets type + * + * @param string $type type + * + * @return self + */ + public function setType(string $type) + { + if (is_null($type)) { + throw new InvalidArgumentException('non-nullable type cannot be null'); + } + $this->container['type'] = $type; + + return $this; + } + + /** + * Gets api_id + * + * @return string|null + */ public function getApiId() { return $this->container['api_id']; @@ -397,11 +403,11 @@ public function getApiId() /** * Sets api_id * - * @param string $api_id the unique ID for this field + * @param string|null $api_id the unique ID for this field * * @return self */ - public function setApiId(string $api_id) + public function setApiId(?string $api_id) { if (is_null($api_id)) { throw new InvalidArgumentException('non-nullable api_id cannot be null'); @@ -414,7 +420,7 @@ public function setApiId(string $api_id) /** * Gets name * - * @return string + * @return string|null */ public function getName() { @@ -424,11 +430,11 @@ public function getName() /** * Sets name * - * @param string $name the name of the Custom Field + * @param string|null $name the name of the Custom Field * * @return self */ - public function setName(string $name) + public function setName(?string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); @@ -439,28 +445,35 @@ public function setName(string $name) } /** - * Gets type + * Gets signer * - * @return string + * @return string|null */ - public function getType() + public function getSigner() { - return $this->container['type']; + return $this->container['signer']; } /** - * Sets type + * Sets signer * - * @param string $type type + * @param string|null $signer The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). * * @return self */ - public function setType(string $type) + public function setSigner(?string $signer) { - if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + if (is_null($signer)) { + array_push($this->openAPINullablesSetToNull, 'signer'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('signer', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } } - $this->container['type'] = $type; + $this->container['signer'] = $signer; return $this; } @@ -468,7 +481,7 @@ public function setType(string $type) /** * Gets x * - * @return int + * @return int|null */ public function getX() { @@ -478,11 +491,11 @@ public function getX() /** * Sets x * - * @param int $x the horizontal offset in pixels for this form field + * @param int|null $x the horizontal offset in pixels for this form field * * @return self */ - public function setX(int $x) + public function setX(?int $x) { if (is_null($x)) { throw new InvalidArgumentException('non-nullable x cannot be null'); @@ -495,7 +508,7 @@ public function setX(int $x) /** * Gets y * - * @return int + * @return int|null */ public function getY() { @@ -505,11 +518,11 @@ public function getY() /** * Sets y * - * @param int $y the vertical offset in pixels for this form field + * @param int|null $y the vertical offset in pixels for this form field * * @return self */ - public function setY(int $y) + public function setY(?int $y) { if (is_null($y)) { throw new InvalidArgumentException('non-nullable y cannot be null'); @@ -522,7 +535,7 @@ public function setY(int $y) /** * Gets width * - * @return int + * @return int|null */ public function getWidth() { @@ -532,11 +545,11 @@ public function getWidth() /** * Sets width * - * @param int $width the width in pixels of this form field + * @param int|null $width the width in pixels of this form field * * @return self */ - public function setWidth(int $width) + public function setWidth(?int $width) { if (is_null($width)) { throw new InvalidArgumentException('non-nullable width cannot be null'); @@ -549,7 +562,7 @@ public function setWidth(int $width) /** * Gets height * - * @return int + * @return int|null */ public function getHeight() { @@ -559,11 +572,11 @@ public function getHeight() /** * Sets height * - * @param int $height the height in pixels of this form field + * @param int|null $height the height in pixels of this form field * * @return self */ - public function setHeight(int $height) + public function setHeight(?int $height) { if (is_null($height)) { throw new InvalidArgumentException('non-nullable height cannot be null'); @@ -576,7 +589,7 @@ public function setHeight(int $height) /** * Gets required * - * @return bool + * @return bool|null */ public function getRequired() { @@ -586,11 +599,11 @@ public function getRequired() /** * Sets required * - * @param bool $required boolean showing whether or not this field is required + * @param bool|null $required boolean showing whether or not this field is required * * @return self */ - public function setRequired(bool $required) + public function setRequired(?bool $required) { if (is_null($required)) { throw new InvalidArgumentException('non-nullable required cannot be null'); @@ -600,40 +613,6 @@ public function setRequired(bool $required) return $this; } - /** - * Gets signer - * - * @return string|null - */ - public function getSigner() - { - return $this->container['signer']; - } - - /** - * Sets signer - * - * @param string|null $signer The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). - * - * @return self - */ - public function setSigner(?string $signer) - { - if (is_null($signer)) { - array_push($this->openAPINullablesSetToNull, 'signer'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('signer', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } - } - $this->container['signer'] = $signer; - - return $this; - } - /** * Gets group * diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php index 1ae1955b6..e63a73978 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php @@ -308,18 +308,6 @@ public function listInvalidProperties() if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } - if ($this->container['avg_text_length'] === null) { - $invalidProperties[] = "'avg_text_length' can't be null"; - } - if ($this->container['is_multiline'] === null) { - $invalidProperties[] = "'is_multiline' can't be null"; - } - if ($this->container['original_font_size'] === null) { - $invalidProperties[] = "'original_font_size' can't be null"; - } - if ($this->container['font_family'] === null) { - $invalidProperties[] = "'font_family' can't be null"; - } return $invalidProperties; } @@ -364,7 +352,7 @@ public function setType(string $type) /** * Gets avg_text_length * - * @return TemplateResponseFieldAvgTextLength + * @return TemplateResponseFieldAvgTextLength|null */ public function getAvgTextLength() { @@ -374,11 +362,11 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param TemplateResponseFieldAvgTextLength $avg_text_length avg_text_length + * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength(TemplateResponseFieldAvgTextLength $avg_text_length) + public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) { if (is_null($avg_text_length)) { throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); @@ -391,7 +379,7 @@ public function setAvgTextLength(TemplateResponseFieldAvgTextLength $avg_text_le /** * Gets is_multiline * - * @return bool + * @return bool|null */ public function getIsMultiline() { @@ -401,11 +389,11 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool $is_multiline whether this form field is multiline text + * @param bool|null $is_multiline whether this form field is multiline text * * @return self */ - public function setIsMultiline(bool $is_multiline) + public function setIsMultiline(?bool $is_multiline) { if (is_null($is_multiline)) { throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); @@ -418,7 +406,7 @@ public function setIsMultiline(bool $is_multiline) /** * Gets original_font_size * - * @return int + * @return int|null */ public function getOriginalFontSize() { @@ -428,11 +416,11 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int $original_font_size original font size used in this form field's text + * @param int|null $original_font_size original font size used in this form field's text * * @return self */ - public function setOriginalFontSize(int $original_font_size) + public function setOriginalFontSize(?int $original_font_size) { if (is_null($original_font_size)) { throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); @@ -445,7 +433,7 @@ public function setOriginalFontSize(int $original_font_size) /** * Gets font_family * - * @return string + * @return string|null */ public function getFontFamily() { @@ -455,11 +443,11 @@ public function getFontFamily() /** * Sets font_family * - * @param string $font_family font family used in this form field's text + * @param string|null $font_family font family used in this form field's text * * @return self */ - public function setFontFamily(string $font_family) + public function setFontFamily(?string $font_family) { if (is_null($font_family)) { throw new InvalidArgumentException('non-nullable font_family cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php b/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php index 6c714950a..541714841 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php @@ -288,15 +288,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['name'] === null) { - $invalidProperties[] = "'name' can't be null"; - } - if ($this->container['rule'] === null) { - $invalidProperties[] = "'rule' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -313,7 +305,7 @@ public function valid() /** * Gets name * - * @return string + * @return string|null */ public function getName() { @@ -323,11 +315,11 @@ public function getName() /** * Sets name * - * @param string $name the name of the form field group + * @param string|null $name the name of the form field group * * @return self */ - public function setName(string $name) + public function setName(?string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); @@ -340,7 +332,7 @@ public function setName(string $name) /** * Gets rule * - * @return TemplateResponseDocumentFieldGroupRule + * @return TemplateResponseDocumentFieldGroupRule|null */ public function getRule() { @@ -350,11 +342,11 @@ public function getRule() /** * Sets rule * - * @param TemplateResponseDocumentFieldGroupRule $rule rule + * @param TemplateResponseDocumentFieldGroupRule|null $rule rule * * @return self */ - public function setRule(TemplateResponseDocumentFieldGroupRule $rule) + public function setRule(?TemplateResponseDocumentFieldGroupRule $rule) { if (is_null($rule)) { throw new InvalidArgumentException('non-nullable rule cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php b/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php index d46ce788b..1bd31bde9 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php @@ -289,15 +289,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['requirement'] === null) { - $invalidProperties[] = "'requirement' can't be null"; - } - if ($this->container['group_label'] === null) { - $invalidProperties[] = "'group_label' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -314,7 +306,7 @@ public function valid() /** * Gets requirement * - * @return string + * @return string|null */ public function getRequirement() { @@ -324,11 +316,11 @@ public function getRequirement() /** * Sets requirement * - * @param string $requirement Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. + * @param string|null $requirement Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. * * @return self */ - public function setRequirement(string $requirement) + public function setRequirement(?string $requirement) { if (is_null($requirement)) { throw new InvalidArgumentException('non-nullable requirement cannot be null'); @@ -341,7 +333,7 @@ public function setRequirement(string $requirement) /** * Gets group_label * - * @return string + * @return string|null */ public function getGroupLabel() { @@ -351,11 +343,11 @@ public function getGroupLabel() /** * Sets group_label * - * @param string $group_label Name of the group + * @param string|null $group_label Name of the group * * @return self */ - public function setGroupLabel(string $group_label) + public function setGroupLabel(?string $group_label) { if (is_null($group_label)) { throw new InvalidArgumentException('non-nullable group_label cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php index cb72f6d81..ecc03a7db 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php @@ -58,9 +58,9 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce * @var string[] */ protected static $openAPITypes = [ + 'type' => 'string', 'api_id' => 'string', 'name' => 'string', - 'type' => 'string', 'signer' => 'string', 'x' => 'int', 'y' => 'int', @@ -77,9 +77,9 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce * @psalm-var array */ protected static $openAPIFormats = [ + 'type' => null, 'api_id' => null, 'name' => null, - 'type' => null, 'signer' => null, 'x' => null, 'y' => null, @@ -94,9 +94,9 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce * @var bool[] */ protected static array $openAPINullables = [ + 'type' => false, 'api_id' => false, 'name' => false, - 'type' => false, 'signer' => false, 'x' => false, 'y' => false, @@ -183,9 +183,9 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ + 'type' => 'type', 'api_id' => 'api_id', 'name' => 'name', - 'type' => 'type', 'signer' => 'signer', 'x' => 'x', 'y' => 'y', @@ -200,9 +200,9 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ + 'type' => 'setType', 'api_id' => 'setApiId', 'name' => 'setName', - 'type' => 'setType', 'signer' => 'setSigner', 'x' => 'setX', 'y' => 'setY', @@ -217,9 +217,9 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ + 'type' => 'getType', 'api_id' => 'getApiId', 'name' => 'getName', - 'type' => 'getType', 'signer' => 'getSigner', 'x' => 'getX', 'y' => 'getY', @@ -284,9 +284,9 @@ public function getModelName() */ public function __construct(array $data = null) { + $this->setIfExists('type', $data ?? [], null); $this->setIfExists('api_id', $data ?? [], null); $this->setIfExists('name', $data ?? [], null); - $this->setIfExists('type', $data ?? [], null); $this->setIfExists('signer', $data ?? [], null); $this->setIfExists('x', $data ?? [], null); $this->setIfExists('y', $data ?? [], null); @@ -357,33 +357,9 @@ public function listInvalidProperties() { $invalidProperties = []; - if ($this->container['api_id'] === null) { - $invalidProperties[] = "'api_id' can't be null"; - } - if ($this->container['name'] === null) { - $invalidProperties[] = "'name' can't be null"; - } if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } - if ($this->container['signer'] === null) { - $invalidProperties[] = "'signer' can't be null"; - } - if ($this->container['x'] === null) { - $invalidProperties[] = "'x' can't be null"; - } - if ($this->container['y'] === null) { - $invalidProperties[] = "'y' can't be null"; - } - if ($this->container['width'] === null) { - $invalidProperties[] = "'width' can't be null"; - } - if ($this->container['height'] === null) { - $invalidProperties[] = "'height' can't be null"; - } - if ($this->container['required'] === null) { - $invalidProperties[] = "'required' can't be null"; - } return $invalidProperties; } @@ -399,82 +375,82 @@ public function valid() } /** - * Gets api_id + * Gets type * * @return string */ - public function getApiId() + public function getType() { - return $this->container['api_id']; + return $this->container['type']; } /** - * Sets api_id + * Sets type * - * @param string $api_id a unique id for the form field + * @param string $type type * * @return self */ - public function setApiId(string $api_id) + public function setType(string $type) { - if (is_null($api_id)) { - throw new InvalidArgumentException('non-nullable api_id cannot be null'); + if (is_null($type)) { + throw new InvalidArgumentException('non-nullable type cannot be null'); } - $this->container['api_id'] = $api_id; + $this->container['type'] = $type; return $this; } /** - * Gets name + * Gets api_id * - * @return string + * @return string|null */ - public function getName() + public function getApiId() { - return $this->container['name']; + return $this->container['api_id']; } /** - * Sets name + * Sets api_id * - * @param string $name the name of the form field + * @param string|null $api_id a unique id for the form field * * @return self */ - public function setName(string $name) + public function setApiId(?string $api_id) { - if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + if (is_null($api_id)) { + throw new InvalidArgumentException('non-nullable api_id cannot be null'); } - $this->container['name'] = $name; + $this->container['api_id'] = $api_id; return $this; } /** - * Gets type + * Gets name * - * @return string + * @return string|null */ - public function getType() + public function getName() { - return $this->container['type']; + return $this->container['name']; } /** - * Sets type + * Sets name * - * @param string $type type + * @param string|null $name the name of the form field * * @return self */ - public function setType(string $type) + public function setName(?string $name) { - if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + if (is_null($name)) { + throw new InvalidArgumentException('non-nullable name cannot be null'); } - $this->container['type'] = $type; + $this->container['name'] = $name; return $this; } @@ -482,7 +458,7 @@ public function setType(string $type) /** * Gets signer * - * @return string + * @return string|null */ public function getSigner() { @@ -492,11 +468,11 @@ public function getSigner() /** * Sets signer * - * @param string $signer the signer of the Form Field + * @param string|null $signer the signer of the Form Field * * @return self */ - public function setSigner(string $signer) + public function setSigner(?string $signer) { if (is_null($signer)) { throw new InvalidArgumentException('non-nullable signer cannot be null'); @@ -509,7 +485,7 @@ public function setSigner(string $signer) /** * Gets x * - * @return int + * @return int|null */ public function getX() { @@ -519,11 +495,11 @@ public function getX() /** * Sets x * - * @param int $x the horizontal offset in pixels for this form field + * @param int|null $x the horizontal offset in pixels for this form field * * @return self */ - public function setX(int $x) + public function setX(?int $x) { if (is_null($x)) { throw new InvalidArgumentException('non-nullable x cannot be null'); @@ -536,7 +512,7 @@ public function setX(int $x) /** * Gets y * - * @return int + * @return int|null */ public function getY() { @@ -546,11 +522,11 @@ public function getY() /** * Sets y * - * @param int $y the vertical offset in pixels for this form field + * @param int|null $y the vertical offset in pixels for this form field * * @return self */ - public function setY(int $y) + public function setY(?int $y) { if (is_null($y)) { throw new InvalidArgumentException('non-nullable y cannot be null'); @@ -563,7 +539,7 @@ public function setY(int $y) /** * Gets width * - * @return int + * @return int|null */ public function getWidth() { @@ -573,11 +549,11 @@ public function getWidth() /** * Sets width * - * @param int $width the width in pixels of this form field + * @param int|null $width the width in pixels of this form field * * @return self */ - public function setWidth(int $width) + public function setWidth(?int $width) { if (is_null($width)) { throw new InvalidArgumentException('non-nullable width cannot be null'); @@ -590,7 +566,7 @@ public function setWidth(int $width) /** * Gets height * - * @return int + * @return int|null */ public function getHeight() { @@ -600,11 +576,11 @@ public function getHeight() /** * Sets height * - * @param int $height the height in pixels of this form field + * @param int|null $height the height in pixels of this form field * * @return self */ - public function setHeight(int $height) + public function setHeight(?int $height) { if (is_null($height)) { throw new InvalidArgumentException('non-nullable height cannot be null'); @@ -617,7 +593,7 @@ public function setHeight(int $height) /** * Gets required * - * @return bool + * @return bool|null */ public function getRequired() { @@ -627,11 +603,11 @@ public function getRequired() /** * Sets required * - * @param bool $required boolean showing whether or not this field is required + * @param bool|null $required boolean showing whether or not this field is required * * @return self */ - public function setRequired(bool $required) + public function setRequired(?bool $required) { if (is_null($required)) { throw new InvalidArgumentException('non-nullable required cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php index 0f232111f..687269f79 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php @@ -315,18 +315,6 @@ public function listInvalidProperties() if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } - if ($this->container['avg_text_length'] === null) { - $invalidProperties[] = "'avg_text_length' can't be null"; - } - if ($this->container['is_multiline'] === null) { - $invalidProperties[] = "'is_multiline' can't be null"; - } - if ($this->container['original_font_size'] === null) { - $invalidProperties[] = "'original_font_size' can't be null"; - } - if ($this->container['font_family'] === null) { - $invalidProperties[] = "'font_family' can't be null"; - } return $invalidProperties; } @@ -371,7 +359,7 @@ public function setType(string $type) /** * Gets avg_text_length * - * @return TemplateResponseFieldAvgTextLength + * @return TemplateResponseFieldAvgTextLength|null */ public function getAvgTextLength() { @@ -381,11 +369,11 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param TemplateResponseFieldAvgTextLength $avg_text_length avg_text_length + * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength(TemplateResponseFieldAvgTextLength $avg_text_length) + public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) { if (is_null($avg_text_length)) { throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); @@ -398,7 +386,7 @@ public function setAvgTextLength(TemplateResponseFieldAvgTextLength $avg_text_le /** * Gets is_multiline * - * @return bool + * @return bool|null */ public function getIsMultiline() { @@ -408,11 +396,11 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool $is_multiline whether this form field is multiline text + * @param bool|null $is_multiline whether this form field is multiline text * * @return self */ - public function setIsMultiline(bool $is_multiline) + public function setIsMultiline(?bool $is_multiline) { if (is_null($is_multiline)) { throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); @@ -425,7 +413,7 @@ public function setIsMultiline(bool $is_multiline) /** * Gets original_font_size * - * @return int + * @return int|null */ public function getOriginalFontSize() { @@ -435,11 +423,11 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int $original_font_size original font size used in this form field's text + * @param int|null $original_font_size original font size used in this form field's text * * @return self */ - public function setOriginalFontSize(int $original_font_size) + public function setOriginalFontSize(?int $original_font_size) { if (is_null($original_font_size)) { throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); @@ -452,7 +440,7 @@ public function setOriginalFontSize(int $original_font_size) /** * Gets font_family * - * @return string + * @return string|null */ public function getFontFamily() { @@ -462,11 +450,11 @@ public function getFontFamily() /** * Sets font_family * - * @param string $font_family font family used in this form field's text + * @param string|null $font_family font family used in this form field's text * * @return self */ - public function setFontFamily(string $font_family) + public function setFontFamily(?string $font_family) { if (is_null($font_family)) { throw new InvalidArgumentException('non-nullable font_family cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php index d8a69b6e0..42c15b9ed 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php @@ -354,18 +354,6 @@ public function listInvalidProperties() if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } - if ($this->container['avg_text_length'] === null) { - $invalidProperties[] = "'avg_text_length' can't be null"; - } - if ($this->container['is_multiline'] === null) { - $invalidProperties[] = "'is_multiline' can't be null"; - } - if ($this->container['original_font_size'] === null) { - $invalidProperties[] = "'original_font_size' can't be null"; - } - if ($this->container['font_family'] === null) { - $invalidProperties[] = "'font_family' can't be null"; - } $allowedValues = $this->getValidationTypeAllowableValues(); if (!is_null($this->container['validation_type']) && !in_array($this->container['validation_type'], $allowedValues, true)) { $invalidProperties[] = sprintf( @@ -419,7 +407,7 @@ public function setType(string $type) /** * Gets avg_text_length * - * @return TemplateResponseFieldAvgTextLength + * @return TemplateResponseFieldAvgTextLength|null */ public function getAvgTextLength() { @@ -429,11 +417,11 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param TemplateResponseFieldAvgTextLength $avg_text_length avg_text_length + * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength(TemplateResponseFieldAvgTextLength $avg_text_length) + public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) { if (is_null($avg_text_length)) { throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); @@ -446,7 +434,7 @@ public function setAvgTextLength(TemplateResponseFieldAvgTextLength $avg_text_le /** * Gets is_multiline * - * @return bool + * @return bool|null */ public function getIsMultiline() { @@ -456,11 +444,11 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool $is_multiline whether this form field is multiline text + * @param bool|null $is_multiline whether this form field is multiline text * * @return self */ - public function setIsMultiline(bool $is_multiline) + public function setIsMultiline(?bool $is_multiline) { if (is_null($is_multiline)) { throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); @@ -473,7 +461,7 @@ public function setIsMultiline(bool $is_multiline) /** * Gets original_font_size * - * @return int + * @return int|null */ public function getOriginalFontSize() { @@ -483,11 +471,11 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int $original_font_size original font size used in this form field's text + * @param int|null $original_font_size original font size used in this form field's text * * @return self */ - public function setOriginalFontSize(int $original_font_size) + public function setOriginalFontSize(?int $original_font_size) { if (is_null($original_font_size)) { throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); @@ -500,7 +488,7 @@ public function setOriginalFontSize(int $original_font_size) /** * Gets font_family * - * @return string + * @return string|null */ public function getFontFamily() { @@ -510,11 +498,11 @@ public function getFontFamily() /** * Sets font_family * - * @param string $font_family font family used in this form field's text + * @param string|null $font_family font family used in this form field's text * * @return self */ - public function setFontFamily(string $font_family) + public function setFontFamily(?string $font_family) { if (is_null($font_family)) { throw new InvalidArgumentException('non-nullable font_family cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php index 4536c117d..bd18e1847 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php @@ -58,9 +58,9 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc * @var string[] */ protected static $openAPITypes = [ + 'type' => 'string', 'api_id' => 'string', 'name' => 'string', - 'type' => 'string', 'signer' => 'string', 'x' => 'int', 'y' => 'int', @@ -78,9 +78,9 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc * @psalm-var array */ protected static $openAPIFormats = [ + 'type' => null, 'api_id' => null, 'name' => null, - 'type' => null, 'signer' => null, 'x' => null, 'y' => null, @@ -96,9 +96,9 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc * @var bool[] */ protected static array $openAPINullables = [ + 'type' => false, 'api_id' => false, 'name' => false, - 'type' => false, 'signer' => false, 'x' => false, 'y' => false, @@ -186,9 +186,9 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ + 'type' => 'type', 'api_id' => 'api_id', 'name' => 'name', - 'type' => 'type', 'signer' => 'signer', 'x' => 'x', 'y' => 'y', @@ -204,9 +204,9 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ + 'type' => 'setType', 'api_id' => 'setApiId', 'name' => 'setName', - 'type' => 'setType', 'signer' => 'setSigner', 'x' => 'setX', 'y' => 'setY', @@ -222,9 +222,9 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ + 'type' => 'getType', 'api_id' => 'getApiId', 'name' => 'getName', - 'type' => 'getType', 'signer' => 'getSigner', 'x' => 'getX', 'y' => 'getY', @@ -290,9 +290,9 @@ public function getModelName() */ public function __construct(array $data = null) { + $this->setIfExists('type', $data ?? [], null); $this->setIfExists('api_id', $data ?? [], null); $this->setIfExists('name', $data ?? [], null); - $this->setIfExists('type', $data ?? [], null); $this->setIfExists('signer', $data ?? [], 'me_now'); $this->setIfExists('x', $data ?? [], null); $this->setIfExists('y', $data ?? [], null); @@ -364,33 +364,9 @@ public function listInvalidProperties() { $invalidProperties = []; - if ($this->container['api_id'] === null) { - $invalidProperties[] = "'api_id' can't be null"; - } - if ($this->container['name'] === null) { - $invalidProperties[] = "'name' can't be null"; - } if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } - if ($this->container['signer'] === null) { - $invalidProperties[] = "'signer' can't be null"; - } - if ($this->container['x'] === null) { - $invalidProperties[] = "'x' can't be null"; - } - if ($this->container['y'] === null) { - $invalidProperties[] = "'y' can't be null"; - } - if ($this->container['width'] === null) { - $invalidProperties[] = "'width' can't be null"; - } - if ($this->container['height'] === null) { - $invalidProperties[] = "'height' can't be null"; - } - if ($this->container['required'] === null) { - $invalidProperties[] = "'required' can't be null"; - } return $invalidProperties; } @@ -406,82 +382,82 @@ public function valid() } /** - * Gets api_id + * Gets type * * @return string */ - public function getApiId() + public function getType() { - return $this->container['api_id']; + return $this->container['type']; } /** - * Sets api_id + * Sets type * - * @param string $api_id a unique id for the static field + * @param string $type type * * @return self */ - public function setApiId(string $api_id) + public function setType(string $type) { - if (is_null($api_id)) { - throw new InvalidArgumentException('non-nullable api_id cannot be null'); + if (is_null($type)) { + throw new InvalidArgumentException('non-nullable type cannot be null'); } - $this->container['api_id'] = $api_id; + $this->container['type'] = $type; return $this; } /** - * Gets name + * Gets api_id * - * @return string + * @return string|null */ - public function getName() + public function getApiId() { - return $this->container['name']; + return $this->container['api_id']; } /** - * Sets name + * Sets api_id * - * @param string $name the name of the static field + * @param string|null $api_id a unique id for the static field * * @return self */ - public function setName(string $name) + public function setApiId(?string $api_id) { - if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + if (is_null($api_id)) { + throw new InvalidArgumentException('non-nullable api_id cannot be null'); } - $this->container['name'] = $name; + $this->container['api_id'] = $api_id; return $this; } /** - * Gets type + * Gets name * - * @return string + * @return string|null */ - public function getType() + public function getName() { - return $this->container['type']; + return $this->container['name']; } /** - * Sets type + * Sets name * - * @param string $type type + * @param string|null $name the name of the static field * * @return self */ - public function setType(string $type) + public function setName(?string $name) { - if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + if (is_null($name)) { + throw new InvalidArgumentException('non-nullable name cannot be null'); } - $this->container['type'] = $type; + $this->container['name'] = $name; return $this; } @@ -489,7 +465,7 @@ public function setType(string $type) /** * Gets signer * - * @return string + * @return string|null */ public function getSigner() { @@ -499,11 +475,11 @@ public function getSigner() /** * Sets signer * - * @param string $signer the signer of the Static Field + * @param string|null $signer the signer of the Static Field * * @return self */ - public function setSigner(string $signer) + public function setSigner(?string $signer) { if (is_null($signer)) { throw new InvalidArgumentException('non-nullable signer cannot be null'); @@ -516,7 +492,7 @@ public function setSigner(string $signer) /** * Gets x * - * @return int + * @return int|null */ public function getX() { @@ -526,11 +502,11 @@ public function getX() /** * Sets x * - * @param int $x the horizontal offset in pixels for this static field + * @param int|null $x the horizontal offset in pixels for this static field * * @return self */ - public function setX(int $x) + public function setX(?int $x) { if (is_null($x)) { throw new InvalidArgumentException('non-nullable x cannot be null'); @@ -543,7 +519,7 @@ public function setX(int $x) /** * Gets y * - * @return int + * @return int|null */ public function getY() { @@ -553,11 +529,11 @@ public function getY() /** * Sets y * - * @param int $y the vertical offset in pixels for this static field + * @param int|null $y the vertical offset in pixels for this static field * * @return self */ - public function setY(int $y) + public function setY(?int $y) { if (is_null($y)) { throw new InvalidArgumentException('non-nullable y cannot be null'); @@ -570,7 +546,7 @@ public function setY(int $y) /** * Gets width * - * @return int + * @return int|null */ public function getWidth() { @@ -580,11 +556,11 @@ public function getWidth() /** * Sets width * - * @param int $width the width in pixels of this static field + * @param int|null $width the width in pixels of this static field * * @return self */ - public function setWidth(int $width) + public function setWidth(?int $width) { if (is_null($width)) { throw new InvalidArgumentException('non-nullable width cannot be null'); @@ -597,7 +573,7 @@ public function setWidth(int $width) /** * Gets height * - * @return int + * @return int|null */ public function getHeight() { @@ -607,11 +583,11 @@ public function getHeight() /** * Sets height * - * @param int $height the height in pixels of this static field + * @param int|null $height the height in pixels of this static field * * @return self */ - public function setHeight(int $height) + public function setHeight(?int $height) { if (is_null($height)) { throw new InvalidArgumentException('non-nullable height cannot be null'); @@ -624,7 +600,7 @@ public function setHeight(int $height) /** * Gets required * - * @return bool + * @return bool|null */ public function getRequired() { @@ -634,11 +610,11 @@ public function getRequired() /** * Sets required * - * @param bool $required boolean showing whether or not this field is required + * @param bool|null $required boolean showing whether or not this field is required * * @return self */ - public function setRequired(bool $required) + public function setRequired(?bool $required) { if (is_null($required)) { throw new InvalidArgumentException('non-nullable required cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php b/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php index f43ee698c..9277db26a 100644 --- a/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php +++ b/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php @@ -289,15 +289,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['num_lines'] === null) { - $invalidProperties[] = "'num_lines' can't be null"; - } - if ($this->container['num_chars_per_line'] === null) { - $invalidProperties[] = "'num_chars_per_line' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -314,7 +306,7 @@ public function valid() /** * Gets num_lines * - * @return int + * @return int|null */ public function getNumLines() { @@ -324,11 +316,11 @@ public function getNumLines() /** * Sets num_lines * - * @param int $num_lines number of lines + * @param int|null $num_lines number of lines * * @return self */ - public function setNumLines(int $num_lines) + public function setNumLines(?int $num_lines) { if (is_null($num_lines)) { throw new InvalidArgumentException('non-nullable num_lines cannot be null'); @@ -341,7 +333,7 @@ public function setNumLines(int $num_lines) /** * Gets num_chars_per_line * - * @return int + * @return int|null */ public function getNumCharsPerLine() { @@ -351,11 +343,11 @@ public function getNumCharsPerLine() /** * Sets num_chars_per_line * - * @param int $num_chars_per_line number of characters per line + * @param int|null $num_chars_per_line number of characters per line * * @return self */ - public function setNumCharsPerLine(int $num_chars_per_line) + public function setNumCharsPerLine(?int $num_chars_per_line) { if (is_null($num_chars_per_line)) { throw new InvalidArgumentException('non-nullable num_chars_per_line cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseSignerRole.php b/sdks/php/src/Model/TemplateResponseSignerRole.php index 094e01375..98a80c6e0 100644 --- a/sdks/php/src/Model/TemplateResponseSignerRole.php +++ b/sdks/php/src/Model/TemplateResponseSignerRole.php @@ -288,12 +288,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['name'] === null) { - $invalidProperties[] = "'name' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -310,7 +305,7 @@ public function valid() /** * Gets name * - * @return string + * @return string|null */ public function getName() { @@ -320,11 +315,11 @@ public function getName() /** * Sets name * - * @param string $name the name of the Role + * @param string|null $name the name of the Role * * @return self */ - public function setName(string $name) + public function setName(?string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); diff --git a/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php b/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php index f3df49b86..70d2e87dc 100644 --- a/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php +++ b/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php @@ -289,12 +289,7 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - $invalidProperties = []; - - if ($this->container['template_id'] === null) { - $invalidProperties[] = "'template_id' can't be null"; - } - return $invalidProperties; + return []; } /** @@ -311,7 +306,7 @@ public function valid() /** * Gets template_id * - * @return string + * @return string|null */ public function getTemplateId() { @@ -321,11 +316,11 @@ public function getTemplateId() /** * Sets template_id * - * @param string $template_id the id of the Template + * @param string|null $template_id the id of the Template * * @return self */ - public function setTemplateId(string $template_id) + public function setTemplateId(?string $template_id) { if (is_null($template_id)) { throw new InvalidArgumentException('non-nullable template_id cannot be null'); diff --git a/sdks/python/docs/ApiAppResponse.md b/sdks/python/docs/ApiAppResponse.md index c3461ca70..ae25a38c4 100644 --- a/sdks/python/docs/ApiAppResponse.md +++ b/sdks/python/docs/ApiAppResponse.md @@ -5,15 +5,15 @@ Contains information about an API App. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `client_id`*_required_ | ```str``` | The app's client id | | -| `created_at`*_required_ | ```int``` | The time that the app was created | | -| `domains`*_required_ | ```List[str]``` | The domain name(s) associated with the app | | -| `name`*_required_ | ```str``` | The name of the app | | -| `is_approved`*_required_ | ```bool``` | Boolean to indicate if the app has been approved | | -| `options`*_required_ | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | -| `owner_account`*_required_ | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `callback_url` | ```str``` | The app's callback URL (for events) | | +| `client_id` | ```str``` | The app's client id | | +| `created_at` | ```int``` | The time that the app was created | | +| `domains` | ```List[str]``` | The domain name(s) associated with the app | | +| `name` | ```str``` | The name of the app | | +| `is_approved` | ```bool``` | Boolean to indicate if the app has been approved | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | +| `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | +| `owner_account` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `white_labeling_options` | [```ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | | [[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/ApiAppResponseOAuth.md b/sdks/python/docs/ApiAppResponseOAuth.md index a5aa95788..0c18e5f1e 100644 --- a/sdks/python/docs/ApiAppResponseOAuth.md +++ b/sdks/python/docs/ApiAppResponseOAuth.md @@ -5,10 +5,10 @@ An object describing the app's OAuth properties, or null if OAuth is not con ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url`*_required_ | ```str``` | The app's OAuth callback URL. | | -| `scopes`*_required_ | ```List[str]``` | Array of OAuth scopes used by the app. | | -| `charges_users`*_required_ | ```bool``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | +| `callback_url` | ```str``` | The app's OAuth callback URL. | | | `secret` | ```str``` | The app's OAuth secret, or null if the app does not belong to user. | | +| `scopes` | ```List[str]``` | Array of OAuth scopes used by the app. | | +| `charges_users` | ```bool``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | [[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/ApiAppResponseOptions.md b/sdks/python/docs/ApiAppResponseOptions.md index 96f399312..42f8144e5 100644 --- a/sdks/python/docs/ApiAppResponseOptions.md +++ b/sdks/python/docs/ApiAppResponseOptions.md @@ -5,7 +5,7 @@ An object with options that override account settings. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `can_insert_everywhere`*_required_ | ```bool``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `can_insert_everywhere` | ```bool``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | [[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/ApiAppResponseOwnerAccount.md b/sdks/python/docs/ApiAppResponseOwnerAccount.md index b11b8402e..9b8e22f08 100644 --- a/sdks/python/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/python/docs/ApiAppResponseOwnerAccount.md @@ -5,8 +5,8 @@ An object describing the app's owner ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id`*_required_ | ```str``` | The owner account's ID | | -| `email_address`*_required_ | ```str``` | The owner account's email address | | +| `account_id` | ```str``` | The owner account's ID | | +| `email_address` | ```str``` | The owner account's email address | | [[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/ApiAppResponseWhiteLabelingOptions.md b/sdks/python/docs/ApiAppResponseWhiteLabelingOptions.md index ee9742c8e..375c8f2cf 100644 --- a/sdks/python/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/python/docs/ApiAppResponseWhiteLabelingOptions.md @@ -5,20 +5,20 @@ An object with options to customize the app's signer page ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `header_background_color`*_required_ | ```str``` | | | -| `legal_version`*_required_ | ```str``` | | | -| `link_color`*_required_ | ```str``` | | | -| `page_background_color`*_required_ | ```str``` | | | -| `primary_button_color`*_required_ | ```str``` | | | -| `primary_button_color_hover`*_required_ | ```str``` | | | -| `primary_button_text_color`*_required_ | ```str``` | | | -| `primary_button_text_color_hover`*_required_ | ```str``` | | | -| `secondary_button_color`*_required_ | ```str``` | | | -| `secondary_button_color_hover`*_required_ | ```str``` | | | -| `secondary_button_text_color`*_required_ | ```str``` | | | -| `secondary_button_text_color_hover`*_required_ | ```str``` | | | -| `text_color1`*_required_ | ```str``` | | | -| `text_color2`*_required_ | ```str``` | | | +| `header_background_color` | ```str``` | | | +| `legal_version` | ```str``` | | | +| `link_color` | ```str``` | | | +| `page_background_color` | ```str``` | | | +| `primary_button_color` | ```str``` | | | +| `primary_button_color_hover` | ```str``` | | | +| `primary_button_text_color` | ```str``` | | | +| `primary_button_text_color_hover` | ```str``` | | | +| `secondary_button_color` | ```str``` | | | +| `secondary_button_color_hover` | ```str``` | | | +| `secondary_button_text_color` | ```str``` | | | +| `secondary_button_text_color_hover` | ```str``` | | | +| `text_color1` | ```str``` | | | +| `text_color2` | ```str``` | | | [[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/BulkSendJobResponse.md b/sdks/python/docs/BulkSendJobResponse.md index 0c5051615..19e770fee 100644 --- a/sdks/python/docs/BulkSendJobResponse.md +++ b/sdks/python/docs/BulkSendJobResponse.md @@ -5,10 +5,10 @@ Contains information about the BulkSendJob such as when it was created and how m ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_job_id`*_required_ | ```str``` | The id of the BulkSendJob. | | -| `total`*_required_ | ```int``` | The total amount of Signature Requests queued for sending. | | -| `is_creator`*_required_ | ```bool``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `created_at`*_required_ | ```int``` | Time that the BulkSendJob was created. | | +| `bulk_send_job_id` | ```str``` | The id of the BulkSendJob. | | +| `total` | ```int``` | The total amount of Signature Requests queued for sending. | | +| `is_creator` | ```bool``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | +| `created_at` | ```int``` | Time that the BulkSendJob was created. | | [[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/FaxLineResponseFaxLine.md b/sdks/python/docs/FaxLineResponseFaxLine.md index ac5821f1b..f3e14c0f7 100644 --- a/sdks/python/docs/FaxLineResponseFaxLine.md +++ b/sdks/python/docs/FaxLineResponseFaxLine.md @@ -5,10 +5,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```str``` | Number | | -| `created_at`*_required_ | ```int``` | Created at | | -| `updated_at`*_required_ | ```int``` | Updated at | | -| `accounts`*_required_ | [```List[AccountResponse]```](AccountResponse.md) | | | +| `number` | ```str``` | Number | | +| `created_at` | ```int``` | Created at | | +| `updated_at` | ```int``` | Updated at | | +| `accounts` | [```List[AccountResponse]```](AccountResponse.md) | | | [[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/TeamResponse.md b/sdks/python/docs/TeamResponse.md index 05256b88e..150fd646e 100644 --- a/sdks/python/docs/TeamResponse.md +++ b/sdks/python/docs/TeamResponse.md @@ -5,10 +5,10 @@ Contains information about your team and its members ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```str``` | The name of your Team | | -| `accounts`*_required_ | [```List[AccountResponse]```](AccountResponse.md) | | | -| `invited_accounts`*_required_ | [```List[AccountResponse]```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | -| `invited_emails`*_required_ | ```List[str]``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `name` | ```str``` | The name of your Team | | +| `accounts` | [```List[AccountResponse]```](AccountResponse.md) | | | +| `invited_accounts` | [```List[AccountResponse]```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | +| `invited_emails` | ```List[str]``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | [[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/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index b8801fb09..56b48ec48 100644 --- a/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -5,9 +5,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id`*_required_ | ```str``` | The id of the Template. | | -| `edit_url`*_required_ | ```str``` | Link to edit the template. | | -| `expires_at`*_required_ | ```int``` | When the link expires. | | +| `template_id` | ```str``` | The id of the Template. | | +| `edit_url` | ```str``` | Link to edit the template. | | +| `expires_at` | ```int``` | When the link expires. | | | `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | [[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/TemplateCreateResponseTemplate.md b/sdks/python/docs/TemplateCreateResponseTemplate.md index 8281fab89..1c3d76f37 100644 --- a/sdks/python/docs/TemplateCreateResponseTemplate.md +++ b/sdks/python/docs/TemplateCreateResponseTemplate.md @@ -5,7 +5,7 @@ Template object with parameters: `template_id`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id`*_required_ | ```str``` | The id of the Template. | | +| `template_id` | ```str``` | The id of the Template. | | [[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/TemplateResponse.md b/sdks/python/docs/TemplateResponse.md index c86b24d1f..315cf7176 100644 --- a/sdks/python/docs/TemplateResponse.md +++ b/sdks/python/docs/TemplateResponse.md @@ -5,22 +5,22 @@ Contains information about the templates you and your team have created. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id`*_required_ | ```str``` | The id of the Template. | | -| `title`*_required_ | ```str``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message`*_required_ | ```str``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `is_creator`*_required_ | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `can_edit`*_required_ | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `is_locked`*_required_ | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata`*_required_ | ```object``` | The metadata attached to the template. | | -| `signer_roles`*_required_ | [```List[TemplateResponseSignerRole]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `cc_roles`*_required_ | [```List[TemplateResponseCCRole]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents`*_required_ | [```List[TemplateResponseDocument]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | -| `accounts`*_required_ | [```List[TemplateResponseAccount]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | -| `attachments`*_required_ | [```List[SignatureRequestResponseAttachment]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `template_id` | ```str``` | The id of the Template. | | +| `title` | ```str``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message` | ```str``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | | `updated_at` | ```int``` | Time the template was last updated. | | | `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | +| `is_creator` | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `can_edit` | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `is_locked` | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata` | ```object``` | The metadata attached to the template. | | +| `signer_roles` | [```List[TemplateResponseSignerRole]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `cc_roles` | [```List[TemplateResponseCCRole]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | +| `documents` | [```List[TemplateResponseDocument]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `custom_fields` | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | +| `accounts` | [```List[TemplateResponseAccount]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments` | [```List[SignatureRequestResponseAttachment]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | [[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/TemplateResponseAccount.md b/sdks/python/docs/TemplateResponseAccount.md index da824a979..7668fc726 100644 --- a/sdks/python/docs/TemplateResponseAccount.md +++ b/sdks/python/docs/TemplateResponseAccount.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_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.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` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | [[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/TemplateResponseAccountQuota.md b/sdks/python/docs/TemplateResponseAccountQuota.md index 18ab10015..7e83dcc11 100644 --- a/sdks/python/docs/TemplateResponseAccountQuota.md +++ b/sdks/python/docs/TemplateResponseAccountQuota.md @@ -5,10 +5,10 @@ An array of the designated CC roles that must be specified when sending a Signat ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates_left`*_required_ | ```int``` | API templates remaining. | | -| `api_signature_requests_left`*_required_ | ```int``` | API signature requests remaining. | | -| `documents_left`*_required_ | ```int``` | Signature requests remaining. | | -| `sms_verifications_left`*_required_ | ```int``` | SMS verifications remaining. | | +| `templates_left` | ```int``` | API templates remaining. | | +| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | +| `documents_left` | ```int``` | Signature requests remaining. | | +| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | [[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/TemplateResponseCCRole.md b/sdks/python/docs/TemplateResponseCCRole.md index 81fe0a22d..1aa9fa707 100644 --- a/sdks/python/docs/TemplateResponseCCRole.md +++ b/sdks/python/docs/TemplateResponseCCRole.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```str``` | The name of the Role. | | +| `name` | ```str``` | The name of the Role. | | [[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/TemplateResponseDocument.md b/sdks/python/docs/TemplateResponseDocument.md index 6ce6cded9..8071995b9 100644 --- a/sdks/python/docs/TemplateResponseDocument.md +++ b/sdks/python/docs/TemplateResponseDocument.md @@ -5,12 +5,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```str``` | Name of the associated file. | | -| `field_groups`*_required_ | [```List[TemplateResponseDocumentFieldGroup]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `form_fields`*_required_ | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `custom_fields`*_required_ | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `static_fields`*_required_ | [```List[TemplateResponseDocumentStaticFieldBase]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | +| `name` | ```str``` | Name of the associated file. | | | `index` | ```int``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | +| `field_groups` | [```List[TemplateResponseDocumentFieldGroup]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `form_fields` | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `custom_fields` | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `static_fields` | [```List[TemplateResponseDocumentStaticFieldBase]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | [[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/TemplateResponseDocumentCustomFieldBase.md b/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md index 802b74749..83354a3f4 100644 --- a/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md @@ -5,15 +5,15 @@ An array of Form Field objects containing the name and type of each named field. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_id`*_required_ | ```str``` | The unique ID for this field. | | -| `name`*_required_ | ```str``` | The name of the Custom Field. | | | `type`*_required_ | ```str``` | | | -| `x`*_required_ | ```int``` | The horizontal offset in pixels for this form field. | | -| `y`*_required_ | ```int``` | The vertical offset in pixels for this form field. | | -| `width`*_required_ | ```int``` | The width in pixels of this form field. | | -| `height`*_required_ | ```int``` | The height in pixels of this form field. | | -| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | +| `api_id` | ```str``` | The unique ID for this field. | | +| `name` | ```str``` | The name of the Custom Field. | | | `signer` | ```str``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | +| `x` | ```int``` | The horizontal offset in pixels for this form field. | | +| `y` | ```int``` | The vertical offset in pixels for this form field. | | +| `width` | ```int``` | The width in pixels of this form field. | | +| `height` | ```int``` | The height in pixels of this form field. | | +| `required` | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseDocumentCustomFieldText.md b/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md index 35f8038d8..474097e03 100644 --- a/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md @@ -6,10 +6,10 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | -| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | -| `font_family`*_required_ | ```str``` | Font family used in this form field's text. | | +| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size` | ```int``` | Original font size used in this form field's text. | | +| `font_family` | ```str``` | Font family used in this form field's text. | | [[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/TemplateResponseDocumentFieldGroup.md b/sdks/python/docs/TemplateResponseDocumentFieldGroup.md index 718a3e198..29a19c7cf 100644 --- a/sdks/python/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/python/docs/TemplateResponseDocumentFieldGroup.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```str``` | The name of the form field group. | | -| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name` | ```str``` | The name of the form field group. | | +| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | [[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/TemplateResponseDocumentFieldGroupRule.md b/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md index 2b44ba01e..3f0a44f1a 100644 --- a/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md @@ -5,8 +5,8 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `requirement`*_required_ | ```str``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `group_label`*_required_ | ```str``` | Name of the group | | +| `requirement` | ```str``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `group_label` | ```str``` | Name of the group | | [[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/TemplateResponseDocumentFormFieldBase.md b/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md index fa864f418..a0c465ca8 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md @@ -5,15 +5,15 @@ An array of Form Field objects containing the name and type of each named field. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_id`*_required_ | ```str``` | A unique id for the form field. | | -| `name`*_required_ | ```str``` | The name of the form field. | | | `type`*_required_ | ```str``` | | | -| `signer`*_required_ | ```str``` | The signer of the Form Field. | | -| `x`*_required_ | ```int``` | The horizontal offset in pixels for this form field. | | -| `y`*_required_ | ```int``` | The vertical offset in pixels for this form field. | | -| `width`*_required_ | ```int``` | The width in pixels of this form field. | | -| `height`*_required_ | ```int``` | The height in pixels of this form field. | | -| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | +| `api_id` | ```str``` | A unique id for the form field. | | +| `name` | ```str``` | The name of the form field. | | +| `signer` | ```str``` | The signer of the Form Field. | | +| `x` | ```int``` | The horizontal offset in pixels for this form field. | | +| `y` | ```int``` | The vertical offset in pixels for this form field. | | +| `width` | ```int``` | The width in pixels of this form field. | | +| `height` | ```int``` | The height in pixels of this form field. | | +| `required` | ```bool``` | Boolean showing whether or not this field is required. | | [[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/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md index 574f277e4..ec6a6e4fa 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -6,10 +6,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | -| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | -| `font_family`*_required_ | ```str``` | Font family used in this form field's text. | | +| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size` | ```int``` | Original font size used in this form field's text. | | +| `font_family` | ```str``` | Font family used in this form field's text. | | | `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldText.md b/sdks/python/docs/TemplateResponseDocumentFormFieldText.md index b1c58101f..9e6604250 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldText.md @@ -6,10 +6,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | -| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | -| `font_family`*_required_ | ```str``` | Font family used in this form field's text. | | +| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size` | ```int``` | Original font size used in this form field's text. | | +| `font_family` | ```str``` | Font family used in this form field's text. | | | `validation_type` | ```str``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | | `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md index 39a2be0f7..a7347b687 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md @@ -5,15 +5,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_id`*_required_ | ```str``` | A unique id for the static field. | | -| `name`*_required_ | ```str``` | The name of the static field. | | | `type`*_required_ | ```str``` | | | -| `signer`*_required_ | ```str``` | The signer of the Static Field. | [default to 'me_now'] | -| `x`*_required_ | ```int``` | The horizontal offset in pixels for this static field. | | -| `y`*_required_ | ```int``` | The vertical offset in pixels for this static field. | | -| `width`*_required_ | ```int``` | The width in pixels of this static field. | | -| `height`*_required_ | ```int``` | The height in pixels of this static field. | | -| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | +| `api_id` | ```str``` | A unique id for the static field. | | +| `name` | ```str``` | The name of the static field. | | +| `signer` | ```str``` | The signer of the Static Field. | [default to 'me_now'] | +| `x` | ```int``` | The horizontal offset in pixels for this static field. | | +| `y` | ```int``` | The vertical offset in pixels for this static field. | | +| `width` | ```int``` | The width in pixels of this static field. | | +| `height` | ```int``` | The height in pixels of this static field. | | +| `required` | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseFieldAvgTextLength.md b/sdks/python/docs/TemplateResponseFieldAvgTextLength.md index 7cb7f1475..f50991c74 100644 --- a/sdks/python/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/python/docs/TemplateResponseFieldAvgTextLength.md @@ -5,8 +5,8 @@ Average text length in this field. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `num_lines`*_required_ | ```int``` | Number of lines. | | -| `num_chars_per_line`*_required_ | ```int``` | Number of characters per line. | | +| `num_lines` | ```int``` | Number of lines. | | +| `num_chars_per_line` | ```int``` | Number of characters per line. | | [[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/TemplateResponseSignerRole.md b/sdks/python/docs/TemplateResponseSignerRole.md index 75bd84379..7a65a361d 100644 --- a/sdks/python/docs/TemplateResponseSignerRole.md +++ b/sdks/python/docs/TemplateResponseSignerRole.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```str``` | The name of the Role. | | +| `name` | ```str``` | The name of the Role. | | | `order` | ```int``` | If signer order is assigned this is the 0-based index for this role. | | [[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/TemplateUpdateFilesResponseTemplate.md b/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md index fbd42b28c..27ea3171f 100644 --- a/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md @@ -5,7 +5,7 @@ Contains template id ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id`*_required_ | ```str``` | The id of the Template. | | +| `template_id` | ```str``` | The id of the Template. | | | `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | [[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/api_app_response.py b/sdks/python/dropbox_sign/models/api_app_response.py index 9381e2f88..a1f0bf157 100644 --- a/sdks/python/dropbox_sign/models/api_app_response.py +++ b/sdks/python/dropbox_sign/models/api_app_response.py @@ -40,32 +40,36 @@ class ApiAppResponse(BaseModel): Contains information about an API App. """ # noqa: E501 - client_id: StrictStr = Field(description="The app's client id") - created_at: StrictInt = Field(description="The time that the app was created") - domains: List[StrictStr] = Field( - description="The domain name(s) associated with the app" - ) - name: StrictStr = Field(description="The name of the app") - is_approved: StrictBool = Field( - description="Boolean to indicate if the app has been approved" - ) - options: ApiAppResponseOptions - owner_account: ApiAppResponseOwnerAccount callback_url: Optional[StrictStr] = Field( default=None, description="The app's callback URL (for events)" ) + client_id: Optional[StrictStr] = Field( + default=None, description="The app's client id" + ) + created_at: Optional[StrictInt] = Field( + default=None, description="The time that the app was created" + ) + domains: Optional[List[StrictStr]] = Field( + default=None, description="The domain name(s) associated with the app" + ) + name: Optional[StrictStr] = Field(default=None, description="The name of the app") + is_approved: Optional[StrictBool] = Field( + default=None, description="Boolean to indicate if the app has been approved" + ) oauth: Optional[ApiAppResponseOAuth] = None + options: Optional[ApiAppResponseOptions] = None + owner_account: Optional[ApiAppResponseOwnerAccount] = None white_labeling_options: Optional[ApiAppResponseWhiteLabelingOptions] = None __properties: ClassVar[List[str]] = [ + "callback_url", "client_id", "created_at", "domains", "name", "is_approved", + "oauth", "options", "owner_account", - "callback_url", - "oauth", "white_labeling_options", ] @@ -119,15 +123,15 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # override the default output from pydantic by calling `to_dict()` of oauth + if self.oauth: + _dict["oauth"] = self.oauth.to_dict() # override the default output from pydantic by calling `to_dict()` of options if self.options: _dict["options"] = self.options.to_dict() # override the default output from pydantic by calling `to_dict()` of owner_account if self.owner_account: _dict["owner_account"] = self.owner_account.to_dict() - # override the default output from pydantic by calling `to_dict()` of oauth - if self.oauth: - _dict["oauth"] = self.oauth.to_dict() # override the default output from pydantic by calling `to_dict()` of white_labeling_options if self.white_labeling_options: _dict["white_labeling_options"] = self.white_labeling_options.to_dict() @@ -144,11 +148,17 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "callback_url": obj.get("callback_url"), "client_id": obj.get("client_id"), "created_at": obj.get("created_at"), "domains": obj.get("domains"), "name": obj.get("name"), "is_approved": obj.get("is_approved"), + "oauth": ( + ApiAppResponseOAuth.from_dict(obj["oauth"]) + if obj.get("oauth") is not None + else None + ), "options": ( ApiAppResponseOptions.from_dict(obj["options"]) if obj.get("options") is not None @@ -159,12 +169,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("owner_account") is not None else None ), - "callback_url": obj.get("callback_url"), - "oauth": ( - ApiAppResponseOAuth.from_dict(obj["oauth"]) - if obj.get("oauth") is not None - else None - ), "white_labeling_options": ( ApiAppResponseWhiteLabelingOptions.from_dict( obj["white_labeling_options"] @@ -189,15 +193,15 @@ def init(cls, data: Any) -> Self: @classmethod def openapi_types(cls) -> Dict[str, str]: return { + "callback_url": "(str,)", "client_id": "(str,)", "created_at": "(int,)", "domains": "(List[str],)", "name": "(str,)", "is_approved": "(bool,)", + "oauth": "(ApiAppResponseOAuth,)", "options": "(ApiAppResponseOptions,)", "owner_account": "(ApiAppResponseOwnerAccount,)", - "callback_url": "(str,)", - "oauth": "(ApiAppResponseOAuth,)", "white_labeling_options": "(ApiAppResponseWhiteLabelingOptions,)", } diff --git a/sdks/python/dropbox_sign/models/api_app_response_o_auth.py b/sdks/python/dropbox_sign/models/api_app_response_o_auth.py index cd0f83dfa..981f94d9f 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_o_auth.py +++ b/sdks/python/dropbox_sign/models/api_app_response_o_auth.py @@ -32,22 +32,25 @@ class ApiAppResponseOAuth(BaseModel): An object describing the app's OAuth properties, or null if OAuth is not configured for the app. """ # noqa: E501 - callback_url: StrictStr = Field(description="The app's OAuth callback URL.") - scopes: List[StrictStr] = Field( - description="Array of OAuth scopes used by the app." - ) - charges_users: StrictBool = Field( - description="Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests." + callback_url: Optional[StrictStr] = Field( + default=None, description="The app's OAuth callback URL." ) secret: Optional[StrictStr] = Field( default=None, description="The app's OAuth secret, or null if the app does not belong to user.", ) + scopes: Optional[List[StrictStr]] = Field( + default=None, description="Array of OAuth scopes used by the app." + ) + charges_users: Optional[StrictBool] = Field( + default=None, + description="Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.", + ) __properties: ClassVar[List[str]] = [ "callback_url", + "secret", "scopes", "charges_users", - "secret", ] model_config = ConfigDict( @@ -114,9 +117,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { "callback_url": obj.get("callback_url"), + "secret": obj.get("secret"), "scopes": obj.get("scopes"), "charges_users": obj.get("charges_users"), - "secret": obj.get("secret"), } ) return _obj @@ -135,9 +138,9 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "callback_url": "(str,)", + "secret": "(str,)", "scopes": "(List[str],)", "charges_users": "(bool,)", - "secret": "(str,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/api_app_response_options.py b/sdks/python/dropbox_sign/models/api_app_response_options.py index cedaa70a5..751daf0de 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_options.py +++ b/sdks/python/dropbox_sign/models/api_app_response_options.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool -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,8 +32,9 @@ class ApiAppResponseOptions(BaseModel): An object with options that override account settings. """ # noqa: E501 - can_insert_everywhere: StrictBool = Field( - description='Boolean denoting if signers can "Insert Everywhere" in one click while signing a document' + can_insert_everywhere: Optional[StrictBool] = Field( + default=None, + description='Boolean denoting if signers can "Insert Everywhere" in one click while signing a document', ) __properties: ClassVar[List[str]] = ["can_insert_everywhere"] diff --git a/sdks/python/dropbox_sign/models/api_app_response_owner_account.py b/sdks/python/dropbox_sign/models/api_app_response_owner_account.py index a3710b418..c1ed456c8 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_owner_account.py +++ b/sdks/python/dropbox_sign/models/api_app_response_owner_account.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -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,8 +32,12 @@ class ApiAppResponseOwnerAccount(BaseModel): An object describing the app's owner """ # noqa: E501 - account_id: StrictStr = Field(description="The owner account's ID") - email_address: StrictStr = Field(description="The owner account's email address") + account_id: Optional[StrictStr] = Field( + default=None, description="The owner account's ID" + ) + email_address: Optional[StrictStr] = Field( + default=None, description="The owner account's email address" + ) __properties: ClassVar[List[str]] = ["account_id", "email_address"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py b/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py index b3f7a02f6..734022f90 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py +++ b/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, StrictStr -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,20 +32,20 @@ class ApiAppResponseWhiteLabelingOptions(BaseModel): An object with options to customize the app's signer page """ # noqa: E501 - header_background_color: StrictStr - legal_version: StrictStr - link_color: StrictStr - page_background_color: StrictStr - primary_button_color: StrictStr - primary_button_color_hover: StrictStr - primary_button_text_color: StrictStr - primary_button_text_color_hover: StrictStr - secondary_button_color: StrictStr - secondary_button_color_hover: StrictStr - secondary_button_text_color: StrictStr - secondary_button_text_color_hover: StrictStr - text_color1: StrictStr - text_color2: StrictStr + header_background_color: Optional[StrictStr] = None + legal_version: Optional[StrictStr] = None + link_color: Optional[StrictStr] = None + page_background_color: Optional[StrictStr] = None + primary_button_color: Optional[StrictStr] = None + primary_button_color_hover: Optional[StrictStr] = None + primary_button_text_color: Optional[StrictStr] = None + primary_button_text_color_hover: Optional[StrictStr] = None + secondary_button_color: Optional[StrictStr] = None + secondary_button_color_hover: Optional[StrictStr] = None + secondary_button_text_color: Optional[StrictStr] = None + secondary_button_text_color_hover: Optional[StrictStr] = None + text_color1: Optional[StrictStr] = None + text_color2: Optional[StrictStr] = None __properties: ClassVar[List[str]] = [ "header_background_color", "legal_version", diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_response.py index 70575bff9..0812cb85d 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_response.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr -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,14 +32,20 @@ class BulkSendJobResponse(BaseModel): Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. """ # noqa: E501 - bulk_send_job_id: StrictStr = Field(description="The id of the BulkSendJob.") - total: StrictInt = Field( - description="The total amount of Signature Requests queued for sending." + bulk_send_job_id: Optional[StrictStr] = Field( + default=None, description="The id of the BulkSendJob." ) - is_creator: StrictBool = Field( - description="True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member." + total: Optional[StrictInt] = Field( + default=None, + description="The total amount of Signature Requests queued for sending.", + ) + is_creator: Optional[StrictBool] = Field( + default=None, + description="True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member.", + ) + created_at: Optional[StrictInt] = Field( + default=None, description="Time that the BulkSendJob was created." ) - created_at: StrictInt = Field(description="Time that the BulkSendJob was created.") __properties: ClassVar[List[str]] = [ "bulk_send_job_id", "total", diff --git a/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py b/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py index ac486d75d..7d89f44cc 100644 --- a/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py +++ b/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.account_response import AccountResponse from typing import Optional, Set, Tuple from typing_extensions import Self @@ -33,10 +33,10 @@ class FaxLineResponseFaxLine(BaseModel): FaxLineResponseFaxLine """ # noqa: E501 - number: StrictStr = Field(description="Number") - created_at: StrictInt = Field(description="Created at") - updated_at: StrictInt = Field(description="Updated at") - accounts: List[AccountResponse] + number: Optional[StrictStr] = Field(default=None, description="Number") + created_at: Optional[StrictInt] = Field(default=None, description="Created at") + updated_at: Optional[StrictInt] = Field(default=None, description="Updated at") + accounts: Optional[List[AccountResponse]] = None __properties: ClassVar[List[str]] = [ "number", "created_at", diff --git a/sdks/python/dropbox_sign/models/team_response.py b/sdks/python/dropbox_sign/models/team_response.py index ad0521d0e..57bec3332 100644 --- a/sdks/python/dropbox_sign/models/team_response.py +++ b/sdks/python/dropbox_sign/models/team_response.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.account_response import AccountResponse from typing import Optional, Set, Tuple from typing_extensions import Self @@ -33,13 +33,15 @@ class TeamResponse(BaseModel): Contains information about your team and its members """ # noqa: E501 - name: StrictStr = Field(description="The name of your Team") - accounts: List[AccountResponse] - invited_accounts: List[AccountResponse] = Field( - description="A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`." + name: Optional[StrictStr] = Field(default=None, description="The name of your Team") + accounts: Optional[List[AccountResponse]] = None + invited_accounts: Optional[List[AccountResponse]] = Field( + default=None, + description="A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`.", ) - invited_emails: List[StrictStr] = Field( - description="A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account." + invited_emails: Optional[List[StrictStr]] = Field( + default=None, + description="A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account.", ) __properties: ClassVar[List[str]] = [ "name", diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py index bc66784aa..be23c205a 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py @@ -33,9 +33,15 @@ class TemplateCreateEmbeddedDraftResponseTemplate(BaseModel): Template object with parameters: `template_id`, `edit_url`, `expires_at`. """ # noqa: E501 - template_id: StrictStr = Field(description="The id of the Template.") - edit_url: StrictStr = Field(description="Link to edit the template.") - expires_at: StrictInt = Field(description="When the link expires.") + template_id: Optional[StrictStr] = Field( + default=None, description="The id of the Template." + ) + edit_url: Optional[StrictStr] = Field( + default=None, description="Link to edit the template." + ) + expires_at: Optional[StrictInt] = Field( + default=None, description="When the link expires." + ) warnings: Optional[List[WarningResponse]] = Field( default=None, description="A list of warnings." ) diff --git a/sdks/python/dropbox_sign/models/template_create_response_template.py b/sdks/python/dropbox_sign/models/template_create_response_template.py index 77253dcd3..e4f253ef0 100644 --- a/sdks/python/dropbox_sign/models/template_create_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_response_template.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -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 TemplateCreateResponseTemplate(BaseModel): Template object with parameters: `template_id`. """ # noqa: E501 - template_id: StrictStr = Field(description="The id of the Template.") + template_id: Optional[StrictStr] = Field( + default=None, description="The id of the Template." + ) __properties: ClassVar[List[str]] = ["template_id"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/template_response.py b/sdks/python/dropbox_sign/models/template_response.py index 7b55f5e58..da7729424 100644 --- a/sdks/python/dropbox_sign/models/template_response.py +++ b/sdks/python/dropbox_sign/models/template_response.py @@ -45,46 +45,50 @@ class TemplateResponse(BaseModel): Contains information about the templates you and your team have created. """ # noqa: E501 - template_id: StrictStr = Field(description="The id of the Template.") - title: StrictStr = Field( - description="The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest." + template_id: Optional[StrictStr] = Field( + default=None, description="The id of the Template." ) - message: StrictStr = Field( - description="The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest." - ) - is_creator: StrictBool = Field( - description="`true` if you are the owner of this template, `false` if it's been shared with you by a team member." + title: Optional[StrictStr] = Field( + default=None, + description="The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.", ) - can_edit: StrictBool = Field( - description="Indicates whether edit rights have been granted to you by the owner (always `true` if that's you)." + message: Optional[StrictStr] = Field( + default=None, + description="The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.", ) - is_locked: StrictBool = Field( - description="Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests." + updated_at: Optional[StrictInt] = Field( + default=None, description="Time the template was last updated." ) - metadata: Dict[str, Any] = Field( - description="The metadata attached to the template." + is_embedded: Optional[StrictBool] = Field( + default=None, + description="`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.", ) - signer_roles: List[TemplateResponseSignerRole] = Field( - description="An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template." + is_creator: Optional[StrictBool] = Field( + default=None, + description="`true` if you are the owner of this template, `false` if it's been shared with you by a team member.", ) - cc_roles: List[TemplateResponseCCRole] = Field( - description="An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template." + can_edit: Optional[StrictBool] = Field( + default=None, + description="Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).", ) - documents: List[TemplateResponseDocument] = Field( - description="An array describing each document associated with this Template. Includes form field data for each document." + is_locked: Optional[StrictBool] = Field( + default=None, + description="Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.", ) - accounts: List[TemplateResponseAccount] = Field( - description="An array of the Accounts that can use this Template." + metadata: Optional[Dict[str, Any]] = Field( + default=None, description="The metadata attached to the template." ) - attachments: List[SignatureRequestResponseAttachment] = Field( - description="Signer attachments." + signer_roles: Optional[List[TemplateResponseSignerRole]] = Field( + default=None, + description="An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.", ) - updated_at: Optional[StrictInt] = Field( - default=None, description="Time the template was last updated." + cc_roles: Optional[List[TemplateResponseCCRole]] = Field( + default=None, + description="An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.", ) - is_embedded: Optional[StrictBool] = Field( + documents: Optional[List[TemplateResponseDocument]] = Field( default=None, - description="`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.", + description="An array describing each document associated with this Template. Includes form field data for each document.", ) custom_fields: Optional[List[TemplateResponseDocumentCustomFieldBase]] = Field( default=None, @@ -94,10 +98,18 @@ class TemplateResponse(BaseModel): default=None, description="Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.", ) + accounts: Optional[List[TemplateResponseAccount]] = Field( + default=None, description="An array of the Accounts that can use this Template." + ) + attachments: Optional[List[SignatureRequestResponseAttachment]] = Field( + default=None, description="Signer attachments." + ) __properties: ClassVar[List[str]] = [ "template_id", "title", "message", + "updated_at", + "is_embedded", "is_creator", "can_edit", "is_locked", @@ -105,12 +117,10 @@ class TemplateResponse(BaseModel): "signer_roles", "cc_roles", "documents", - "accounts", - "attachments", - "updated_at", - "is_embedded", "custom_fields", "named_form_fields", + "accounts", + "attachments", ] model_config = ConfigDict( @@ -184,20 +194,6 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: if _item_documents: _items.append(_item_documents.to_dict()) _dict["documents"] = _items - # override the default output from pydantic by calling `to_dict()` of each item in accounts (list) - _items = [] - if self.accounts: - for _item_accounts in self.accounts: - if _item_accounts: - _items.append(_item_accounts.to_dict()) - _dict["accounts"] = _items - # override the default output from pydantic by calling `to_dict()` of each item in attachments (list) - _items = [] - if self.attachments: - for _item_attachments in self.attachments: - if _item_attachments: - _items.append(_item_attachments.to_dict()) - _dict["attachments"] = _items # override the default output from pydantic by calling `to_dict()` of each item in custom_fields (list) _items = [] if self.custom_fields: @@ -212,6 +208,20 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: if _item_named_form_fields: _items.append(_item_named_form_fields.to_dict()) _dict["named_form_fields"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in accounts (list) + _items = [] + if self.accounts: + for _item_accounts in self.accounts: + if _item_accounts: + _items.append(_item_accounts.to_dict()) + _dict["accounts"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in attachments (list) + _items = [] + if self.attachments: + for _item_attachments in self.attachments: + if _item_attachments: + _items.append(_item_attachments.to_dict()) + _dict["attachments"] = _items return _dict @classmethod @@ -228,6 +238,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "template_id": obj.get("template_id"), "title": obj.get("title"), "message": obj.get("message"), + "updated_at": obj.get("updated_at"), + "is_embedded": obj.get("is_embedded"), "is_creator": obj.get("is_creator"), "can_edit": obj.get("can_edit"), "is_locked": obj.get("is_locked"), @@ -256,24 +268,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("documents") is not None else None ), - "accounts": ( - [ - TemplateResponseAccount.from_dict(_item) - for _item in obj["accounts"] - ] - if obj.get("accounts") is not None - else None - ), - "attachments": ( - [ - SignatureRequestResponseAttachment.from_dict(_item) - for _item in obj["attachments"] - ] - if obj.get("attachments") is not None - else None - ), - "updated_at": obj.get("updated_at"), - "is_embedded": obj.get("is_embedded"), "custom_fields": ( [ TemplateResponseDocumentCustomFieldBase.from_dict(_item) @@ -290,6 +284,22 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("named_form_fields") is not None else None ), + "accounts": ( + [ + TemplateResponseAccount.from_dict(_item) + for _item in obj["accounts"] + ] + if obj.get("accounts") is not None + else None + ), + "attachments": ( + [ + SignatureRequestResponseAttachment.from_dict(_item) + for _item in obj["attachments"] + ] + if obj.get("attachments") is not None + else None + ), } ) return _obj @@ -310,6 +320,8 @@ def openapi_types(cls) -> Dict[str, str]: "template_id": "(str,)", "title": "(str,)", "message": "(str,)", + "updated_at": "(int,)", + "is_embedded": "(bool,)", "is_creator": "(bool,)", "can_edit": "(bool,)", "is_locked": "(bool,)", @@ -317,12 +329,10 @@ def openapi_types(cls) -> Dict[str, str]: "signer_roles": "(List[TemplateResponseSignerRole],)", "cc_roles": "(List[TemplateResponseCCRole],)", "documents": "(List[TemplateResponseDocument],)", - "accounts": "(List[TemplateResponseAccount],)", - "attachments": "(List[SignatureRequestResponseAttachment],)", - "updated_at": "(int,)", - "is_embedded": "(bool,)", "custom_fields": "(List[TemplateResponseDocumentCustomFieldBase],)", "named_form_fields": "(List[TemplateResponseDocumentFormFieldBase],)", + "accounts": "(List[TemplateResponseAccount],)", + "attachments": "(List[SignatureRequestResponseAttachment],)", } @classmethod @@ -331,8 +341,8 @@ def openapi_type_is_array(cls, property_name: str) -> bool: "signer_roles", "cc_roles", "documents", - "accounts", - "attachments", "custom_fields", "named_form_fields", + "accounts", + "attachments", ] diff --git a/sdks/python/dropbox_sign/models/template_response_account.py b/sdks/python/dropbox_sign/models/template_response_account.py index 1b34f5e00..71358ff84 100644 --- a/sdks/python/dropbox_sign/models/template_response_account.py +++ b/sdks/python/dropbox_sign/models/template_response_account.py @@ -35,27 +35,32 @@ class TemplateResponseAccount(BaseModel): TemplateResponseAccount """ # 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: TemplateResponseAccountQuota 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[TemplateResponseAccountQuota] = None __properties: ClassVar[List[str]] = [ "account_id", + "email_address", "is_locked", "is_paid_hs", "is_paid_hf", "quotas", - "email_address", ] model_config = ConfigDict( @@ -125,6 +130,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"), @@ -133,7 +139,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"), } ) return _obj @@ -152,11 +157,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": "(TemplateResponseAccountQuota,)", - "email_address": "(str,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_response_account_quota.py b/sdks/python/dropbox_sign/models/template_response_account_quota.py index 6c96e8cd7..6c03effe9 100644 --- a/sdks/python/dropbox_sign/models/template_response_account_quota.py +++ b/sdks/python/dropbox_sign/models/template_response_account_quota.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,13 +32,17 @@ class TemplateResponseAccountQuota(BaseModel): An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. """ # noqa: E501 - templates_left: StrictInt = Field(description="API templates remaining.") - api_signature_requests_left: StrictInt = Field( - description="API signature requests remaining." + templates_left: Optional[StrictInt] = Field( + default=None, description="API templates remaining." ) - documents_left: StrictInt = Field(description="Signature requests remaining.") - sms_verifications_left: StrictInt = Field( - description="SMS verifications remaining." + api_signature_requests_left: Optional[StrictInt] = Field( + default=None, description="API signature requests remaining." + ) + documents_left: Optional[StrictInt] = Field( + default=None, description="Signature requests remaining." + ) + sms_verifications_left: Optional[StrictInt] = Field( + default=None, description="SMS verifications remaining." ) __properties: ClassVar[List[str]] = [ "templates_left", diff --git a/sdks/python/dropbox_sign/models/template_response_cc_role.py b/sdks/python/dropbox_sign/models/template_response_cc_role.py index 2a9e77900..8c005227d 100644 --- a/sdks/python/dropbox_sign/models/template_response_cc_role.py +++ b/sdks/python/dropbox_sign/models/template_response_cc_role.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -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,7 @@ class TemplateResponseCCRole(BaseModel): TemplateResponseCCRole """ # noqa: E501 - name: StrictStr = Field(description="The name of the Role.") + name: Optional[StrictStr] = Field(default=None, description="The name of the Role.") __properties: ClassVar[List[str]] = ["name"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/template_response_document.py b/sdks/python/dropbox_sign/models/template_response_document.py index e7b4be883..56e887bd0 100644 --- a/sdks/python/dropbox_sign/models/template_response_document.py +++ b/sdks/python/dropbox_sign/models/template_response_document.py @@ -44,30 +44,35 @@ class TemplateResponseDocument(BaseModel): TemplateResponseDocument """ # noqa: E501 - name: StrictStr = Field(description="Name of the associated file.") - field_groups: List[TemplateResponseDocumentFieldGroup] = Field( - description="An array of Form Field Group objects." + name: Optional[StrictStr] = Field( + default=None, description="Name of the associated file." ) - form_fields: List[TemplateResponseDocumentFormFieldBase] = Field( - description="An array of Form Field objects containing the name and type of each named field." + index: Optional[StrictInt] = Field( + default=None, + description="Document ordering, the lowest index is displayed first and the highest last (0-based indexing).", ) - custom_fields: List[TemplateResponseDocumentCustomFieldBase] = Field( - description="An array of Form Field objects containing the name and type of each named field." + field_groups: Optional[List[TemplateResponseDocumentFieldGroup]] = Field( + default=None, description="An array of Form Field Group objects." ) - static_fields: List[TemplateResponseDocumentStaticFieldBase] = Field( - description="An array describing static overlay fields. **NOTE:** Only available for certain subscriptions." + form_fields: Optional[List[TemplateResponseDocumentFormFieldBase]] = Field( + default=None, + description="An array of Form Field objects containing the name and type of each named field.", ) - index: Optional[StrictInt] = Field( + custom_fields: Optional[List[TemplateResponseDocumentCustomFieldBase]] = Field( default=None, - description="Document ordering, the lowest index is displayed first and the highest last (0-based indexing).", + description="An array of Form Field objects containing the name and type of each named field.", + ) + static_fields: Optional[List[TemplateResponseDocumentStaticFieldBase]] = Field( + default=None, + description="An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.", ) __properties: ClassVar[List[str]] = [ "name", + "index", "field_groups", "form_fields", "custom_fields", "static_fields", - "index", ] model_config = ConfigDict( @@ -162,6 +167,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { "name": obj.get("name"), + "index": obj.get("index"), "field_groups": ( [ TemplateResponseDocumentFieldGroup.from_dict(_item) @@ -194,7 +200,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("static_fields") is not None else None ), - "index": obj.get("index"), } ) return _obj @@ -213,11 +218,11 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "name": "(str,)", + "index": "(int,)", "field_groups": "(List[TemplateResponseDocumentFieldGroup],)", "form_fields": "(List[TemplateResponseDocumentFormFieldBase],)", "custom_fields": "(List[TemplateResponseDocumentCustomFieldBase],)", "static_fields": "(List[TemplateResponseDocumentStaticFieldBase],)", - "index": "(int,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py index 988002152..a7d2fa60c 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py @@ -43,37 +43,46 @@ class TemplateResponseDocumentCustomFieldBase(BaseModel): An array of Form Field objects containing the name and type of each named field. """ # noqa: E501 - api_id: StrictStr = Field(description="The unique ID for this field.") - name: StrictStr = Field(description="The name of the Custom Field.") type: StrictStr - x: StrictInt = Field( - description="The horizontal offset in pixels for this form field." + api_id: Optional[StrictStr] = Field( + default=None, description="The unique ID for this field." ) - y: StrictInt = Field( - description="The vertical offset in pixels for this form field." - ) - width: StrictInt = Field(description="The width in pixels of this form field.") - height: StrictInt = Field(description="The height in pixels of this form field.") - required: StrictBool = Field( - description="Boolean showing whether or not this field is required." + name: Optional[StrictStr] = Field( + default=None, description="The name of the Custom Field." ) signer: Union[StrictStr, StrictInt, None] = Field( description="The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender)." ) + x: Optional[StrictInt] = Field( + default=None, description="The horizontal offset in pixels for this form field." + ) + y: Optional[StrictInt] = Field( + default=None, description="The vertical offset in pixels for this form field." + ) + width: Optional[StrictInt] = Field( + default=None, description="The width in pixels of this form field." + ) + height: Optional[StrictInt] = Field( + default=None, description="The height in pixels of this form field." + ) + required: Optional[StrictBool] = Field( + default=None, + description="Boolean showing whether or not this field is required.", + ) group: Optional[StrictStr] = Field( default=None, description="The name of the group this field is in. If this field is not a group, this defaults to `null`.", ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", + "signer", "x", "y", "width", "height", "required", - "signer", "group", ] @@ -183,15 +192,15 @@ def from_dict(cls, obj: Dict[str, Any]) -> Optional[ @classmethod def openapi_types(cls) -> Dict[str, str]: return { + "type": "(str,)", "api_id": "(str,)", "name": "(str,)", - "type": "(str,)", + "signer": "(int, str,)", "x": "(int,)", "y": "(int,)", "width": "(int,)", "height": "(int,)", "required": "(bool,)", - "signer": "(int, str,)", "group": "(str,)", } diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py index 620e742fe..4edf644c2 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py @@ -41,15 +41,15 @@ class TemplateResponseDocumentCustomFieldCheckbox( description="The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`" ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", + "signer", "x", "y", "width", "height", "required", - "signer", "group", ] @@ -116,15 +116,15 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "checkbox", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "checkbox", + "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), "width": obj.get("width"), "height": obj.get("height"), "required": obj.get("required"), - "signer": obj.get("signer"), "group": obj.get("group"), } ) @@ -146,12 +146,12 @@ def openapi_types(cls) -> Dict[str, str]: "type": "(str,)", "api_id": "(str,)", "name": "(str,)", + "signer": "(int, str,)", "x": "(int,)", "y": "(int,)", "width": "(int,)", "height": "(int,)", "required": "(bool,)", - "signer": "(int, str,)", "group": "(str,)", } diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py index 79e87d225..760dd57a4 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py @@ -19,7 +19,7 @@ import json from pydantic import ConfigDict, Field, StrictBool, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.template_response_document_custom_field_base import ( TemplateResponseDocumentCustomFieldBase, ) @@ -41,32 +41,37 @@ class TemplateResponseDocumentCustomFieldText(TemplateResponseDocumentCustomFiel type: StrictStr = Field( description="The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`" ) - avg_text_length: TemplateResponseFieldAvgTextLength - is_multiline: StrictBool = Field( - description="Whether this form field is multiline text.", alias="isMultiline" + avg_text_length: Optional[TemplateResponseFieldAvgTextLength] = None + is_multiline: Optional[StrictBool] = Field( + default=None, + description="Whether this form field is multiline text.", + alias="isMultiline", ) - original_font_size: StrictInt = Field( + original_font_size: Optional[StrictInt] = Field( + default=None, description="Original font size used in this form field's text.", alias="originalFontSize", ) - font_family: StrictStr = Field( - description="Font family used in this form field's text.", alias="fontFamily" + font_family: Optional[StrictStr] = Field( + default=None, + description="Font family used in this form field's text.", + alias="fontFamily", ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", + "signer", "x", "y", "width", "height", "required", + "group", "avg_text_length", "isMultiline", "originalFontSize", "fontFamily", - "signer", - "group", ] model_config = ConfigDict( @@ -135,14 +140,16 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "text", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "text", + "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), "width": obj.get("width"), "height": obj.get("height"), "required": obj.get("required"), + "group": obj.get("group"), "avg_text_length": ( TemplateResponseFieldAvgTextLength.from_dict(obj["avg_text_length"]) if obj.get("avg_text_length") is not None @@ -151,8 +158,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "isMultiline": obj.get("isMultiline"), "originalFontSize": obj.get("originalFontSize"), "fontFamily": obj.get("fontFamily"), - "signer": obj.get("signer"), - "group": obj.get("group"), } ) return _obj @@ -177,12 +182,12 @@ def openapi_types(cls) -> Dict[str, str]: "font_family": "(str,)", "api_id": "(str,)", "name": "(str,)", + "signer": "(int, str,)", "x": "(int,)", "y": "(int,)", "width": "(int,)", "height": "(int,)", "required": "(bool,)", - "signer": "(int, str,)", "group": "(str,)", } diff --git a/sdks/python/dropbox_sign/models/template_response_document_field_group.py b/sdks/python/dropbox_sign/models/template_response_document_field_group.py index c74f1fe64..201bd139e 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_field_group.py +++ b/sdks/python/dropbox_sign/models/template_response_document_field_group.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.template_response_document_field_group_rule import ( TemplateResponseDocumentFieldGroupRule, ) @@ -35,8 +35,10 @@ class TemplateResponseDocumentFieldGroup(BaseModel): TemplateResponseDocumentFieldGroup """ # noqa: E501 - name: StrictStr = Field(description="The name of the form field group.") - rule: TemplateResponseDocumentFieldGroupRule + name: Optional[StrictStr] = Field( + default=None, description="The name of the form field group." + ) + rule: Optional[TemplateResponseDocumentFieldGroupRule] = None __properties: ClassVar[List[str]] = ["name", "rule"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py b/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py index b932c4984..e5ade9d4e 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py +++ b/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -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,10 +32,13 @@ class TemplateResponseDocumentFieldGroupRule(BaseModel): The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). """ # noqa: E501 - requirement: StrictStr = Field( - description="Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group." + requirement: Optional[StrictStr] = Field( + default=None, + description="Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group.", + ) + group_label: Optional[StrictStr] = Field( + default=None, description="Name of the group", alias="groupLabel" ) - group_label: StrictStr = Field(description="Name of the group", alias="groupLabel") __properties: ClassVar[List[str]] = ["requirement", "groupLabel"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py index 2b5660900..62f6d5f5b 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py @@ -20,7 +20,7 @@ from importlib import import_module from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Union +from typing import Any, ClassVar, Dict, List, Optional, Union from typing import Optional, Set, Tuple from typing_extensions import Self import io @@ -61,27 +61,36 @@ class TemplateResponseDocumentFormFieldBase(BaseModel): An array of Form Field objects containing the name and type of each named field. """ # noqa: E501 - api_id: StrictStr = Field(description="A unique id for the form field.") - name: StrictStr = Field(description="The name of the form field.") type: StrictStr + api_id: Optional[StrictStr] = Field( + default=None, description="A unique id for the form field." + ) + name: Optional[StrictStr] = Field( + default=None, description="The name of the form field." + ) signer: Union[StrictStr, StrictInt] = Field( description="The signer of the Form Field." ) - x: StrictInt = Field( - description="The horizontal offset in pixels for this form field." + x: Optional[StrictInt] = Field( + default=None, description="The horizontal offset in pixels for this form field." + ) + y: Optional[StrictInt] = Field( + default=None, description="The vertical offset in pixels for this form field." + ) + width: Optional[StrictInt] = Field( + default=None, description="The width in pixels of this form field." ) - y: StrictInt = Field( - description="The vertical offset in pixels for this form field." + height: Optional[StrictInt] = Field( + default=None, description="The height in pixels of this form field." ) - width: StrictInt = Field(description="The width in pixels of this form field.") - height: StrictInt = Field(description="The height in pixels of this form field.") - required: StrictBool = Field( - description="Boolean showing whether or not this field is required." + required: Optional[StrictBool] = Field( + default=None, + description="Boolean showing whether or not this field is required.", ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -238,9 +247,9 @@ def from_dict(cls, obj: Dict[str, Any]) -> Optional[ @classmethod def openapi_types(cls) -> Dict[str, str]: return { + "type": "(str,)", "api_id": "(str,)", "name": "(str,)", - "type": "(str,)", "signer": "(int, str,)", "x": "(int,)", "y": "(int,)", diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py index 807940bca..29c4ff1e8 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py @@ -43,9 +43,9 @@ class TemplateResponseDocumentFormFieldCheckbox(TemplateResponseDocumentFormFiel description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -118,9 +118,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "checkbox", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "checkbox", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), @@ -146,6 +146,7 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "type": "(str,)", + "group": "(str,)", "api_id": "(str,)", "name": "(str,)", "signer": "(int, str,)", @@ -154,7 +155,6 @@ def openapi_types(cls) -> Dict[str, str]: "width": "(int,)", "height": "(int,)", "required": "(bool,)", - "group": "(str,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py index 0a58c895d..9b466fa1c 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py @@ -45,9 +45,9 @@ class TemplateResponseDocumentFormFieldDateSigned( description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -120,11 +120,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "api_id": obj.get("api_id"), - "name": obj.get("name"), "type": ( obj.get("type") if obj.get("type") is not None else "date_signed" ), + "api_id": obj.get("api_id"), + "name": obj.get("name"), "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), @@ -150,6 +150,7 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "type": "(str,)", + "group": "(str,)", "api_id": "(str,)", "name": "(str,)", "signer": "(int, str,)", @@ -158,7 +159,6 @@ def openapi_types(cls) -> Dict[str, str]: "width": "(int,)", "height": "(int,)", "required": "(bool,)", - "group": "(str,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py index 6f99acde6..65b253c5d 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py @@ -43,9 +43,9 @@ class TemplateResponseDocumentFormFieldDropdown(TemplateResponseDocumentFormFiel description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -118,9 +118,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "dropdown", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "dropdown", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), @@ -146,6 +146,7 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "type": "(str,)", + "group": "(str,)", "api_id": "(str,)", "name": "(str,)", "signer": "(int, str,)", @@ -154,7 +155,6 @@ def openapi_types(cls) -> Dict[str, str]: "width": "(int,)", "height": "(int,)", "required": "(bool,)", - "group": "(str,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py index da496caa2..90f0c1f25 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py @@ -41,25 +41,30 @@ class TemplateResponseDocumentFormFieldHyperlink(TemplateResponseDocumentFormFie type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) - avg_text_length: TemplateResponseFieldAvgTextLength - is_multiline: StrictBool = Field( - description="Whether this form field is multiline text.", alias="isMultiline" + avg_text_length: Optional[TemplateResponseFieldAvgTextLength] = None + is_multiline: Optional[StrictBool] = Field( + default=None, + description="Whether this form field is multiline text.", + alias="isMultiline", ) - original_font_size: StrictInt = Field( + original_font_size: Optional[StrictInt] = Field( + default=None, description="Original font size used in this form field's text.", alias="originalFontSize", ) - font_family: StrictStr = Field( - description="Font family used in this form field's text.", alias="fontFamily" + font_family: Optional[StrictStr] = Field( + default=None, + description="Font family used in this form field's text.", + alias="fontFamily", ) group: Optional[StrictStr] = Field( default=None, description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -139,9 +144,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "hyperlink", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "hyperlink", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), @@ -179,6 +184,7 @@ def openapi_types(cls) -> Dict[str, str]: "is_multiline": "(bool,)", "original_font_size": "(int,)", "font_family": "(str,)", + "group": "(str,)", "api_id": "(str,)", "name": "(str,)", "signer": "(int, str,)", @@ -187,7 +193,6 @@ def openapi_types(cls) -> Dict[str, str]: "width": "(int,)", "height": "(int,)", "required": "(bool,)", - "group": "(str,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py index 71b714532..bc8512b4f 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py @@ -43,9 +43,9 @@ class TemplateResponseDocumentFormFieldInitials(TemplateResponseDocumentFormFiel description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -118,9 +118,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "initials", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "initials", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), @@ -146,6 +146,7 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "type": "(str,)", + "group": "(str,)", "api_id": "(str,)", "name": "(str,)", "signer": "(int, str,)", @@ -154,7 +155,6 @@ def openapi_types(cls) -> Dict[str, str]: "width": "(int,)", "height": "(int,)", "required": "(bool,)", - "group": "(str,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py index a38a7a65f..7e76f9e27 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py @@ -42,16 +42,16 @@ class TemplateResponseDocumentFormFieldRadio(TemplateResponseDocumentFormFieldBa description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields." ) __properties: ClassVar[List[str]] = [ + "type", + "group", "api_id", "name", - "type", "signer", "x", "y", "width", "height", "required", - "group", ] model_config = ConfigDict( @@ -117,16 +117,16 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "radio", + "group": obj.get("group"), "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "radio", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), "width": obj.get("width"), "height": obj.get("height"), "required": obj.get("required"), - "group": obj.get("group"), } ) return _obj diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py index 89ba48fcc..7e742cebe 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py @@ -43,9 +43,9 @@ class TemplateResponseDocumentFormFieldSignature(TemplateResponseDocumentFormFie description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -118,9 +118,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "signature", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "signature", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), @@ -146,6 +146,7 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "type": "(str,)", + "group": "(str,)", "api_id": "(str,)", "name": "(str,)", "signer": "(int, str,)", @@ -154,7 +155,6 @@ def openapi_types(cls) -> Dict[str, str]: "width": "(int,)", "height": "(int,)", "required": "(bool,)", - "group": "(str,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py index 8282093d9..c04d1b550 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py @@ -48,16 +48,21 @@ class TemplateResponseDocumentFormFieldText(TemplateResponseDocumentFormFieldBas type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) - avg_text_length: TemplateResponseFieldAvgTextLength - is_multiline: StrictBool = Field( - description="Whether this form field is multiline text.", alias="isMultiline" + avg_text_length: Optional[TemplateResponseFieldAvgTextLength] = None + is_multiline: Optional[StrictBool] = Field( + default=None, + description="Whether this form field is multiline text.", + alias="isMultiline", ) - original_font_size: StrictInt = Field( + original_font_size: Optional[StrictInt] = Field( + default=None, description="Original font size used in this form field's text.", alias="originalFontSize", ) - font_family: StrictStr = Field( - description="Font family used in this form field's text.", alias="fontFamily" + font_family: Optional[StrictStr] = Field( + default=None, + description="Font family used in this form field's text.", + alias="fontFamily", ) validation_type: Optional[StrictStr] = Field( default=None, @@ -68,9 +73,9 @@ class TemplateResponseDocumentFormFieldText(TemplateResponseDocumentFormFieldBas description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -176,9 +181,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "text", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "text", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), @@ -217,6 +222,8 @@ def openapi_types(cls) -> Dict[str, str]: "is_multiline": "(bool,)", "original_font_size": "(int,)", "font_family": "(str,)", + "validation_type": "(str,)", + "group": "(str,)", "api_id": "(str,)", "name": "(str,)", "signer": "(int, str,)", @@ -225,8 +232,6 @@ def openapi_types(cls) -> Dict[str, str]: "width": "(int,)", "height": "(int,)", "required": "(bool,)", - "validation_type": "(str,)", - "group": "(str,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py index 18d800e8f..4c16302d2 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py @@ -61,29 +61,41 @@ class TemplateResponseDocumentStaticFieldBase(BaseModel): An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. """ # noqa: E501 - api_id: StrictStr = Field(description="A unique id for the static field.") - name: StrictStr = Field(description="The name of the static field.") type: StrictStr - signer: StrictStr = Field(description="The signer of the Static Field.") - x: StrictInt = Field( - description="The horizontal offset in pixels for this static field." + api_id: Optional[StrictStr] = Field( + default=None, description="A unique id for the static field." ) - y: StrictInt = Field( - description="The vertical offset in pixels for this static field." + name: Optional[StrictStr] = Field( + default=None, description="The name of the static field." ) - width: StrictInt = Field(description="The width in pixels of this static field.") - height: StrictInt = Field(description="The height in pixels of this static field.") - required: StrictBool = Field( - description="Boolean showing whether or not this field is required." + signer: Optional[StrictStr] = Field( + default="me_now", description="The signer of the Static Field." + ) + x: Optional[StrictInt] = Field( + default=None, + description="The horizontal offset in pixels for this static field.", + ) + y: Optional[StrictInt] = Field( + default=None, description="The vertical offset in pixels for this static field." + ) + width: Optional[StrictInt] = Field( + default=None, description="The width in pixels of this static field." + ) + height: Optional[StrictInt] = Field( + default=None, description="The height in pixels of this static field." + ) + required: Optional[StrictBool] = Field( + default=None, + description="Boolean showing whether or not this field is required.", ) group: Optional[StrictStr] = Field( default=None, description="The name of the group this field is in. If this field is not a group, this defaults to `null`.", ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -241,9 +253,9 @@ def from_dict(cls, obj: Dict[str, Any]) -> Optional[ @classmethod def openapi_types(cls) -> Dict[str, str]: return { + "type": "(str,)", "api_id": "(str,)", "name": "(str,)", - "type": "(str,)", "signer": "(str,)", "x": "(int,)", "y": "(int,)", diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py index e56e41e37..ea1c2b787 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldCheckbox( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "checkbox", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "checkbox", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py index e24b49d0d..3a9bf86e0 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldDateSigned( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -116,11 +116,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "api_id": obj.get("api_id"), - "name": obj.get("name"), "type": ( obj.get("type") if obj.get("type") is not None else "date_signed" ), + "api_id": obj.get("api_id"), + "name": obj.get("name"), "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py index 7689e4f80..8444e77d8 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldDropdown( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "dropdown", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "dropdown", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py index 8b5e4a5a9..43106f1b1 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldHyperlink( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "hyperlink", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "hyperlink", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py index e6880abd5..884425354 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldInitials( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "initials", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "initials", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py index 94873742e..e0701f1cc 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py @@ -39,9 +39,9 @@ class TemplateResponseDocumentStaticFieldRadio(TemplateResponseDocumentStaticFie description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -114,9 +114,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "radio", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "radio", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py index 417f92b19..dbd12110f 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldSignature( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "signature", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "signature", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py index deda059a0..7fe3d5925 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py @@ -39,9 +39,9 @@ class TemplateResponseDocumentStaticFieldText(TemplateResponseDocumentStaticFiel description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ + "type", "api_id", "name", - "type", "signer", "x", "y", @@ -114,9 +114,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "type": obj.get("type") if obj.get("type") is not None else "text", "api_id": obj.get("api_id"), "name": obj.get("name"), - "type": obj.get("type") if obj.get("type") is not None else "text", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), diff --git a/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py b/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py index e2e27d72f..b3b5d4aff 100644 --- a/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py +++ b/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.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,8 +32,10 @@ class TemplateResponseFieldAvgTextLength(BaseModel): Average text length in this field. """ # noqa: E501 - num_lines: StrictInt = Field(description="Number of lines.") - num_chars_per_line: StrictInt = Field(description="Number of characters per line.") + num_lines: Optional[StrictInt] = Field(default=None, description="Number of lines.") + num_chars_per_line: Optional[StrictInt] = Field( + default=None, description="Number of characters per line." + ) __properties: ClassVar[List[str]] = ["num_lines", "num_chars_per_line"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/template_response_signer_role.py b/sdks/python/dropbox_sign/models/template_response_signer_role.py index ffbf7a5b3..aab8250c4 100644 --- a/sdks/python/dropbox_sign/models/template_response_signer_role.py +++ b/sdks/python/dropbox_sign/models/template_response_signer_role.py @@ -32,7 +32,7 @@ class TemplateResponseSignerRole(BaseModel): TemplateResponseSignerRole """ # noqa: E501 - name: StrictStr = Field(description="The name of the Role.") + name: Optional[StrictStr] = Field(default=None, description="The name of the Role.") order: Optional[StrictInt] = Field( default=None, description="If signer order is assigned this is the 0-based index for this role.", diff --git a/sdks/python/dropbox_sign/models/template_update_files_response_template.py b/sdks/python/dropbox_sign/models/template_update_files_response_template.py index fc44b1dda..a8fb50fa3 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_response_template.py +++ b/sdks/python/dropbox_sign/models/template_update_files_response_template.py @@ -33,7 +33,9 @@ class TemplateUpdateFilesResponseTemplate(BaseModel): Contains template id """ # noqa: E501 - template_id: StrictStr = Field(description="The id of the Template.") + template_id: Optional[StrictStr] = Field( + default=None, description="The id of the Template." + ) warnings: Optional[List[WarningResponse]] = Field( default=None, description="A list of warnings." ) diff --git a/sdks/ruby/docs/ApiAppResponse.md b/sdks/ruby/docs/ApiAppResponse.md index aabe14b57..ff1067f07 100644 --- a/sdks/ruby/docs/ApiAppResponse.md +++ b/sdks/ruby/docs/ApiAppResponse.md @@ -6,14 +6,14 @@ Contains information about an API App. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `client_id`*_required_ | ```String``` | The app's client id | | -| `created_at`*_required_ | ```Integer``` | The time that the app was created | | -| `domains`*_required_ | ```Array``` | The domain name(s) associated with the app | | -| `name`*_required_ | ```String``` | The name of the app | | -| `is_approved`*_required_ | ```Boolean``` | Boolean to indicate if the app has been approved | | -| `options`*_required_ | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | -| `owner_account`*_required_ | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `callback_url` | ```String``` | The app's callback URL (for events) | | +| `client_id` | ```String``` | The app's client id | | +| `created_at` | ```Integer``` | The time that the app was created | | +| `domains` | ```Array``` | The domain name(s) associated with the app | | +| `name` | ```String``` | The name of the app | | +| `is_approved` | ```Boolean``` | Boolean to indicate if the app has been approved | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | +| `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | +| `owner_account` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | | `white_labeling_options` | [```ApiAppResponseWhiteLabelingOptions```](ApiAppResponseWhiteLabelingOptions.md) | | | diff --git a/sdks/ruby/docs/ApiAppResponseOAuth.md b/sdks/ruby/docs/ApiAppResponseOAuth.md index f4ee09acd..b39bcc302 100644 --- a/sdks/ruby/docs/ApiAppResponseOAuth.md +++ b/sdks/ruby/docs/ApiAppResponseOAuth.md @@ -6,8 +6,8 @@ An object describing the app's OAuth properties, or null if OAuth is not con | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `callback_url`*_required_ | ```String``` | The app's OAuth callback URL. | | -| `scopes`*_required_ | ```Array``` | Array of OAuth scopes used by the app. | | -| `charges_users`*_required_ | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | +| `callback_url` | ```String``` | The app's OAuth callback URL. | | | `secret` | ```String``` | The app's OAuth secret, or null if the app does not belong to user. | | +| `scopes` | ```Array``` | Array of OAuth scopes used by the app. | | +| `charges_users` | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | diff --git a/sdks/ruby/docs/ApiAppResponseOptions.md b/sdks/ruby/docs/ApiAppResponseOptions.md index 1e25ee967..6661e960f 100644 --- a/sdks/ruby/docs/ApiAppResponseOptions.md +++ b/sdks/ruby/docs/ApiAppResponseOptions.md @@ -6,5 +6,5 @@ An object with options that override account settings. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `can_insert_everywhere`*_required_ | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `can_insert_everywhere` | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | diff --git a/sdks/ruby/docs/ApiAppResponseOwnerAccount.md b/sdks/ruby/docs/ApiAppResponseOwnerAccount.md index 0ed1d1466..6ae8b315d 100644 --- a/sdks/ruby/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/ruby/docs/ApiAppResponseOwnerAccount.md @@ -6,6 +6,6 @@ An object describing the app's owner | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `account_id`*_required_ | ```String``` | The owner account's ID | | -| `email_address`*_required_ | ```String``` | The owner account's email address | | +| `account_id` | ```String``` | The owner account's ID | | +| `email_address` | ```String``` | The owner account's email address | | diff --git a/sdks/ruby/docs/ApiAppResponseWhiteLabelingOptions.md b/sdks/ruby/docs/ApiAppResponseWhiteLabelingOptions.md index 7f567105e..3b02d6762 100644 --- a/sdks/ruby/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/ruby/docs/ApiAppResponseWhiteLabelingOptions.md @@ -6,18 +6,18 @@ An object with options to customize the app's signer page | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `header_background_color`*_required_ | ```String``` | | | -| `legal_version`*_required_ | ```String``` | | | -| `link_color`*_required_ | ```String``` | | | -| `page_background_color`*_required_ | ```String``` | | | -| `primary_button_color`*_required_ | ```String``` | | | -| `primary_button_color_hover`*_required_ | ```String``` | | | -| `primary_button_text_color`*_required_ | ```String``` | | | -| `primary_button_text_color_hover`*_required_ | ```String``` | | | -| `secondary_button_color`*_required_ | ```String``` | | | -| `secondary_button_color_hover`*_required_ | ```String``` | | | -| `secondary_button_text_color`*_required_ | ```String``` | | | -| `secondary_button_text_color_hover`*_required_ | ```String``` | | | -| `text_color1`*_required_ | ```String``` | | | -| `text_color2`*_required_ | ```String``` | | | +| `header_background_color` | ```String``` | | | +| `legal_version` | ```String``` | | | +| `link_color` | ```String``` | | | +| `page_background_color` | ```String``` | | | +| `primary_button_color` | ```String``` | | | +| `primary_button_color_hover` | ```String``` | | | +| `primary_button_text_color` | ```String``` | | | +| `primary_button_text_color_hover` | ```String``` | | | +| `secondary_button_color` | ```String``` | | | +| `secondary_button_color_hover` | ```String``` | | | +| `secondary_button_text_color` | ```String``` | | | +| `secondary_button_text_color_hover` | ```String``` | | | +| `text_color1` | ```String``` | | | +| `text_color2` | ```String``` | | | diff --git a/sdks/ruby/docs/BulkSendJobResponse.md b/sdks/ruby/docs/BulkSendJobResponse.md index ef640a841..30b30234d 100644 --- a/sdks/ruby/docs/BulkSendJobResponse.md +++ b/sdks/ruby/docs/BulkSendJobResponse.md @@ -6,8 +6,8 @@ Contains information about the BulkSendJob such as when it was created and how m | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `bulk_send_job_id`*_required_ | ```String``` | The id of the BulkSendJob. | | -| `total`*_required_ | ```Integer``` | The total amount of Signature Requests queued for sending. | | -| `is_creator`*_required_ | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `created_at`*_required_ | ```Integer``` | Time that the BulkSendJob was created. | | +| `bulk_send_job_id` | ```String``` | The id of the BulkSendJob. | | +| `total` | ```Integer``` | The total amount of Signature Requests queued for sending. | | +| `is_creator` | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | +| `created_at` | ```Integer``` | Time that the BulkSendJob was created. | | diff --git a/sdks/ruby/docs/FaxLineResponseFaxLine.md b/sdks/ruby/docs/FaxLineResponseFaxLine.md index 390bdd37f..03d2a1d95 100644 --- a/sdks/ruby/docs/FaxLineResponseFaxLine.md +++ b/sdks/ruby/docs/FaxLineResponseFaxLine.md @@ -6,8 +6,8 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number`*_required_ | ```String``` | Number | | -| `created_at`*_required_ | ```Integer``` | Created at | | -| `updated_at`*_required_ | ```Integer``` | Updated at | | -| `accounts`*_required_ | [```Array```](AccountResponse.md) | | | +| `number` | ```String``` | Number | | +| `created_at` | ```Integer``` | Created at | | +| `updated_at` | ```Integer``` | Updated at | | +| `accounts` | [```Array```](AccountResponse.md) | | | diff --git a/sdks/ruby/docs/TeamResponse.md b/sdks/ruby/docs/TeamResponse.md index 777d1eb52..b7b847604 100644 --- a/sdks/ruby/docs/TeamResponse.md +++ b/sdks/ruby/docs/TeamResponse.md @@ -6,8 +6,8 @@ Contains information about your team and its members | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name`*_required_ | ```String``` | The name of your Team | | -| `accounts`*_required_ | [```Array```](AccountResponse.md) | | | -| `invited_accounts`*_required_ | [```Array```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | -| `invited_emails`*_required_ | ```Array``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `name` | ```String``` | The name of your Team | | +| `accounts` | [```Array```](AccountResponse.md) | | | +| `invited_accounts` | [```Array```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | +| `invited_emails` | ```Array``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | diff --git a/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index d33b22d57..9006aa0f8 100644 --- a/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -6,8 +6,8 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id`*_required_ | ```String``` | The id of the Template. | | -| `edit_url`*_required_ | ```String``` | Link to edit the template. | | -| `expires_at`*_required_ | ```Integer``` | When the link expires. | | +| `template_id` | ```String``` | The id of the Template. | | +| `edit_url` | ```String``` | Link to edit the template. | | +| `expires_at` | ```Integer``` | When the link expires. | | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/ruby/docs/TemplateCreateResponseTemplate.md b/sdks/ruby/docs/TemplateCreateResponseTemplate.md index 4e63e9ea8..4d9488de7 100644 --- a/sdks/ruby/docs/TemplateCreateResponseTemplate.md +++ b/sdks/ruby/docs/TemplateCreateResponseTemplate.md @@ -6,5 +6,5 @@ Template object with parameters: `template_id`. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id`*_required_ | ```String``` | The id of the Template. | | +| `template_id` | ```String``` | The id of the Template. | | diff --git a/sdks/ruby/docs/TemplateResponse.md b/sdks/ruby/docs/TemplateResponse.md index 0d850ce62..792e16a36 100644 --- a/sdks/ruby/docs/TemplateResponse.md +++ b/sdks/ruby/docs/TemplateResponse.md @@ -6,20 +6,20 @@ Contains information about the templates you and your team have created. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id`*_required_ | ```String``` | The id of the Template. | | -| `title`*_required_ | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message`*_required_ | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `is_creator`*_required_ | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `can_edit`*_required_ | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `is_locked`*_required_ | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata`*_required_ | ```Object``` | The metadata attached to the template. | | -| `signer_roles`*_required_ | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `cc_roles`*_required_ | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents`*_required_ | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | -| `accounts`*_required_ | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | -| `attachments`*_required_ | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `template_id` | ```String``` | The id of the Template. | | +| `title` | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message` | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | | `updated_at` | ```Integer``` | Time the template was last updated. | | | `is_embedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | +| `is_creator` | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `can_edit` | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `is_locked` | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata` | ```Object``` | The metadata attached to the template. | | +| `signer_roles` | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `cc_roles` | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | +| `documents` | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `custom_fields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | +| `accounts` | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | diff --git a/sdks/ruby/docs/TemplateResponseAccount.md b/sdks/ruby/docs/TemplateResponseAccount.md index 3c4b18f3c..dcb2bc328 100644 --- a/sdks/ruby/docs/TemplateResponseAccount.md +++ b/sdks/ruby/docs/TemplateResponseAccount.md @@ -6,10 +6,10 @@ | 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_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.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` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | diff --git a/sdks/ruby/docs/TemplateResponseAccountQuota.md b/sdks/ruby/docs/TemplateResponseAccountQuota.md index 1b67e4ee6..8e314836a 100644 --- a/sdks/ruby/docs/TemplateResponseAccountQuota.md +++ b/sdks/ruby/docs/TemplateResponseAccountQuota.md @@ -6,8 +6,8 @@ An array of the designated CC roles that must be specified when sending a Signat | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `templates_left`*_required_ | ```Integer``` | API templates remaining. | | -| `api_signature_requests_left`*_required_ | ```Integer``` | API signature requests remaining. | | -| `documents_left`*_required_ | ```Integer``` | Signature requests remaining. | | -| `sms_verifications_left`*_required_ | ```Integer``` | SMS verifications remaining. | | +| `templates_left` | ```Integer``` | API templates remaining. | | +| `api_signature_requests_left` | ```Integer``` | API signature requests remaining. | | +| `documents_left` | ```Integer``` | Signature requests remaining. | | +| `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | | diff --git a/sdks/ruby/docs/TemplateResponseCCRole.md b/sdks/ruby/docs/TemplateResponseCCRole.md index 00ab61067..b8c9b08f8 100644 --- a/sdks/ruby/docs/TemplateResponseCCRole.md +++ b/sdks/ruby/docs/TemplateResponseCCRole.md @@ -6,5 +6,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name`*_required_ | ```String``` | The name of the Role. | | +| `name` | ```String``` | The name of the Role. | | diff --git a/sdks/ruby/docs/TemplateResponseDocument.md b/sdks/ruby/docs/TemplateResponseDocument.md index 6959cb0fa..5b9a105ae 100644 --- a/sdks/ruby/docs/TemplateResponseDocument.md +++ b/sdks/ruby/docs/TemplateResponseDocument.md @@ -6,10 +6,10 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name`*_required_ | ```String``` | Name of the associated file. | | -| `field_groups`*_required_ | [```Array```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `form_fields`*_required_ | [```Array```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `custom_fields`*_required_ | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `static_fields`*_required_ | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | +| `name` | ```String``` | Name of the associated file. | | | `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | +| `field_groups` | [```Array```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `form_fields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `custom_fields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `static_fields` | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md index 01e988fcb..53f1fae78 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md @@ -6,14 +6,14 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `api_id`*_required_ | ```String``` | The unique ID for this field. | | -| `name`*_required_ | ```String``` | The name of the Custom Field. | | | `type`*_required_ | ```String``` | | | -| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | -| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | -| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `api_id` | ```String``` | The unique ID for this field. | | +| `name` | ```String``` | The name of the Custom Field. | | | `signer` | ```String``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | +| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width` | ```Integer``` | The width in pixels of this form field. | | +| `height` | ```Integer``` | The height in pixels of this form field. | | +| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md index 9582a0b11..52138173c 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md @@ -7,8 +7,8 @@ This class extends `TemplateResponseDocumentCustomFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | -| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | -| `original_font_size`*_required_ | ```Integer``` | Original font size used in this form field's text. | | -| `font_family`*_required_ | ```String``` | Font family used in this form field's text. | | +| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | | +| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | | +| `font_family` | ```String``` | Font family used in this form field's text. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md b/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md index c8fea8928..114dba8b6 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name`*_required_ | ```String``` | The name of the form field group. | | -| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name` | ```String``` | The name of the form field group. | | +| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md index ef8689712..601ef69a3 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md @@ -6,6 +6,6 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `requirement`*_required_ | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `group_label`*_required_ | ```String``` | Name of the group | | +| `requirement` | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `group_label` | ```String``` | Name of the group | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md index 0daaa439a..381c4814b 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md @@ -6,13 +6,13 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `api_id`*_required_ | ```String``` | A unique id for the form field. | | -| `name`*_required_ | ```String``` | The name of the form field. | | | `type`*_required_ | ```String``` | | | -| `signer`*_required_ | ```String``` | The signer of the Form Field. | | -| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | -| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | -| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `api_id` | ```String``` | A unique id for the form field. | | +| `name` | ```String``` | The name of the form field. | | +| `signer` | ```String``` | The signer of the Form Field. | | +| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width` | ```Integer``` | The width in pixels of this form field. | | +| `height` | ```Integer``` | The height in pixels of this form field. | | +| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md index 83c3646b1..2bf06c0c0 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -7,9 +7,9 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | -| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | -| `original_font_size`*_required_ | ```Integer``` | Original font size used in this form field's text. | | -| `font_family`*_required_ | ```String``` | Font family used in this form field's text. | | +| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | | +| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | | +| `font_family` | ```String``` | Font family used in this form field's text. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md index 15341ae02..7bfe70283 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md @@ -7,10 +7,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | -| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | -| `original_font_size`*_required_ | ```Integer``` | Original font size used in this form field's text. | | -| `font_family`*_required_ | ```String``` | Font family used in this form field's text. | | +| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | | +| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | | +| `font_family` | ```String``` | Font family used in this form field's text. | | | `validation_type` | ```String``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md index b7b085348..49696a59f 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md @@ -6,14 +6,14 @@ An array describing static overlay fields. **NOTE:** Only available for certain | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `api_id`*_required_ | ```String``` | A unique id for the static field. | | -| `name`*_required_ | ```String``` | The name of the static field. | | | `type`*_required_ | ```String``` | | | -| `signer`*_required_ | ```String``` | The signer of the Static Field. | [default to 'me_now'] | -| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this static field. | | -| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this static field. | | -| `width`*_required_ | ```Integer``` | The width in pixels of this static field. | | -| `height`*_required_ | ```Integer``` | The height in pixels of this static field. | | -| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `api_id` | ```String``` | A unique id for the static field. | | +| `name` | ```String``` | The name of the static field. | | +| `signer` | ```String``` | The signer of the Static Field. | [default to 'me_now'] | +| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | | +| `y` | ```Integer``` | The vertical offset in pixels for this static field. | | +| `width` | ```Integer``` | The width in pixels of this static field. | | +| `height` | ```Integer``` | The height in pixels of this static field. | | +| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md b/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md index ee8754dfc..923bc0fc1 100644 --- a/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md @@ -6,6 +6,6 @@ Average text length in this field. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `num_lines`*_required_ | ```Integer``` | Number of lines. | | -| `num_chars_per_line`*_required_ | ```Integer``` | Number of characters per line. | | +| `num_lines` | ```Integer``` | Number of lines. | | +| `num_chars_per_line` | ```Integer``` | Number of characters per line. | | diff --git a/sdks/ruby/docs/TemplateResponseSignerRole.md b/sdks/ruby/docs/TemplateResponseSignerRole.md index 16d41a529..e61e1ef66 100644 --- a/sdks/ruby/docs/TemplateResponseSignerRole.md +++ b/sdks/ruby/docs/TemplateResponseSignerRole.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name`*_required_ | ```String``` | The name of the Role. | | +| `name` | ```String``` | The name of the Role. | | | `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this role. | | diff --git a/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md index 5f03f54e9..f0964f519 100644 --- a/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md @@ -6,6 +6,6 @@ Contains template id | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id`*_required_ | ```String``` | The id of the Template. | | +| `template_id` | ```String``` | The id of the Template. | | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response.rb index e7b21b8d0..2f7923ed0 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response.rb @@ -19,6 +19,10 @@ module Dropbox module Dropbox::Sign # Contains information about an API App. class ApiAppResponse + # The app's callback URL (for events) + # @return [String, nil] + attr_accessor :callback_url + # The app's client id # @return [String] attr_accessor :client_id @@ -39,34 +43,30 @@ class ApiAppResponse # @return [Boolean] attr_accessor :is_approved - # @return [ApiAppResponseOptions] + # @return [ApiAppResponseOAuth, nil] + attr_accessor :oauth + + # @return [ApiAppResponseOptions, nil] attr_accessor :options # @return [ApiAppResponseOwnerAccount] attr_accessor :owner_account - # The app's callback URL (for events) - # @return [String, nil] - attr_accessor :callback_url - - # @return [ApiAppResponseOAuth, nil] - attr_accessor :oauth - # @return [ApiAppResponseWhiteLabelingOptions, nil] attr_accessor :white_labeling_options # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { + :'callback_url' => :'callback_url', :'client_id' => :'client_id', :'created_at' => :'created_at', :'domains' => :'domains', :'name' => :'name', :'is_approved' => :'is_approved', + :'oauth' => :'oauth', :'options' => :'options', :'owner_account' => :'owner_account', - :'callback_url' => :'callback_url', - :'oauth' => :'oauth', :'white_labeling_options' => :'white_labeling_options' } end @@ -79,15 +79,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { + :'callback_url' => :'String', :'client_id' => :'String', :'created_at' => :'Integer', :'domains' => :'Array', :'name' => :'String', :'is_approved' => :'Boolean', + :'oauth' => :'ApiAppResponseOAuth', :'options' => :'ApiAppResponseOptions', :'owner_account' => :'ApiAppResponseOwnerAccount', - :'callback_url' => :'String', - :'oauth' => :'ApiAppResponseOAuth', :'white_labeling_options' => :'ApiAppResponseWhiteLabelingOptions' } end @@ -97,6 +97,7 @@ def self.openapi_nullable Set.new([ :'callback_url', :'oauth', + :'options', :'white_labeling_options' ]) end @@ -141,6 +142,10 @@ def initialize(attributes = {}) h[k.to_sym] = v } + if attributes.key?(:'callback_url') + self.callback_url = attributes[:'callback_url'] + end + if attributes.key?(:'client_id') self.client_id = attributes[:'client_id'] end @@ -163,6 +168,10 @@ def initialize(attributes = {}) self.is_approved = attributes[:'is_approved'] end + if attributes.key?(:'oauth') + self.oauth = attributes[:'oauth'] + end + if attributes.key?(:'options') self.options = attributes[:'options'] end @@ -171,14 +180,6 @@ def initialize(attributes = {}) self.owner_account = attributes[:'owner_account'] end - if attributes.key?(:'callback_url') - self.callback_url = attributes[:'callback_url'] - end - - if attributes.key?(:'oauth') - self.oauth = attributes[:'oauth'] - end - if attributes.key?(:'white_labeling_options') self.white_labeling_options = attributes[:'white_labeling_options'] end @@ -188,47 +189,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @client_id.nil? - invalid_properties.push('invalid value for "client_id", client_id cannot be nil.') - end - - if @created_at.nil? - invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') - end - - if @domains.nil? - invalid_properties.push('invalid value for "domains", domains cannot be nil.') - end - - if @name.nil? - invalid_properties.push('invalid value for "name", name cannot be nil.') - end - - if @is_approved.nil? - invalid_properties.push('invalid value for "is_approved", is_approved cannot be nil.') - end - - if @options.nil? - invalid_properties.push('invalid value for "options", options cannot be nil.') - end - - if @owner_account.nil? - invalid_properties.push('invalid value for "owner_account", owner_account 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 @client_id.nil? - return false if @created_at.nil? - return false if @domains.nil? - return false if @name.nil? - return false if @is_approved.nil? - return false if @options.nil? - return false if @owner_account.nil? true end @@ -237,15 +203,15 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && + callback_url == o.callback_url && client_id == o.client_id && created_at == o.created_at && domains == o.domains && name == o.name && is_approved == o.is_approved && + oauth == o.oauth && options == o.options && owner_account == o.owner_account && - callback_url == o.callback_url && - oauth == o.oauth && white_labeling_options == o.white_labeling_options end @@ -258,7 +224,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [client_id, created_at, domains, name, is_approved, options, owner_account, callback_url, oauth, white_labeling_options].hash + [callback_url, client_id, created_at, domains, name, is_approved, oauth, options, owner_account, white_labeling_options].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response_o_auth.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response_o_auth.rb index 1cc322299..c861200d5 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response_o_auth.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response_o_auth.rb @@ -23,6 +23,10 @@ class ApiAppResponseOAuth # @return [String] attr_accessor :callback_url + # The app's OAuth secret, or null if the app does not belong to user. + # @return [String, nil] + attr_accessor :secret + # Array of OAuth scopes used by the app. # @return [Array] attr_accessor :scopes @@ -31,17 +35,13 @@ class ApiAppResponseOAuth # @return [Boolean] attr_accessor :charges_users - # The app's OAuth secret, or null if the app does not belong to user. - # @return [String, nil] - attr_accessor :secret - # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'callback_url' => :'callback_url', + :'secret' => :'secret', :'scopes' => :'scopes', - :'charges_users' => :'charges_users', - :'secret' => :'secret' + :'charges_users' => :'charges_users' } end @@ -54,16 +54,16 @@ def self.acceptable_attributes def self.openapi_types { :'callback_url' => :'String', + :'secret' => :'String', :'scopes' => :'Array', - :'charges_users' => :'Boolean', - :'secret' => :'String' + :'charges_users' => :'Boolean' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'secret' + :'secret', ]) end @@ -111,6 +111,10 @@ def initialize(attributes = {}) self.callback_url = attributes[:'callback_url'] end + if attributes.key?(:'secret') + self.secret = attributes[:'secret'] + end + if attributes.key?(:'scopes') if (value = attributes[:'scopes']).is_a?(Array) self.scopes = value @@ -120,37 +124,18 @@ def initialize(attributes = {}) if attributes.key?(:'charges_users') self.charges_users = attributes[:'charges_users'] end - - if attributes.key?(:'secret') - self.secret = attributes[:'secret'] - end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @callback_url.nil? - invalid_properties.push('invalid value for "callback_url", callback_url cannot be nil.') - end - - if @scopes.nil? - invalid_properties.push('invalid value for "scopes", scopes cannot be nil.') - end - - if @charges_users.nil? - invalid_properties.push('invalid value for "charges_users", charges_users 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 @callback_url.nil? - return false if @scopes.nil? - return false if @charges_users.nil? true end @@ -160,9 +145,9 @@ def ==(o) return true if self.equal?(o) self.class == o.class && callback_url == o.callback_url && + secret == o.secret && scopes == o.scopes && - charges_users == o.charges_users && - secret == o.secret + charges_users == o.charges_users end # @see the `==` method @@ -174,7 +159,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [callback_url, scopes, charges_users, secret].hash + [callback_url, secret, scopes, charges_users].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response_options.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response_options.rb index 7370fdbea..8e7742ae2 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response_options.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response_options.rb @@ -97,17 +97,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @can_insert_everywhere.nil? - invalid_properties.push('invalid value for "can_insert_everywhere", can_insert_everywhere 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 @can_insert_everywhere.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response_owner_account.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response_owner_account.rb index 067aa02f4..50abb33d1 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response_owner_account.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response_owner_account.rb @@ -107,22 +107,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 @email_address.nil? - invalid_properties.push('invalid value for "email_address", email_address 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 @email_address.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb index be704ff9f..99f0227d1 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb @@ -213,82 +213,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @header_background_color.nil? - invalid_properties.push('invalid value for "header_background_color", header_background_color cannot be nil.') - end - - if @legal_version.nil? - invalid_properties.push('invalid value for "legal_version", legal_version cannot be nil.') - end - - if @link_color.nil? - invalid_properties.push('invalid value for "link_color", link_color cannot be nil.') - end - - if @page_background_color.nil? - invalid_properties.push('invalid value for "page_background_color", page_background_color cannot be nil.') - end - - if @primary_button_color.nil? - invalid_properties.push('invalid value for "primary_button_color", primary_button_color cannot be nil.') - end - - if @primary_button_color_hover.nil? - invalid_properties.push('invalid value for "primary_button_color_hover", primary_button_color_hover cannot be nil.') - end - - if @primary_button_text_color.nil? - invalid_properties.push('invalid value for "primary_button_text_color", primary_button_text_color cannot be nil.') - end - - if @primary_button_text_color_hover.nil? - invalid_properties.push('invalid value for "primary_button_text_color_hover", primary_button_text_color_hover cannot be nil.') - end - - if @secondary_button_color.nil? - invalid_properties.push('invalid value for "secondary_button_color", secondary_button_color cannot be nil.') - end - - if @secondary_button_color_hover.nil? - invalid_properties.push('invalid value for "secondary_button_color_hover", secondary_button_color_hover cannot be nil.') - end - - if @secondary_button_text_color.nil? - invalid_properties.push('invalid value for "secondary_button_text_color", secondary_button_text_color cannot be nil.') - end - - if @secondary_button_text_color_hover.nil? - invalid_properties.push('invalid value for "secondary_button_text_color_hover", secondary_button_text_color_hover cannot be nil.') - end - - if @text_color1.nil? - invalid_properties.push('invalid value for "text_color1", text_color1 cannot be nil.') - end - - if @text_color2.nil? - invalid_properties.push('invalid value for "text_color2", text_color2 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 @header_background_color.nil? - return false if @legal_version.nil? - return false if @link_color.nil? - return false if @page_background_color.nil? - return false if @primary_button_color.nil? - return false if @primary_button_color_hover.nil? - return false if @primary_button_text_color.nil? - return false if @primary_button_text_color_hover.nil? - return false if @secondary_button_color.nil? - return false if @secondary_button_color_hover.nil? - return false if @secondary_button_text_color.nil? - return false if @secondary_button_text_color_hover.nil? - return false if @text_color1.nil? - return false if @text_color2.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_response.rb b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_response.rb index 4037251c5..b84d927a1 100644 --- a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_response.rb @@ -20,7 +20,7 @@ module Dropbox::Sign # Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. class BulkSendJobResponse # The id of the BulkSendJob. - # @return [String] + # @return [String, nil] attr_accessor :bulk_send_job_id # The total amount of Signature Requests queued for sending. @@ -63,6 +63,7 @@ def self.openapi_types # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'bulk_send_job_id', ]) end @@ -127,32 +128,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @bulk_send_job_id.nil? - invalid_properties.push('invalid value for "bulk_send_job_id", bulk_send_job_id cannot be nil.') - end - - if @total.nil? - invalid_properties.push('invalid value for "total", total cannot be nil.') - end - - if @is_creator.nil? - invalid_properties.push('invalid value for "is_creator", is_creator cannot be nil.') - end - - if @created_at.nil? - invalid_properties.push('invalid value for "created_at", created_at 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 @bulk_send_job_id.nil? - return false if @total.nil? - return false if @is_creator.nil? - return false if @created_at.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_line_response_fax_line.rb b/sdks/ruby/lib/dropbox-sign/models/fax_line_response_fax_line.rb index a293f3e77..02d7797ab 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_line_response_fax_line.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_line_response_fax_line.rb @@ -127,32 +127,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @number.nil? - invalid_properties.push('invalid value for "number", number cannot be nil.') - end - - if @created_at.nil? - invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') - end - - if @updated_at.nil? - invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.') - end - - if @accounts.nil? - invalid_properties.push('invalid value for "accounts", accounts 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 @number.nil? - return false if @created_at.nil? - return false if @updated_at.nil? - return false if @accounts.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/team_response.rb b/sdks/ruby/lib/dropbox-sign/models/team_response.rb index 25aa2627d..b3362473c 100644 --- a/sdks/ruby/lib/dropbox-sign/models/team_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/team_response.rb @@ -132,32 +132,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @name.nil? - invalid_properties.push('invalid value for "name", name cannot be nil.') - end - - if @accounts.nil? - invalid_properties.push('invalid value for "accounts", accounts cannot be nil.') - end - - if @invited_accounts.nil? - invalid_properties.push('invalid value for "invited_accounts", invited_accounts cannot be nil.') - end - - if @invited_emails.nil? - invalid_properties.push('invalid value for "invited_emails", invited_emails 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 @name.nil? - return false if @accounts.nil? - return false if @invited_accounts.nil? - return false if @invited_emails.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb index 7d005908e..a8eeafb20 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb @@ -129,27 +129,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @template_id.nil? - invalid_properties.push('invalid value for "template_id", template_id cannot be nil.') - end - - if @edit_url.nil? - invalid_properties.push('invalid value for "edit_url", edit_url cannot be nil.') - end - - if @expires_at.nil? - invalid_properties.push('invalid value for "expires_at", expires_at 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 @template_id.nil? - return false if @edit_url.nil? - return false if @expires_at.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb index 4abd9bbdc..91e0dc57f 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb @@ -97,17 +97,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @template_id.nil? - invalid_properties.push('invalid value for "template_id", template_id 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 @template_id.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response.rb b/sdks/ruby/lib/dropbox-sign/models/template_response.rb index e070bc7a7..51450dde3 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response.rb @@ -31,6 +31,14 @@ class TemplateResponse # @return [String] attr_accessor :message + # Time the template was last updated. + # @return [Integer] + attr_accessor :updated_at + + # `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + # @return [Boolean, nil] + attr_accessor :is_embedded + # `true` if you are the owner of this template, `false` if it's been shared with you by a team member. # @return [Boolean] attr_accessor :is_creator @@ -59,22 +67,6 @@ class TemplateResponse # @return [Array] attr_accessor :documents - # An array of the Accounts that can use this Template. - # @return [Array] - attr_accessor :accounts - - # Signer attachments. - # @return [Array] - attr_accessor :attachments - - # Time the template was last updated. - # @return [Integer] - attr_accessor :updated_at - - # `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. - # @return [Boolean, nil] - attr_accessor :is_embedded - # Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. # @return [Array, nil] attr_accessor :custom_fields @@ -83,12 +75,22 @@ class TemplateResponse # @return [Array, nil] attr_accessor :named_form_fields + # An array of the Accounts that can use this Template. + # @return [Array] + attr_accessor :accounts + + # Signer attachments. + # @return [Array] + attr_accessor :attachments + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'template_id' => :'template_id', :'title' => :'title', :'message' => :'message', + :'updated_at' => :'updated_at', + :'is_embedded' => :'is_embedded', :'is_creator' => :'is_creator', :'can_edit' => :'can_edit', :'is_locked' => :'is_locked', @@ -96,12 +98,10 @@ def self.attribute_map :'signer_roles' => :'signer_roles', :'cc_roles' => :'cc_roles', :'documents' => :'documents', - :'accounts' => :'accounts', - :'attachments' => :'attachments', - :'updated_at' => :'updated_at', - :'is_embedded' => :'is_embedded', :'custom_fields' => :'custom_fields', - :'named_form_fields' => :'named_form_fields' + :'named_form_fields' => :'named_form_fields', + :'accounts' => :'accounts', + :'attachments' => :'attachments' } end @@ -116,6 +116,8 @@ def self.openapi_types :'template_id' => :'String', :'title' => :'String', :'message' => :'String', + :'updated_at' => :'Integer', + :'is_embedded' => :'Boolean', :'is_creator' => :'Boolean', :'can_edit' => :'Boolean', :'is_locked' => :'Boolean', @@ -123,12 +125,10 @@ def self.openapi_types :'signer_roles' => :'Array', :'cc_roles' => :'Array', :'documents' => :'Array', - :'accounts' => :'Array', - :'attachments' => :'Array', - :'updated_at' => :'Integer', - :'is_embedded' => :'Boolean', :'custom_fields' => :'Array', - :'named_form_fields' => :'Array' + :'named_form_fields' => :'Array', + :'accounts' => :'Array', + :'attachments' => :'Array' } end @@ -137,7 +137,7 @@ def self.openapi_nullable Set.new([ :'is_embedded', :'custom_fields', - :'named_form_fields' + :'named_form_fields', ]) end @@ -193,6 +193,14 @@ def initialize(attributes = {}) self.message = attributes[:'message'] end + if attributes.key?(:'updated_at') + self.updated_at = attributes[:'updated_at'] + end + + if attributes.key?(:'is_embedded') + self.is_embedded = attributes[:'is_embedded'] + end + if attributes.key?(:'is_creator') self.is_creator = attributes[:'is_creator'] end @@ -227,26 +235,6 @@ def initialize(attributes = {}) end end - if attributes.key?(:'accounts') - if (value = attributes[:'accounts']).is_a?(Array) - self.accounts = value - end - end - - if attributes.key?(:'attachments') - if (value = attributes[:'attachments']).is_a?(Array) - self.attachments = value - end - end - - if attributes.key?(:'updated_at') - self.updated_at = attributes[:'updated_at'] - end - - if attributes.key?(:'is_embedded') - self.is_embedded = attributes[:'is_embedded'] - end - if attributes.key?(:'custom_fields') if (value = attributes[:'custom_fields']).is_a?(Array) self.custom_fields = value @@ -258,78 +246,30 @@ def initialize(attributes = {}) self.named_form_fields = value end end + + if attributes.key?(:'accounts') + if (value = attributes[:'accounts']).is_a?(Array) + self.accounts = value + end + end + + if attributes.key?(:'attachments') + if (value = attributes[:'attachments']).is_a?(Array) + self.attachments = value + end + end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @template_id.nil? - invalid_properties.push('invalid value for "template_id", template_id cannot be nil.') - end - - if @title.nil? - invalid_properties.push('invalid value for "title", title cannot be nil.') - end - - if @message.nil? - invalid_properties.push('invalid value for "message", message cannot be nil.') - end - - if @is_creator.nil? - invalid_properties.push('invalid value for "is_creator", is_creator cannot be nil.') - end - - if @can_edit.nil? - invalid_properties.push('invalid value for "can_edit", can_edit cannot be nil.') - end - - if @is_locked.nil? - invalid_properties.push('invalid value for "is_locked", is_locked cannot be nil.') - end - - if @metadata.nil? - invalid_properties.push('invalid value for "metadata", metadata cannot be nil.') - end - - if @signer_roles.nil? - invalid_properties.push('invalid value for "signer_roles", signer_roles cannot be nil.') - end - - if @cc_roles.nil? - invalid_properties.push('invalid value for "cc_roles", cc_roles cannot be nil.') - end - - if @documents.nil? - invalid_properties.push('invalid value for "documents", documents cannot be nil.') - end - - if @accounts.nil? - invalid_properties.push('invalid value for "accounts", accounts cannot be nil.') - end - - if @attachments.nil? - invalid_properties.push('invalid value for "attachments", attachments 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 @template_id.nil? - return false if @title.nil? - return false if @message.nil? - return false if @is_creator.nil? - return false if @can_edit.nil? - return false if @is_locked.nil? - return false if @metadata.nil? - return false if @signer_roles.nil? - return false if @cc_roles.nil? - return false if @documents.nil? - return false if @accounts.nil? - return false if @attachments.nil? true end @@ -341,6 +281,8 @@ def ==(o) template_id == o.template_id && title == o.title && message == o.message && + updated_at == o.updated_at && + is_embedded == o.is_embedded && is_creator == o.is_creator && can_edit == o.can_edit && is_locked == o.is_locked && @@ -348,12 +290,10 @@ def ==(o) signer_roles == o.signer_roles && cc_roles == o.cc_roles && documents == o.documents && - accounts == o.accounts && - attachments == o.attachments && - updated_at == o.updated_at && - is_embedded == o.is_embedded && custom_fields == o.custom_fields && - named_form_fields == o.named_form_fields + named_form_fields == o.named_form_fields && + accounts == o.accounts && + attachments == o.attachments end # @see the `==` method @@ -365,7 +305,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [template_id, title, message, is_creator, can_edit, is_locked, metadata, signer_roles, cc_roles, documents, accounts, attachments, updated_at, is_embedded, custom_fields, named_form_fields].hash + [template_id, title, message, updated_at, is_embedded, is_creator, can_edit, is_locked, metadata, signer_roles, cc_roles, documents, custom_fields, named_form_fields, accounts, attachments].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb index 81a10b28d..c40120392 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb @@ -22,6 +22,10 @@ class TemplateResponseAccount # @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,19 +41,15 @@ class TemplateResponseAccount # @return [TemplateResponseAccountQuota] attr_accessor :quotas - # The email address associated with the Account. - # @return [String] - attr_accessor :email_address - # Attribute mapping from ruby-style variable name to JSON key. 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' + :'quotas' => :'quotas' } end @@ -62,11 +62,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' => :'TemplateResponseAccountQuota', - :'email_address' => :'String' + :'quotas' => :'TemplateResponseAccountQuota' } end @@ -120,6 +120,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 @@ -135,47 +139,18 @@ def initialize(attributes = {}) if attributes.key?(:'quotas') self.quotas = attributes[:'quotas'] end - - if attributes.key?(:'email_address') - self.email_address = attributes[:'email_address'] - end end # Show invalid properties with the reasons. Usually used together with valid? # @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 @@ -185,11 +160,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 + quotas == o.quotas end # @see the `==` method @@ -201,7 +176,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].hash + [account_id, email_address, is_locked, is_paid_hs, is_paid_hf, quotas].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb index 5ae884798..4e46afa40 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb @@ -127,32 +127,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @templates_left.nil? - invalid_properties.push('invalid value for "templates_left", templates_left cannot be nil.') - end - - if @api_signature_requests_left.nil? - invalid_properties.push('invalid value for "api_signature_requests_left", api_signature_requests_left cannot be nil.') - end - - if @documents_left.nil? - invalid_properties.push('invalid value for "documents_left", documents_left cannot be nil.') - end - - if @sms_verifications_left.nil? - invalid_properties.push('invalid value for "sms_verifications_left", sms_verifications_left 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 @templates_left.nil? - return false if @api_signature_requests_left.nil? - return false if @documents_left.nil? - return false if @sms_verifications_left.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb index 6b62d9366..7b73e8d36 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb @@ -96,17 +96,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @name.nil? - invalid_properties.push('invalid value for "name", name 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 @name.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb index c1103ef2b..49eaf4fc6 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb @@ -22,6 +22,10 @@ class TemplateResponseDocument # @return [String] attr_accessor :name + # Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + # @return [Integer] + attr_accessor :index + # An array of Form Field Group objects. # @return [Array] attr_accessor :field_groups @@ -38,19 +42,15 @@ class TemplateResponseDocument # @return [Array] attr_accessor :static_fields - # Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - # @return [Integer] - attr_accessor :index - # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'name' => :'name', + :'index' => :'index', :'field_groups' => :'field_groups', :'form_fields' => :'form_fields', :'custom_fields' => :'custom_fields', - :'static_fields' => :'static_fields', - :'index' => :'index' + :'static_fields' => :'static_fields' } end @@ -63,11 +63,11 @@ def self.acceptable_attributes def self.openapi_types { :'name' => :'String', + :'index' => :'Integer', :'field_groups' => :'Array', :'form_fields' => :'Array', :'custom_fields' => :'Array', - :'static_fields' => :'Array', - :'index' => :'Integer' + :'static_fields' => :'Array' } end @@ -121,6 +121,10 @@ def initialize(attributes = {}) self.name = attributes[:'name'] end + if attributes.key?(:'index') + self.index = attributes[:'index'] + end + if attributes.key?(:'field_groups') if (value = attributes[:'field_groups']).is_a?(Array) self.field_groups = value @@ -144,47 +148,18 @@ def initialize(attributes = {}) self.static_fields = value end end - - if attributes.key?(:'index') - self.index = attributes[:'index'] - end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @name.nil? - invalid_properties.push('invalid value for "name", name cannot be nil.') - end - - if @field_groups.nil? - invalid_properties.push('invalid value for "field_groups", field_groups cannot be nil.') - end - - if @form_fields.nil? - invalid_properties.push('invalid value for "form_fields", form_fields cannot be nil.') - end - - if @custom_fields.nil? - invalid_properties.push('invalid value for "custom_fields", custom_fields cannot be nil.') - end - - if @static_fields.nil? - invalid_properties.push('invalid value for "static_fields", static_fields 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 @name.nil? - return false if @field_groups.nil? - return false if @form_fields.nil? - return false if @custom_fields.nil? - return false if @static_fields.nil? true end @@ -194,11 +169,11 @@ def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && + index == o.index && field_groups == o.field_groups && form_fields == o.form_fields && custom_fields == o.custom_fields && - static_fields == o.static_fields && - index == o.index + static_fields == o.static_fields end # @see the `==` method @@ -210,7 +185,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [name, field_groups, form_fields, custom_fields, static_fields, index].hash + [name, index, field_groups, form_fields, custom_fields, static_fields].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb index 76ae0662a..a80739b91 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb @@ -19,6 +19,9 @@ module Dropbox module Dropbox::Sign # An array of Form Field objects containing the name and type of each named field. class TemplateResponseDocumentCustomFieldBase + # @return [String] + attr_accessor :type + # The unique ID for this field. # @return [String] attr_accessor :api_id @@ -27,8 +30,9 @@ class TemplateResponseDocumentCustomFieldBase # @return [String] attr_accessor :name - # @return [String] - attr_accessor :type + # The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + # @return [Integer, String, nil] + attr_accessor :signer # The horizontal offset in pixels for this form field. # @return [Integer] @@ -50,10 +54,6 @@ class TemplateResponseDocumentCustomFieldBase # @return [Boolean] attr_accessor :required - # The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). - # @return [Integer, String, nil] - attr_accessor :signer - # The name of the group this field is in. If this field is not a group, this defaults to `null`. # @return [String, nil] attr_accessor :group @@ -61,15 +61,15 @@ class TemplateResponseDocumentCustomFieldBase # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { + :'type' => :'type', :'api_id' => :'api_id', :'name' => :'name', - :'type' => :'type', + :'signer' => :'signer', :'x' => :'x', :'y' => :'y', :'width' => :'width', :'height' => :'height', :'required' => :'required', - :'signer' => :'signer', :'group' => :'group' } end @@ -82,15 +82,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { + :'type' => :'String', :'api_id' => :'String', :'name' => :'String', - :'type' => :'String', + :'signer' => :'String', :'x' => :'Integer', :'y' => :'Integer', :'width' => :'Integer', :'height' => :'Integer', :'required' => :'Boolean', - :'signer' => :'String', :'group' => :'String' } end @@ -151,6 +151,10 @@ def initialize(attributes = {}) h[k.to_sym] = v } + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + if attributes.key?(:'api_id') self.api_id = attributes[:'api_id'] end @@ -159,8 +163,8 @@ def initialize(attributes = {}) self.name = attributes[:'name'] end - if attributes.key?(:'type') - self.type = attributes[:'type'] + if attributes.key?(:'signer') + self.signer = attributes[:'signer'] end if attributes.key?(:'x') @@ -183,10 +187,6 @@ def initialize(attributes = {}) self.required = attributes[:'required'] end - if attributes.key?(:'signer') - self.signer = attributes[:'signer'] - end - if attributes.key?(:'group') self.group = attributes[:'group'] end @@ -196,52 +196,17 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @api_id.nil? - invalid_properties.push('invalid value for "api_id", api_id cannot be nil.') - end - - if @name.nil? - invalid_properties.push('invalid value for "name", name cannot be nil.') - end - if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end - if @x.nil? - invalid_properties.push('invalid value for "x", x cannot be nil.') - end - - if @y.nil? - invalid_properties.push('invalid value for "y", y cannot be nil.') - end - - if @width.nil? - invalid_properties.push('invalid value for "width", width cannot be nil.') - end - - if @height.nil? - invalid_properties.push('invalid value for "height", height cannot be nil.') - end - - if @required.nil? - invalid_properties.push('invalid value for "required", required 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 @api_id.nil? - return false if @name.nil? return false if @type.nil? - return false if @x.nil? - return false if @y.nil? - return false if @width.nil? - return false if @height.nil? - return false if @required.nil? true end @@ -250,15 +215,15 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && + type == o.type && api_id == o.api_id && name == o.name && - type == o.type && + signer == o.signer && x == o.x && y == o.y && width == o.width && height == o.height && required == o.required && - signer == o.signer && group == o.group end @@ -271,7 +236,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [api_id, name, type, x, y, width, height, required, signer, group].hash + [type, api_id, name, signer, x, y, width, height, required, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb index 6205bf088..653b131ae 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb @@ -145,22 +145,6 @@ def list_invalid_properties invalid_properties.push('invalid value for "type", type cannot be nil.') end - if @avg_text_length.nil? - invalid_properties.push('invalid value for "avg_text_length", avg_text_length cannot be nil.') - end - - if @is_multiline.nil? - invalid_properties.push('invalid value for "is_multiline", is_multiline cannot be nil.') - end - - if @original_font_size.nil? - invalid_properties.push('invalid value for "original_font_size", original_font_size cannot be nil.') - end - - if @font_family.nil? - invalid_properties.push('invalid value for "font_family", font_family cannot be nil.') - end - invalid_properties end @@ -168,10 +152,6 @@ def list_invalid_properties # @return true if the model is valid def valid? return false if @type.nil? - return false if @avg_text_length.nil? - return false if @is_multiline.nil? - return false if @original_font_size.nil? - return false if @font_family.nil? true && super end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb index 0352a4080..ce2389e3a 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb @@ -105,22 +105,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @name.nil? - invalid_properties.push('invalid value for "name", name cannot be nil.') - end - - if @rule.nil? - invalid_properties.push('invalid value for "rule", rule 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 @name.nil? - return false if @rule.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb index 27ba34343..5b0d3ec6d 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb @@ -107,22 +107,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @requirement.nil? - invalid_properties.push('invalid value for "requirement", requirement cannot be nil.') - end - - if @group_label.nil? - invalid_properties.push('invalid value for "group_label", group_label 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 @requirement.nil? - return false if @group_label.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb index c7aa4af27..bc91770be 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb @@ -19,6 +19,9 @@ module Dropbox module Dropbox::Sign # An array of Form Field objects containing the name and type of each named field. class TemplateResponseDocumentFormFieldBase + # @return [String] + attr_accessor :type + # A unique id for the form field. # @return [String] attr_accessor :api_id @@ -27,9 +30,6 @@ class TemplateResponseDocumentFormFieldBase # @return [String] attr_accessor :name - # @return [String] - attr_accessor :type - # The signer of the Form Field. # @return [Integer, String] attr_accessor :signer @@ -57,9 +57,9 @@ class TemplateResponseDocumentFormFieldBase # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { + :'type' => :'type', :'api_id' => :'api_id', :'name' => :'name', - :'type' => :'type', :'signer' => :'signer', :'x' => :'x', :'y' => :'y', @@ -77,9 +77,9 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { + :'type' => :'String', :'api_id' => :'String', :'name' => :'String', - :'type' => :'String', :'signer' => :'String', :'x' => :'Integer', :'y' => :'Integer', @@ -161,6 +161,10 @@ def initialize(attributes = {}) h[k.to_sym] = v } + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + if attributes.key?(:'api_id') self.api_id = attributes[:'api_id'] end @@ -169,10 +173,6 @@ def initialize(attributes = {}) self.name = attributes[:'name'] end - if attributes.key?(:'type') - self.type = attributes[:'type'] - end - if attributes.key?(:'signer') self.signer = attributes[:'signer'] end @@ -202,57 +202,17 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @api_id.nil? - invalid_properties.push('invalid value for "api_id", api_id cannot be nil.') - end - - if @name.nil? - invalid_properties.push('invalid value for "name", name cannot be nil.') - end - if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end - if @signer.nil? - invalid_properties.push('invalid value for "signer", signer cannot be nil.') - end - - if @x.nil? - invalid_properties.push('invalid value for "x", x cannot be nil.') - end - - if @y.nil? - invalid_properties.push('invalid value for "y", y cannot be nil.') - end - - if @width.nil? - invalid_properties.push('invalid value for "width", width cannot be nil.') - end - - if @height.nil? - invalid_properties.push('invalid value for "height", height cannot be nil.') - end - - if @required.nil? - invalid_properties.push('invalid value for "required", required 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 @api_id.nil? - return false if @name.nil? return false if @type.nil? - return false if @signer.nil? - return false if @x.nil? - return false if @y.nil? - return false if @width.nil? - return false if @height.nil? - return false if @required.nil? true end @@ -261,9 +221,9 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && + type == o.type && api_id == o.api_id && name == o.name && - type == o.type && signer == o.signer && x == o.x && y == o.y && @@ -281,7 +241,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [api_id, name, type, signer, x, y, width, height, required].hash + [type, api_id, name, signer, x, y, width, height, required].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb index 8ae570661..f2f8631ac 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb @@ -156,22 +156,6 @@ def list_invalid_properties invalid_properties.push('invalid value for "type", type cannot be nil.') end - if @avg_text_length.nil? - invalid_properties.push('invalid value for "avg_text_length", avg_text_length cannot be nil.') - end - - if @is_multiline.nil? - invalid_properties.push('invalid value for "is_multiline", is_multiline cannot be nil.') - end - - if @original_font_size.nil? - invalid_properties.push('invalid value for "original_font_size", original_font_size cannot be nil.') - end - - if @font_family.nil? - invalid_properties.push('invalid value for "font_family", font_family cannot be nil.') - end - invalid_properties end @@ -179,10 +163,6 @@ def list_invalid_properties # @return true if the model is valid def valid? return false if @type.nil? - return false if @avg_text_length.nil? - return false if @is_multiline.nil? - return false if @original_font_size.nil? - return false if @font_family.nil? true && super end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb index b5b10d59d..51ed8bcd8 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb @@ -189,22 +189,6 @@ def list_invalid_properties invalid_properties.push('invalid value for "type", type cannot be nil.') end - if @avg_text_length.nil? - invalid_properties.push('invalid value for "avg_text_length", avg_text_length cannot be nil.') - end - - if @is_multiline.nil? - invalid_properties.push('invalid value for "is_multiline", is_multiline cannot be nil.') - end - - if @original_font_size.nil? - invalid_properties.push('invalid value for "original_font_size", original_font_size cannot be nil.') - end - - if @font_family.nil? - invalid_properties.push('invalid value for "font_family", font_family cannot be nil.') - end - invalid_properties end @@ -212,10 +196,6 @@ def list_invalid_properties # @return true if the model is valid def valid? return false if @type.nil? - return false if @avg_text_length.nil? - return false if @is_multiline.nil? - return false if @original_font_size.nil? - return false if @font_family.nil? validation_type_validator = EnumAttributeValidator.new('String', ["numbers_only", "letters_only", "phone_number", "bank_routing_number", "bank_account_number", "email_address", "zip_code", "social_security_number", "employer_identification_number", "custom_regex"]) return false unless validation_type_validator.valid?(@validation_type) true && super diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb index 8a4cbac11..a2d962291 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb @@ -19,6 +19,9 @@ module Dropbox module Dropbox::Sign # An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. class TemplateResponseDocumentStaticFieldBase + # @return [String] + attr_accessor :type + # A unique id for the static field. # @return [String] attr_accessor :api_id @@ -27,9 +30,6 @@ class TemplateResponseDocumentStaticFieldBase # @return [String] attr_accessor :name - # @return [String] - attr_accessor :type - # The signer of the Static Field. # @return [String] attr_accessor :signer @@ -61,9 +61,9 @@ class TemplateResponseDocumentStaticFieldBase # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { + :'type' => :'type', :'api_id' => :'api_id', :'name' => :'name', - :'type' => :'type', :'signer' => :'signer', :'x' => :'x', :'y' => :'y', @@ -82,9 +82,9 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { + :'type' => :'String', :'api_id' => :'String', :'name' => :'String', - :'type' => :'String', :'signer' => :'String', :'x' => :'Integer', :'y' => :'Integer', @@ -168,6 +168,10 @@ def initialize(attributes = {}) h[k.to_sym] = v } + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + if attributes.key?(:'api_id') self.api_id = attributes[:'api_id'] end @@ -176,10 +180,6 @@ def initialize(attributes = {}) self.name = attributes[:'name'] end - if attributes.key?(:'type') - self.type = attributes[:'type'] - end - if attributes.key?(:'signer') self.signer = attributes[:'signer'] else @@ -215,57 +215,17 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @api_id.nil? - invalid_properties.push('invalid value for "api_id", api_id cannot be nil.') - end - - if @name.nil? - invalid_properties.push('invalid value for "name", name cannot be nil.') - end - if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end - if @signer.nil? - invalid_properties.push('invalid value for "signer", signer cannot be nil.') - end - - if @x.nil? - invalid_properties.push('invalid value for "x", x cannot be nil.') - end - - if @y.nil? - invalid_properties.push('invalid value for "y", y cannot be nil.') - end - - if @width.nil? - invalid_properties.push('invalid value for "width", width cannot be nil.') - end - - if @height.nil? - invalid_properties.push('invalid value for "height", height cannot be nil.') - end - - if @required.nil? - invalid_properties.push('invalid value for "required", required 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 @api_id.nil? - return false if @name.nil? return false if @type.nil? - return false if @signer.nil? - return false if @x.nil? - return false if @y.nil? - return false if @width.nil? - return false if @height.nil? - return false if @required.nil? true end @@ -274,9 +234,9 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && + type == o.type && api_id == o.api_id && name == o.name && - type == o.type && signer == o.signer && x == o.x && y == o.y && @@ -295,7 +255,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [api_id, name, type, signer, x, y, width, height, required, group].hash + [type, api_id, name, signer, x, y, width, height, required, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb index 172098f29..a85e2c339 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb @@ -107,22 +107,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @num_lines.nil? - invalid_properties.push('invalid value for "num_lines", num_lines cannot be nil.') - end - - if @num_chars_per_line.nil? - invalid_properties.push('invalid value for "num_chars_per_line", num_chars_per_line 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 @num_lines.nil? - return false if @num_chars_per_line.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb index ea43ce2bc..286607280 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb @@ -106,17 +106,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @name.nil? - invalid_properties.push('invalid value for "name", name 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 @name.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb b/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb index 23748015e..97280f302 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb @@ -109,17 +109,12 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if @template_id.nil? - invalid_properties.push('invalid value for "template_id", template_id 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 @template_id.nil? true end From 7381c06764d31e7eff5cc2a179e55bec98513f5e Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Mon, 21 Oct 2024 09:32:25 -0500 Subject: [PATCH 11/16] Improvements to Account response; sets defaults (#432) --- openapi-raw.yaml | 8 +++- openapi-sdk.yaml | 14 ++++-- openapi.yaml | 14 ++++-- sdks/dotnet/README.md | 2 +- sdks/dotnet/docs/AccountResponseQuotas.md | 2 +- sdks/dotnet/docs/AccountResponseUsage.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 ++++++++------ .../Model/AccountResponseUsage.cs | 16 +++---- sdks/java-v1/README.md | 2 +- sdks/java-v1/docs/AccountResponseQuotas.md | 2 +- sdks/java-v1/docs/SignatureRequestApi.md | 2 +- sdks/java-v1/docs/TemplateApi.md | 4 +- .../sign/model/AccountResponseQuotas.java | 12 ++--- .../sign/model/AccountResponseUsage.java | 2 +- sdks/java-v2/README.md | 2 +- sdks/java-v2/docs/AccountResponseQuotas.md | 2 +- 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 | 14 +++--- .../sign/model/AccountResponseUsage.java | 2 +- sdks/node/README.md | 2 +- sdks/node/api/signatureRequestApi.ts | 2 +- sdks/node/api/templateApi.ts | 2 +- sdks/node/dist/api.js | 11 +++++ sdks/node/docs/api/SignatureRequestApi.md | 2 +- sdks/node/docs/api/TemplateApi.md | 4 +- sdks/node/docs/model/AccountResponseQuotas.md | 12 ++--- sdks/node/docs/model/AccountResponseUsage.md | 2 +- sdks/node/model/accountResponseQuotas.ts | 14 +++--- sdks/node/model/accountResponseUsage.ts | 2 +- .../types/model/accountResponseUsage.d.ts | 2 +- 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/docs/Model/AccountResponseUsage.md | 2 +- sdks/php/src/Api/TemplateApi.php | 8 ++-- sdks/php/src/Model/AccountResponseQuotas.php | 14 +++--- sdks/php/src/Model/AccountResponseUsage.php | 14 ++---- sdks/python/README.md | 2 +- sdks/python/docs/AccountResponseQuotas.md | 12 ++--- sdks/python/docs/AccountResponseUsage.md | 2 +- 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 | 48 ++++++++++++++----- .../models/account_response_usage.py | 12 ++++- sdks/ruby/README.md | 2 +- sdks/ruby/docs/AccountResponseQuotas.md | 12 ++--- sdks/ruby/docs/AccountResponseUsage.md | 2 +- 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 | 14 +++++- .../models/account_response_usage.rb | 5 +- translations/en.yaml | 12 ++--- 64 files changed, 266 insertions(+), 196 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 07648f251..bfec5feeb 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -9806,26 +9806,32 @@ components: api_signature_requests_left: description: '_t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT' type: integer + default: 0 nullable: true documents_left: description: '_t__AccountQuota::DOCUMENTS_LEFT' type: integer + default: 0 nullable: true templates_total: description: '_t__AccountQuota::TEMPLATES_TOTAL' type: integer + default: 0 nullable: true templates_left: description: '_t__AccountQuota::TEMPLATES_LEFT' type: integer + default: 0 nullable: true sms_verifications_left: description: '_t__AccountQuota::SMS_VERIFICATIONS_LEFT' type: integer + default: 0 nullable: true num_fax_pages_left: description: '_t__AccountQuota::NUM_FAX_PAGES_LEFT' type: integer + default: 0 nullable: true type: object x-internal-class: true @@ -9835,7 +9841,7 @@ components: fax_pages_sent: description: '_t__AccountUsage::FAX_PAGES_SENT' type: integer - nullable: true + default: 0 type: object x-internal-class: true AccountVerifyResponseAccount: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 0473fccb3..8860e0756 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -2737,7 +2737,7 @@ paths: The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. - This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. + This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. @@ -5474,7 +5474,7 @@ paths: post: tags: - Template - summary: 'Create Template' + summary: 'Create Template' description: 'Creates a template that can then be used.' operationId: templateCreate requestBody: @@ -10414,26 +10414,32 @@ components: api_signature_requests_left: description: 'API signature requests remaining.' type: integer + default: 0 nullable: true documents_left: description: 'Signature requests remaining.' type: integer + default: 0 nullable: true templates_total: description: 'Total API templates allowed.' type: integer + default: 0 nullable: true templates_left: description: 'API templates remaining.' type: integer + default: 0 nullable: true sms_verifications_left: - description: 'SMS verifications remaining.' + description: 'SMS verifications remaining.' type: integer + default: 0 nullable: true num_fax_pages_left: description: 'Number of fax pages left' type: integer + default: 0 nullable: true type: object x-internal-class: true @@ -10443,7 +10449,7 @@ components: fax_pages_sent: description: 'Number of fax pages sent' type: integer - nullable: true + default: 0 type: object x-internal-class: true AccountVerifyResponseAccount: diff --git a/openapi.yaml b/openapi.yaml index 6ff9bab8b..6fce424d7 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -2737,7 +2737,7 @@ paths: The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. - This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. + This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. @@ -5474,7 +5474,7 @@ paths: post: tags: - Template - summary: 'Create Template' + summary: 'Create Template' description: 'Creates a template that can then be used.' operationId: templateCreate requestBody: @@ -10392,26 +10392,32 @@ components: api_signature_requests_left: description: 'API signature requests remaining.' type: integer + default: 0 nullable: true documents_left: description: 'Signature requests remaining.' type: integer + default: 0 nullable: true templates_total: description: 'Total API templates allowed.' type: integer + default: 0 nullable: true templates_left: description: 'API templates remaining.' type: integer + default: 0 nullable: true sms_verifications_left: - description: 'SMS verifications remaining.' + description: 'SMS verifications remaining.' type: integer + default: 0 nullable: true num_fax_pages_left: description: 'Number of fax pages left' type: integer + default: 0 nullable: true type: object x-internal-class: true @@ -10421,7 +10427,7 @@ components: fax_pages_sent: description: 'Number of fax pages sent' type: integer - nullable: true + default: 0 type: object x-internal-class: true AccountVerifyResponseAccount: diff --git a/sdks/dotnet/README.md b/sdks/dotnet/README.md index e3507dbe3..a13746f94 100644 --- a/sdks/dotnet/README.md +++ b/sdks/dotnet/README.md @@ -178,7 +178,7 @@ Class | Method | HTTP request | Description *TeamApi* | [**TeamSubTeams**](docs/TeamApi.md#teamsubteams) | **GET** /team/sub_teams/{team_id} | List Sub Teams *TeamApi* | [**TeamUpdate**](docs/TeamApi.md#teamupdate) | **PUT** /team | Update Team *TemplateApi* | [**TemplateAddUser**](docs/TemplateApi.md#templateadduser) | **POST** /template/add_user/{template_id} | Add User to Template -*TemplateApi* | [**TemplateCreate**](docs/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template +*TemplateApi* | [**TemplateCreate**](docs/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template *TemplateApi* | [**TemplateCreateEmbeddedDraft**](docs/TemplateApi.md#templatecreateembeddeddraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft *TemplateApi* | [**TemplateDelete**](docs/TemplateApi.md#templatedelete) | **POST** /template/delete/{template_id} | Delete Template *TemplateApi* | [**TemplateFiles**](docs/TemplateApi.md#templatefiles) | **GET** /template/files/{template_id} | Get Template Files diff --git a/sdks/dotnet/docs/AccountResponseQuotas.md b/sdks/dotnet/docs/AccountResponseQuotas.md index 2e12ea8cb..ca716dbff 100644 --- a/sdks/dotnet/docs/AccountResponseQuotas.md +++ b/sdks/dotnet/docs/AccountResponseQuotas.md @@ -5,7 +5,7 @@ Details concerning remaining monthly quotas. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiSignatureRequestsLeft** | **int?** | API signature requests remaining. | [optional] **DocumentsLeft** | **int?** | Signature requests remaining. | [optional] **TemplatesTotal** | **int?** | Total API templates allowed. | [optional] **TemplatesLeft** | **int?** | API templates remaining. | [optional] **SmsVerificationsLeft** | **int?** | SMS verifications remaining. | [optional] **NumFaxPagesLeft** | **int?** | Number of fax pages left | [optional] +**ApiSignatureRequestsLeft** | **int?** | API signature requests remaining. | [optional] [default to 0]**DocumentsLeft** | **int?** | Signature requests remaining. | [optional] [default to 0]**TemplatesTotal** | **int?** | Total API templates allowed. | [optional] [default to 0]**TemplatesLeft** | **int?** | API templates remaining. | [optional] [default to 0]**SmsVerificationsLeft** | **int?** | SMS verifications remaining. | [optional] [default to 0]**NumFaxPagesLeft** | **int?** | Number of fax pages left | [optional] [default to 0] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/AccountResponseUsage.md b/sdks/dotnet/docs/AccountResponseUsage.md index fa5536881..27e541f8f 100644 --- a/sdks/dotnet/docs/AccountResponseUsage.md +++ b/sdks/dotnet/docs/AccountResponseUsage.md @@ -5,7 +5,7 @@ Details concerning monthly usage Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**FaxPagesSent** | **int?** | Number of fax pages sent | [optional] +**FaxPagesSent** | **int** | Number of fax pages sent | [optional] [default to 0] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestApi.md b/sdks/dotnet/docs/SignatureRequestApi.md index c411d0c01..a507cc08f 100644 --- a/sdks/dotnet/docs/SignatureRequestApi.md +++ b/sdks/dotnet/docs/SignatureRequestApi.md @@ -312,7 +312,7 @@ catch (ApiException e) Cancel Incomplete Signature Request -Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. +Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. ### Example ```csharp diff --git a/sdks/dotnet/docs/TemplateApi.md b/sdks/dotnet/docs/TemplateApi.md index d7f4c3bda..c51decd9d 100644 --- a/sdks/dotnet/docs/TemplateApi.md +++ b/sdks/dotnet/docs/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | |--------|--------------|-------------| | [**TemplateAddUser**](TemplateApi.md#templateadduser) | **POST** /template/add_user/{template_id} | Add User to Template | -| [**TemplateCreate**](TemplateApi.md#templatecreate) | **POST** /template/create | Create Template | +| [**TemplateCreate**](TemplateApi.md#templatecreate) | **POST** /template/create | Create Template | | [**TemplateCreateEmbeddedDraft**](TemplateApi.md#templatecreateembeddeddraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | | [**TemplateDelete**](TemplateApi.md#templatedelete) | **POST** /template/delete/{template_id} | Delete Template | | [**TemplateFiles**](TemplateApi.md#templatefiles) | **GET** /template/files/{template_id} | Get Template Files | @@ -120,7 +120,7 @@ catch (ApiException e) # **TemplateCreate** > TemplateCreateResponse TemplateCreate (TemplateCreateRequest templateCreateRequest) -Create Template +Create Template Creates a template that can then be used. @@ -214,7 +214,7 @@ This returns an ApiResponse object which contains the response data, status code ```csharp try { - // Create Template + // Create Template ApiResponse response = apiInstance.TemplateCreateWithHttpInfo(templateCreateRequest); Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Response Headers: " + response.Headers); diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs index 0669f9132..7671b5780 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/SignatureRequestApi.cs @@ -77,7 +77,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// Cancel Incomplete Signature Request /// /// - /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. @@ -89,7 +89,7 @@ public interface ISignatureRequestApiSync : IApiAccessor /// Cancel Incomplete Signature Request /// /// - /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. @@ -472,7 +472,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// Cancel Incomplete Signature Request /// /// - /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. @@ -485,7 +485,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor /// Cancel Incomplete Signature Request /// /// - /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. @@ -1309,7 +1309,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequest } /// - /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. @@ -1321,7 +1321,7 @@ public void SignatureRequestCancel(string signatureRequestId, int operationIndex } /// - /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. @@ -1390,7 +1390,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestCancelWithHttpInf } /// - /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. @@ -1403,7 +1403,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequestCancelWithHttpInf } /// - /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. /// /// Thrown when fails to make API call /// The id of the incomplete SignatureRequest to cancel. diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs index 01bb32262..f98f0671c 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs @@ -53,7 +53,7 @@ public interface ITemplateApiSync : IApiAccessor /// ApiResponse of TemplateGetResponse ApiResponse TemplateAddUserWithHttpInfo(string templateId, TemplateAddUserRequest templateAddUserRequest, int operationIndex = 0); /// - /// Create Template + /// Create Template /// /// /// Creates a template that can then be used. @@ -65,7 +65,7 @@ public interface ITemplateApiSync : IApiAccessor TemplateCreateResponse TemplateCreate(TemplateCreateRequest templateCreateRequest, int operationIndex = 0); /// - /// Create Template + /// Create Template /// /// /// Creates a template that can then be used. @@ -333,7 +333,7 @@ public interface ITemplateApiAsync : IApiAccessor /// Task of ApiResponse (TemplateGetResponse) System.Threading.Tasks.Task> TemplateAddUserWithHttpInfoAsync(string templateId, TemplateAddUserRequest templateAddUserRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// - /// Create Template + /// Create Template /// /// /// Creates a template that can then be used. @@ -346,7 +346,7 @@ public interface ITemplateApiAsync : IApiAccessor System.Threading.Tasks.Task TemplateCreateAsync(TemplateCreateRequest templateCreateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// - /// Create Template + /// Create Template /// /// /// Creates a template that can then be used. @@ -919,7 +919,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateAddUserWithH } /// - /// Create Template Creates a template that can then be used. + /// Create Template Creates a template that can then be used. /// /// Thrown when fails to make API call /// @@ -932,7 +932,7 @@ public TemplateCreateResponse TemplateCreate(TemplateCreateRequest templateCreat } /// - /// Create Template Creates a template that can then be used. + /// Create Template Creates a template that can then be used. /// /// Thrown when fails to make API call /// @@ -1009,7 +1009,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateCreateWit } /// - /// Create Template Creates a template that can then be used. + /// Create Template Creates a template that can then be used. /// /// Thrown when fails to make API call /// @@ -1023,7 +1023,7 @@ public Dropbox.Sign.Client.ApiResponse TemplateCreateWit } /// - /// Create Template Creates a template that can then be used. + /// Create Template Creates a template that can then be used. /// /// Thrown when fails to make API call /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs index f72e2721f..8140337a2 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs @@ -41,21 +41,27 @@ protected AccountResponseQuotas() { } /// /// Initializes a new instance of the class. /// - /// API signature requests remaining.. - /// Signature requests remaining.. - /// Total API templates allowed.. - /// API templates remaining.. - /// SMS verifications remaining.. - /// Number of fax pages left. - public AccountResponseQuotas(int? apiSignatureRequestsLeft = default(int?), int? documentsLeft = default(int?), int? templatesTotal = default(int?), int? templatesLeft = default(int?), int? smsVerificationsLeft = default(int?), int? numFaxPagesLeft = default(int?)) + /// API signature requests remaining. (default to 0). + /// Signature requests remaining. (default to 0). + /// Total API templates allowed. (default to 0). + /// API templates remaining. (default to 0). + /// SMS verifications remaining. (default to 0). + /// Number of fax pages left (default to 0). + public AccountResponseQuotas(int? apiSignatureRequestsLeft = 0, int? documentsLeft = 0, int? templatesTotal = 0, int? templatesLeft = 0, int? smsVerificationsLeft = 0, int? numFaxPagesLeft = 0) { - this.ApiSignatureRequestsLeft = apiSignatureRequestsLeft; - this.DocumentsLeft = documentsLeft; - this.TemplatesTotal = templatesTotal; - this.TemplatesLeft = templatesLeft; - this.SmsVerificationsLeft = smsVerificationsLeft; - this.NumFaxPagesLeft = numFaxPagesLeft; + // use default value if no "apiSignatureRequestsLeft" provided + this.ApiSignatureRequestsLeft = apiSignatureRequestsLeft ?? 0; + // use default value if no "documentsLeft" provided + this.DocumentsLeft = documentsLeft ?? 0; + // use default value if no "templatesTotal" provided + this.TemplatesTotal = templatesTotal ?? 0; + // use default value if no "templatesLeft" provided + this.TemplatesLeft = templatesLeft ?? 0; + // use default value if no "smsVerificationsLeft" provided + this.SmsVerificationsLeft = smsVerificationsLeft ?? 0; + // use default value if no "numFaxPagesLeft" provided + this.NumFaxPagesLeft = numFaxPagesLeft ?? 0; } /// @@ -103,9 +109,9 @@ public static AccountResponseQuotas Init(string jsonData) public int? TemplatesLeft { get; set; } /// - /// SMS verifications remaining. + /// SMS verifications remaining. /// - /// SMS verifications remaining. + /// SMS verifications remaining. [DataMember(Name = "sms_verifications_left", EmitDefaultValue = true)] public int? SmsVerificationsLeft { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs index bd9e2e5ac..dd51fdcb5 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs @@ -41,8 +41,8 @@ protected AccountResponseUsage() { } /// /// Initializes a new instance of the class. /// - /// Number of fax pages sent. - public AccountResponseUsage(int? faxPagesSent = default(int?)) + /// Number of fax pages sent (default to 0). + public AccountResponseUsage(int faxPagesSent = 0) { this.FaxPagesSent = faxPagesSent; @@ -69,7 +69,7 @@ public static AccountResponseUsage Init(string jsonData) /// /// Number of fax pages sent [DataMember(Name = "fax_pages_sent", EmitDefaultValue = true)] - public int? FaxPagesSent { get; set; } + public int FaxPagesSent { get; set; } /// /// Returns the string presentation of the object @@ -117,8 +117,7 @@ public bool Equals(AccountResponseUsage input) return ( this.FaxPagesSent == input.FaxPagesSent || - (this.FaxPagesSent != null && - this.FaxPagesSent.Equals(input.FaxPagesSent)) + this.FaxPagesSent.Equals(input.FaxPagesSent) ); } @@ -131,10 +130,7 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; - if (this.FaxPagesSent != null) - { - hashCode = (hashCode * 59) + this.FaxPagesSent.GetHashCode(); - } + hashCode = (hashCode * 59) + this.FaxPagesSent.GetHashCode(); return hashCode; } } @@ -155,7 +151,7 @@ public List GetOpenApiTypes() { Name = "fax_pages_sent", Property = "FaxPagesSent", - Type = "int?", + Type = "int", Value = FaxPagesSent, }); diff --git a/sdks/java-v1/README.md b/sdks/java-v1/README.md index b78da75be..8ef139fc2 100644 --- a/sdks/java-v1/README.md +++ b/sdks/java-v1/README.md @@ -214,7 +214,7 @@ Class | Method | HTTP request | Description *TeamApi* | [**teamSubTeams**](docs/TeamApi.md#teamSubTeams) | **GET** /team/sub_teams/{team_id} | List Sub Teams *TeamApi* | [**teamUpdate**](docs/TeamApi.md#teamUpdate) | **PUT** /team | Update Team *TemplateApi* | [**templateAddUser**](docs/TemplateApi.md#templateAddUser) | **POST** /template/add_user/{template_id} | Add User to Template -*TemplateApi* | [**templateCreate**](docs/TemplateApi.md#templateCreate) | **POST** /template/create | Create Template +*TemplateApi* | [**templateCreate**](docs/TemplateApi.md#templateCreate) | **POST** /template/create | Create Template *TemplateApi* | [**templateCreateEmbeddedDraft**](docs/TemplateApi.md#templateCreateEmbeddedDraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft *TemplateApi* | [**templateDelete**](docs/TemplateApi.md#templateDelete) | **POST** /template/delete/{template_id} | Delete Template *TemplateApi* | [**templateFiles**](docs/TemplateApi.md#templateFiles) | **GET** /template/files/{template_id} | Get Template Files diff --git a/sdks/java-v1/docs/AccountResponseQuotas.md b/sdks/java-v1/docs/AccountResponseQuotas.md index 3b7fe4e58..e7510a8d7 100644 --- a/sdks/java-v1/docs/AccountResponseQuotas.md +++ b/sdks/java-v1/docs/AccountResponseQuotas.md @@ -12,7 +12,7 @@ Details concerning remaining monthly quotas. | `documentsLeft` | ```Integer``` | Signature requests remaining. | | | `templatesTotal` | ```Integer``` | Total API templates allowed. | | | `templatesLeft` | ```Integer``` | API templates remaining. | | -| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | +| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | | `numFaxPagesLeft` | ```Integer``` | Number of fax pages left | | diff --git a/sdks/java-v1/docs/SignatureRequestApi.md b/sdks/java-v1/docs/SignatureRequestApi.md index ee42461ce..60e02426f 100644 --- a/sdks/java-v1/docs/SignatureRequestApi.md +++ b/sdks/java-v1/docs/SignatureRequestApi.md @@ -265,7 +265,7 @@ Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. -This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. +This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. diff --git a/sdks/java-v1/docs/TemplateApi.md b/sdks/java-v1/docs/TemplateApi.md index a3394d6a1..e6c7d1745 100644 --- a/sdks/java-v1/docs/TemplateApi.md +++ b/sdks/java-v1/docs/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | |------------- | ------------- | -------------| [**templateAddUser**](TemplateApi.md#templateAddUser) | **POST** /template/add_user/{template_id} | Add User to Template -[**templateCreate**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template +[**templateCreate**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template [**templateCreateEmbeddedDraft**](TemplateApi.md#templateCreateEmbeddedDraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft [**templateDelete**](TemplateApi.md#templateDelete) | **POST** /template/delete/{template_id} | Delete Template [**templateFiles**](TemplateApi.md#templateFiles) | **GET** /template/files/{template_id} | Get Template Files @@ -100,7 +100,7 @@ public class Example { > TemplateCreateResponse templateCreate(templateCreateRequest) -Create Template +Create Template Creates a template that can then be used. diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java index 584917ff9..bc47dc564 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java @@ -39,22 +39,22 @@ public class AccountResponseQuotas { public static final String JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT = "api_signature_requests_left"; - private Integer apiSignatureRequestsLeft; + private Integer apiSignatureRequestsLeft = 0; public static final String JSON_PROPERTY_DOCUMENTS_LEFT = "documents_left"; - private Integer documentsLeft; + private Integer documentsLeft = 0; public static final String JSON_PROPERTY_TEMPLATES_TOTAL = "templates_total"; - private Integer templatesTotal; + private Integer templatesTotal = 0; public static final String JSON_PROPERTY_TEMPLATES_LEFT = "templates_left"; - private Integer templatesLeft; + private Integer templatesLeft = 0; public static final String JSON_PROPERTY_SMS_VERIFICATIONS_LEFT = "sms_verifications_left"; - private Integer smsVerificationsLeft; + private Integer smsVerificationsLeft = 0; public static final String JSON_PROPERTY_NUM_FAX_PAGES_LEFT = "num_fax_pages_left"; - private Integer numFaxPagesLeft; + private Integer numFaxPagesLeft = 0; public AccountResponseQuotas() {} diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java index daac05931..c45fe4ce2 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java @@ -31,7 +31,7 @@ @JsonIgnoreProperties(ignoreUnknown = true) public class AccountResponseUsage { public static final String JSON_PROPERTY_FAX_PAGES_SENT = "fax_pages_sent"; - private Integer faxPagesSent; + private Integer faxPagesSent = 0; public AccountResponseUsage() {} diff --git a/sdks/java-v2/README.md b/sdks/java-v2/README.md index 75edf1dcb..2733d9f9e 100644 --- a/sdks/java-v2/README.md +++ b/sdks/java-v2/README.md @@ -190,7 +190,7 @@ Class | Method | HTTP request | Description *TeamApi* | [**teamSubTeams**](docs/TeamApi.md#teamSubTeams) | **GET** /team/sub_teams/{team_id} | List Sub Teams *TeamApi* | [**teamUpdate**](docs/TeamApi.md#teamUpdate) | **PUT** /team | Update Team *TemplateApi* | [**templateAddUser**](docs/TemplateApi.md#templateAddUser) | **POST** /template/add_user/{template_id} | Add User to Template -*TemplateApi* | [**templateCreate**](docs/TemplateApi.md#templateCreate) | **POST** /template/create | Create Template +*TemplateApi* | [**templateCreate**](docs/TemplateApi.md#templateCreate) | **POST** /template/create | Create Template *TemplateApi* | [**templateCreateEmbeddedDraft**](docs/TemplateApi.md#templateCreateEmbeddedDraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft *TemplateApi* | [**templateDelete**](docs/TemplateApi.md#templateDelete) | **POST** /template/delete/{template_id} | Delete Template *TemplateApi* | [**templateFiles**](docs/TemplateApi.md#templateFiles) | **GET** /template/files/{template_id} | Get Template Files diff --git a/sdks/java-v2/docs/AccountResponseQuotas.md b/sdks/java-v2/docs/AccountResponseQuotas.md index 3b7fe4e58..e7510a8d7 100644 --- a/sdks/java-v2/docs/AccountResponseQuotas.md +++ b/sdks/java-v2/docs/AccountResponseQuotas.md @@ -12,7 +12,7 @@ Details concerning remaining monthly quotas. | `documentsLeft` | ```Integer``` | Signature requests remaining. | | | `templatesTotal` | ```Integer``` | Total API templates allowed. | | | `templatesLeft` | ```Integer``` | API templates remaining. | | -| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | +| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | | `numFaxPagesLeft` | ```Integer``` | Number of fax pages left | | diff --git a/sdks/java-v2/docs/SignatureRequestApi.md b/sdks/java-v2/docs/SignatureRequestApi.md index ee42461ce..60e02426f 100644 --- a/sdks/java-v2/docs/SignatureRequestApi.md +++ b/sdks/java-v2/docs/SignatureRequestApi.md @@ -265,7 +265,7 @@ Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. -This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. +This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. diff --git a/sdks/java-v2/docs/TemplateApi.md b/sdks/java-v2/docs/TemplateApi.md index a3394d6a1..e6c7d1745 100644 --- a/sdks/java-v2/docs/TemplateApi.md +++ b/sdks/java-v2/docs/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | |------------- | ------------- | -------------| [**templateAddUser**](TemplateApi.md#templateAddUser) | **POST** /template/add_user/{template_id} | Add User to Template -[**templateCreate**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template +[**templateCreate**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template [**templateCreateEmbeddedDraft**](TemplateApi.md#templateCreateEmbeddedDraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft [**templateDelete**](TemplateApi.md#templateDelete) | **POST** /template/delete/{template_id} | Delete Template [**templateFiles**](TemplateApi.md#templateFiles) | **GET** /template/files/{template_id} | Get Template Files @@ -100,7 +100,7 @@ public class Example { > TemplateCreateResponse templateCreate(templateCreateRequest) -Create Template +Create Template Creates a template that can then be used. diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java index c326a36dc..711191bc9 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java @@ -184,7 +184,7 @@ public ApiResponse signatureRequestBulkSendWithTemplate } /** * Cancel Incomplete Signature Request. - * Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + * Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. (required) * @throws ApiException if fails to make API call * @http.response.details @@ -201,7 +201,7 @@ public void signatureRequestCancel(String signatureRequestId) throws ApiExceptio /** * Cancel Incomplete Signature Request. - * Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + * Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/TemplateApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/TemplateApi.java index 7fb8db518..c64166a85 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/TemplateApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/TemplateApi.java @@ -130,7 +130,7 @@ public ApiResponse templateAddUserWithHttpInfo(String templ ); } /** - * Create Template. + * Create Template. * Creates a template that can then be used. * @param templateCreateRequest (required) * @return TemplateCreateResponse @@ -148,7 +148,7 @@ public TemplateCreateResponse templateCreate(TemplateCreateRequest templateCreat /** - * Create Template. + * Create Template. * Creates a template that can then be used. * @param templateCreateRequest (required) * @return ApiResponse<TemplateCreateResponse> diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java index 04c1fe763..fd725681d 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java @@ -44,22 +44,22 @@ @JsonIgnoreProperties(ignoreUnknown=true) public class AccountResponseQuotas { public static final String JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT = "api_signature_requests_left"; - private Integer apiSignatureRequestsLeft; + private Integer apiSignatureRequestsLeft = 0; public static final String JSON_PROPERTY_DOCUMENTS_LEFT = "documents_left"; - private Integer documentsLeft; + private Integer documentsLeft = 0; public static final String JSON_PROPERTY_TEMPLATES_TOTAL = "templates_total"; - private Integer templatesTotal; + private Integer templatesTotal = 0; public static final String JSON_PROPERTY_TEMPLATES_LEFT = "templates_left"; - private Integer templatesLeft; + private Integer templatesLeft = 0; public static final String JSON_PROPERTY_SMS_VERIFICATIONS_LEFT = "sms_verifications_left"; - private Integer smsVerificationsLeft; + private Integer smsVerificationsLeft = 0; public static final String JSON_PROPERTY_NUM_FAX_PAGES_LEFT = "num_fax_pages_left"; - private Integer numFaxPagesLeft; + private Integer numFaxPagesLeft = 0; public AccountResponseQuotas() { } @@ -185,7 +185,7 @@ public AccountResponseQuotas smsVerificationsLeft(Integer smsVerificationsLeft) } /** - * SMS verifications remaining. + * SMS verifications remaining. * @return smsVerificationsLeft */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java index 741d5e58c..34dc9f8c0 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java @@ -39,7 +39,7 @@ @JsonIgnoreProperties(ignoreUnknown=true) public class AccountResponseUsage { public static final String JSON_PROPERTY_FAX_PAGES_SENT = "fax_pages_sent"; - private Integer faxPagesSent; + private Integer faxPagesSent = 0; public AccountResponseUsage() { } diff --git a/sdks/node/README.md b/sdks/node/README.md index 4aca5d208..542d01e29 100644 --- a/sdks/node/README.md +++ b/sdks/node/README.md @@ -157,7 +157,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | *TeamApi* | [**teamSubTeams**](./docs/api/TeamApi.md#teamsubteams) | **GET** /team/sub_teams/{team_id} | List Sub Teams | | *TeamApi* | [**teamUpdate**](./docs/api/TeamApi.md#teamupdate) | **PUT** /team | Update Team | | *TemplateApi* | [**templateAddUser**](./docs/api/TemplateApi.md#templateadduser) | **POST** /template/add_user/{template_id} | Add User to Template | -| *TemplateApi* | [**templateCreate**](./docs/api/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template | +| *TemplateApi* | [**templateCreate**](./docs/api/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template | | *TemplateApi* | [**templateCreateEmbeddedDraft**](./docs/api/TemplateApi.md#templatecreateembeddeddraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | | *TemplateApi* | [**templateDelete**](./docs/api/TemplateApi.md#templatedelete) | **POST** /template/delete/{template_id} | Delete Template | | *TemplateApi* | [**templateFiles**](./docs/api/TemplateApi.md#templatefiles) | **GET** /template/files/{template_id} | Get Template Files | diff --git a/sdks/node/api/signatureRequestApi.ts b/sdks/node/api/signatureRequestApi.ts index 51ccd93bf..3fd0d611e 100644 --- a/sdks/node/api/signatureRequestApi.ts +++ b/sdks/node/api/signatureRequestApi.ts @@ -422,7 +422,7 @@ export class SignatureRequestApi { }); } /** - * Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + * Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. * @summary Cancel Incomplete Signature Request * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. * @param options diff --git a/sdks/node/api/templateApi.ts b/sdks/node/api/templateApi.ts index 50ff0b4e7..35ac24648 100644 --- a/sdks/node/api/templateApi.ts +++ b/sdks/node/api/templateApi.ts @@ -291,7 +291,7 @@ export class TemplateApi { } /** * Creates a template that can then be used. - * @summary Create Template + * @summary Create Template * @param templateCreateRequest * @param options */ diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 812088395..e24c2e532 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -16518,6 +16518,14 @@ AccountResponse.attributeTypeMap = [ // model/accountResponseQuotas.ts var _AccountResponseQuotas = class { + constructor() { + this["apiSignatureRequestsLeft"] = 0; + this["documentsLeft"] = 0; + this["templatesTotal"] = 0; + this["templatesLeft"] = 0; + this["smsVerificationsLeft"] = 0; + this["numFaxPagesLeft"] = 0; + } static getAttributeTypeMap() { return _AccountResponseQuotas.attributeTypeMap; } @@ -16562,6 +16570,9 @@ AccountResponseQuotas.attributeTypeMap = [ // model/accountResponseUsage.ts var _AccountResponseUsage = class { + constructor() { + this["faxPagesSent"] = 0; + } static getAttributeTypeMap() { return _AccountResponseUsage.attributeTypeMap; } diff --git a/sdks/node/docs/api/SignatureRequestApi.md b/sdks/node/docs/api/SignatureRequestApi.md index 189d58b92..459c8c120 100644 --- a/sdks/node/docs/api/SignatureRequestApi.md +++ b/sdks/node/docs/api/SignatureRequestApi.md @@ -379,7 +379,7 @@ signatureRequestCancel(signatureRequestId: string) Cancel Incomplete Signature Request -Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. +Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. ### TypeScript Example diff --git a/sdks/node/docs/api/TemplateApi.md b/sdks/node/docs/api/TemplateApi.md index 995945f30..e73e5930d 100644 --- a/sdks/node/docs/api/TemplateApi.md +++ b/sdks/node/docs/api/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to https://api.hellosign.com/v3. | Method | HTTP request | Description | | ------------- | ------------- | ------------- | | [**templateAddUser()**](TemplateApi.md#templateAddUser) | **POST** /template/add_user/{template_id} | Add User to Template | -| [**templateCreate()**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template | +| [**templateCreate()**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template | | [**templateCreateEmbeddedDraft()**](TemplateApi.md#templateCreateEmbeddedDraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | | [**templateDelete()**](TemplateApi.md#templateDelete) | **POST** /template/delete/{template_id} | Delete Template | | [**templateFiles()**](TemplateApi.md#templateFiles) | **GET** /template/files/{template_id} | Get Template Files | @@ -115,7 +115,7 @@ result.then(response => { templateCreate(templateCreateRequest: TemplateCreateRequest): TemplateCreateResponse ``` -Create Template +Create Template Creates a template that can then be used. diff --git a/sdks/node/docs/model/AccountResponseQuotas.md b/sdks/node/docs/model/AccountResponseQuotas.md index 55beed9cb..7d6188988 100644 --- a/sdks/node/docs/model/AccountResponseQuotas.md +++ b/sdks/node/docs/model/AccountResponseQuotas.md @@ -6,11 +6,11 @@ Details concerning remaining monthly quotas. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `apiSignatureRequestsLeft` | ```number``` | API signature requests remaining. | | -| `documentsLeft` | ```number``` | Signature requests remaining. | | -| `templatesTotal` | ```number``` | Total API templates allowed. | | -| `templatesLeft` | ```number``` | API templates remaining. | | -| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | | -| `numFaxPagesLeft` | ```number``` | Number of fax pages left | | +| `apiSignatureRequestsLeft` | ```number``` | API signature requests remaining. | [default to 0] | +| `documentsLeft` | ```number``` | Signature requests remaining. | [default to 0] | +| `templatesTotal` | ```number``` | Total API templates allowed. | [default to 0] | +| `templatesLeft` | ```number``` | API templates remaining. | [default to 0] | +| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | [default to 0] | +| `numFaxPagesLeft` | ```number``` | Number of fax pages left | [default to 0] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/AccountResponseUsage.md b/sdks/node/docs/model/AccountResponseUsage.md index 2f095fba9..0591e3c98 100644 --- a/sdks/node/docs/model/AccountResponseUsage.md +++ b/sdks/node/docs/model/AccountResponseUsage.md @@ -6,6 +6,6 @@ Details concerning monthly usage Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `faxPagesSent` | ```number``` | Number of fax pages sent | | +| `faxPagesSent` | ```number``` | Number of fax pages sent | [default to 0] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/model/accountResponseQuotas.ts b/sdks/node/model/accountResponseQuotas.ts index 3553070d7..e1efe123f 100644 --- a/sdks/node/model/accountResponseQuotas.ts +++ b/sdks/node/model/accountResponseQuotas.ts @@ -31,27 +31,27 @@ export class AccountResponseQuotas { /** * API signature requests remaining. */ - "apiSignatureRequestsLeft"?: number | null; + "apiSignatureRequestsLeft"?: number | null = 0; /** * Signature requests remaining. */ - "documentsLeft"?: number | null; + "documentsLeft"?: number | null = 0; /** * Total API templates allowed. */ - "templatesTotal"?: number | null; + "templatesTotal"?: number | null = 0; /** * API templates remaining. */ - "templatesLeft"?: number | null; + "templatesLeft"?: number | null = 0; /** - * SMS verifications remaining. + * SMS verifications remaining. */ - "smsVerificationsLeft"?: number | null; + "smsVerificationsLeft"?: number | null = 0; /** * Number of fax pages left */ - "numFaxPagesLeft"?: number | null; + "numFaxPagesLeft"?: number | null = 0; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/accountResponseUsage.ts b/sdks/node/model/accountResponseUsage.ts index 95f6f9f88..ce2d969c0 100644 --- a/sdks/node/model/accountResponseUsage.ts +++ b/sdks/node/model/accountResponseUsage.ts @@ -31,7 +31,7 @@ export class AccountResponseUsage { /** * Number of fax pages sent */ - "faxPagesSent"?: number | null; + "faxPagesSent"?: number = 0; static discriminator: string | undefined = undefined; diff --git a/sdks/node/types/model/accountResponseUsage.d.ts b/sdks/node/types/model/accountResponseUsage.d.ts index 7506ca0ee..0b520ac76 100644 --- a/sdks/node/types/model/accountResponseUsage.d.ts +++ b/sdks/node/types/model/accountResponseUsage.d.ts @@ -1,6 +1,6 @@ import { AttributeTypeMap } from "./"; export declare class AccountResponseUsage { - "faxPagesSent"?: number | null; + "faxPagesSent"?: number; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/php/README.md b/sdks/php/README.md index b68ace90a..11d7e67f7 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -197,7 +197,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | *TeamApi* | [**teamSubTeams**](docs/Api/TeamApi.md#teamsubteams) | **GET** /team/sub_teams/{team_id} | List Sub Teams | | *TeamApi* | [**teamUpdate**](docs/Api/TeamApi.md#teamupdate) | **PUT** /team | Update Team | | *TemplateApi* | [**templateAddUser**](docs/Api/TemplateApi.md#templateadduser) | **POST** /template/add_user/{template_id} | Add User to Template | -| *TemplateApi* | [**templateCreate**](docs/Api/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template | +| *TemplateApi* | [**templateCreate**](docs/Api/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template | | *TemplateApi* | [**templateCreateEmbeddedDraft**](docs/Api/TemplateApi.md#templatecreateembeddeddraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | | *TemplateApi* | [**templateDelete**](docs/Api/TemplateApi.md#templatedelete) | **POST** /template/delete/{template_id} | Delete Template | | *TemplateApi* | [**templateFiles**](docs/Api/TemplateApi.md#templatefiles) | **GET** /template/files/{template_id} | Get Template Files | diff --git a/sdks/php/docs/Api/SignatureRequestApi.md b/sdks/php/docs/Api/SignatureRequestApi.md index 373d1215c..aa4979035 100644 --- a/sdks/php/docs/Api/SignatureRequestApi.md +++ b/sdks/php/docs/Api/SignatureRequestApi.md @@ -227,7 +227,7 @@ signatureRequestCancel($signature_request_id) ``` Cancel Incomplete Signature Request -Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. +Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. ### Example diff --git a/sdks/php/docs/Api/TemplateApi.md b/sdks/php/docs/Api/TemplateApi.md index 3331db8dd..5381a8290 100644 --- a/sdks/php/docs/Api/TemplateApi.md +++ b/sdks/php/docs/Api/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to https://api.hellosign.com/v3. | Method | HTTP request | Description | | ------------- | ------------- | ------------- | | [**templateAddUser()**](TemplateApi.md#templateAddUser) | **POST** /template/add_user/{template_id} | Add User to Template | -| [**templateCreate()**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template | +| [**templateCreate()**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template | | [**templateCreateEmbeddedDraft()**](TemplateApi.md#templateCreateEmbeddedDraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | | [**templateDelete()**](TemplateApi.md#templateDelete) | **POST** /template/delete/{template_id} | Delete Template | | [**templateFiles()**](TemplateApi.md#templateFiles) | **GET** /template/files/{template_id} | Get Template Files | @@ -88,7 +88,7 @@ try { ```php templateCreate($template_create_request): \Dropbox\Sign\Model\TemplateCreateResponse ``` -Create Template +Create Template Creates a template that can then be used. diff --git a/sdks/php/docs/Model/AccountResponseQuotas.md b/sdks/php/docs/Model/AccountResponseQuotas.md index 9490fa320..cd9d40a48 100644 --- a/sdks/php/docs/Model/AccountResponseQuotas.md +++ b/sdks/php/docs/Model/AccountResponseQuotas.md @@ -6,11 +6,11 @@ Details concerning remaining monthly quotas. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | -| `documents_left` | ```int``` | Signature requests remaining. | | -| `templates_total` | ```int``` | Total API templates allowed. | | -| `templates_left` | ```int``` | API templates remaining. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | -| `num_fax_pages_left` | ```int``` | Number of fax pages left | | +| `api_signature_requests_left` | ```int``` | API signature requests remaining. | [default to 0] | +| `documents_left` | ```int``` | Signature requests remaining. | [default to 0] | +| `templates_total` | ```int``` | Total API templates allowed. | [default to 0] | +| `templates_left` | ```int``` | API templates remaining. | [default to 0] | +| `sms_verifications_left` | ```int``` | SMS verifications remaining. | [default to 0] | +| `num_fax_pages_left` | ```int``` | Number of fax pages left | [default to 0] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountResponseUsage.md b/sdks/php/docs/Model/AccountResponseUsage.md index 3d8c992c2..c87b1422d 100644 --- a/sdks/php/docs/Model/AccountResponseUsage.md +++ b/sdks/php/docs/Model/AccountResponseUsage.md @@ -6,6 +6,6 @@ Details concerning monthly usage Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fax_pages_sent` | ```int``` | Number of fax pages sent | | +| `fax_pages_sent` | ```int``` | Number of fax pages sent | [default to 0] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/src/Api/TemplateApi.php b/sdks/php/src/Api/TemplateApi.php index 6b356fc7b..091dc84d6 100644 --- a/sdks/php/src/Api/TemplateApi.php +++ b/sdks/php/src/Api/TemplateApi.php @@ -525,7 +525,7 @@ public function templateAddUserRequest(string $template_id, Model\TemplateAddUse /** * Operation templateCreate * - * Create Template + * Create Template * * @param Model\TemplateCreateRequest $template_create_request template_create_request (required) * @@ -542,7 +542,7 @@ public function templateCreate(Model\TemplateCreateRequest $template_create_requ /** * Operation templateCreateWithHttpInfo * - * Create Template + * Create Template * * @param Model\TemplateCreateRequest $template_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation @@ -679,7 +679,7 @@ public function templateCreateWithHttpInfo(Model\TemplateCreateRequest $template /** * Operation templateCreateAsync * - * Create Template + * Create Template * * @param Model\TemplateCreateRequest $template_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation @@ -701,7 +701,7 @@ function ($response) { /** * Operation templateCreateAsyncWithHttpInfo * - * Create Template + * Create Template * * @param Model\TemplateCreateRequest $template_create_request (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateCreate'] to see the possible values for this operation diff --git a/sdks/php/src/Model/AccountResponseQuotas.php b/sdks/php/src/Model/AccountResponseQuotas.php index 3ec8d7a9e..98fb55ed0 100644 --- a/sdks/php/src/Model/AccountResponseQuotas.php +++ b/sdks/php/src/Model/AccountResponseQuotas.php @@ -265,12 +265,12 @@ public function getModelName() */ public function __construct(array $data = null) { - $this->setIfExists('api_signature_requests_left', $data ?? [], null); - $this->setIfExists('documents_left', $data ?? [], null); - $this->setIfExists('templates_total', $data ?? [], null); - $this->setIfExists('templates_left', $data ?? [], null); - $this->setIfExists('sms_verifications_left', $data ?? [], null); - $this->setIfExists('num_fax_pages_left', $data ?? [], null); + $this->setIfExists('api_signature_requests_left', $data ?? [], 0); + $this->setIfExists('documents_left', $data ?? [], 0); + $this->setIfExists('templates_total', $data ?? [], 0); + $this->setIfExists('templates_left', $data ?? [], 0); + $this->setIfExists('sms_verifications_left', $data ?? [], 0); + $this->setIfExists('num_fax_pages_left', $data ?? [], 0); } /** @@ -479,7 +479,7 @@ public function getSmsVerificationsLeft() /** * Sets sms_verifications_left * - * @param int|null $sms_verifications_left SMS verifications remaining + * @param int|null $sms_verifications_left SMS verifications remaining * * @return self */ diff --git a/sdks/php/src/Model/AccountResponseUsage.php b/sdks/php/src/Model/AccountResponseUsage.php index 94eb509e7..6728300ac 100644 --- a/sdks/php/src/Model/AccountResponseUsage.php +++ b/sdks/php/src/Model/AccountResponseUsage.php @@ -29,6 +29,7 @@ use ArrayAccess; use Dropbox\Sign\ObjectSerializer; +use InvalidArgumentException; use JsonSerializable; use ReturnTypeWillChange; @@ -77,7 +78,7 @@ class AccountResponseUsage implements ModelInterface, ArrayAccess, JsonSerializa * @var bool[] */ protected static array $openAPINullables = [ - 'fax_pages_sent' => true, + 'fax_pages_sent' => false, ]; /** @@ -235,7 +236,7 @@ public function getModelName() */ public function __construct(array $data = null) { - $this->setIfExists('fax_pages_sent', $data ?? [], null); + $this->setIfExists('fax_pages_sent', $data ?? [], 0); } /** @@ -315,14 +316,7 @@ public function getFaxPagesSent() public function setFaxPagesSent(?int $fax_pages_sent) { if (is_null($fax_pages_sent)) { - array_push($this->openAPINullablesSetToNull, 'fax_pages_sent'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('fax_pages_sent', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + throw new InvalidArgumentException('non-nullable fax_pages_sent cannot be null'); } $this->container['fax_pages_sent'] = $fax_pages_sent; diff --git a/sdks/python/README.md b/sdks/python/README.md index 15be18ce8..2ace00b7b 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -152,7 +152,7 @@ Class | Method | HTTP request | Description ```TeamApi``` | [```team_sub_teams```](docs/TeamApi.md#team_sub_teams) | ```GET /team/sub_teams/{team_id}``` | List Sub Teams| ```TeamApi``` | [```team_update```](docs/TeamApi.md#team_update) | ```PUT /team``` | Update Team| |```TemplateApi``` | [```template_add_user```](docs/TemplateApi.md#template_add_user) | ```POST /template/add_user/{template_id}``` | Add User to Template| -```TemplateApi``` | [```template_create```](docs/TemplateApi.md#template_create) | ```POST /template/create``` | Create Template| +```TemplateApi``` | [```template_create```](docs/TemplateApi.md#template_create) | ```POST /template/create``` | Create Template| ```TemplateApi``` | [```template_create_embedded_draft```](docs/TemplateApi.md#template_create_embedded_draft) | ```POST /template/create_embedded_draft``` | Create Embedded Template Draft| ```TemplateApi``` | [```template_delete```](docs/TemplateApi.md#template_delete) | ```POST /template/delete/{template_id}``` | Delete Template| ```TemplateApi``` | [```template_files```](docs/TemplateApi.md#template_files) | ```GET /template/files/{template_id}``` | Get Template Files| diff --git a/sdks/python/docs/AccountResponseQuotas.md b/sdks/python/docs/AccountResponseQuotas.md index 740ad2357..ab1b36dc0 100644 --- a/sdks/python/docs/AccountResponseQuotas.md +++ b/sdks/python/docs/AccountResponseQuotas.md @@ -5,12 +5,12 @@ Details concerning remaining monthly quotas. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | -| `documents_left` | ```int``` | Signature requests remaining. | | -| `templates_total` | ```int``` | Total API templates allowed. | | -| `templates_left` | ```int``` | API templates remaining. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | -| `num_fax_pages_left` | ```int``` | Number of fax pages left | | +| `api_signature_requests_left` | ```int``` | API signature requests remaining. | [default to 0] | +| `documents_left` | ```int``` | Signature requests remaining. | [default to 0] | +| `templates_total` | ```int``` | Total API templates allowed. | [default to 0] | +| `templates_left` | ```int``` | API templates remaining. | [default to 0] | +| `sms_verifications_left` | ```int``` | SMS verifications remaining. | [default to 0] | +| `num_fax_pages_left` | ```int``` | Number of fax pages left | [default to 0] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/AccountResponseUsage.md b/sdks/python/docs/AccountResponseUsage.md index dd99429af..a8ca8e606 100644 --- a/sdks/python/docs/AccountResponseUsage.md +++ b/sdks/python/docs/AccountResponseUsage.md @@ -5,7 +5,7 @@ Details concerning monthly usage ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fax_pages_sent` | ```int``` | Number of fax pages sent | | +| `fax_pages_sent` | ```int``` | Number of fax pages sent | [default to 0] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestApi.md b/sdks/python/docs/SignatureRequestApi.md index a4554ef44..2db45f1a5 100644 --- a/sdks/python/docs/SignatureRequestApi.md +++ b/sdks/python/docs/SignatureRequestApi.md @@ -253,7 +253,7 @@ with ApiClient(configuration) as api_client: Cancel Incomplete Signature Request -Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. +Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. ### Example diff --git a/sdks/python/docs/TemplateApi.md b/sdks/python/docs/TemplateApi.md index 9adb98a8a..153be9c2e 100644 --- a/sdks/python/docs/TemplateApi.md +++ b/sdks/python/docs/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- |[```template_add_user```](TemplateApi.md#template_add_user) | ```POST /template/add_user/{template_id}``` | Add User to Template| -|[```template_create```](TemplateApi.md#template_create) | ```POST /template/create``` | Create Template| +|[```template_create```](TemplateApi.md#template_create) | ```POST /template/create``` | Create Template| |[```template_create_embedded_draft```](TemplateApi.md#template_create_embedded_draft) | ```POST /template/create_embedded_draft``` | Create Embedded Template Draft| |[```template_delete```](TemplateApi.md#template_delete) | ```POST /template/delete/{template_id}``` | Delete Template| |[```template_files```](TemplateApi.md#template_files) | ```GET /template/files/{template_id}``` | Get Template Files| @@ -90,7 +90,7 @@ with ApiClient(configuration) as api_client: # ```template_create``` > ```TemplateCreateResponse template_create(template_create_request)``` -Create Template +Create Template Creates a template that can then be used. diff --git a/sdks/python/dropbox_sign/api/signature_request_api.py b/sdks/python/dropbox_sign/api/signature_request_api.py index 4298079c1..f78d1a219 100644 --- a/sdks/python/dropbox_sign/api/signature_request_api.py +++ b/sdks/python/dropbox_sign/api/signature_request_api.py @@ -649,7 +649,7 @@ def signature_request_cancel( ) -> None: """Cancel Incomplete Signature Request - Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. :param signature_request_id: The id of the incomplete SignatureRequest to cancel. (required) :type signature_request_id: str @@ -717,7 +717,7 @@ def signature_request_cancel_with_http_info( ) -> ApiResponse[None]: """Cancel Incomplete Signature Request - Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. :param signature_request_id: The id of the incomplete SignatureRequest to cancel. (required) :type signature_request_id: str @@ -785,7 +785,7 @@ def signature_request_cancel_without_preload_content( ) -> RESTResponseType: """Cancel Incomplete Signature Request - Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. :param signature_request_id: The id of the incomplete SignatureRequest to cancel. (required) :type signature_request_id: str diff --git a/sdks/python/dropbox_sign/api/template_api.py b/sdks/python/dropbox_sign/api/template_api.py index 9f87978ee..87be9f0fd 100644 --- a/sdks/python/dropbox_sign/api/template_api.py +++ b/sdks/python/dropbox_sign/api/template_api.py @@ -372,7 +372,7 @@ def template_create( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> TemplateCreateResponse: - """Create Template + """Create Template Creates a template that can then be used. @@ -437,7 +437,7 @@ def template_create_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[TemplateCreateResponse]: - """Create Template + """Create Template Creates a template that can then be used. @@ -502,7 +502,7 @@ def template_create_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Create Template + """Create Template Creates a template that can then be used. diff --git a/sdks/python/dropbox_sign/models/account_response_quotas.py b/sdks/python/dropbox_sign/models/account_response_quotas.py index 1b90d4162..c39cc3889 100644 --- a/sdks/python/dropbox_sign/models/account_response_quotas.py +++ b/sdks/python/dropbox_sign/models/account_response_quotas.py @@ -33,22 +33,22 @@ class AccountResponseQuotas(BaseModel): """ # noqa: E501 api_signature_requests_left: Optional[StrictInt] = Field( - default=None, description="API signature requests remaining." + default=0, description="API signature requests remaining." ) documents_left: Optional[StrictInt] = Field( - default=None, description="Signature requests remaining." + default=0, description="Signature requests remaining." ) templates_total: Optional[StrictInt] = Field( - default=None, description="Total API templates allowed." + default=0, description="Total API templates allowed." ) templates_left: Optional[StrictInt] = Field( - default=None, description="API templates remaining." + default=0, description="API templates remaining." ) sms_verifications_left: Optional[StrictInt] = Field( - default=None, description="SMS verifications remaining." + default=0, description="SMS verifications remaining." ) num_fax_pages_left: Optional[StrictInt] = Field( - default=None, description="Number of fax pages left" + default=0, description="Number of fax pages left" ) __properties: ClassVar[List[str]] = [ "api_signature_requests_left", @@ -122,12 +122,36 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "api_signature_requests_left": obj.get("api_signature_requests_left"), - "documents_left": obj.get("documents_left"), - "templates_total": obj.get("templates_total"), - "templates_left": obj.get("templates_left"), - "sms_verifications_left": obj.get("sms_verifications_left"), - "num_fax_pages_left": obj.get("num_fax_pages_left"), + "api_signature_requests_left": ( + obj.get("api_signature_requests_left") + if obj.get("api_signature_requests_left") is not None + else 0 + ), + "documents_left": ( + obj.get("documents_left") + if obj.get("documents_left") is not None + else 0 + ), + "templates_total": ( + obj.get("templates_total") + if obj.get("templates_total") is not None + else 0 + ), + "templates_left": ( + obj.get("templates_left") + if obj.get("templates_left") is not None + else 0 + ), + "sms_verifications_left": ( + obj.get("sms_verifications_left") + if obj.get("sms_verifications_left") is not None + else 0 + ), + "num_fax_pages_left": ( + obj.get("num_fax_pages_left") + if obj.get("num_fax_pages_left") is not None + else 0 + ), } ) return _obj diff --git a/sdks/python/dropbox_sign/models/account_response_usage.py b/sdks/python/dropbox_sign/models/account_response_usage.py index 8efc7a64b..84e6f9841 100644 --- a/sdks/python/dropbox_sign/models/account_response_usage.py +++ b/sdks/python/dropbox_sign/models/account_response_usage.py @@ -33,7 +33,7 @@ class AccountResponseUsage(BaseModel): """ # noqa: E501 fax_pages_sent: Optional[StrictInt] = Field( - default=None, description="Number of fax pages sent" + default=0, description="Number of fax pages sent" ) __properties: ClassVar[List[str]] = ["fax_pages_sent"] @@ -98,7 +98,15 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if not isinstance(obj, dict): return cls.model_validate(obj) - _obj = cls.model_validate({"fax_pages_sent": obj.get("fax_pages_sent")}) + _obj = cls.model_validate( + { + "fax_pages_sent": ( + obj.get("fax_pages_sent") + if obj.get("fax_pages_sent") is not None + else 0 + ) + } + ) return _obj @classmethod diff --git a/sdks/ruby/README.md b/sdks/ruby/README.md index 1dd16ae20..e8291bf2f 100644 --- a/sdks/ruby/README.md +++ b/sdks/ruby/README.md @@ -158,7 +158,7 @@ All URIs are relative to *https://api.hellosign.com/v3* |*Dropbox::Sign::TeamApi* | [**team_sub_teams**](docs/TeamApi.md#team_sub_teams) | **GET** /team/sub_teams/{team_id} | List Sub Teams | |*Dropbox::Sign::TeamApi* | [**team_update**](docs/TeamApi.md#team_update) | **PUT** /team | Update Team | |*Dropbox::Sign::TemplateApi* | [**template_add_user**](docs/TemplateApi.md#template_add_user) | **POST** /template/add_user/{template_id} | Add User to Template | -|*Dropbox::Sign::TemplateApi* | [**template_create**](docs/TemplateApi.md#template_create) | **POST** /template/create | Create Template | +|*Dropbox::Sign::TemplateApi* | [**template_create**](docs/TemplateApi.md#template_create) | **POST** /template/create | Create Template | |*Dropbox::Sign::TemplateApi* | [**template_create_embedded_draft**](docs/TemplateApi.md#template_create_embedded_draft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft | |*Dropbox::Sign::TemplateApi* | [**template_delete**](docs/TemplateApi.md#template_delete) | **POST** /template/delete/{template_id} | Delete Template | |*Dropbox::Sign::TemplateApi* | [**template_files**](docs/TemplateApi.md#template_files) | **GET** /template/files/{template_id} | Get Template Files | diff --git a/sdks/ruby/docs/AccountResponseQuotas.md b/sdks/ruby/docs/AccountResponseQuotas.md index 2a6b0c98a..d50615615 100644 --- a/sdks/ruby/docs/AccountResponseQuotas.md +++ b/sdks/ruby/docs/AccountResponseQuotas.md @@ -6,10 +6,10 @@ Details concerning remaining monthly quotas. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `api_signature_requests_left` | ```Integer``` | API signature requests remaining. | | -| `documents_left` | ```Integer``` | Signature requests remaining. | | -| `templates_total` | ```Integer``` | Total API templates allowed. | | -| `templates_left` | ```Integer``` | API templates remaining. | | -| `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | | -| `num_fax_pages_left` | ```Integer``` | Number of fax pages left | | +| `api_signature_requests_left` | ```Integer``` | API signature requests remaining. | [default to 0] | +| `documents_left` | ```Integer``` | Signature requests remaining. | [default to 0] | +| `templates_total` | ```Integer``` | Total API templates allowed. | [default to 0] | +| `templates_left` | ```Integer``` | API templates remaining. | [default to 0] | +| `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | [default to 0] | +| `num_fax_pages_left` | ```Integer``` | Number of fax pages left | [default to 0] | diff --git a/sdks/ruby/docs/AccountResponseUsage.md b/sdks/ruby/docs/AccountResponseUsage.md index 6dc2ddc21..85145219a 100644 --- a/sdks/ruby/docs/AccountResponseUsage.md +++ b/sdks/ruby/docs/AccountResponseUsage.md @@ -6,5 +6,5 @@ Details concerning monthly usage | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `fax_pages_sent` | ```Integer``` | Number of fax pages sent | | +| `fax_pages_sent` | ```Integer``` | Number of fax pages sent | [default to 0] | diff --git a/sdks/ruby/docs/SignatureRequestApi.md b/sdks/ruby/docs/SignatureRequestApi.md index 7bc3482fa..0261ffa5c 100644 --- a/sdks/ruby/docs/SignatureRequestApi.md +++ b/sdks/ruby/docs/SignatureRequestApi.md @@ -249,7 +249,7 @@ end Cancel Incomplete Signature Request -Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. +Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. ### Examples diff --git a/sdks/ruby/docs/TemplateApi.md b/sdks/ruby/docs/TemplateApi.md index 3e9361b14..bcd27fae0 100644 --- a/sdks/ruby/docs/TemplateApi.md +++ b/sdks/ruby/docs/TemplateApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [`template_add_user`](TemplateApi.md#template_add_user) | **POST** `/template/add_user/{template_id}` | Add User to Template | -| [`template_create`](TemplateApi.md#template_create) | **POST** `/template/create` | Create Template | +| [`template_create`](TemplateApi.md#template_create) | **POST** `/template/create` | Create Template | | [`template_create_embedded_draft`](TemplateApi.md#template_create_embedded_draft) | **POST** `/template/create_embedded_draft` | Create Embedded Template Draft | | [`template_delete`](TemplateApi.md#template_delete) | **POST** `/template/delete/{template_id}` | Delete Template | | [`template_files`](TemplateApi.md#template_files) | **GET** `/template/files/{template_id}` | Get Template Files | @@ -97,7 +97,7 @@ end > ` template_create(template_create_request)` -Create Template +Create Template Creates a template that can then be used. @@ -164,7 +164,7 @@ This returns an Array which contains the response data, status code and headers. ```ruby begin - # Create Template + # Create Template data, status_code, headers = api_instance.template_create_with_http_info(template_create_request) p status_code # => 2xx p headers # => { ... } diff --git a/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb b/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb index 438940953..d61d27b46 100644 --- a/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb @@ -241,7 +241,7 @@ def signature_request_bulk_send_with_template_with_http_info(signature_request_b end # Cancel Incomplete Signature Request - # Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + # Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. # @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel. # @param [Hash] opts the optional parameters # @return [nil] @@ -251,7 +251,7 @@ def signature_request_cancel(signature_request_id, opts = {}) end # Cancel Incomplete Signature Request - # Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + # Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. # @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel. # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/api/template_api.rb b/sdks/ruby/lib/dropbox-sign/api/template_api.rb index 445ee2b47..7b6e4ac16 100644 --- a/sdks/ruby/lib/dropbox-sign/api/template_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/template_api.rb @@ -137,7 +137,7 @@ def template_add_user_with_http_info(template_id, template_add_user_request, opt return data, status_code, headers end - # Create Template + # Create Template # Creates a template that can then be used. # @param template_create_request [TemplateCreateRequest] # @param [Hash] opts the optional parameters @@ -147,7 +147,7 @@ def template_create(template_create_request, opts = {}) data end - # Create Template + # Create Template # Creates a template that can then be used. # @param template_create_request [TemplateCreateRequest] # @param [Hash] opts the optional parameters diff --git a/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb b/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb index 03ac4898f..d202a1c1b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb @@ -35,7 +35,7 @@ class AccountResponseQuotas # @return [Integer, nil] attr_accessor :templates_left - # SMS verifications remaining. + # SMS verifications remaining. # @return [Integer, nil] attr_accessor :sms_verifications_left @@ -126,26 +126,38 @@ def initialize(attributes = {}) if attributes.key?(:'api_signature_requests_left') self.api_signature_requests_left = attributes[:'api_signature_requests_left'] + else + self.api_signature_requests_left = 0 end if attributes.key?(:'documents_left') self.documents_left = attributes[:'documents_left'] + else + self.documents_left = 0 end if attributes.key?(:'templates_total') self.templates_total = attributes[:'templates_total'] + else + self.templates_total = 0 end if attributes.key?(:'templates_left') self.templates_left = attributes[:'templates_left'] + else + self.templates_left = 0 end if attributes.key?(:'sms_verifications_left') self.sms_verifications_left = attributes[:'sms_verifications_left'] + else + self.sms_verifications_left = 0 end if attributes.key?(:'num_fax_pages_left') self.num_fax_pages_left = attributes[:'num_fax_pages_left'] + else + self.num_fax_pages_left = 0 end end diff --git a/sdks/ruby/lib/dropbox-sign/models/account_response_usage.rb b/sdks/ruby/lib/dropbox-sign/models/account_response_usage.rb index 3eb518794..fe57fc441 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response_usage.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response_usage.rb @@ -20,7 +20,7 @@ module Dropbox::Sign # Details concerning monthly usage class AccountResponseUsage # Number of fax pages sent - # @return [Integer, nil] + # @return [Integer] attr_accessor :fax_pages_sent # Attribute mapping from ruby-style variable name to JSON key. @@ -45,7 +45,6 @@ def self.openapi_types # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'fax_pages_sent' ]) end @@ -91,6 +90,8 @@ def initialize(attributes = {}) if attributes.key?(:'fax_pages_sent') self.fax_pages_sent = attributes[:'fax_pages_sent'] + else + self.fax_pages_sent = 0 end end diff --git a/translations/en.yaml b/translations/en.yaml index a2b4a367c..53aa2306d 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -275,7 +275,7 @@ The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. - This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. + This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. @@ -644,7 +644,7 @@ "TemplateCreateEmbeddedDraft::USE_PREEXISTING_FIELDS": Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). -"TemplateCreate::SUMMARY": Create Template +"TemplateCreate::SUMMARY": Create Template "TemplateCreate::DESCRIPTION": Creates a template that can then be used. "TemplateCreate::ALLOW_CCS": This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. @@ -768,7 +768,7 @@ "UnclaimedDraftCreate::TYPE": The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional. "UnclaimedDraftCreate::USE_PREEXISTING_FIELDS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. "UnclaimedDraftCreate::USE_TEXT_TAGS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. -"UnclaimedDraftCreate::EXPIRES_AT": |- +"UnclaimedDraftCreate::EXPIRES_AT": |- When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response. @@ -818,7 +818,7 @@ Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. -"UnclaimedDraftCreateEmbedded::EXPIRES_AT": |- +"UnclaimedDraftCreateEmbedded::EXPIRES_AT": |- When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response. @@ -1201,7 +1201,7 @@ "AccountQuota::TEMPLATES_TOTAL": Total API templates allowed. "AccountQuota::API_SIGNATURE_REQUESTS_LEFT": API signature requests remaining. "AccountQuota::DOCUMENTS_LEFT": Signature requests remaining. -"AccountQuota::SMS_VERIFICATIONS_LEFT": SMS verifications remaining. +"AccountQuota::SMS_VERIFICATIONS_LEFT": SMS verifications remaining. "AccountQuota::NUM_FAX_PAGES_LEFT": Number of fax pages left "AccountUsage::FAX_PAGES_SENT": Number of fax pages sent @@ -1258,7 +1258,7 @@ "EmbeddedEditUrlResponseEmbedded::DESCRIPTION": An embedded template object. "EmbeddedEditUrlResponseEmbedded::EDIT_URL": A template url that can be opened in an iFrame. -"EmbeddedEditUrlResponseEmbedded::EXPIRES_AT": The specific time that the the `edit_url` link expires, in epoch. +"EmbeddedEditUrlResponseEmbedded::EXPIRES_AT": The specific time that the the `edit_url` link expires, in epoch. "EventCallbackAccountRequest::DESCRIPTION": |- **Account Callback Payloads --** From ec1f88e35fc986eaa501f2a18229d0c2701f1cec Mon Sep 17 00:00:00 2001 From: Maksud Aghayev Date: Thu, 24 Oct 2024 15:07:33 -0700 Subject: [PATCH 12/16] Fax API SDK + OpenAPI (#430) --- examples/FaxDelete.cs | 28 + examples/FaxDelete.java | 25 + examples/FaxDelete.js | 13 + examples/FaxDelete.php | 18 + examples/FaxDelete.py | 16 + examples/FaxDelete.rb | 14 + examples/FaxDelete.sh | 2 + examples/FaxDelete.ts | 13 + examples/FaxFiles.cs | 34 + examples/FaxFiles.java | 28 + examples/FaxFiles.js | 17 + examples/FaxFiles.php | 21 + examples/FaxFiles.py | 19 + examples/FaxFiles.rb | 17 + examples/FaxFiles.sh | 3 + examples/FaxFiles.ts | 17 + examples/FaxGet.cs | 31 + examples/FaxGet.java | 27 + examples/FaxGet.js | 16 + examples/FaxGet.php | 21 + examples/FaxGet.py | 19 + examples/FaxGet.rb | 17 + examples/FaxGet.sh | 2 + examples/FaxGet.ts | 16 + examples/FaxList.cs | 32 + examples/FaxList.java | 28 + examples/FaxList.js | 17 + examples/FaxList.php | 22 + examples/FaxList.py | 23 + examples/FaxList.rb | 18 + examples/FaxList.sh | 2 + examples/FaxList.ts | 17 + examples/FaxSend.cs | 49 + examples/FaxSend.java | 37 + examples/FaxSend.js | 47 + examples/FaxSend.php | 29 + examples/FaxSend.py | 28 + examples/FaxSend.rb | 25 + examples/FaxSend.sh | 10 + examples/FaxSend.ts | 47 + examples/json/FaxGetResponseExample.json | 21 + examples/json/FaxListResponseExample.json | 29 + examples/json/FaxSendRequestExample.json | 12 + openapi-raw.yaml | 671 ++++++ openapi-sdk.yaml | 671 ++++++ openapi.yaml | 671 ++++++ sdks/dotnet/README.md | 10 + sdks/dotnet/docs/FaxApi.md | 489 +++++ sdks/dotnet/docs/FaxGetResponse.md | 10 + sdks/dotnet/docs/FaxListResponse.md | 10 + sdks/dotnet/docs/FaxResponse.md | 10 + sdks/dotnet/docs/FaxResponseTransmission.md | 10 + sdks/dotnet/docs/FaxSendRequest.md | 10 + sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs | 1206 +++++++++++ .../src/Dropbox.Sign/Model/FaxGetResponse.cs | 197 ++ .../src/Dropbox.Sign/Model/FaxListResponse.cs | 201 ++ .../src/Dropbox.Sign/Model/FaxResponse.cs | 443 ++++ .../src/Dropbox.Sign/Model/FaxResponseFax.cs | 397 ++++ .../Model/FaxResponseFaxTransmission.cs | 240 +++ .../Model/FaxResponseTransmission.cs | 302 +++ .../src/Dropbox.Sign/Model/FaxSendRequest.cs | 383 ++++ sdks/dotnet/src/Dropbox.Sign/Model/SubFile.cs | 167 ++ sdks/java-v1/README.md | 10 + sdks/java-v1/docs/FaxApi.md | 364 ++++ sdks/java-v1/docs/FaxGetResponse.md | 15 + sdks/java-v1/docs/FaxListResponse.md | 15 + sdks/java-v1/docs/FaxResponse.md | 23 + sdks/java-v1/docs/FaxResponseTransmission.md | 32 + sdks/java-v1/docs/FaxSendRequest.md | 22 + .../java/com/dropbox/sign/api/FaxApi.java | 421 ++++ .../dropbox/sign/model/FaxGetResponse.java | 221 ++ .../dropbox/sign/model/FaxListResponse.java | 224 ++ .../com/dropbox/sign/model/FaxResponse.java | 627 ++++++ .../sign/model/FaxResponseTransmission.java | 360 ++++ .../dropbox/sign/model/FaxSendRequest.java | 576 ++++++ sdks/java-v2/README.md | 10 + sdks/java-v2/docs/FaxApi.md | 364 ++++ sdks/java-v2/docs/FaxGetResponse.md | 15 + sdks/java-v2/docs/FaxListResponse.md | 15 + sdks/java-v2/docs/FaxResponse.md | 23 + sdks/java-v2/docs/FaxResponseTransmission.md | 32 + sdks/java-v2/docs/FaxSendRequest.md | 22 + .../java/com/dropbox/sign/api/FaxApi.java | 416 ++++ .../dropbox/sign/model/FaxGetResponse.java | 240 +++ .../dropbox/sign/model/FaxListResponse.java | 240 +++ .../com/dropbox/sign/model/FaxResponse.java | 649 ++++++ .../sign/model/FaxResponseTransmission.java | 375 ++++ .../dropbox/sign/model/FaxSendRequest.java | 597 ++++++ sdks/node/README.md | 10 + sdks/node/api/faxApi.ts | 779 +++++++ sdks/node/api/index.ts | 3 + sdks/node/dist/api.js | 1420 ++++++++++--- sdks/node/docs/api/FaxApi.md | 458 +++++ sdks/node/docs/model/FaxGetResponse.md | 12 + sdks/node/docs/model/FaxListResponse.md | 12 + sdks/node/docs/model/FaxResponse.md | 20 + .../docs/model/FaxResponseTransmission.md | 14 + sdks/node/docs/model/FaxSendRequest.md | 19 + sdks/node/model/faxGetResponse.ts | 59 + sdks/node/model/faxListResponse.ts | 56 + sdks/node/model/faxResponse.ts | 133 ++ sdks/node/model/faxResponseTransmission.ts | 91 + sdks/node/model/faxSendRequest.ts | 123 ++ sdks/node/model/index.ts | 17 + sdks/node/types/api/faxApi.d.ts | 32 + sdks/node/types/api/index.d.ts | 5 +- sdks/node/types/model/faxGetResponse.d.ts | 11 + sdks/node/types/model/faxListResponse.d.ts | 11 + sdks/node/types/model/faxResponse.d.ts | 20 + .../types/model/faxResponseTransmission.d.ts | 23 + sdks/node/types/model/faxSendRequest.d.ts | 16 + sdks/node/types/model/index.d.ts | 7 +- sdks/php/README.md | 10 + sdks/php/docs/Api/FaxApi.md | 314 +++ sdks/php/docs/Model/FaxGetResponse.md | 12 + sdks/php/docs/Model/FaxListResponse.md | 12 + sdks/php/docs/Model/FaxResponse.md | 20 + .../php/docs/Model/FaxResponseTransmission.md | 14 + sdks/php/docs/Model/FaxSendRequest.md | 19 + sdks/php/src/Api/FaxApi.php | 1803 +++++++++++++++++ sdks/php/src/Model/FaxGetResponse.php | 450 ++++ sdks/php/src/Model/FaxListResponse.php | 453 +++++ sdks/php/src/Model/FaxResponse.php | 749 +++++++ .../php/src/Model/FaxResponseTransmission.php | 571 ++++++ sdks/php/src/Model/FaxSendRequest.php | 689 +++++++ sdks/python/README.md | 10 + sdks/python/docs/FaxApi.md | 334 +++ sdks/python/docs/FaxGetResponse.md | 12 + sdks/python/docs/FaxListResponse.md | 12 + sdks/python/docs/FaxResponse.md | 20 + sdks/python/docs/FaxResponseTransmission.md | 14 + sdks/python/docs/FaxSendRequest.md | 19 + sdks/python/dropbox_sign/__init__.py | 5 + sdks/python/dropbox_sign/api/__init__.py | 1 + sdks/python/dropbox_sign/api/fax_api.py | 1327 ++++++++++++ sdks/python/dropbox_sign/apis/__init__.py | 1 + sdks/python/dropbox_sign/models/__init__.py | 5 + .../dropbox_sign/models/fax_get_response.py | 151 ++ .../dropbox_sign/models/fax_list_response.py | 149 ++ .../dropbox_sign/models/fax_response.py | 181 ++ .../dropbox_sign/models/fax_response_fax.py | 187 ++ .../models/fax_response_fax_transmission.py | 146 ++ .../models/fax_response_transmission.py | 160 ++ .../dropbox_sign/models/fax_send_request.py | 177 ++ sdks/python/dropbox_sign/models/sub_file.py | 125 ++ sdks/ruby/README.md | 10 + sdks/ruby/docs/FaxApi.md | 364 ++++ sdks/ruby/docs/FaxGetResponse.md | 11 + sdks/ruby/docs/FaxListResponse.md | 11 + sdks/ruby/docs/FaxResponse.md | 19 + sdks/ruby/docs/FaxResponseTransmission.md | 13 + sdks/ruby/docs/FaxSendRequest.md | 18 + sdks/ruby/lib/dropbox-sign.rb | 6 + sdks/ruby/lib/dropbox-sign/api/fax_api.rb | 495 +++++ .../dropbox-sign/models/fax_get_response.rb | 263 +++ .../dropbox-sign/models/fax_list_response.rb | 267 +++ .../lib/dropbox-sign/models/fax_response.rb | 399 ++++ .../models/fax_response_transmission.rb | 328 +++ .../dropbox-sign/models/fax_send_request.rb | 345 ++++ test_fixtures/FaxGetResponse.json | 23 + test_fixtures/FaxListResponse.json | 31 + test_fixtures/FaxSendRequest.json | 14 + test_fixtures/FaxSendResponse.json | 16 + translations/en.yaml | 49 + 164 files changed, 26795 insertions(+), 323 deletions(-) create mode 100644 examples/FaxDelete.cs create mode 100644 examples/FaxDelete.java create mode 100644 examples/FaxDelete.js create mode 100644 examples/FaxDelete.php create mode 100644 examples/FaxDelete.py create mode 100644 examples/FaxDelete.rb create mode 100644 examples/FaxDelete.sh create mode 100644 examples/FaxDelete.ts create mode 100644 examples/FaxFiles.cs create mode 100644 examples/FaxFiles.java create mode 100644 examples/FaxFiles.js create mode 100644 examples/FaxFiles.php create mode 100644 examples/FaxFiles.py create mode 100644 examples/FaxFiles.rb create mode 100644 examples/FaxFiles.sh create mode 100644 examples/FaxFiles.ts create mode 100644 examples/FaxGet.cs create mode 100644 examples/FaxGet.java create mode 100644 examples/FaxGet.js create mode 100644 examples/FaxGet.php create mode 100644 examples/FaxGet.py create mode 100644 examples/FaxGet.rb create mode 100644 examples/FaxGet.sh create mode 100644 examples/FaxGet.ts create mode 100644 examples/FaxList.cs create mode 100644 examples/FaxList.java create mode 100644 examples/FaxList.js create mode 100644 examples/FaxList.php create mode 100644 examples/FaxList.py create mode 100644 examples/FaxList.rb create mode 100644 examples/FaxList.sh create mode 100644 examples/FaxList.ts create mode 100644 examples/FaxSend.cs create mode 100644 examples/FaxSend.java create mode 100644 examples/FaxSend.js create mode 100644 examples/FaxSend.php create mode 100644 examples/FaxSend.py create mode 100644 examples/FaxSend.rb create mode 100644 examples/FaxSend.sh create mode 100644 examples/FaxSend.ts create mode 100644 examples/json/FaxGetResponseExample.json create mode 100644 examples/json/FaxListResponseExample.json create mode 100644 examples/json/FaxSendRequestExample.json create mode 100644 sdks/dotnet/docs/FaxApi.md create mode 100644 sdks/dotnet/docs/FaxGetResponse.md create mode 100644 sdks/dotnet/docs/FaxListResponse.md create mode 100644 sdks/dotnet/docs/FaxResponse.md create mode 100644 sdks/dotnet/docs/FaxResponseTransmission.md create mode 100644 sdks/dotnet/docs/FaxSendRequest.md create mode 100644 sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs create mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/FaxGetResponse.cs create mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/FaxListResponse.cs create mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/FaxResponse.cs create mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFax.cs create mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFaxTransmission.cs create mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseTransmission.cs create mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs create mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/SubFile.cs create mode 100644 sdks/java-v1/docs/FaxApi.md create mode 100644 sdks/java-v1/docs/FaxGetResponse.md create mode 100644 sdks/java-v1/docs/FaxListResponse.md create mode 100644 sdks/java-v1/docs/FaxResponse.md create mode 100644 sdks/java-v1/docs/FaxResponseTransmission.md create mode 100644 sdks/java-v1/docs/FaxSendRequest.md create mode 100644 sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java create mode 100644 sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxGetResponse.java create mode 100644 sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxListResponse.java create mode 100644 sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxResponse.java create mode 100644 sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxResponseTransmission.java create mode 100644 sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java create mode 100644 sdks/java-v2/docs/FaxApi.md create mode 100644 sdks/java-v2/docs/FaxGetResponse.md create mode 100644 sdks/java-v2/docs/FaxListResponse.md create mode 100644 sdks/java-v2/docs/FaxResponse.md create mode 100644 sdks/java-v2/docs/FaxResponseTransmission.md create mode 100644 sdks/java-v2/docs/FaxSendRequest.md create mode 100644 sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java create mode 100644 sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxGetResponse.java create mode 100644 sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxListResponse.java create mode 100644 sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxResponse.java create mode 100644 sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxResponseTransmission.java create mode 100644 sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java create mode 100644 sdks/node/api/faxApi.ts create mode 100644 sdks/node/docs/api/FaxApi.md create mode 100644 sdks/node/docs/model/FaxGetResponse.md create mode 100644 sdks/node/docs/model/FaxListResponse.md create mode 100644 sdks/node/docs/model/FaxResponse.md create mode 100644 sdks/node/docs/model/FaxResponseTransmission.md create mode 100644 sdks/node/docs/model/FaxSendRequest.md create mode 100644 sdks/node/model/faxGetResponse.ts create mode 100644 sdks/node/model/faxListResponse.ts create mode 100644 sdks/node/model/faxResponse.ts create mode 100644 sdks/node/model/faxResponseTransmission.ts create mode 100644 sdks/node/model/faxSendRequest.ts create mode 100644 sdks/node/types/api/faxApi.d.ts create mode 100644 sdks/node/types/model/faxGetResponse.d.ts create mode 100644 sdks/node/types/model/faxListResponse.d.ts create mode 100644 sdks/node/types/model/faxResponse.d.ts create mode 100644 sdks/node/types/model/faxResponseTransmission.d.ts create mode 100644 sdks/node/types/model/faxSendRequest.d.ts create mode 100644 sdks/php/docs/Api/FaxApi.md create mode 100644 sdks/php/docs/Model/FaxGetResponse.md create mode 100644 sdks/php/docs/Model/FaxListResponse.md create mode 100644 sdks/php/docs/Model/FaxResponse.md create mode 100644 sdks/php/docs/Model/FaxResponseTransmission.md create mode 100644 sdks/php/docs/Model/FaxSendRequest.md create mode 100644 sdks/php/src/Api/FaxApi.php create mode 100644 sdks/php/src/Model/FaxGetResponse.php create mode 100644 sdks/php/src/Model/FaxListResponse.php create mode 100644 sdks/php/src/Model/FaxResponse.php create mode 100644 sdks/php/src/Model/FaxResponseTransmission.php create mode 100644 sdks/php/src/Model/FaxSendRequest.php create mode 100644 sdks/python/docs/FaxApi.md create mode 100644 sdks/python/docs/FaxGetResponse.md create mode 100644 sdks/python/docs/FaxListResponse.md create mode 100644 sdks/python/docs/FaxResponse.md create mode 100644 sdks/python/docs/FaxResponseTransmission.md create mode 100644 sdks/python/docs/FaxSendRequest.md create mode 100644 sdks/python/dropbox_sign/api/fax_api.py create mode 100644 sdks/python/dropbox_sign/models/fax_get_response.py create mode 100644 sdks/python/dropbox_sign/models/fax_list_response.py create mode 100644 sdks/python/dropbox_sign/models/fax_response.py create mode 100644 sdks/python/dropbox_sign/models/fax_response_fax.py create mode 100644 sdks/python/dropbox_sign/models/fax_response_fax_transmission.py create mode 100644 sdks/python/dropbox_sign/models/fax_response_transmission.py create mode 100644 sdks/python/dropbox_sign/models/fax_send_request.py create mode 100644 sdks/python/dropbox_sign/models/sub_file.py create mode 100644 sdks/ruby/docs/FaxApi.md create mode 100644 sdks/ruby/docs/FaxGetResponse.md create mode 100644 sdks/ruby/docs/FaxListResponse.md create mode 100644 sdks/ruby/docs/FaxResponse.md create mode 100644 sdks/ruby/docs/FaxResponseTransmission.md create mode 100644 sdks/ruby/docs/FaxSendRequest.md create mode 100644 sdks/ruby/lib/dropbox-sign/api/fax_api.rb create mode 100644 sdks/ruby/lib/dropbox-sign/models/fax_get_response.rb create mode 100644 sdks/ruby/lib/dropbox-sign/models/fax_list_response.rb create mode 100644 sdks/ruby/lib/dropbox-sign/models/fax_response.rb create mode 100644 sdks/ruby/lib/dropbox-sign/models/fax_response_transmission.rb create mode 100644 sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb create mode 100644 test_fixtures/FaxGetResponse.json create mode 100644 test_fixtures/FaxListResponse.json create mode 100644 test_fixtures/FaxSendRequest.json create mode 100644 test_fixtures/FaxSendResponse.json diff --git a/examples/FaxDelete.cs b/examples/FaxDelete.cs new file mode 100644 index 000000000..88a6ed074 --- /dev/null +++ b/examples/FaxDelete.cs @@ -0,0 +1,28 @@ +using System; +using System.Collections.Generic; +using System.IO; +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +public class Example +{ + public static void Main() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxApi = new FaxApi(config); + + try + { + faxApi.FaxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxDelete.java b/examples/FaxDelete.java new file mode 100644 index 000000000..794b74d94 --- /dev/null +++ b/examples/FaxDelete.java @@ -0,0 +1,25 @@ +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.util.List; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + try { + faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + } catch (ApiException e) { + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxDelete.js b/examples/FaxDelete.js new file mode 100644 index 000000000..38492bd21 --- /dev/null +++ b/examples/FaxDelete.js @@ -0,0 +1,13 @@ +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const result = faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + +result.catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxDelete.php b/examples/FaxDelete.php new file mode 100644 index 000000000..a5c62f5e9 --- /dev/null +++ b/examples/FaxDelete.php @@ -0,0 +1,18 @@ +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +try { + $faxApi->faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} diff --git a/examples/FaxDelete.py b/examples/FaxDelete.py new file mode 100644 index 000000000..adf2a5da8 --- /dev/null +++ b/examples/FaxDelete.py @@ -0,0 +1,16 @@ +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, apis, models + +configuration = Configuration( + # Configure HTTP basic authorization: api_key + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_api = apis.FaxApi(api_client) + + try: + fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967") + except ApiException as e: + print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxDelete.rb b/examples/FaxDelete.rb new file mode 100644 index 000000000..f68be3440 --- /dev/null +++ b/examples/FaxDelete.rb @@ -0,0 +1,14 @@ +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" +end + +fax_api = Dropbox::Sign::FaxApi.new + +begin + fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling Dropbox Sign API: #{e}" +end diff --git a/examples/FaxDelete.sh b/examples/FaxDelete.sh new file mode 100644 index 000000000..3f8bf21e7 --- /dev/null +++ b/examples/FaxDelete.sh @@ -0,0 +1,2 @@ +curl -X DELETE 'https://api.hellosign.com/v3/fax/{fax_id}' \ + -u 'YOUR_API_KEY:' diff --git a/examples/FaxDelete.ts b/examples/FaxDelete.ts new file mode 100644 index 000000000..38492bd21 --- /dev/null +++ b/examples/FaxDelete.ts @@ -0,0 +1,13 @@ +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const result = faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + +result.catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxFiles.cs b/examples/FaxFiles.cs new file mode 100644 index 000000000..fbaf4166e --- /dev/null +++ b/examples/FaxFiles.cs @@ -0,0 +1,34 @@ +using System; +using System.Collections.Generic; +using System.IO; +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +public class Example +{ + public static void Main() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxApi = new FaxApi(config); + + var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + + try + { + var result = faxApi.FaxFiles(faxId); + var fileStream = File.Create("file_response.pdf"); + result.Seek(0, SeekOrigin.Begin); + result.CopyTo(fileStream); + fileStream.Close(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxFiles.java b/examples/FaxFiles.java new file mode 100644 index 000000000..bd6dcc5df --- /dev/null +++ b/examples/FaxFiles.java @@ -0,0 +1,28 @@ +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.io.File; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + + try { + File result = faxApi.faxFiles(faxId); + result.renameTo(new File("file_response.pdf"));; + } catch (ApiException e) { + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxFiles.js b/examples/FaxFiles.js new file mode 100644 index 000000000..d7390cf60 --- /dev/null +++ b/examples/FaxFiles.js @@ -0,0 +1,17 @@ +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +const result = faxApi.faxFiles(faxId); +result.then(response => { + fs.createWriteStream('file_response.pdf').write(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxFiles.php b/examples/FaxFiles.php new file mode 100644 index 000000000..d543eea9c --- /dev/null +++ b/examples/FaxFiles.php @@ -0,0 +1,21 @@ +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +try { + $result = $faxApi->faxFiles($faxId); + copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} diff --git a/examples/FaxFiles.py b/examples/FaxFiles.py new file mode 100644 index 000000000..110a0f7b5 --- /dev/null +++ b/examples/FaxFiles.py @@ -0,0 +1,19 @@ +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, apis, models + +configuration = Configuration( + # Configure HTTP basic authorization: api_key + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_api = apis.FaxApi(api_client) + + fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + + try: + response = fax_api.fax_files(fax_id) + open("file_response.pdf", "wb").write(response.read()) + except ApiException as e: + print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxFiles.rb b/examples/FaxFiles.rb new file mode 100644 index 000000000..d867387ad --- /dev/null +++ b/examples/FaxFiles.rb @@ -0,0 +1,17 @@ +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" +end + +fax_api = Dropbox::Sign::FaxApi.new + +faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +begin + file_bin = fax_api.fax_files(data) + FileUtils.cp(file_bin.path, "path/to/file.pdf") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling Dropbox Sign API: #{e}" +end diff --git a/examples/FaxFiles.sh b/examples/FaxFiles.sh new file mode 100644 index 000000000..02f04e4a1 --- /dev/null +++ b/examples/FaxFiles.sh @@ -0,0 +1,3 @@ +curl -X GET 'https://api.hellosign.com/v3/fax/files/{fax_id}' \ + -u 'YOUR_API_KEY:' \ + --output downloaded_document.pdf \ No newline at end of file diff --git a/examples/FaxFiles.ts b/examples/FaxFiles.ts new file mode 100644 index 000000000..d7390cf60 --- /dev/null +++ b/examples/FaxFiles.ts @@ -0,0 +1,17 @@ +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +const result = faxApi.faxFiles(faxId); +result.then(response => { + fs.createWriteStream('file_response.pdf').write(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxGet.cs b/examples/FaxGet.cs new file mode 100644 index 000000000..6396e0c34 --- /dev/null +++ b/examples/FaxGet.cs @@ -0,0 +1,31 @@ +using System; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +public class Example +{ + public static void Main() + { + var config = new Configuration(); + // Configure HTTP basic authorization: api_key + config.Username = "YOUR_API_KEY"; + + var faxApi = new FaxApi(config); + + var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + + try + { + var result = faxApi.FaxGet(faxId); + Console.WriteLine(result); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxGet.java b/examples/FaxGet.java new file mode 100644 index 000000000..a9cc433df --- /dev/null +++ b/examples/FaxGet.java @@ -0,0 +1,27 @@ +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + + try { + FaxGetResponse result = faxApi.faxGet(faxId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxGet.js b/examples/FaxGet.js new file mode 100644 index 000000000..8a1dbbfda --- /dev/null +++ b/examples/FaxGet.js @@ -0,0 +1,16 @@ +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + +const result = faxApi.faxGet(faxId); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxGet.php b/examples/FaxGet.php new file mode 100644 index 000000000..43b7a1f3e --- /dev/null +++ b/examples/FaxGet.php @@ -0,0 +1,21 @@ +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +try { + $result = $faxApi->faxGet($faxId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} diff --git a/examples/FaxGet.py b/examples/FaxGet.py new file mode 100644 index 000000000..c56656833 --- /dev/null +++ b/examples/FaxGet.py @@ -0,0 +1,19 @@ +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, apis + +configuration = Configuration( + # Configure HTTP basic authorization: api_key + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_api = apis.FaxApi(api_client) + + fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + + try: + response = fax_api.fax_get(fax_id) + pprint(response) + except ApiException as e: + print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxGet.rb b/examples/FaxGet.rb new file mode 100644 index 000000000..64dc1c057 --- /dev/null +++ b/examples/FaxGet.rb @@ -0,0 +1,17 @@ +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" +end + +fax_api = Dropbox::Sign::FaxApi.new + +fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + +begin + result = fax_api.fax_get(fax_id) + p result +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling Dropbox Sign API: #{e}" +end diff --git a/examples/FaxGet.sh b/examples/FaxGet.sh new file mode 100644 index 000000000..03aad0e46 --- /dev/null +++ b/examples/FaxGet.sh @@ -0,0 +1,2 @@ +curl -X GET 'https://api.hellosign.com/v3/fax/{fax_id}' \ + -u 'YOUR_API_KEY:' diff --git a/examples/FaxGet.ts b/examples/FaxGet.ts new file mode 100644 index 000000000..793f6e5d3 --- /dev/null +++ b/examples/FaxGet.ts @@ -0,0 +1,16 @@ +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.ApiAppApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + +const result = faxApi.faxGet(faxId); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxList.cs b/examples/FaxList.cs new file mode 100644 index 000000000..f87d9b8f2 --- /dev/null +++ b/examples/FaxList.cs @@ -0,0 +1,32 @@ +using System; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +public class Example +{ + public static void Main() + { + var config = new Configuration(); + // Configure HTTP basic authorization: api_key + config.Username = "YOUR_API_KEY"; + + var faxApi = new FaxApi(config); + + var page = 1; + var pageSize = 2; + + try + { + var result = faxApi.FaxList(page, pageSize); + Console.WriteLine(result); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxList.java b/examples/FaxList.java new file mode 100644 index 000000000..042bb7107 --- /dev/null +++ b/examples/FaxList.java @@ -0,0 +1,28 @@ +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + var page = 1; + var pageSize = 2; + + try { + FaxListResponse result = faxApi.faxList(page, pageSize); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxList.js b/examples/FaxList.js new file mode 100644 index 000000000..385f44779 --- /dev/null +++ b/examples/FaxList.js @@ -0,0 +1,17 @@ +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const page = 1; +const pageSize = 2; + +const result = faxApi.faxList(page, pageSize); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxList.php b/examples/FaxList.php new file mode 100644 index 000000000..d2a513c21 --- /dev/null +++ b/examples/FaxList.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +$page = 1; +$pageSize = 2; + +try { + $result = $faxApi->faxList($page, $pageSize); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} diff --git a/examples/FaxList.py b/examples/FaxList.py new file mode 100644 index 000000000..6b71f79b6 --- /dev/null +++ b/examples/FaxList.py @@ -0,0 +1,23 @@ +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, apis + +configuration = Configuration( + # Configure HTTP basic authorization: api_key + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_api = apis.FaxApi(api_client) + + page = 1 + page_size = 2 + + try: + response = fax_api.fax_list( + page=page, + page_size=page_size, + ) + pprint(response) + except ApiException as e: + print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxList.rb b/examples/FaxList.rb new file mode 100644 index 000000000..3f37a71ea --- /dev/null +++ b/examples/FaxList.rb @@ -0,0 +1,18 @@ +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" +end + +fax_api = Dropbox::Sign::FaxApi.new + +page = 1 +page_size = 2 + +begin + result = fax_api.fax_list({ page: page, page_size: page_size }) + p result +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling Dropbox Sign API: #{e}" +end diff --git a/examples/FaxList.sh b/examples/FaxList.sh new file mode 100644 index 000000000..9739d65dc --- /dev/null +++ b/examples/FaxList.sh @@ -0,0 +1,2 @@ +curl -X GET 'https://api.hellosign.com/v3/fax/list?page=1&page_size=20' \ + -u 'YOUR_API_KEY:' diff --git a/examples/FaxList.ts b/examples/FaxList.ts new file mode 100644 index 000000000..385f44779 --- /dev/null +++ b/examples/FaxList.ts @@ -0,0 +1,17 @@ +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const page = 1; +const pageSize = 2; + +const result = faxApi.faxList(page, pageSize); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxSend.cs b/examples/FaxSend.cs new file mode 100644 index 000000000..8e72a4f93 --- /dev/null +++ b/examples/FaxSend.cs @@ -0,0 +1,49 @@ +using System; +using System.Collections.Generic; +using System.IO; +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +public class Example +{ + public static void Main() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxApi = new FaxApi(config); + + var files = new List { + new FileStream( + "./example_fax.pdf", + FileMode.Open, + FileAccess.Read, + FileShare.Read + ) + }; + + var data = new FaxSendRequest( + files: files, + testMode: true, + recipient: "16690000001", + sender: "16690000000", + coverPageTo: "Jill Fax", + coverPageMessage: "I'm sending you a fax!", + coverPageFrom: "Faxer Faxerson", + title: "This is what the fax is about!", + ); + + try + { + var result = faxApi.FaxSend(data); + Console.WriteLine(result); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxSend.java b/examples/FaxSend.java new file mode 100644 index 000000000..4e764da83 --- /dev/null +++ b/examples/FaxSend.java @@ -0,0 +1,37 @@ +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.util.List; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + + var data = new FaxSendRequest() + .addFilesItem(new File("example_fax.pdf")) + .testMode(true) + .recipient("16690000001") + .sender("16690000000") + .coverPageTo("Jill Fax") + .coverPageMessage("I'm sending you a fax!") + .coverPageFrom("Faxer Faxerson") + .title("This is what the fax is about!"); + + try { + FaxCreateResponse result = faxApi.faxSend(data); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxSend.js b/examples/FaxSend.js new file mode 100644 index 000000000..4b0eef2da --- /dev/null +++ b/examples/FaxSend.js @@ -0,0 +1,47 @@ +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +// Upload a local file +const file = fs.createReadStream("example_signature_request.pdf"); + +// or, upload from buffer +const fileBuffer = { + value: fs.readFileSync("example_signature_request.pdf"), + options: { + filename: "example_signature_request.pdf", + contentType: "application/pdf", + }, +}; + +// or, upload from buffer alternative +const fileBufferAlt = { + value: Buffer.from("abc-123"), + options: { + filename: "txt-sample.txt", + contentType: "text/plain", + }, +}; + +const data = { + files: [ file, fileBuffer, fileBufferAlt ], + testMode: true, + recipient: "16690000001", + sender: "16690000000", + coverPageTo: "Jill Fax", + coverPageMessage: "I'm sending you a fax!", + coverPageFrom: "Faxer Faxerson", + title: "This is what the fax is about!", +}; + +const result = faxApi.faxSend(data); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/FaxSend.php b/examples/FaxSend.php new file mode 100644 index 000000000..2dd42d386 --- /dev/null +++ b/examples/FaxSend.php @@ -0,0 +1,29 @@ +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +$data = new Dropbox\Sign\Model\FaxSendRequest(); +$data->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) + ->setTestMode(true) + ->setRecipient("16690000001") + ->setSender("16690000000") + ->setCoverPageTo("Jill Fax") + ->setCoverPageMessage("I'm sending you a fax!") + ->setCoverPageFrom("Faxer Faxerson") + ->setTitle("This is what the fax is about!"); + +try { + $result = $faxApi->faxSend($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} diff --git a/examples/FaxSend.py b/examples/FaxSend.py new file mode 100644 index 000000000..c24d6ada7 --- /dev/null +++ b/examples/FaxSend.py @@ -0,0 +1,28 @@ +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, apis, models + +configuration = Configuration( + # Configure HTTP basic authorization: api_key + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_api = apis.FaxApi(api_client) + + data = models.FaxSendRequest( + files=[open("example_signature_request.pdf", "rb")], + test_mode=True, + recipient="16690000001", + sender="16690000000", + cover_page_to="Jill Fax", + cover_page_message="I'm sending you a fax!", + cover_page_from="Faxer Faxerson", + title="This is what the fax is about!", + ) + + try: + response = fax_api.fax_send(data) + pprint(response) + except ApiException as e: + print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxSend.rb b/examples/FaxSend.rb new file mode 100644 index 000000000..c37cbbd10 --- /dev/null +++ b/examples/FaxSend.rb @@ -0,0 +1,25 @@ +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" +end + +fax_api = Dropbox::Sign::FaxApi.new + +data = Dropbox::Sign::FaxSendRequest.new +data.files = [File.new("example_signature_request.pdf", "r")] +data.test_mode = true +data.recipient = "16690000001" +data.sender = "16690000000" +data.cover_page_to = "Jill Fax" +data.cover_page_message = "I'm sending you a fax!" +data.cover_page_from = "Faxer Faxerson" +data.title = "This is what the fax is about!" + +begin + result = fax_api.fax_send(data) + p result +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling Dropbox Sign API: #{e}" +end diff --git a/examples/FaxSend.sh b/examples/FaxSend.sh new file mode 100644 index 000000000..7ab64cb31 --- /dev/null +++ b/examples/FaxSend.sh @@ -0,0 +1,10 @@ +curl -X POST 'https://api.hellosign.com/v3/fax/send' \ + -u 'YOUR_API_KEY:' \ + -F 'files[0]=@mutual-NDA-example.pdf' \ + -F 'test_mode=1' \ + -F 'recipient=16690000001' \ + -F 'sender=16690000000' \ + -F 'cover_page_to=Jill Fax' \ + -F 'cover_page_message=I sent you a fax!' \ + -F 'cover_page_from=Faxer Faxerson' \ + -F 'title=This is what the fax is about!' \ No newline at end of file diff --git a/examples/FaxSend.ts b/examples/FaxSend.ts new file mode 100644 index 000000000..2f3f6e25d --- /dev/null +++ b/examples/FaxSend.ts @@ -0,0 +1,47 @@ +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +// Upload a local file +const file = fs.createReadStream("example_signature_request.pdf"); + +// or, upload from buffer +const fileBuffer: DropboxSign.RequestDetailedFile = { + value: fs.readFileSync("example_signature_request.pdf"), + options: { + filename: "example_signature_request.pdf", + contentType: "application/pdf", + }, +}; + +// or, upload from buffer alternative +const fileBufferAlt: DropboxSign.RequestDetailedFile = { + value: Buffer.from("abc-123"), + options: { + filename: "txt-sample.txt", + contentType: "text/plain", + }, +}; + +const data: DropboxSign.FaxSendRequest = { + files: [ file, fileBuffer, fileBufferAlt ], + testMode: true, + recipient: "16690000001", + sender: "16690000000", + coverPageTo: "Jill Fax", + coverPageMessage: "I'm sending you a fax!", + coverPageFrom: "Faxer Faxerson", + title: "This is what the fax is about!", +}; + +const result = faxApi.faxSend(data); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); diff --git a/examples/json/FaxGetResponseExample.json b/examples/json/FaxGetResponseExample.json new file mode 100644 index 000000000..30475f119 --- /dev/null +++ b/examples/json/FaxGetResponseExample.json @@ -0,0 +1,21 @@ +{ + "fax": { + "fax_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d", + "title": "example title", + "original_title": "example original title", + "subject": "example subject", + "message": "example message", + "metadata": [], + "created_at": 1726774555, + "sender": "me@dropboxsign.com", + "transmissions": [ + { + "recipient": "recipient@dropboxsign.com", + "sender": "me@dropboxsign.com", + "sent_at": 1723231831, + "status_code": "success" + } + ], + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + } +} \ No newline at end of file diff --git a/examples/json/FaxListResponseExample.json b/examples/json/FaxListResponseExample.json new file mode 100644 index 000000000..bf4f66bcc --- /dev/null +++ b/examples/json/FaxListResponseExample.json @@ -0,0 +1,29 @@ +{ + "list_info": { + "num_pages": 1, + "num_results": 1, + "page": 1, + "page_size": 1 + }, + "faxes": [ + { + "fax_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d", + "title": "example title", + "original_title": "example original title", + "subject": "example subject", + "message": "example message", + "metadata": [], + "created_at": 1726774555, + "sender": "me@dropboxsign.com", + "transmissions": [ + { + "recipient": "recipient@dropboxsign.com", + "sender": "me@dropboxsign.com", + "sent_at": 1723231831, + "status_code": "success" + } + ], + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + } + ] +} diff --git a/examples/json/FaxSendRequestExample.json b/examples/json/FaxSendRequestExample.json new file mode 100644 index 000000000..fe7e68820 --- /dev/null +++ b/examples/json/FaxSendRequestExample.json @@ -0,0 +1,12 @@ +{ + "file_url": [ + "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" + ], + "test_mode": "true", + "recipient": "16690000001", + "sender": "16690000000", + "cover_page_to": "Jill Fax", + "cover_page_message": "I'm sending you a fax!", + "cover_page_from": "Faxer Faxerson", + "title": "This is what the fax is about!" +} \ No newline at end of file diff --git a/openapi-raw.yaml b/openapi-raw.yaml index bfec5feeb..55a0a1dfb 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -1403,6 +1403,304 @@ paths: seo: title: '_t__EmbeddedSignUrl::SEO::TITLE' description: '_t__EmbeddedSignUrl::SEO::DESCRIPTION' + '/fax/{fax_id}': + get: + tags: + - Fax + summary: '_t__FaxGet::SUMMARY' + description: '_t__FaxGet::DESCRIPTION' + operationId: faxGet + parameters: + - + name: fax_id + in: path + description: '_t__FaxParam::FAX_ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + '200': + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxGetResponse' + examples: + default_example: + $ref: '#/components/examples/FaxGetResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxGet.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxGet.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxGet.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxGet.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxGet.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxGet.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxGet.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxGet.sh + x-meta: + seo: + title: '_t__FaxGet::SEO::TITLE' + description: '_t__FaxGet::SEO::DESCRIPTION' + delete: + tags: + - Fax + summary: '_t__FaxDelete::SUMMARY' + description: '_t__FaxDelete::DESCRIPTION' + operationId: faxDelete + parameters: + - + name: fax_id + in: path + description: '_t__FaxParam::FAX_ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + '204': + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxDelete.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxDelete.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxDelete.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxDelete.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxDelete.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxDelete.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxDelete.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxDelete.sh + x-meta: + seo: + title: '_t__FaxDelete::SEO::TITLE' + description: '_t__FaxDelete::SEO::DESCRIPTION' + '/fax/files/{fax_id}': + get: + tags: + - Fax + summary: '_t__FaxFiles::SUMMARY' + description: '_t__FaxFiles::DESCRIPTION' + operationId: faxFiles + parameters: + - + name: fax_id + in: path + description: '_t__FaxParam::FAX_ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + '200': + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/pdf: + schema: + type: string + format: binary + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 410_example: + $ref: '#/components/examples/Error410ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxFiles.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxFiles.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxFiles.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxFiles.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxFiles.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxFiles.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxFiles.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxFiles.sh + x-meta: + seo: + title: '_t__FaxFiles::SEO::TITLE' + description: '_t__FaxFiles::SEO::DESCRIPTION' /fax_line/add_user: put: tags: @@ -2200,6 +2498,220 @@ paths: seo: title: '_t__FaxLineRemoveUser::SEO::TITLE' description: '_t__FaxLineRemoveUser::SEO::DESCRIPTION' + /fax/list: + get: + tags: + - Fax + summary: '_t__FaxList::SUMMARY' + description: '_t__FaxList::DESCRIPTION' + operationId: faxList + parameters: + - + name: page + in: query + description: '_t__FaxList::PAGE' + schema: + type: integer + default: 1 + minimum: 1 + example: 1 + - + name: page_size + in: query + description: '_t__FaxList::PAGE_SIZE' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 + example: 20 + responses: + '200': + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxListResponse' + examples: + default_example: + $ref: '#/components/examples/FaxListResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxList.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxList.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxList.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxList.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxList.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxList.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxList.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxList.sh + x-meta: + seo: + title: '_t__FaxList::SEO::TITLE' + description: '_t__FaxList::SEO::DESCRIPTION' + /fax/send: + post: + tags: + - Fax + summary: '_t__FaxSend::SUMMARY' + description: '_t__FaxSend::DESCRIPTION' + operationId: faxSend + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/FaxSendRequest' + examples: + default_example: + $ref: '#/components/examples/FaxSendRequestExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/FaxSendRequest' + responses: + '200': + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxGetResponse' + examples: + default_example: + $ref: '#/components/examples/FaxGetResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxSend.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxSend.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxSend.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxSend.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxSend.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxSend.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxSend.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxSend.sh + x-meta: + seo: + title: '_t__FaxSend::SEO::TITLE' + description: '_t__FaxSend::SEO::DESCRIPTION' /oauth/token: post: tags: @@ -7285,6 +7797,50 @@ components: type: string format: email type: object + FaxSendRequest: + required: + - recipient + properties: + recipient: + description: '_t__FaxSend::RECIPIENT' + type: string + example: recipient@example.com + sender: + description: '_t__FaxSend::SENDER' + type: string + example: sender@example.com + files: + description: '_t__FaxSend::FILE' + type: array + items: + type: string + format: binary + file_urls: + description: '_t__FaxSend::FILE_URL' + type: array + items: + type: string + test_mode: + description: '_t__FaxSend::TEST_MODE' + type: boolean + default: false + cover_page_to: + description: '_t__FaxSend::COVER_PAGE_TO' + type: string + example: 'Recipient Name' + cover_page_from: + description: '_t__FaxSend::COVER_PAGE_FROM' + type: string + example: 'Sender Name' + cover_page_message: + description: '_t__FaxSend::COVER_PAGE_MESSAGE' + type: string + example: 'Please find the attached documents.' + title: + description: '_t__FaxSend::TITLE' + type: string + example: 'Fax Title' + type: object OAuthTokenGenerateRequest: required: - client_id @@ -9643,6 +10199,19 @@ components: error: $ref: '#/components/schemas/ErrorResponseError' type: object + FaxGetResponse: + required: + - fax + properties: + fax: + $ref: '#/components/schemas/FaxResponse' + warnings: + description: '_t__WarningResponse::LIST_DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true FaxLineResponse: required: - fax_line @@ -9678,6 +10247,19 @@ components: $ref: '#/components/schemas/WarningResponse' type: object x-internal-class: true + FaxListResponse: + required: + - faxes + - list_info + properties: + faxes: + type: array + items: + $ref: '#/components/schemas/FaxResponse' + list_info: + $ref: '#/components/schemas/ListInfoResponse' + type: object + x-internal-class: true FileResponse: required: - file_url @@ -10028,6 +10610,54 @@ components: description: '_t__ErrorResponseError::ERROR_NAME' type: string type: object + FaxResponse: + required: + - fax_id + - title + - original_title + - subject + - message + - metadata + - created_at + - sender + - transmissions + - files_url + properties: + fax_id: + description: '_t__FaxResponse::FAX_ID' + type: string + title: + description: '_t__FaxResponse::TITLE' + type: string + original_title: + description: '_t__FaxResponse::ORIGINAL_TITLE' + type: string + subject: + description: '_t__FaxResponse::SUBJECT' + type: string + message: + description: '_t__FaxResponse::MESSAGE' + type: string + metadata: + description: '_t__FaxResponse::METADATA' + type: object + additionalProperties: { } + created_at: + description: '_t__FaxResponse::CREATED_AT' + type: integer + sender: + description: '_t__FaxResponse::SENDER' + type: string + transmissions: + description: '_t__FaxResponse::TRANSMISSIONS' + type: array + items: + $ref: '#/components/schemas/FaxResponseTransmission' + files_url: + description: '_t__FaxResponse::FILES_URL' + type: string + type: object + x-internal-class: true FaxLineResponseFaxLine: properties: number: @@ -10045,6 +10675,35 @@ components: $ref: '#/components/schemas/AccountResponse' type: object x-internal-class: true + FaxResponseTransmission: + required: + - recipient + - sender + - status_code + properties: + recipient: + description: '_t__Sub::FaxResponseTransmission::RECIPIENT' + type: string + sender: + description: '_t__Sub::FaxResponseTransmission::SENDER' + type: string + status_code: + description: '_t__Sub::FaxResponseTransmission::STATUS_CODE' + type: string + enum: + - success + - transmitting + - error_could_not_fax + - error_unknown + - error_busy + - error_no_answer + - error_disconnected + - error_bad_destination + sent_at: + description: '_t__Sub::FaxResponseTransmission::SENT_AT' + type: integer + type: object + x-internal-class: true ListInfoResponse: description: '_t__ListInfoResponse::DESCRIPTION' properties: @@ -11670,6 +12329,10 @@ components: summary: 'Default Example' value: $ref: examples/json/FaxLineRemoveUserRequestExample.json + FaxSendRequestExample: + summary: 'Default Example' + value: + $ref: examples/json/FaxSendRequestExample.json OAuthTokenGenerateRequestExample: summary: 'OAuth Token Generate Example' value: @@ -11914,6 +12577,10 @@ components: summary: '_t__Error::4XX' value: $ref: examples/json/Error4XXResponseExample.json + FaxGetResponseExample: + summary: '_t__FaxGetResponseExample::SUMMARY' + value: + $ref: examples/json/FaxGetResponseExample.json FaxLineResponseExample: summary: '_t__FaxLineResponseExample::SUMMARY' value: @@ -11926,6 +12593,10 @@ components: summary: '_t__FaxLineListResponseExample::SUMMARY' value: $ref: examples/json/FaxLineListResponseExample.json + FaxListResponseExample: + summary: '_t__FaxListResponseExample::SUMMARY' + value: + $ref: examples/json/FaxListResponseExample.json ReportCreateResponseExample: summary: '_t__ReportCreateResponseExample::SUMMARY' value: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 8860e0756..93ba10ed3 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -1409,6 +1409,304 @@ paths: seo: title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here.' + '/fax/{fax_id}': + get: + tags: + - Fax + summary: 'Get Fax' + description: 'Returns information about fax' + operationId: faxGet + parameters: + - + name: fax_id + in: path + description: 'Fax ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + 200: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxGetResponse' + examples: + default_example: + $ref: '#/components/examples/FaxGetResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxGet.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxGet.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxGet.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxGet.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxGet.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxGet.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxGet.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxGet.sh + x-meta: + seo: + title: 'Get Fax | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here.' + delete: + tags: + - Fax + summary: 'Delete Fax' + description: 'Deletes the specified Fax from the system.' + operationId: faxDelete + parameters: + - + name: fax_id + in: path + description: 'Fax ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + 204: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxDelete.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxDelete.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxDelete.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxDelete.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxDelete.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxDelete.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxDelete.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxDelete.sh + x-meta: + seo: + title: 'Delete Fax | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax, click here.' + '/fax/files/{fax_id}': + get: + tags: + - Fax + summary: 'List Fax Files' + description: 'Returns list of fax files' + operationId: faxFiles + parameters: + - + name: fax_id + in: path + description: 'Fax ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + 200: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/pdf: + schema: + type: string + format: binary + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 410_example: + $ref: '#/components/examples/Error410ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxFiles.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxFiles.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxFiles.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxFiles.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxFiles.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxFiles.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxFiles.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxFiles.sh + x-meta: + seo: + title: 'Fax Files | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here.' /fax_line/add_user: put: tags: @@ -2206,6 +2504,220 @@ paths: seo: title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers' description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.' + /fax/list: + get: + tags: + - Fax + summary: 'Lists Faxes' + description: 'Returns properties of multiple faxes' + operationId: faxList + parameters: + - + name: page + in: query + description: Page + schema: + type: integer + default: 1 + minimum: 1 + example: 1 + - + name: page_size + in: query + description: 'Page size' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 + example: 20 + responses: + 200: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxListResponse' + examples: + default_example: + $ref: '#/components/examples/FaxListResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxList.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxList.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxList.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxList.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxList.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxList.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxList.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxList.sh + x-meta: + seo: + title: 'List Faxes | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your faxes, click here.' + /fax/send: + post: + tags: + - Fax + summary: 'Send Fax' + description: 'Action to prepare and send a fax' + operationId: faxSend + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/FaxSendRequest' + examples: + default_example: + $ref: '#/components/examples/FaxSendRequestExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/FaxSendRequest' + responses: + 200: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxGetResponse' + examples: + default_example: + $ref: '#/components/examples/FaxGetResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxSend.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxSend.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxSend.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxSend.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxSend.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxSend.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxSend.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxSend.sh + x-meta: + seo: + title: 'Send Fax| API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.' /oauth/token: post: tags: @@ -7379,6 +7891,50 @@ components: type: string format: email type: object + FaxSendRequest: + required: + - recipient + properties: + recipient: + description: 'Fax Send To Recipient' + type: string + example: recipient@example.com + sender: + description: 'Fax Send From Sender (used only with fax number)' + type: string + example: sender@example.com + files: + description: 'Fax File to Send' + type: array + items: + type: string + format: binary + file_urls: + description: 'Fax File URL to Send' + type: array + items: + type: string + test_mode: + description: 'API Test Mode Setting' + type: boolean + default: false + cover_page_to: + description: 'Fax Cover Page for Recipient' + type: string + example: 'Recipient Name' + cover_page_from: + description: 'Fax Cover Page for Sender' + type: string + example: 'Sender Name' + cover_page_message: + description: 'Fax Cover Page Message' + type: string + example: 'Please find the attached documents.' + title: + description: 'Fax Title' + type: string + example: 'Fax Title' + type: object OAuthTokenGenerateRequest: required: - client_id @@ -10251,6 +10807,19 @@ components: error: $ref: '#/components/schemas/ErrorResponseError' type: object + FaxGetResponse: + required: + - fax + properties: + fax: + $ref: '#/components/schemas/FaxResponse' + warnings: + description: 'A list of warnings.' + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true FaxLineResponse: required: - fax_line @@ -10286,6 +10855,19 @@ components: $ref: '#/components/schemas/WarningResponse' type: object x-internal-class: true + FaxListResponse: + required: + - faxes + - list_info + properties: + faxes: + type: array + items: + $ref: '#/components/schemas/FaxResponse' + list_info: + $ref: '#/components/schemas/ListInfoResponse' + type: object + x-internal-class: true FileResponse: required: - file_url @@ -10636,6 +11218,54 @@ components: description: 'Name of the error.' type: string type: object + FaxResponse: + required: + - fax_id + - title + - original_title + - subject + - message + - metadata + - created_at + - sender + - transmissions + - files_url + properties: + fax_id: + description: 'Fax ID' + type: string + title: + description: 'Fax Title' + type: string + original_title: + description: 'Fax Original Title' + type: string + subject: + description: 'Fax Subject' + type: string + message: + description: 'Fax Message' + type: string + metadata: + description: 'Fax Metadata' + type: object + additionalProperties: {} + created_at: + description: 'Fax Created At Timestamp' + type: integer + sender: + description: 'Fax Sender Email' + type: string + transmissions: + description: 'Fax Transmissions List' + type: array + items: + $ref: '#/components/schemas/FaxResponseTransmission' + files_url: + description: 'Fax Files URL' + type: string + type: object + x-internal-class: true FaxLineResponseFaxLine: properties: number: @@ -10653,6 +11283,35 @@ components: $ref: '#/components/schemas/AccountResponse' type: object x-internal-class: true + FaxResponseTransmission: + required: + - recipient + - sender + - status_code + properties: + recipient: + description: 'Fax Transmission Recipient' + type: string + sender: + description: 'Fax Transmission Sender' + type: string + status_code: + description: 'Fax Transmission Status Code' + type: string + enum: + - success + - transmitting + - error_could_not_fax + - error_unknown + - error_busy + - error_no_answer + - error_disconnected + - error_bad_destination + sent_at: + description: 'Fax Transmission Sent Timestamp' + type: integer + type: object + x-internal-class: true ListInfoResponse: description: 'Contains pagination information about the data returned.' properties: @@ -12462,6 +13121,10 @@ components: summary: 'Default Example' value: $ref: examples/json/FaxLineRemoveUserRequestExample.json + FaxSendRequestExample: + summary: 'Default Example' + value: + $ref: examples/json/FaxSendRequestExample.json OAuthTokenGenerateRequestExample: summary: 'OAuth Token Generate Example' value: @@ -12706,6 +13369,10 @@ components: summary: 'Error 4XX failed_operation' value: $ref: examples/json/Error4XXResponseExample.json + FaxGetResponseExample: + summary: 'Fax Response' + value: + $ref: examples/json/FaxGetResponseExample.json FaxLineResponseExample: summary: 'Sample Fax Line Response' value: @@ -12718,6 +13385,10 @@ components: summary: 'Sample Fax Line List Response' value: $ref: examples/json/FaxLineListResponseExample.json + FaxListResponseExample: + summary: 'Returns the properties and settings of multiple Faxes.' + value: + $ref: examples/json/FaxListResponseExample.json ReportCreateResponseExample: summary: Report value: diff --git a/openapi.yaml b/openapi.yaml index 6fce424d7..cf83c56af 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1409,6 +1409,304 @@ paths: seo: title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here.' + '/fax/{fax_id}': + get: + tags: + - Fax + summary: 'Get Fax' + description: 'Returns information about fax' + operationId: faxGet + parameters: + - + name: fax_id + in: path + description: 'Fax ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + 200: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxGetResponse' + examples: + default_example: + $ref: '#/components/examples/FaxGetResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxGet.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxGet.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxGet.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxGet.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxGet.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxGet.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxGet.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxGet.sh + x-meta: + seo: + title: 'Get Fax | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here.' + delete: + tags: + - Fax + summary: 'Delete Fax' + description: 'Deletes the specified Fax from the system.' + operationId: faxDelete + parameters: + - + name: fax_id + in: path + description: 'Fax ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + 204: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxDelete.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxDelete.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxDelete.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxDelete.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxDelete.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxDelete.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxDelete.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxDelete.sh + x-meta: + seo: + title: 'Delete Fax | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax, click here.' + '/fax/files/{fax_id}': + get: + tags: + - Fax + summary: 'List Fax Files' + description: 'Returns list of fax files' + operationId: faxFiles + parameters: + - + name: fax_id + in: path + description: 'Fax ID' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + responses: + 200: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/pdf: + schema: + type: string + format: binary + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 410_example: + $ref: '#/components/examples/Error410ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxFiles.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxFiles.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxFiles.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxFiles.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxFiles.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxFiles.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxFiles.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxFiles.sh + x-meta: + seo: + title: 'Fax Files | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here.' /fax_line/add_user: put: tags: @@ -2206,6 +2504,220 @@ paths: seo: title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers' description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.' + /fax/list: + get: + tags: + - Fax + summary: 'Lists Faxes' + description: 'Returns properties of multiple faxes' + operationId: faxList + parameters: + - + name: page + in: query + description: Page + schema: + type: integer + default: 1 + minimum: 1 + example: 1 + - + name: page_size + in: query + description: 'Page size' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 + example: 20 + responses: + 200: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxListResponse' + examples: + default_example: + $ref: '#/components/examples/FaxListResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxList.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxList.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxList.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxList.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxList.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxList.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxList.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxList.sh + x-meta: + seo: + title: 'List Faxes | API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your faxes, click here.' + /fax/send: + post: + tags: + - Fax + summary: 'Send Fax' + description: 'Action to prepare and send a fax' + operationId: faxSend + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/FaxSendRequest' + examples: + default_example: + $ref: '#/components/examples/FaxSendRequestExample' + multipart/form-data: + schema: + $ref: '#/components/schemas/FaxSendRequest' + responses: + 200: + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/FaxGetResponse' + examples: + default_example: + $ref: '#/components/examples/FaxGetResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 404_example: + $ref: '#/components/examples/Error404ResponseExample' + 429_example: + $ref: '#/components/examples/Error429ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' + security: + - + api_key: [] + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/FaxSend.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/FaxSend.cs + - + lang: JavaScript + label: JavaScript + source: + $ref: examples/FaxSend.js + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/FaxSend.ts + - + lang: Java + label: Java + source: + $ref: examples/FaxSend.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/FaxSend.rb + - + lang: Python + label: Python + source: + $ref: examples/FaxSend.py + - + lang: cURL + label: cURL + source: + $ref: examples/FaxSend.sh + x-meta: + seo: + title: 'Send Fax| API Documentation | Dropbox Fax for Developers' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.' /oauth/token: post: tags: @@ -7379,6 +7891,50 @@ components: type: string format: email type: object + FaxSendRequest: + required: + - recipient + properties: + recipient: + description: 'Fax Send To Recipient' + type: string + example: recipient@example.com + sender: + description: 'Fax Send From Sender (used only with fax number)' + type: string + example: sender@example.com + files: + description: 'Fax File to Send' + type: array + items: + type: string + format: binary + file_urls: + description: 'Fax File URL to Send' + type: array + items: + type: string + test_mode: + description: 'API Test Mode Setting' + type: boolean + default: false + cover_page_to: + description: 'Fax Cover Page for Recipient' + type: string + example: 'Recipient Name' + cover_page_from: + description: 'Fax Cover Page for Sender' + type: string + example: 'Sender Name' + cover_page_message: + description: 'Fax Cover Page Message' + type: string + example: 'Please find the attached documents.' + title: + description: 'Fax Title' + type: string + example: 'Fax Title' + type: object OAuthTokenGenerateRequest: required: - client_id @@ -10229,6 +10785,19 @@ components: error: $ref: '#/components/schemas/ErrorResponseError' type: object + FaxGetResponse: + required: + - fax + properties: + fax: + $ref: '#/components/schemas/FaxResponse' + warnings: + description: 'A list of warnings.' + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true FaxLineResponse: required: - fax_line @@ -10264,6 +10833,19 @@ components: $ref: '#/components/schemas/WarningResponse' type: object x-internal-class: true + FaxListResponse: + required: + - faxes + - list_info + properties: + faxes: + type: array + items: + $ref: '#/components/schemas/FaxResponse' + list_info: + $ref: '#/components/schemas/ListInfoResponse' + type: object + x-internal-class: true FileResponse: required: - file_url @@ -10614,6 +11196,54 @@ components: description: 'Name of the error.' type: string type: object + FaxResponse: + required: + - fax_id + - title + - original_title + - subject + - message + - metadata + - created_at + - sender + - transmissions + - files_url + properties: + fax_id: + description: 'Fax ID' + type: string + title: + description: 'Fax Title' + type: string + original_title: + description: 'Fax Original Title' + type: string + subject: + description: 'Fax Subject' + type: string + message: + description: 'Fax Message' + type: string + metadata: + description: 'Fax Metadata' + type: object + additionalProperties: {} + created_at: + description: 'Fax Created At Timestamp' + type: integer + sender: + description: 'Fax Sender Email' + type: string + transmissions: + description: 'Fax Transmissions List' + type: array + items: + $ref: '#/components/schemas/FaxResponseTransmission' + files_url: + description: 'Fax Files URL' + type: string + type: object + x-internal-class: true FaxLineResponseFaxLine: properties: number: @@ -10631,6 +11261,35 @@ components: $ref: '#/components/schemas/AccountResponse' type: object x-internal-class: true + FaxResponseTransmission: + required: + - recipient + - sender + - status_code + properties: + recipient: + description: 'Fax Transmission Recipient' + type: string + sender: + description: 'Fax Transmission Sender' + type: string + status_code: + description: 'Fax Transmission Status Code' + type: string + enum: + - success + - transmitting + - error_could_not_fax + - error_unknown + - error_busy + - error_no_answer + - error_disconnected + - error_bad_destination + sent_at: + description: 'Fax Transmission Sent Timestamp' + type: integer + type: object + x-internal-class: true ListInfoResponse: description: 'Contains pagination information about the data returned.' properties: @@ -12440,6 +13099,10 @@ components: summary: 'Default Example' value: $ref: examples/json/FaxLineRemoveUserRequestExample.json + FaxSendRequestExample: + summary: 'Default Example' + value: + $ref: examples/json/FaxSendRequestExample.json OAuthTokenGenerateRequestExample: summary: 'OAuth Token Generate Example' value: @@ -12684,6 +13347,10 @@ components: summary: 'Error 4XX failed_operation' value: $ref: examples/json/Error4XXResponseExample.json + FaxGetResponseExample: + summary: 'Fax Response' + value: + $ref: examples/json/FaxGetResponseExample.json FaxLineResponseExample: summary: 'Sample Fax Line Response' value: @@ -12696,6 +13363,10 @@ components: summary: 'Sample Fax Line List Response' value: $ref: examples/json/FaxLineListResponseExample.json + FaxListResponseExample: + summary: 'Returns the properties and settings of multiple Faxes.' + value: + $ref: examples/json/FaxListResponseExample.json ReportCreateResponseExample: summary: Report value: diff --git a/sdks/dotnet/README.md b/sdks/dotnet/README.md index a13746f94..176cb9fa5 100644 --- a/sdks/dotnet/README.md +++ b/sdks/dotnet/README.md @@ -141,6 +141,11 @@ Class | Method | HTTP request | Description *BulkSendJobApi* | [**BulkSendJobList**](docs/BulkSendJobApi.md#bulksendjoblist) | **GET** /bulk_send_job/list | List Bulk Send Jobs *EmbeddedApi* | [**EmbeddedEditUrl**](docs/EmbeddedApi.md#embeddedediturl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL *EmbeddedApi* | [**EmbeddedSignUrl**](docs/EmbeddedApi.md#embeddedsignurl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL +*FaxApi* | [**FaxDelete**](docs/FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax +*FaxApi* | [**FaxFiles**](docs/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files +*FaxApi* | [**FaxGet**](docs/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax +*FaxApi* | [**FaxList**](docs/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes +*FaxApi* | [**FaxSend**](docs/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax *FaxLineApi* | [**FaxLineAddUser**](docs/FaxLineApi.md#faxlineadduser) | **PUT** /fax_line/add_user | Add Fax Line User *FaxLineApi* | [**FaxLineAreaCodeGet**](docs/FaxLineApi.md#faxlineareacodeget) | **GET** /fax_line/area_codes | Get Available Fax Line Area Codes *FaxLineApi* | [**FaxLineCreate**](docs/FaxLineApi.md#faxlinecreate) | **POST** /fax_line/create | Purchase Fax Line @@ -231,6 +236,7 @@ Class | Method | HTTP request | Description - [Model.EventCallbackRequest](docs/EventCallbackRequest.md) - [Model.EventCallbackRequestEvent](docs/EventCallbackRequestEvent.md) - [Model.EventCallbackRequestEventMetadata](docs/EventCallbackRequestEventMetadata.md) + - [Model.FaxGetResponse](docs/FaxGetResponse.md) - [Model.FaxLineAddUserRequest](docs/FaxLineAddUserRequest.md) - [Model.FaxLineAreaCodeGetCountryEnum](docs/FaxLineAreaCodeGetCountryEnum.md) - [Model.FaxLineAreaCodeGetProvinceEnum](docs/FaxLineAreaCodeGetProvinceEnum.md) @@ -242,6 +248,10 @@ Class | Method | HTTP request | Description - [Model.FaxLineRemoveUserRequest](docs/FaxLineRemoveUserRequest.md) - [Model.FaxLineResponse](docs/FaxLineResponse.md) - [Model.FaxLineResponseFaxLine](docs/FaxLineResponseFaxLine.md) + - [Model.FaxListResponse](docs/FaxListResponse.md) + - [Model.FaxResponse](docs/FaxResponse.md) + - [Model.FaxResponseTransmission](docs/FaxResponseTransmission.md) + - [Model.FaxSendRequest](docs/FaxSendRequest.md) - [Model.FileResponse](docs/FileResponse.md) - [Model.FileResponseDataUri](docs/FileResponseDataUri.md) - [Model.ListInfoResponse](docs/ListInfoResponse.md) diff --git a/sdks/dotnet/docs/FaxApi.md b/sdks/dotnet/docs/FaxApi.md new file mode 100644 index 000000000..303d4eff9 --- /dev/null +++ b/sdks/dotnet/docs/FaxApi.md @@ -0,0 +1,489 @@ +# Dropbox.Sign.Api.FaxApi + +All URIs are relative to *https://api.hellosign.com/v3* + +| Method | HTTP request | Description | +|--------|--------------|-------------| +| [**FaxDelete**](FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax | +| [**FaxFiles**](FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files | +| [**FaxGet**](FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax | +| [**FaxList**](FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes | +| [**FaxSend**](FaxApi.md#faxsend) | **POST** /fax/send | Send Fax | + + +# **FaxDelete** +> void FaxDelete (string faxId) + +Delete Fax + +Deletes the specified Fax from the system. + +### Example +```csharp +using System; +using System.Collections.Generic; +using System.IO; +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +public class Example +{ + public static void Main() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxApi = new FaxApi(config); + + try + { + faxApi.FaxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} + +``` + +#### Using the FaxDeleteWithHttpInfo variant +This returns an ApiResponse object which contains the response data, status code and headers. + +```csharp +try +{ + // Delete Fax + apiInstance.FaxDeleteWithHttpInfo(faxId); +} +catch (ApiException e) +{ + Debug.Print("Exception when calling FaxApi.FaxDeleteWithHttpInfo: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| **faxId** | **string** | Fax ID | | + +### Return type + +void (empty response body) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **FaxFiles** +> System.IO.Stream FaxFiles (string faxId) + +List Fax Files + +Returns list of fax files + +### Example +```csharp +using System; +using System.Collections.Generic; +using System.IO; +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +public class Example +{ + public static void Main() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxApi = new FaxApi(config); + + var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + + try + { + var result = faxApi.FaxFiles(faxId); + var fileStream = File.Create("file_response.pdf"); + result.Seek(0, SeekOrigin.Begin); + result.CopyTo(fileStream); + fileStream.Close(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} + +``` + +#### Using the FaxFilesWithHttpInfo variant +This returns an ApiResponse object which contains the response data, status code and headers. + +```csharp +try +{ + // List Fax Files + ApiResponse response = apiInstance.FaxFilesWithHttpInfo(faxId); + Debug.Write("Status Code: " + response.StatusCode); + Debug.Write("Response Headers: " + response.Headers); + Debug.Write("Response Body: " + response.Data); +} +catch (ApiException e) +{ + Debug.Print("Exception when calling FaxApi.FaxFilesWithHttpInfo: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| **faxId** | **string** | Fax ID | | + +### Return type + +**System.IO.Stream** + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/pdf, application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **FaxGet** +> FaxGetResponse FaxGet (string faxId) + +Get Fax + +Returns information about fax + +### Example +```csharp +using System; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +public class Example +{ + public static void Main() + { + var config = new Configuration(); + // Configure HTTP basic authorization: api_key + config.Username = "YOUR_API_KEY"; + + var faxApi = new FaxApi(config); + + var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + + try + { + var result = faxApi.FaxGet(faxId); + Console.WriteLine(result); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} + +``` + +#### Using the FaxGetWithHttpInfo variant +This returns an ApiResponse object which contains the response data, status code and headers. + +```csharp +try +{ + // Get Fax + ApiResponse response = apiInstance.FaxGetWithHttpInfo(faxId); + Debug.Write("Status Code: " + response.StatusCode); + Debug.Write("Response Headers: " + response.Headers); + Debug.Write("Response Body: " + response.Data); +} +catch (ApiException e) +{ + Debug.Print("Exception when calling FaxApi.FaxGetWithHttpInfo: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| **faxId** | **string** | Fax ID | | + +### Return type + +[**FaxGetResponse**](FaxGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **FaxList** +> FaxListResponse FaxList (int? page = null, int? pageSize = null) + +Lists Faxes + +Returns properties of multiple faxes + +### Example +```csharp +using System; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +public class Example +{ + public static void Main() + { + var config = new Configuration(); + // Configure HTTP basic authorization: api_key + config.Username = "YOUR_API_KEY"; + + var faxApi = new FaxApi(config); + + var page = 1; + var pageSize = 2; + + try + { + var result = faxApi.FaxList(page, pageSize); + Console.WriteLine(result); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} + +``` + +#### Using the FaxListWithHttpInfo variant +This returns an ApiResponse object which contains the response data, status code and headers. + +```csharp +try +{ + // Lists Faxes + ApiResponse response = apiInstance.FaxListWithHttpInfo(page, pageSize); + Debug.Write("Status Code: " + response.StatusCode); + Debug.Write("Response Headers: " + response.Headers); + Debug.Write("Response Body: " + response.Data); +} +catch (ApiException e) +{ + Debug.Print("Exception when calling FaxApi.FaxListWithHttpInfo: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| **page** | **int?** | Page | [optional] [default to 1] | +| **pageSize** | **int?** | Page size | [optional] [default to 20] | + +### Return type + +[**FaxListResponse**](FaxListResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **FaxSend** +> FaxGetResponse FaxSend (FaxSendRequest faxSendRequest) + +Send Fax + +Action to prepare and send a fax + +### Example +```csharp +using System; +using System.Collections.Generic; +using System.IO; +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +public class Example +{ + public static void Main() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxApi = new FaxApi(config); + + var files = new List { + new FileStream( + "./example_fax.pdf", + FileMode.Open, + FileAccess.Read, + FileShare.Read + ) + }; + + var data = new FaxSendRequest( + files: files, + testMode: true, + recipient: "16690000001", + sender: "16690000000", + coverPageTo: "Jill Fax", + coverPageMessage: "I'm sending you a fax!", + coverPageFrom: "Faxer Faxerson", + title: "This is what the fax is about!", + ); + + try + { + var result = faxApi.FaxSend(data); + Console.WriteLine(result); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} + +``` + +#### Using the FaxSendWithHttpInfo variant +This returns an ApiResponse object which contains the response data, status code and headers. + +```csharp +try +{ + // Send Fax + ApiResponse response = apiInstance.FaxSendWithHttpInfo(faxSendRequest); + Debug.Write("Status Code: " + response.StatusCode); + Debug.Write("Response Headers: " + response.Headers); + Debug.Write("Response Body: " + response.Data); +} +catch (ApiException e) +{ + Debug.Print("Exception when calling FaxApi.FaxSendWithHttpInfo: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); +} +``` + +### Parameters + +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| **faxSendRequest** | [**FaxSendRequest**](FaxSendRequest.md) | | | + +### Return type + +[**FaxGetResponse**](FaxGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/sdks/dotnet/docs/FaxGetResponse.md b/sdks/dotnet/docs/FaxGetResponse.md new file mode 100644 index 000000000..42b82e12c --- /dev/null +++ b/sdks/dotnet/docs/FaxGetResponse.md @@ -0,0 +1,10 @@ +# Dropbox.Sign.Model.FaxGetResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Fax** | [**FaxResponse**](FaxResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/sdks/dotnet/docs/FaxListResponse.md b/sdks/dotnet/docs/FaxListResponse.md new file mode 100644 index 000000000..1cea1149f --- /dev/null +++ b/sdks/dotnet/docs/FaxListResponse.md @@ -0,0 +1,10 @@ +# Dropbox.Sign.Model.FaxListResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Faxes** | [**List<FaxResponse>**](FaxResponse.md) | | **ListInfo** | [**ListInfoResponse**](ListInfoResponse.md) | | + +[[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/FaxResponse.md b/sdks/dotnet/docs/FaxResponse.md new file mode 100644 index 000000000..27a06144d --- /dev/null +++ b/sdks/dotnet/docs/FaxResponse.md @@ -0,0 +1,10 @@ +# Dropbox.Sign.Model.FaxResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FaxId** | **string** | Fax ID | **Title** | **string** | Fax Title | **OriginalTitle** | **string** | Fax Original Title | **Subject** | **string** | Fax Subject | **Message** | **string** | Fax Message | **Metadata** | **Dictionary<string, Object>** | Fax Metadata | **CreatedAt** | **int** | Fax Created At Timestamp | **Sender** | **string** | Fax Sender Email | **Transmissions** | [**List<FaxResponseTransmission>**](FaxResponseTransmission.md) | Fax Transmissions List | **FilesUrl** | **string** | Fax Files URL | + +[[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/FaxResponseTransmission.md b/sdks/dotnet/docs/FaxResponseTransmission.md new file mode 100644 index 000000000..c306b85d4 --- /dev/null +++ b/sdks/dotnet/docs/FaxResponseTransmission.md @@ -0,0 +1,10 @@ +# Dropbox.Sign.Model.FaxResponseTransmission + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Recipient** | **string** | Fax Transmission Recipient | **Sender** | **string** | Fax Transmission Sender | **StatusCode** | **string** | Fax Transmission Status Code | **SentAt** | **int** | Fax Transmission Sent Timestamp | [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/FaxSendRequest.md b/sdks/dotnet/docs/FaxSendRequest.md new file mode 100644 index 000000000..b02d7f0b8 --- /dev/null +++ b/sdks/dotnet/docs/FaxSendRequest.md @@ -0,0 +1,10 @@ +# Dropbox.Sign.Model.FaxSendRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Recipient** | **string** | Fax Send To Recipient | **Sender** | **string** | Fax Send From Sender (used only with fax number) | [optional] **Files** | **List<System.IO.Stream>** | Fax File to Send | [optional] **FileUrls** | **List<string>** | Fax File URL to Send | [optional] **TestMode** | **bool** | API Test Mode Setting | [optional] [default to false]**CoverPageTo** | **string** | Fax Cover Page for Recipient | [optional] **CoverPageFrom** | **string** | Fax Cover Page for Sender | [optional] **CoverPageMessage** | **string** | Fax Cover Page Message | [optional] **Title** | **string** | Fax Title | [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/src/Dropbox.Sign/Api/FaxApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs new file mode 100644 index 000000000..b9819df28 --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs @@ -0,0 +1,1206 @@ +/* + * Dropbox Sign API + * + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Net; +using System.Net.Mime; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.Sign.Api +{ + + /// + /// Represents a collection of functions to interact with the API endpoints + /// + public interface IFaxApiSync : IApiAccessor + { + #region Synchronous Operations + /// + /// Delete Fax + /// + /// + /// Deletes the specified Fax from the system. + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// + void FaxDelete(string faxId, int operationIndex = 0); + + /// + /// Delete Fax + /// + /// + /// Deletes the specified Fax from the system. + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// ApiResponse of Object(void) + ApiResponse FaxDeleteWithHttpInfo(string faxId, int operationIndex = 0); + /// + /// List Fax Files + /// + /// + /// Returns list of fax files + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// System.IO.Stream + System.IO.Stream FaxFiles(string faxId, int operationIndex = 0); + + /// + /// List Fax Files + /// + /// + /// Returns list of fax files + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// ApiResponse of System.IO.Stream + ApiResponse FaxFilesWithHttpInfo(string faxId, int operationIndex = 0); + /// + /// Get Fax + /// + /// + /// Returns information about fax + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// FaxGetResponse + FaxGetResponse FaxGet(string faxId, int operationIndex = 0); + + /// + /// Get Fax + /// + /// + /// Returns information about fax + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// ApiResponse of FaxGetResponse + ApiResponse FaxGetWithHttpInfo(string faxId, int operationIndex = 0); + /// + /// Lists Faxes + /// + /// + /// Returns properties of multiple faxes + /// + /// Thrown when fails to make API call + /// Page (optional, default to 1) + /// Page size (optional, default to 20) + /// Index associated with the operation. + /// FaxListResponse + FaxListResponse FaxList(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0); + + /// + /// Lists Faxes + /// + /// + /// Returns properties of multiple faxes + /// + /// Thrown when fails to make API call + /// Page (optional, default to 1) + /// Page size (optional, default to 20) + /// Index associated with the operation. + /// ApiResponse of FaxListResponse + ApiResponse FaxListWithHttpInfo(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0); + /// + /// Send Fax + /// + /// + /// Action to prepare and send a fax + /// + /// Thrown when fails to make API call + /// + /// Index associated with the operation. + /// FaxGetResponse + FaxGetResponse FaxSend(FaxSendRequest faxSendRequest, int operationIndex = 0); + + /// + /// Send Fax + /// + /// + /// Action to prepare and send a fax + /// + /// Thrown when fails to make API call + /// + /// Index associated with the operation. + /// ApiResponse of FaxGetResponse + ApiResponse FaxSendWithHttpInfo(FaxSendRequest faxSendRequest, int operationIndex = 0); + #endregion Synchronous Operations + } + + /// + /// Represents a collection of functions to interact with the API endpoints + /// + public interface IFaxApiAsync : IApiAccessor + { + #region Asynchronous Operations + /// + /// Delete Fax + /// + /// + /// Deletes the specified Fax from the system. + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of void + System.Threading.Tasks.Task FaxDeleteAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + + /// + /// Delete Fax + /// + /// + /// Deletes the specified Fax from the system. + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse + System.Threading.Tasks.Task> FaxDeleteWithHttpInfoAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + /// + /// List Fax Files + /// + /// + /// Returns list of fax files + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of System.IO.Stream + System.Threading.Tasks.Task FaxFilesAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + + /// + /// List Fax Files + /// + /// + /// Returns list of fax files + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (System.IO.Stream) + System.Threading.Tasks.Task> FaxFilesWithHttpInfoAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + /// + /// Get Fax + /// + /// + /// Returns information about fax + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of FaxGetResponse + System.Threading.Tasks.Task FaxGetAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + + /// + /// Get Fax + /// + /// + /// Returns information about fax + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (FaxGetResponse) + System.Threading.Tasks.Task> FaxGetWithHttpInfoAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + /// + /// Lists Faxes + /// + /// + /// Returns properties of multiple faxes + /// + /// Thrown when fails to make API call + /// Page (optional, default to 1) + /// Page size (optional, default to 20) + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of FaxListResponse + System.Threading.Tasks.Task FaxListAsync(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + + /// + /// Lists Faxes + /// + /// + /// Returns properties of multiple faxes + /// + /// Thrown when fails to make API call + /// Page (optional, default to 1) + /// Page size (optional, default to 20) + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (FaxListResponse) + System.Threading.Tasks.Task> FaxListWithHttpInfoAsync(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + /// + /// Send Fax + /// + /// + /// Action to prepare and send a fax + /// + /// Thrown when fails to make API call + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of FaxGetResponse + System.Threading.Tasks.Task FaxSendAsync(FaxSendRequest faxSendRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + + /// + /// Send Fax + /// + /// + /// Action to prepare and send a fax + /// + /// Thrown when fails to make API call + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (FaxGetResponse) + System.Threading.Tasks.Task> FaxSendWithHttpInfoAsync(FaxSendRequest faxSendRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + #endregion Asynchronous Operations + } + + /// + /// Represents a collection of functions to interact with the API endpoints + /// + public interface IFaxApi : IFaxApiSync, IFaxApiAsync + { + + } + + /// + /// Represents a collection of functions to interact with the API endpoints + /// + public partial class FaxApi : IFaxApi + { + private Dropbox.Sign.Client.ExceptionFactory _exceptionFactory = (name, response) => null; + + /// + /// Initializes a new instance of the class. + /// + /// + public FaxApi() : this((string)null) + { + } + + /// + /// Initializes a new instance of the class. + /// + /// + public FaxApi(string basePath) + { + this.Configuration = Dropbox.Sign.Client.Configuration.MergeConfigurations( + Dropbox.Sign.Client.GlobalConfiguration.Instance, + new Dropbox.Sign.Client.Configuration { BasePath = basePath } + ); + this.Client = new Dropbox.Sign.Client.ApiClient(this.Configuration.BasePath); + this.AsynchronousClient = new Dropbox.Sign.Client.ApiClient(this.Configuration.BasePath); + this.ExceptionFactory = Dropbox.Sign.Client.Configuration.DefaultExceptionFactory; + } + + /// + /// Initializes a new instance of the class + /// using Configuration object + /// + /// An instance of Configuration + /// + public FaxApi(Dropbox.Sign.Client.Configuration configuration) + { + if (configuration == null) throw new ArgumentNullException("configuration"); + + this.Configuration = Dropbox.Sign.Client.Configuration.MergeConfigurations( + Dropbox.Sign.Client.GlobalConfiguration.Instance, + configuration + ); + this.Client = new Dropbox.Sign.Client.ApiClient(this.Configuration.BasePath); + this.AsynchronousClient = new Dropbox.Sign.Client.ApiClient(this.Configuration.BasePath); + ExceptionFactory = Dropbox.Sign.Client.Configuration.DefaultExceptionFactory; + } + + /// + /// Initializes a new instance of the class + /// using a Configuration object and client instance. + /// + /// The client interface for synchronous API access. + /// The client interface for asynchronous API access. + /// The configuration object. + public FaxApi(Dropbox.Sign.Client.ISynchronousClient client, Dropbox.Sign.Client.IAsynchronousClient asyncClient, Dropbox.Sign.Client.IReadableConfiguration configuration) + { + if (client == null) throw new ArgumentNullException("client"); + if (asyncClient == null) throw new ArgumentNullException("asyncClient"); + if (configuration == null) throw new ArgumentNullException("configuration"); + + this.Client = client; + this.AsynchronousClient = asyncClient; + this.Configuration = configuration; + this.ExceptionFactory = Dropbox.Sign.Client.Configuration.DefaultExceptionFactory; + } + + /// + /// The client for accessing this underlying API asynchronously. + /// + public Dropbox.Sign.Client.IAsynchronousClient AsynchronousClient { get; set; } + + /// + /// The client for accessing this underlying API synchronously. + /// + public Dropbox.Sign.Client.ISynchronousClient Client { get; set; } + + /// + /// Gets the base path of the API client. + /// + /// The base path + public string GetBasePath() + { + return this.Configuration.BasePath; + } + + /// + /// Gets or sets the configuration object + /// + /// An instance of the Configuration + public Dropbox.Sign.Client.IReadableConfiguration Configuration { get; set; } + + /// + /// Provides a factory method hook for the creation of exceptions. + /// + public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory + { + get + { + if (_exceptionFactory != null && _exceptionFactory.GetInvocationList().Length > 1) + { + throw new InvalidOperationException("Multicast delegate for ExceptionFactory is unsupported."); + } + return _exceptionFactory; + } + set { _exceptionFactory = value; } + } + + /// + /// Delete Fax Deletes the specified Fax from the system. + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// + public void FaxDelete(string faxId, int operationIndex = 0) + { + FaxDeleteWithHttpInfo(faxId); + } + + /// + /// Delete Fax Deletes the specified Fax from the system. + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// ApiResponse of Object(void) + public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxId, int operationIndex = 0) + { + // verify the required parameter 'faxId' is set + if (faxId == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'faxId' when calling FaxApi->FaxDelete"); + } + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + }; + var localVarContentType = Dropbox.Sign.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("fax_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(faxId)); // path parameter + + localVarRequestOptions.Operation = "FaxApi.FaxDelete"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + + // make the HTTP request + var localVarResponse = this.Client.Delete("/fax/{fax_id}", localVarRequestOptions, this.Configuration); + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("FaxDelete", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Delete Fax Deletes the specified Fax from the system. + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of void + public async System.Threading.Tasks.Task FaxDeleteAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + await FaxDeleteWithHttpInfoAsync(faxId, operationIndex, cancellationToken).ConfigureAwait(false); + } + + /// + /// Delete Fax Deletes the specified Fax from the system. + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse + public async System.Threading.Tasks.Task> FaxDeleteWithHttpInfoAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + // verify the required parameter 'faxId' is set + if (faxId == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'faxId' when calling FaxApi->FaxDelete"); + } + + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + }; + var localVarContentType = Dropbox.Sign.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("fax_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(faxId)); // path parameter + + localVarRequestOptions.Operation = "FaxApi.FaxDelete"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + + // make the HTTP request + var localVarResponse = await this.AsynchronousClient.DeleteAsync("/fax/{fax_id}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("FaxDelete", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// List Fax Files Returns list of fax files + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// System.IO.Stream + public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = FaxFilesWithHttpInfo(faxId); + return localVarResponse.Data; + } + + /// + /// List Fax Files Returns list of fax files + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// ApiResponse of System.IO.Stream + public Dropbox.Sign.Client.ApiResponse FaxFilesWithHttpInfo(string faxId, int operationIndex = 0) + { + // verify the required parameter 'faxId' is set + if (faxId == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'faxId' when calling FaxApi->FaxFiles"); + } + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + }; + var localVarContentType = Dropbox.Sign.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + + // to determine the Accept header + string[] _accepts = new string[] { + "application/pdf", + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("fax_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(faxId)); // path parameter + + localVarRequestOptions.Operation = "FaxApi.FaxFiles"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + + // make the HTTP request + var localVarResponse = this.Client.Get("/fax/files/{fax_id}", localVarRequestOptions, this.Configuration); + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("FaxFiles", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// List Fax Files Returns list of fax files + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of System.IO.Stream + public async System.Threading.Tasks.Task FaxFilesAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = await FaxFilesWithHttpInfoAsync(faxId, operationIndex, cancellationToken).ConfigureAwait(false); + return localVarResponse.Data; + } + + /// + /// List Fax Files Returns list of fax files + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (System.IO.Stream) + public async System.Threading.Tasks.Task> FaxFilesWithHttpInfoAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + // verify the required parameter 'faxId' is set + if (faxId == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'faxId' when calling FaxApi->FaxFiles"); + } + + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + }; + var localVarContentType = Dropbox.Sign.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + + // to determine the Accept header + string[] _accepts = new string[] { + "application/pdf", + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("fax_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(faxId)); // path parameter + + localVarRequestOptions.Operation = "FaxApi.FaxFiles"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + + // make the HTTP request + var localVarResponse = await this.AsynchronousClient.GetAsync("/fax/files/{fax_id}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("FaxFiles", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Get Fax Returns information about fax + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// FaxGetResponse + public FaxGetResponse FaxGet(string faxId, int operationIndex = 0) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = FaxGetWithHttpInfo(faxId); + return localVarResponse.Data; + } + + /// + /// Get Fax Returns information about fax + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// ApiResponse of FaxGetResponse + public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string faxId, int operationIndex = 0) + { + // verify the required parameter 'faxId' is set + if (faxId == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'faxId' when calling FaxApi->FaxGet"); + } + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + }; + var localVarContentType = Dropbox.Sign.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("fax_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(faxId)); // path parameter + + localVarRequestOptions.Operation = "FaxApi.FaxGet"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + + // make the HTTP request + var localVarResponse = this.Client.Get("/fax/{fax_id}", localVarRequestOptions, this.Configuration); + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("FaxGet", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Get Fax Returns information about fax + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of FaxGetResponse + public async System.Threading.Tasks.Task FaxGetAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = await FaxGetWithHttpInfoAsync(faxId, operationIndex, cancellationToken).ConfigureAwait(false); + return localVarResponse.Data; + } + + /// + /// Get Fax Returns information about fax + /// + /// Thrown when fails to make API call + /// Fax ID + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (FaxGetResponse) + public async System.Threading.Tasks.Task> FaxGetWithHttpInfoAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + // verify the required parameter 'faxId' is set + if (faxId == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'faxId' when calling FaxApi->FaxGet"); + } + + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + }; + var localVarContentType = Dropbox.Sign.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("fax_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(faxId)); // path parameter + + localVarRequestOptions.Operation = "FaxApi.FaxGet"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + + // make the HTTP request + var localVarResponse = await this.AsynchronousClient.GetAsync("/fax/{fax_id}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("FaxGet", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Lists Faxes Returns properties of multiple faxes + /// + /// Thrown when fails to make API call + /// Page (optional, default to 1) + /// Page size (optional, default to 20) + /// Index associated with the operation. + /// FaxListResponse + public FaxListResponse FaxList(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = FaxListWithHttpInfo(page, pageSize); + return localVarResponse.Data; + } + + /// + /// Lists Faxes Returns properties of multiple faxes + /// + /// Thrown when fails to make API call + /// Page (optional, default to 1) + /// Page size (optional, default to 20) + /// Index associated with the operation. + /// ApiResponse of FaxListResponse + public Dropbox.Sign.Client.ApiResponse FaxListWithHttpInfo(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0) + { + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + }; + var localVarContentType = Dropbox.Sign.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + if (page != null) + { + localVarRequestOptions.QueryParameters.Add(Dropbox.Sign.Client.ClientUtils.ParameterToMultiMap("", "page", page)); + } + if (pageSize != null) + { + localVarRequestOptions.QueryParameters.Add(Dropbox.Sign.Client.ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); + } + + localVarRequestOptions.Operation = "FaxApi.FaxList"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + + // make the HTTP request + var localVarResponse = this.Client.Get("/fax/list", localVarRequestOptions, this.Configuration); + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("FaxList", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Lists Faxes Returns properties of multiple faxes + /// + /// Thrown when fails to make API call + /// Page (optional, default to 1) + /// Page size (optional, default to 20) + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of FaxListResponse + public async System.Threading.Tasks.Task FaxListAsync(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = await FaxListWithHttpInfoAsync(page, pageSize, operationIndex, cancellationToken).ConfigureAwait(false); + return localVarResponse.Data; + } + + /// + /// Lists Faxes Returns properties of multiple faxes + /// + /// Thrown when fails to make API call + /// Page (optional, default to 1) + /// Page size (optional, default to 20) + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (FaxListResponse) + public async System.Threading.Tasks.Task> FaxListWithHttpInfoAsync(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + }; + var localVarContentType = Dropbox.Sign.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + if (page != null) + { + localVarRequestOptions.QueryParameters.Add(Dropbox.Sign.Client.ClientUtils.ParameterToMultiMap("", "page", page)); + } + if (pageSize != null) + { + localVarRequestOptions.QueryParameters.Add(Dropbox.Sign.Client.ClientUtils.ParameterToMultiMap("", "page_size", pageSize)); + } + + localVarRequestOptions.Operation = "FaxApi.FaxList"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + + // make the HTTP request + var localVarResponse = await this.AsynchronousClient.GetAsync("/fax/list", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("FaxList", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Send Fax Action to prepare and send a fax + /// + /// Thrown when fails to make API call + /// + /// Index associated with the operation. + /// FaxGetResponse + public FaxGetResponse FaxSend(FaxSendRequest faxSendRequest, int operationIndex = 0) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = FaxSendWithHttpInfo(faxSendRequest); + return localVarResponse.Data; + } + + /// + /// Send Fax Action to prepare and send a fax + /// + /// Thrown when fails to make API call + /// + /// Index associated with the operation. + /// ApiResponse of FaxGetResponse + public Dropbox.Sign.Client.ApiResponse FaxSendWithHttpInfo(FaxSendRequest faxSendRequest, int operationIndex = 0) + { + // verify the required parameter 'faxSendRequest' is set + if (faxSendRequest == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'faxSendRequest' when calling FaxApi->FaxSend"); + } + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + var localVarContentType = ""; + var openApiTypes = faxSendRequest.GetOpenApiTypes(); + if (ClientUtils.HasFileType(openApiTypes)) + { + ClientUtils.SetFormData(localVarRequestOptions, openApiTypes); + localVarContentType = "multipart/form-data"; + } + else + { + localVarContentType = "application/json"; + localVarRequestOptions.Data = faxSendRequest; + } + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + + localVarRequestOptions.Operation = "FaxApi.FaxSend"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + + // make the HTTP request + var localVarResponse = this.Client.Post("/fax/send", localVarRequestOptions, this.Configuration); + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("FaxSend", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// + /// Send Fax Action to prepare and send a fax + /// + /// Thrown when fails to make API call + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of FaxGetResponse + public async System.Threading.Tasks.Task FaxSendAsync(FaxSendRequest faxSendRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + Dropbox.Sign.Client.ApiResponse localVarResponse = await FaxSendWithHttpInfoAsync(faxSendRequest, operationIndex, cancellationToken).ConfigureAwait(false); + return localVarResponse.Data; + } + + /// + /// Send Fax Action to prepare and send a fax + /// + /// Thrown when fails to make API call + /// + /// Index associated with the operation. + /// Cancellation Token to cancel the request. + /// Task of ApiResponse (FaxGetResponse) + public async System.Threading.Tasks.Task> FaxSendWithHttpInfoAsync(FaxSendRequest faxSendRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + { + // verify the required parameter 'faxSendRequest' is set + if (faxSendRequest == null) + { + throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'faxSendRequest' when calling FaxApi->FaxSend"); + } + + + Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions(); + + var localVarContentType = ""; + var openApiTypes = faxSendRequest.GetOpenApiTypes(); + if (ClientUtils.HasFileType(openApiTypes)) + { + ClientUtils.SetFormData(localVarRequestOptions, openApiTypes); + localVarContentType = "multipart/form-data"; + } + else + { + localVarContentType = "application/json"; + localVarRequestOptions.Data = faxSendRequest; + } + + // to determine the Accept header + string[] _accepts = new string[] { + "application/json" + }; + + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + + localVarRequestOptions.Operation = "FaxApi.FaxSend"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (api_key) required + // http basic authentication required + if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization")) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password)); + } + + // make the HTTP request + var localVarResponse = await this.AsynchronousClient.PostAsync("/fax/send", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("FaxSend", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + } +} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxGetResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxGetResponse.cs new file mode 100644 index 000000000..59214ef6e --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxGetResponse.cs @@ -0,0 +1,197 @@ +/* + * Dropbox Sign API + * + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// FaxGetResponse + /// + [DataContract(Name = "FaxGetResponse")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class FaxGetResponse : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected FaxGetResponse() { } + /// + /// Initializes a new instance of the class. + /// + /// fax (required). + /// A list of warnings.. + public FaxGetResponse(FaxResponse fax = default(FaxResponse), List warnings = default(List)) + { + + // to ensure "fax" is required (not null) + if (fax == null) + { + throw new ArgumentNullException("fax is a required property for FaxGetResponse and cannot be null"); + } + this.Fax = fax; + this.Warnings = warnings; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static FaxGetResponse Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of FaxGetResponse"); + } + + return obj; + } + + /// + /// Gets or Sets Fax + /// + [DataMember(Name = "fax", IsRequired = true, EmitDefaultValue = true)] + public FaxResponse Fax { get; set; } + + /// + /// A list of warnings. + /// + /// A list of warnings. + [DataMember(Name = "warnings", EmitDefaultValue = true)] + public List Warnings { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class FaxGetResponse {\n"); + sb.Append(" Fax: ").Append(Fax).Append("\n"); + sb.Append(" Warnings: ").Append(Warnings).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as FaxGetResponse); + } + + /// + /// Returns true if FaxGetResponse instances are equal + /// + /// Instance of FaxGetResponse to be compared + /// Boolean + public bool Equals(FaxGetResponse input) + { + if (input == null) + { + return false; + } + return + ( + this.Fax == input.Fax || + (this.Fax != null && + this.Fax.Equals(input.Fax)) + ) && + ( + this.Warnings == input.Warnings || + this.Warnings != null && + input.Warnings != null && + this.Warnings.SequenceEqual(input.Warnings) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Fax != null) + { + hashCode = (hashCode * 59) + this.Fax.GetHashCode(); + } + if (this.Warnings != null) + { + hashCode = (hashCode * 59) + this.Warnings.GetHashCode(); + } + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType() + { + Name = "fax", + Property = "Fax", + Type = "FaxResponse", + Value = Fax, + }); + types.Add(new OpenApiType() + { + Name = "warnings", + Property = "Warnings", + Type = "List", + Value = Warnings, + }); + + return types; + } + } + +} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxListResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxListResponse.cs new file mode 100644 index 000000000..d5c62990a --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxListResponse.cs @@ -0,0 +1,201 @@ +/* + * Dropbox Sign API + * + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// FaxListResponse + /// + [DataContract(Name = "FaxListResponse")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class FaxListResponse : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected FaxListResponse() { } + /// + /// Initializes a new instance of the class. + /// + /// faxes (required). + /// listInfo (required). + public FaxListResponse(List faxes = default(List), ListInfoResponse listInfo = default(ListInfoResponse)) + { + + // to ensure "faxes" is required (not null) + if (faxes == null) + { + throw new ArgumentNullException("faxes is a required property for FaxListResponse and cannot be null"); + } + this.Faxes = faxes; + // to ensure "listInfo" is required (not null) + if (listInfo == null) + { + throw new ArgumentNullException("listInfo is a required property for FaxListResponse and cannot be null"); + } + this.ListInfo = listInfo; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static FaxListResponse Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of FaxListResponse"); + } + + return obj; + } + + /// + /// Gets or Sets Faxes + /// + [DataMember(Name = "faxes", IsRequired = true, EmitDefaultValue = true)] + public List Faxes { get; set; } + + /// + /// Gets or Sets ListInfo + /// + [DataMember(Name = "list_info", IsRequired = true, EmitDefaultValue = true)] + public ListInfoResponse ListInfo { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class FaxListResponse {\n"); + sb.Append(" Faxes: ").Append(Faxes).Append("\n"); + sb.Append(" ListInfo: ").Append(ListInfo).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as FaxListResponse); + } + + /// + /// Returns true if FaxListResponse instances are equal + /// + /// Instance of FaxListResponse to be compared + /// Boolean + public bool Equals(FaxListResponse input) + { + if (input == null) + { + return false; + } + return + ( + this.Faxes == input.Faxes || + this.Faxes != null && + input.Faxes != null && + this.Faxes.SequenceEqual(input.Faxes) + ) && + ( + this.ListInfo == input.ListInfo || + (this.ListInfo != null && + this.ListInfo.Equals(input.ListInfo)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Faxes != null) + { + hashCode = (hashCode * 59) + this.Faxes.GetHashCode(); + } + if (this.ListInfo != null) + { + hashCode = (hashCode * 59) + this.ListInfo.GetHashCode(); + } + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType() + { + Name = "faxes", + Property = "Faxes", + Type = "List", + Value = Faxes, + }); + types.Add(new OpenApiType() + { + Name = "list_info", + Property = "ListInfo", + Type = "ListInfoResponse", + Value = ListInfo, + }); + + return types; + } + } + +} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponse.cs new file mode 100644 index 000000000..60125d8e1 --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponse.cs @@ -0,0 +1,443 @@ +/* + * Dropbox Sign API + * + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// FaxResponse + /// + [DataContract(Name = "FaxResponse")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class FaxResponse : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected FaxResponse() { } + /// + /// Initializes a new instance of the class. + /// + /// Fax ID (required). + /// Fax Title (required). + /// Fax Original Title (required). + /// Fax Subject (required). + /// Fax Message (required). + /// Fax Metadata (required). + /// Fax Created At Timestamp (required). + /// Fax Sender Email (required). + /// Fax Transmissions List (required). + /// Fax Files URL (required). + public FaxResponse(string faxId = default(string), string title = default(string), string originalTitle = default(string), string subject = default(string), string message = default(string), Dictionary metadata = default(Dictionary), int createdAt = default(int), string sender = default(string), List transmissions = default(List), string filesUrl = default(string)) + { + + // to ensure "faxId" is required (not null) + if (faxId == null) + { + throw new ArgumentNullException("faxId is a required property for FaxResponse and cannot be null"); + } + this.FaxId = faxId; + // to ensure "title" is required (not null) + if (title == null) + { + throw new ArgumentNullException("title is a required property for FaxResponse and cannot be null"); + } + this.Title = title; + // to ensure "originalTitle" is required (not null) + if (originalTitle == null) + { + throw new ArgumentNullException("originalTitle is a required property for FaxResponse and cannot be null"); + } + this.OriginalTitle = originalTitle; + // to ensure "subject" is required (not null) + if (subject == null) + { + throw new ArgumentNullException("subject is a required property for FaxResponse and cannot be null"); + } + this.Subject = subject; + // to ensure "message" is required (not null) + if (message == null) + { + throw new ArgumentNullException("message is a required property for FaxResponse and cannot be null"); + } + this.Message = message; + // to ensure "metadata" is required (not null) + if (metadata == null) + { + throw new ArgumentNullException("metadata is a required property for FaxResponse and cannot be null"); + } + this.Metadata = metadata; + this.CreatedAt = createdAt; + // to ensure "sender" is required (not null) + if (sender == null) + { + throw new ArgumentNullException("sender is a required property for FaxResponse and cannot be null"); + } + this.Sender = sender; + // to ensure "transmissions" is required (not null) + if (transmissions == null) + { + throw new ArgumentNullException("transmissions is a required property for FaxResponse and cannot be null"); + } + this.Transmissions = transmissions; + // to ensure "filesUrl" is required (not null) + if (filesUrl == null) + { + throw new ArgumentNullException("filesUrl is a required property for FaxResponse and cannot be null"); + } + this.FilesUrl = filesUrl; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static FaxResponse Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of FaxResponse"); + } + + return obj; + } + + /// + /// Fax ID + /// + /// Fax ID + [DataMember(Name = "fax_id", IsRequired = true, EmitDefaultValue = true)] + public string FaxId { get; set; } + + /// + /// Fax Title + /// + /// Fax Title + [DataMember(Name = "title", IsRequired = true, EmitDefaultValue = true)] + public string Title { get; set; } + + /// + /// Fax Original Title + /// + /// Fax Original Title + [DataMember(Name = "original_title", IsRequired = true, EmitDefaultValue = true)] + public string OriginalTitle { get; set; } + + /// + /// Fax Subject + /// + /// Fax Subject + [DataMember(Name = "subject", IsRequired = true, EmitDefaultValue = true)] + public string Subject { get; set; } + + /// + /// Fax Message + /// + /// Fax Message + [DataMember(Name = "message", IsRequired = true, EmitDefaultValue = true)] + public string Message { get; set; } + + /// + /// Fax Metadata + /// + /// Fax Metadata + [DataMember(Name = "metadata", IsRequired = true, EmitDefaultValue = true)] + public Dictionary Metadata { get; set; } + + /// + /// Fax Created At Timestamp + /// + /// Fax Created At Timestamp + [DataMember(Name = "created_at", IsRequired = true, EmitDefaultValue = true)] + public int CreatedAt { get; set; } + + /// + /// Fax Sender Email + /// + /// Fax Sender Email + [DataMember(Name = "sender", IsRequired = true, EmitDefaultValue = true)] + public string Sender { get; set; } + + /// + /// Fax Transmissions List + /// + /// Fax Transmissions List + [DataMember(Name = "transmissions", IsRequired = true, EmitDefaultValue = true)] + public List Transmissions { get; set; } + + /// + /// Fax Files URL + /// + /// Fax Files URL + [DataMember(Name = "files_url", IsRequired = true, EmitDefaultValue = true)] + public string FilesUrl { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class FaxResponse {\n"); + sb.Append(" FaxId: ").Append(FaxId).Append("\n"); + sb.Append(" Title: ").Append(Title).Append("\n"); + sb.Append(" OriginalTitle: ").Append(OriginalTitle).Append("\n"); + sb.Append(" Subject: ").Append(Subject).Append("\n"); + sb.Append(" Message: ").Append(Message).Append("\n"); + sb.Append(" Metadata: ").Append(Metadata).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" Sender: ").Append(Sender).Append("\n"); + sb.Append(" Transmissions: ").Append(Transmissions).Append("\n"); + sb.Append(" FilesUrl: ").Append(FilesUrl).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as FaxResponse); + } + + /// + /// Returns true if FaxResponse instances are equal + /// + /// Instance of FaxResponse to be compared + /// Boolean + public bool Equals(FaxResponse input) + { + if (input == null) + { + return false; + } + return + ( + this.FaxId == input.FaxId || + (this.FaxId != null && + this.FaxId.Equals(input.FaxId)) + ) && + ( + this.Title == input.Title || + (this.Title != null && + this.Title.Equals(input.Title)) + ) && + ( + this.OriginalTitle == input.OriginalTitle || + (this.OriginalTitle != null && + this.OriginalTitle.Equals(input.OriginalTitle)) + ) && + ( + this.Subject == input.Subject || + (this.Subject != null && + this.Subject.Equals(input.Subject)) + ) && + ( + this.Message == input.Message || + (this.Message != null && + this.Message.Equals(input.Message)) + ) && + ( + this.Metadata == input.Metadata || + this.Metadata != null && + input.Metadata != null && + this.Metadata.SequenceEqual(input.Metadata) + ) && + ( + this.CreatedAt == input.CreatedAt || + this.CreatedAt.Equals(input.CreatedAt) + ) && + ( + this.Sender == input.Sender || + (this.Sender != null && + this.Sender.Equals(input.Sender)) + ) && + ( + this.Transmissions == input.Transmissions || + this.Transmissions != null && + input.Transmissions != null && + this.Transmissions.SequenceEqual(input.Transmissions) + ) && + ( + this.FilesUrl == input.FilesUrl || + (this.FilesUrl != null && + this.FilesUrl.Equals(input.FilesUrl)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.FaxId != null) + { + hashCode = (hashCode * 59) + this.FaxId.GetHashCode(); + } + if (this.Title != null) + { + hashCode = (hashCode * 59) + this.Title.GetHashCode(); + } + if (this.OriginalTitle != null) + { + hashCode = (hashCode * 59) + this.OriginalTitle.GetHashCode(); + } + if (this.Subject != null) + { + hashCode = (hashCode * 59) + this.Subject.GetHashCode(); + } + if (this.Message != null) + { + hashCode = (hashCode * 59) + this.Message.GetHashCode(); + } + if (this.Metadata != null) + { + hashCode = (hashCode * 59) + this.Metadata.GetHashCode(); + } + hashCode = (hashCode * 59) + this.CreatedAt.GetHashCode(); + if (this.Sender != null) + { + hashCode = (hashCode * 59) + this.Sender.GetHashCode(); + } + if (this.Transmissions != null) + { + hashCode = (hashCode * 59) + this.Transmissions.GetHashCode(); + } + if (this.FilesUrl != null) + { + hashCode = (hashCode * 59) + this.FilesUrl.GetHashCode(); + } + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType() + { + Name = "fax_id", + Property = "FaxId", + Type = "string", + Value = FaxId, + }); + types.Add(new OpenApiType() + { + Name = "title", + Property = "Title", + Type = "string", + Value = Title, + }); + types.Add(new OpenApiType() + { + Name = "original_title", + Property = "OriginalTitle", + Type = "string", + Value = OriginalTitle, + }); + types.Add(new OpenApiType() + { + Name = "subject", + Property = "Subject", + Type = "string", + Value = Subject, + }); + types.Add(new OpenApiType() + { + Name = "message", + Property = "Message", + Type = "string", + Value = Message, + }); + types.Add(new OpenApiType() + { + Name = "metadata", + Property = "Metadata", + Type = "Dictionary", + Value = Metadata, + }); + types.Add(new OpenApiType() + { + Name = "created_at", + Property = "CreatedAt", + Type = "int", + Value = CreatedAt, + }); + types.Add(new OpenApiType() + { + Name = "sender", + Property = "Sender", + Type = "string", + Value = Sender, + }); + types.Add(new OpenApiType() + { + Name = "transmissions", + Property = "Transmissions", + Type = "List", + Value = Transmissions, + }); + types.Add(new OpenApiType() + { + Name = "files_url", + Property = "FilesUrl", + Type = "string", + Value = FilesUrl, + }); + + return types; + } + } + +} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFax.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFax.cs new file mode 100644 index 000000000..abb8cab5f --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFax.cs @@ -0,0 +1,397 @@ +/* + * Dropbox Sign API + * + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// FaxResponseFax + /// + [DataContract(Name = "FaxResponseFax")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class FaxResponseFax : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected FaxResponseFax() { } + /// + /// Initializes a new instance of the class. + /// + /// Fax ID. + /// Fax Title. + /// Fax Original Title. + /// Fax Subject. + /// Fax Message. + /// Fax Metadata. + /// Fax Created At Timestamp. + /// Fax Sender Email. + /// Fax Transmissions List. + /// Fax Files URL. + public FaxResponseFax(string faxId = default(string), string title = default(string), string originalTitle = default(string), string subject = default(string), string message = default(string), Object metadata = default(Object), int createdAt = default(int), string from = default(string), List transmissions = default(List), string filesUrl = default(string)) + { + + this.FaxId = faxId; + this.Title = title; + this.OriginalTitle = originalTitle; + this.Subject = subject; + this.Message = message; + this.Metadata = metadata; + this.CreatedAt = createdAt; + this.From = from; + this.Transmissions = transmissions; + this.FilesUrl = filesUrl; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static FaxResponseFax Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of FaxResponseFax"); + } + + return obj; + } + + /// + /// Fax ID + /// + /// Fax ID + [DataMember(Name = "fax_id", EmitDefaultValue = true)] + public string FaxId { get; set; } + + /// + /// Fax Title + /// + /// Fax Title + [DataMember(Name = "title", EmitDefaultValue = true)] + public string Title { get; set; } + + /// + /// Fax Original Title + /// + /// Fax Original Title + [DataMember(Name = "original_title", EmitDefaultValue = true)] + public string OriginalTitle { get; set; } + + /// + /// Fax Subject + /// + /// Fax Subject + [DataMember(Name = "subject", EmitDefaultValue = true)] + public string Subject { get; set; } + + /// + /// Fax Message + /// + /// Fax Message + [DataMember(Name = "message", EmitDefaultValue = true)] + public string Message { get; set; } + + /// + /// Fax Metadata + /// + /// Fax Metadata + [DataMember(Name = "metadata", EmitDefaultValue = true)] + public Object Metadata { get; set; } + + /// + /// Fax Created At Timestamp + /// + /// Fax Created At Timestamp + [DataMember(Name = "created_at", EmitDefaultValue = true)] + public int CreatedAt { get; set; } + + /// + /// Fax Sender Email + /// + /// Fax Sender Email + [DataMember(Name = "from", EmitDefaultValue = true)] + public string From { get; set; } + + /// + /// Fax Transmissions List + /// + /// Fax Transmissions List + [DataMember(Name = "transmissions", EmitDefaultValue = true)] + public List Transmissions { get; set; } + + /// + /// Fax Files URL + /// + /// Fax Files URL + [DataMember(Name = "files_url", EmitDefaultValue = true)] + public string FilesUrl { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class FaxResponseFax {\n"); + sb.Append(" FaxId: ").Append(FaxId).Append("\n"); + sb.Append(" Title: ").Append(Title).Append("\n"); + sb.Append(" OriginalTitle: ").Append(OriginalTitle).Append("\n"); + sb.Append(" Subject: ").Append(Subject).Append("\n"); + sb.Append(" Message: ").Append(Message).Append("\n"); + sb.Append(" Metadata: ").Append(Metadata).Append("\n"); + sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); + sb.Append(" From: ").Append(From).Append("\n"); + sb.Append(" Transmissions: ").Append(Transmissions).Append("\n"); + sb.Append(" FilesUrl: ").Append(FilesUrl).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as FaxResponseFax); + } + + /// + /// Returns true if FaxResponseFax instances are equal + /// + /// Instance of FaxResponseFax to be compared + /// Boolean + public bool Equals(FaxResponseFax input) + { + if (input == null) + { + return false; + } + return + ( + this.FaxId == input.FaxId || + (this.FaxId != null && + this.FaxId.Equals(input.FaxId)) + ) && + ( + this.Title == input.Title || + (this.Title != null && + this.Title.Equals(input.Title)) + ) && + ( + this.OriginalTitle == input.OriginalTitle || + (this.OriginalTitle != null && + this.OriginalTitle.Equals(input.OriginalTitle)) + ) && + ( + this.Subject == input.Subject || + (this.Subject != null && + this.Subject.Equals(input.Subject)) + ) && + ( + this.Message == input.Message || + (this.Message != null && + this.Message.Equals(input.Message)) + ) && + ( + this.Metadata == input.Metadata || + (this.Metadata != null && + this.Metadata.Equals(input.Metadata)) + ) && + ( + this.CreatedAt == input.CreatedAt || + this.CreatedAt.Equals(input.CreatedAt) + ) && + ( + this.From == input.From || + (this.From != null && + this.From.Equals(input.From)) + ) && + ( + this.Transmissions == input.Transmissions || + this.Transmissions != null && + input.Transmissions != null && + this.Transmissions.SequenceEqual(input.Transmissions) + ) && + ( + this.FilesUrl == input.FilesUrl || + (this.FilesUrl != null && + this.FilesUrl.Equals(input.FilesUrl)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.FaxId != null) + { + hashCode = (hashCode * 59) + this.FaxId.GetHashCode(); + } + if (this.Title != null) + { + hashCode = (hashCode * 59) + this.Title.GetHashCode(); + } + if (this.OriginalTitle != null) + { + hashCode = (hashCode * 59) + this.OriginalTitle.GetHashCode(); + } + if (this.Subject != null) + { + hashCode = (hashCode * 59) + this.Subject.GetHashCode(); + } + if (this.Message != null) + { + hashCode = (hashCode * 59) + this.Message.GetHashCode(); + } + if (this.Metadata != null) + { + hashCode = (hashCode * 59) + this.Metadata.GetHashCode(); + } + hashCode = (hashCode * 59) + this.CreatedAt.GetHashCode(); + if (this.From != null) + { + hashCode = (hashCode * 59) + this.From.GetHashCode(); + } + if (this.Transmissions != null) + { + hashCode = (hashCode * 59) + this.Transmissions.GetHashCode(); + } + if (this.FilesUrl != null) + { + hashCode = (hashCode * 59) + this.FilesUrl.GetHashCode(); + } + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType() + { + Name = "fax_id", + Property = "FaxId", + Type = "string", + Value = FaxId, + }); + types.Add(new OpenApiType() + { + Name = "title", + Property = "Title", + Type = "string", + Value = Title, + }); + types.Add(new OpenApiType() + { + Name = "original_title", + Property = "OriginalTitle", + Type = "string", + Value = OriginalTitle, + }); + types.Add(new OpenApiType() + { + Name = "subject", + Property = "Subject", + Type = "string", + Value = Subject, + }); + types.Add(new OpenApiType() + { + Name = "message", + Property = "Message", + Type = "string", + Value = Message, + }); + types.Add(new OpenApiType() + { + Name = "metadata", + Property = "Metadata", + Type = "Object", + Value = Metadata, + }); + types.Add(new OpenApiType() + { + Name = "created_at", + Property = "CreatedAt", + Type = "int", + Value = CreatedAt, + }); + types.Add(new OpenApiType() + { + Name = "from", + Property = "From", + Type = "string", + Value = From, + }); + types.Add(new OpenApiType() + { + Name = "transmissions", + Property = "Transmissions", + Type = "List", + Value = Transmissions, + }); + types.Add(new OpenApiType() + { + Name = "files_url", + Property = "FilesUrl", + Type = "string", + Value = FilesUrl, + }); + + return types; + } + } + +} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFaxTransmission.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFaxTransmission.cs new file mode 100644 index 000000000..51e666148 --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFaxTransmission.cs @@ -0,0 +1,240 @@ +/* + * Dropbox Sign API + * + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// FaxResponseFaxTransmission + /// + [DataContract(Name = "FaxResponseFaxTransmission")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class FaxResponseFaxTransmission : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected FaxResponseFaxTransmission() { } + /// + /// Initializes a new instance of the class. + /// + /// Fax Transmission Recipient. + /// Fax Transmission Sender. + /// Fax Transmission Status Code. + /// Fax Transmission Sent Timestamp. + public FaxResponseFaxTransmission(string recipient = default(string), string sender = default(string), string statusCode = default(string), int sentAt = default(int)) + { + + this.Recipient = recipient; + this.Sender = sender; + this.StatusCode = statusCode; + this.SentAt = sentAt; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static FaxResponseFaxTransmission Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of FaxResponseFaxTransmission"); + } + + return obj; + } + + /// + /// Fax Transmission Recipient + /// + /// Fax Transmission Recipient + [DataMember(Name = "recipient", EmitDefaultValue = true)] + public string Recipient { get; set; } + + /// + /// Fax Transmission Sender + /// + /// Fax Transmission Sender + [DataMember(Name = "sender", EmitDefaultValue = true)] + public string Sender { get; set; } + + /// + /// Fax Transmission Status Code + /// + /// Fax Transmission Status Code + [DataMember(Name = "status_code", EmitDefaultValue = true)] + public string StatusCode { get; set; } + + /// + /// Fax Transmission Sent Timestamp + /// + /// Fax Transmission Sent Timestamp + [DataMember(Name = "sent_at", EmitDefaultValue = true)] + public int SentAt { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class FaxResponseFaxTransmission {\n"); + sb.Append(" Recipient: ").Append(Recipient).Append("\n"); + sb.Append(" Sender: ").Append(Sender).Append("\n"); + sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); + sb.Append(" SentAt: ").Append(SentAt).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as FaxResponseFaxTransmission); + } + + /// + /// Returns true if FaxResponseFaxTransmission instances are equal + /// + /// Instance of FaxResponseFaxTransmission to be compared + /// Boolean + public bool Equals(FaxResponseFaxTransmission input) + { + if (input == null) + { + return false; + } + return + ( + this.Recipient == input.Recipient || + (this.Recipient != null && + this.Recipient.Equals(input.Recipient)) + ) && + ( + this.Sender == input.Sender || + (this.Sender != null && + this.Sender.Equals(input.Sender)) + ) && + ( + this.StatusCode == input.StatusCode || + (this.StatusCode != null && + this.StatusCode.Equals(input.StatusCode)) + ) && + ( + this.SentAt == input.SentAt || + this.SentAt.Equals(input.SentAt) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Recipient != null) + { + hashCode = (hashCode * 59) + this.Recipient.GetHashCode(); + } + if (this.Sender != null) + { + hashCode = (hashCode * 59) + this.Sender.GetHashCode(); + } + if (this.StatusCode != null) + { + hashCode = (hashCode * 59) + this.StatusCode.GetHashCode(); + } + hashCode = (hashCode * 59) + this.SentAt.GetHashCode(); + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType() + { + Name = "recipient", + Property = "Recipient", + Type = "string", + Value = Recipient, + }); + types.Add(new OpenApiType() + { + Name = "sender", + Property = "Sender", + Type = "string", + Value = Sender, + }); + types.Add(new OpenApiType() + { + Name = "status_code", + Property = "StatusCode", + Type = "string", + Value = StatusCode, + }); + types.Add(new OpenApiType() + { + Name = "sent_at", + Property = "SentAt", + Type = "int", + Value = SentAt, + }); + + return types; + } + } + +} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseTransmission.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseTransmission.cs new file mode 100644 index 000000000..0e370714e --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseTransmission.cs @@ -0,0 +1,302 @@ +/* + * Dropbox Sign API + * + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// FaxResponseTransmission + /// + [DataContract(Name = "FaxResponseTransmission")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class FaxResponseTransmission : IEquatable, IValidatableObject + { + /// + /// Fax Transmission Status Code + /// + /// Fax Transmission Status Code + [JsonConverter(typeof(StringEnumConverter))] + public enum StatusCodeEnum + { + /// + /// Enum Success for value: success + /// + [EnumMember(Value = "success")] + Success = 1, + + /// + /// Enum Transmitting for value: transmitting + /// + [EnumMember(Value = "transmitting")] + Transmitting = 2, + + /// + /// Enum ErrorCouldNotFax for value: error_could_not_fax + /// + [EnumMember(Value = "error_could_not_fax")] + ErrorCouldNotFax = 3, + + /// + /// Enum ErrorUnknown for value: error_unknown + /// + [EnumMember(Value = "error_unknown")] + ErrorUnknown = 4, + + /// + /// Enum ErrorBusy for value: error_busy + /// + [EnumMember(Value = "error_busy")] + ErrorBusy = 5, + + /// + /// Enum ErrorNoAnswer for value: error_no_answer + /// + [EnumMember(Value = "error_no_answer")] + ErrorNoAnswer = 6, + + /// + /// Enum ErrorDisconnected for value: error_disconnected + /// + [EnumMember(Value = "error_disconnected")] + ErrorDisconnected = 7, + + /// + /// Enum ErrorBadDestination for value: error_bad_destination + /// + [EnumMember(Value = "error_bad_destination")] + ErrorBadDestination = 8 + } + + + /// + /// Fax Transmission Status Code + /// + /// Fax Transmission Status Code + [DataMember(Name = "status_code", IsRequired = true, EmitDefaultValue = true)] + public StatusCodeEnum StatusCode { get; set; } + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected FaxResponseTransmission() { } + /// + /// Initializes a new instance of the class. + /// + /// Fax Transmission Recipient (required). + /// Fax Transmission Sender (required). + /// Fax Transmission Status Code (required). + /// Fax Transmission Sent Timestamp. + public FaxResponseTransmission(string recipient = default(string), string sender = default(string), StatusCodeEnum statusCode = default(StatusCodeEnum), int sentAt = default(int)) + { + + // to ensure "recipient" is required (not null) + if (recipient == null) + { + throw new ArgumentNullException("recipient is a required property for FaxResponseTransmission and cannot be null"); + } + this.Recipient = recipient; + // to ensure "sender" is required (not null) + if (sender == null) + { + throw new ArgumentNullException("sender is a required property for FaxResponseTransmission and cannot be null"); + } + this.Sender = sender; + this.StatusCode = statusCode; + this.SentAt = sentAt; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static FaxResponseTransmission Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of FaxResponseTransmission"); + } + + return obj; + } + + /// + /// Fax Transmission Recipient + /// + /// Fax Transmission Recipient + [DataMember(Name = "recipient", IsRequired = true, EmitDefaultValue = true)] + public string Recipient { get; set; } + + /// + /// Fax Transmission Sender + /// + /// Fax Transmission Sender + [DataMember(Name = "sender", IsRequired = true, EmitDefaultValue = true)] + public string Sender { get; set; } + + /// + /// Fax Transmission Sent Timestamp + /// + /// Fax Transmission Sent Timestamp + [DataMember(Name = "sent_at", EmitDefaultValue = true)] + public int SentAt { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class FaxResponseTransmission {\n"); + sb.Append(" Recipient: ").Append(Recipient).Append("\n"); + sb.Append(" Sender: ").Append(Sender).Append("\n"); + sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); + sb.Append(" SentAt: ").Append(SentAt).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as FaxResponseTransmission); + } + + /// + /// Returns true if FaxResponseTransmission instances are equal + /// + /// Instance of FaxResponseTransmission to be compared + /// Boolean + public bool Equals(FaxResponseTransmission input) + { + if (input == null) + { + return false; + } + return + ( + this.Recipient == input.Recipient || + (this.Recipient != null && + this.Recipient.Equals(input.Recipient)) + ) && + ( + this.Sender == input.Sender || + (this.Sender != null && + this.Sender.Equals(input.Sender)) + ) && + ( + this.StatusCode == input.StatusCode || + this.StatusCode.Equals(input.StatusCode) + ) && + ( + this.SentAt == input.SentAt || + this.SentAt.Equals(input.SentAt) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Recipient != null) + { + hashCode = (hashCode * 59) + this.Recipient.GetHashCode(); + } + if (this.Sender != null) + { + hashCode = (hashCode * 59) + this.Sender.GetHashCode(); + } + hashCode = (hashCode * 59) + this.StatusCode.GetHashCode(); + hashCode = (hashCode * 59) + this.SentAt.GetHashCode(); + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType() + { + Name = "recipient", + Property = "Recipient", + Type = "string", + Value = Recipient, + }); + types.Add(new OpenApiType() + { + Name = "sender", + Property = "Sender", + Type = "string", + Value = Sender, + }); + types.Add(new OpenApiType() + { + Name = "status_code", + Property = "StatusCode", + Type = "string", + Value = StatusCode, + }); + types.Add(new OpenApiType() + { + Name = "sent_at", + Property = "SentAt", + Type = "int", + Value = SentAt, + }); + + return types; + } + } + +} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs new file mode 100644 index 000000000..e4d42e6d4 --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs @@ -0,0 +1,383 @@ +/* + * Dropbox Sign API + * + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// FaxSendRequest + /// + [DataContract(Name = "FaxSendRequest")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class FaxSendRequest : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected FaxSendRequest() { } + /// + /// Initializes a new instance of the class. + /// + /// Fax Send To Recipient (required). + /// Fax Send From Sender (used only with fax number). + /// Fax File to Send. + /// Fax File URL to Send. + /// API Test Mode Setting (default to false). + /// Fax Cover Page for Recipient. + /// Fax Cover Page for Sender. + /// Fax Cover Page Message. + /// Fax Title. + public FaxSendRequest(string recipient = default(string), string sender = default(string), List files = default(List), List fileUrls = default(List), bool testMode = false, string coverPageTo = default(string), string coverPageFrom = default(string), string coverPageMessage = default(string), string title = default(string)) + { + + // to ensure "recipient" is required (not null) + if (recipient == null) + { + throw new ArgumentNullException("recipient is a required property for FaxSendRequest and cannot be null"); + } + this.Recipient = recipient; + this.Sender = sender; + this.Files = files; + this.FileUrls = fileUrls; + this.TestMode = testMode; + this.CoverPageTo = coverPageTo; + this.CoverPageFrom = coverPageFrom; + this.CoverPageMessage = coverPageMessage; + this.Title = title; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static FaxSendRequest Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of FaxSendRequest"); + } + + return obj; + } + + /// + /// Fax Send To Recipient + /// + /// Fax Send To Recipient + /// recipient@example.com + [DataMember(Name = "recipient", IsRequired = true, EmitDefaultValue = true)] + public string Recipient { get; set; } + + /// + /// Fax Send From Sender (used only with fax number) + /// + /// Fax Send From Sender (used only with fax number) + /// sender@example.com + [DataMember(Name = "sender", EmitDefaultValue = true)] + public string Sender { get; set; } + + /// + /// Fax File to Send + /// + /// Fax File to Send + [DataMember(Name = "files", EmitDefaultValue = true)] + public List Files { get; set; } + + /// + /// Fax File URL to Send + /// + /// Fax File URL to Send + [DataMember(Name = "file_urls", EmitDefaultValue = true)] + public List FileUrls { get; set; } + + /// + /// API Test Mode Setting + /// + /// API Test Mode Setting + [DataMember(Name = "test_mode", EmitDefaultValue = true)] + public bool TestMode { get; set; } + + /// + /// Fax Cover Page for Recipient + /// + /// Fax Cover Page for Recipient + /// Recipient Name + [DataMember(Name = "cover_page_to", EmitDefaultValue = true)] + public string CoverPageTo { get; set; } + + /// + /// Fax Cover Page for Sender + /// + /// Fax Cover Page for Sender + /// Sender Name + [DataMember(Name = "cover_page_from", EmitDefaultValue = true)] + public string CoverPageFrom { get; set; } + + /// + /// Fax Cover Page Message + /// + /// Fax Cover Page Message + /// Please find the attached documents. + [DataMember(Name = "cover_page_message", EmitDefaultValue = true)] + public string CoverPageMessage { get; set; } + + /// + /// Fax Title + /// + /// Fax Title + /// Fax Title + [DataMember(Name = "title", EmitDefaultValue = true)] + public string Title { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class FaxSendRequest {\n"); + sb.Append(" Recipient: ").Append(Recipient).Append("\n"); + sb.Append(" Sender: ").Append(Sender).Append("\n"); + sb.Append(" Files: ").Append(Files).Append("\n"); + sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); + sb.Append(" TestMode: ").Append(TestMode).Append("\n"); + sb.Append(" CoverPageTo: ").Append(CoverPageTo).Append("\n"); + sb.Append(" CoverPageFrom: ").Append(CoverPageFrom).Append("\n"); + sb.Append(" CoverPageMessage: ").Append(CoverPageMessage).Append("\n"); + sb.Append(" Title: ").Append(Title).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as FaxSendRequest); + } + + /// + /// Returns true if FaxSendRequest instances are equal + /// + /// Instance of FaxSendRequest to be compared + /// Boolean + public bool Equals(FaxSendRequest input) + { + if (input == null) + { + return false; + } + return + ( + this.Recipient == input.Recipient || + (this.Recipient != null && + this.Recipient.Equals(input.Recipient)) + ) && + ( + this.Sender == input.Sender || + (this.Sender != null && + this.Sender.Equals(input.Sender)) + ) && + ( + this.Files == input.Files || + this.Files != null && + input.Files != null && + this.Files.SequenceEqual(input.Files) + ) && + ( + this.FileUrls == input.FileUrls || + this.FileUrls != null && + input.FileUrls != null && + this.FileUrls.SequenceEqual(input.FileUrls) + ) && + ( + this.TestMode == input.TestMode || + this.TestMode.Equals(input.TestMode) + ) && + ( + this.CoverPageTo == input.CoverPageTo || + (this.CoverPageTo != null && + this.CoverPageTo.Equals(input.CoverPageTo)) + ) && + ( + this.CoverPageFrom == input.CoverPageFrom || + (this.CoverPageFrom != null && + this.CoverPageFrom.Equals(input.CoverPageFrom)) + ) && + ( + this.CoverPageMessage == input.CoverPageMessage || + (this.CoverPageMessage != null && + this.CoverPageMessage.Equals(input.CoverPageMessage)) + ) && + ( + this.Title == input.Title || + (this.Title != null && + this.Title.Equals(input.Title)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Recipient != null) + { + hashCode = (hashCode * 59) + this.Recipient.GetHashCode(); + } + if (this.Sender != null) + { + hashCode = (hashCode * 59) + this.Sender.GetHashCode(); + } + if (this.Files != null) + { + hashCode = (hashCode * 59) + this.Files.GetHashCode(); + } + if (this.FileUrls != null) + { + hashCode = (hashCode * 59) + this.FileUrls.GetHashCode(); + } + hashCode = (hashCode * 59) + this.TestMode.GetHashCode(); + if (this.CoverPageTo != null) + { + hashCode = (hashCode * 59) + this.CoverPageTo.GetHashCode(); + } + if (this.CoverPageFrom != null) + { + hashCode = (hashCode * 59) + this.CoverPageFrom.GetHashCode(); + } + if (this.CoverPageMessage != null) + { + hashCode = (hashCode * 59) + this.CoverPageMessage.GetHashCode(); + } + if (this.Title != null) + { + hashCode = (hashCode * 59) + this.Title.GetHashCode(); + } + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType() + { + Name = "recipient", + Property = "Recipient", + Type = "string", + Value = Recipient, + }); + types.Add(new OpenApiType() + { + Name = "sender", + Property = "Sender", + Type = "string", + Value = Sender, + }); + types.Add(new OpenApiType() + { + Name = "files", + Property = "Files", + Type = "List", + Value = Files, + }); + types.Add(new OpenApiType() + { + Name = "file_urls", + Property = "FileUrls", + Type = "List", + Value = FileUrls, + }); + types.Add(new OpenApiType() + { + Name = "test_mode", + Property = "TestMode", + Type = "bool", + Value = TestMode, + }); + types.Add(new OpenApiType() + { + Name = "cover_page_to", + Property = "CoverPageTo", + Type = "string", + Value = CoverPageTo, + }); + types.Add(new OpenApiType() + { + Name = "cover_page_from", + Property = "CoverPageFrom", + Type = "string", + Value = CoverPageFrom, + }); + types.Add(new OpenApiType() + { + Name = "cover_page_message", + Property = "CoverPageMessage", + Type = "string", + Value = CoverPageMessage, + }); + types.Add(new OpenApiType() + { + Name = "title", + Property = "Title", + Type = "string", + Value = Title, + }); + + return types; + } + } + +} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubFile.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubFile.cs new file mode 100644 index 000000000..d17056299 --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubFile.cs @@ -0,0 +1,167 @@ +/* + * Dropbox Sign API + * + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// Actual uploaded physical file + /// + [DataContract(Name = "SubFile")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class SubFile : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected SubFile() { } + /// + /// Initializes a new instance of the class. + /// + /// Actual physical uploaded file name that is derived during upload. Not settable parameter. (default to ""). + public SubFile(string name = @"") + { + + // use default value if no "name" provided + this.Name = name ?? ""; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static SubFile Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of SubFile"); + } + + return obj; + } + + /// + /// Actual physical uploaded file name that is derived during upload. Not settable parameter. + /// + /// Actual physical uploaded file name that is derived during upload. Not settable parameter. + [DataMember(Name = "name", EmitDefaultValue = true)] + public string Name { get; set; } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class SubFile {\n"); + sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as SubFile); + } + + /// + /// Returns true if SubFile instances are equal + /// + /// Instance of SubFile to be compared + /// Boolean + public bool Equals(SubFile input) + { + if (input == null) + { + return false; + } + return + ( + this.Name == input.Name || + (this.Name != null && + this.Name.Equals(input.Name)) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Name != null) + { + hashCode = (hashCode * 59) + this.Name.GetHashCode(); + } + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType() + { + Name = "name", + Property = "Name", + Type = "string", + Value = Name, + }); + + return types; + } + } + +} diff --git a/sdks/java-v1/README.md b/sdks/java-v1/README.md index 8ef139fc2..5970dc30d 100644 --- a/sdks/java-v1/README.md +++ b/sdks/java-v1/README.md @@ -177,6 +177,11 @@ Class | Method | HTTP request | Description *BulkSendJobApi* | [**bulkSendJobList**](docs/BulkSendJobApi.md#bulkSendJobList) | **GET** /bulk_send_job/list | List Bulk Send Jobs *EmbeddedApi* | [**embeddedEditUrl**](docs/EmbeddedApi.md#embeddedEditUrl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL *EmbeddedApi* | [**embeddedSignUrl**](docs/EmbeddedApi.md#embeddedSignUrl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL +*FaxApi* | [**faxDelete**](docs/FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax +*FaxApi* | [**faxFiles**](docs/FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files +*FaxApi* | [**faxGet**](docs/FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax +*FaxApi* | [**faxList**](docs/FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes +*FaxApi* | [**faxSend**](docs/FaxApi.md#faxSend) | **POST** /fax/send | Send Fax *FaxLineApi* | [**faxLineAddUser**](docs/FaxLineApi.md#faxLineAddUser) | **PUT** /fax_line/add_user | Add Fax Line User *FaxLineApi* | [**faxLineAreaCodeGet**](docs/FaxLineApi.md#faxLineAreaCodeGet) | **GET** /fax_line/area_codes | Get Available Fax Line Area Codes *FaxLineApi* | [**faxLineCreate**](docs/FaxLineApi.md#faxLineCreate) | **POST** /fax_line/create | Purchase Fax Line @@ -266,6 +271,7 @@ Class | Method | HTTP request | Description - [EventCallbackRequest](docs/EventCallbackRequest.md) - [EventCallbackRequestEvent](docs/EventCallbackRequestEvent.md) - [EventCallbackRequestEventMetadata](docs/EventCallbackRequestEventMetadata.md) + - [FaxGetResponse](docs/FaxGetResponse.md) - [FaxLineAddUserRequest](docs/FaxLineAddUserRequest.md) - [FaxLineAreaCodeGetCountryEnum](docs/FaxLineAreaCodeGetCountryEnum.md) - [FaxLineAreaCodeGetProvinceEnum](docs/FaxLineAreaCodeGetProvinceEnum.md) @@ -277,6 +283,10 @@ Class | Method | HTTP request | Description - [FaxLineRemoveUserRequest](docs/FaxLineRemoveUserRequest.md) - [FaxLineResponse](docs/FaxLineResponse.md) - [FaxLineResponseFaxLine](docs/FaxLineResponseFaxLine.md) + - [FaxListResponse](docs/FaxListResponse.md) + - [FaxResponse](docs/FaxResponse.md) + - [FaxResponseTransmission](docs/FaxResponseTransmission.md) + - [FaxSendRequest](docs/FaxSendRequest.md) - [FileResponse](docs/FileResponse.md) - [FileResponseDataUri](docs/FileResponseDataUri.md) - [ListInfoResponse](docs/ListInfoResponse.md) diff --git a/sdks/java-v1/docs/FaxApi.md b/sdks/java-v1/docs/FaxApi.md new file mode 100644 index 000000000..a3d9baef9 --- /dev/null +++ b/sdks/java-v1/docs/FaxApi.md @@ -0,0 +1,364 @@ +# FaxApi + +All URIs are relative to *https://api.hellosign.com/v3* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +[**faxDelete**](FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax +[**faxFiles**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files +[**faxGet**](FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax +[**faxList**](FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes +[**faxSend**](FaxApi.md#faxSend) | **POST** /fax/send | Send Fax + + + +## faxDelete + +> faxDelete(faxId) + +Delete Fax + +Deletes the specified Fax from the system. + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.util.List; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + try { + faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + } catch (ApiException e) { + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **faxId** | **String**| Fax ID | + +### Return type + +null (empty response body) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + + +## faxFiles + +> File faxFiles(faxId) + +List Fax Files + +Returns list of fax files + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.io.File; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + + try { + File result = faxApi.faxFiles(faxId); + result.renameTo(new File("file_response.pdf"));; + } catch (ApiException e) { + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **faxId** | **String**| Fax ID | + +### Return type + +[**File**](File.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/pdf, application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + + +## faxGet + +> FaxGetResponse faxGet(faxId) + +Get Fax + +Returns information about fax + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + + try { + FaxGetResponse result = faxApi.faxGet(faxId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **faxId** | **String**| Fax ID | + +### Return type + +[**FaxGetResponse**](FaxGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + + +## faxList + +> FaxListResponse faxList(page, pageSize) + +Lists Faxes + +Returns properties of multiple faxes + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + var page = 1; + var pageSize = 2; + + try { + FaxListResponse result = faxApi.faxList(page, pageSize); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **page** | **Integer**| Page | [optional] [default to 1] + **pageSize** | **Integer**| Page size | [optional] [default to 20] + +### Return type + +[**FaxListResponse**](FaxListResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + + +## faxSend + +> FaxGetResponse faxSend(faxSendRequest) + +Send Fax + +Action to prepare and send a fax + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.util.List; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + + var data = new FaxSendRequest() + .addFilesItem(new File("example_fax.pdf")) + .testMode(true) + .recipient("16690000001") + .sender("16690000000") + .coverPageTo("Jill Fax") + .coverPageMessage("I'm sending you a fax!") + .coverPageFrom("Faxer Faxerson") + .title("This is what the fax is about!"); + + try { + FaxCreateResponse result = faxApi.faxSend(data); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **faxSendRequest** | [**FaxSendRequest**](FaxSendRequest.md)| | + +### Return type + +[**FaxGetResponse**](FaxGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: application/json, multipart/form-data +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + diff --git a/sdks/java-v1/docs/FaxGetResponse.md b/sdks/java-v1/docs/FaxGetResponse.md new file mode 100644 index 000000000..cc9dc6e57 --- /dev/null +++ b/sdks/java-v1/docs/FaxGetResponse.md @@ -0,0 +1,15 @@ + + +# FaxGetResponse + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `fax`*_required_ | [```FaxResponse```](FaxResponse.md) | | | +| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | + + + diff --git a/sdks/java-v1/docs/FaxListResponse.md b/sdks/java-v1/docs/FaxListResponse.md new file mode 100644 index 000000000..f25379a27 --- /dev/null +++ b/sdks/java-v1/docs/FaxListResponse.md @@ -0,0 +1,15 @@ + + +# FaxListResponse + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `faxes`*_required_ | [```List```](FaxResponse.md) | | | +| `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | + + + diff --git a/sdks/java-v1/docs/FaxResponse.md b/sdks/java-v1/docs/FaxResponse.md new file mode 100644 index 000000000..77ec7eb10 --- /dev/null +++ b/sdks/java-v1/docs/FaxResponse.md @@ -0,0 +1,23 @@ + + +# FaxResponse + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `faxId`*_required_ | ```String``` | Fax ID | | +| `title`*_required_ | ```String``` | Fax Title | | +| `originalTitle`*_required_ | ```String``` | Fax Original Title | | +| `subject`*_required_ | ```String``` | Fax Subject | | +| `message`*_required_ | ```String``` | Fax Message | | +| `metadata`*_required_ | ```Map``` | Fax Metadata | | +| `createdAt`*_required_ | ```Integer``` | Fax Created At Timestamp | | +| `sender`*_required_ | ```String``` | Fax Sender Email | | +| `transmissions`*_required_ | [```List```](FaxResponseTransmission.md) | Fax Transmissions List | | +| `filesUrl`*_required_ | ```String``` | Fax Files URL | | + + + diff --git a/sdks/java-v1/docs/FaxResponseTransmission.md b/sdks/java-v1/docs/FaxResponseTransmission.md new file mode 100644 index 000000000..09db223e9 --- /dev/null +++ b/sdks/java-v1/docs/FaxResponseTransmission.md @@ -0,0 +1,32 @@ + + +# FaxResponseTransmission + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `recipient`*_required_ | ```String``` | Fax Transmission Recipient | | +| `sender`*_required_ | ```String``` | Fax Transmission Sender | | +| `statusCode`*_required_ | [```StatusCodeEnum```](#StatusCodeEnum) | Fax Transmission Status Code | | +| `sentAt` | ```Integer``` | Fax Transmission Sent Timestamp | | + + + +## Enum: StatusCodeEnum + +| Name | Value | +---- | ----- +| SUCCESS | "success" | +| TRANSMITTING | "transmitting" | +| ERROR_COULD_NOT_FAX | "error_could_not_fax" | +| ERROR_UNKNOWN | "error_unknown" | +| ERROR_BUSY | "error_busy" | +| ERROR_NO_ANSWER | "error_no_answer" | +| ERROR_DISCONNECTED | "error_disconnected" | +| ERROR_BAD_DESTINATION | "error_bad_destination" | + + + diff --git a/sdks/java-v1/docs/FaxSendRequest.md b/sdks/java-v1/docs/FaxSendRequest.md new file mode 100644 index 000000000..5b939a0af --- /dev/null +++ b/sdks/java-v1/docs/FaxSendRequest.md @@ -0,0 +1,22 @@ + + +# FaxSendRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `recipient`*_required_ | ```String``` | Fax Send To Recipient | | +| `sender` | ```String``` | Fax Send From Sender (used only with fax number) | | +| `files` | ```List``` | Fax File to Send | | +| `fileUrls` | ```List``` | Fax File URL to Send | | +| `testMode` | ```Boolean``` | API Test Mode Setting | | +| `coverPageTo` | ```String``` | Fax Cover Page for Recipient | | +| `coverPageFrom` | ```String``` | Fax Cover Page for Sender | | +| `coverPageMessage` | ```String``` | Fax Cover Page Message | | +| `title` | ```String``` | Fax Title | | + + + diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java new file mode 100644 index 000000000..ce101cc84 --- /dev/null +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java @@ -0,0 +1,421 @@ +package com.dropbox.sign.api; + +import com.dropbox.sign.ApiClient; +import com.dropbox.sign.ApiException; +import com.dropbox.sign.ApiResponse; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.Pair; +import com.dropbox.sign.model.FaxGetResponse; +import com.dropbox.sign.model.FaxListResponse; +import com.dropbox.sign.model.FaxSendRequest; +import java.io.File; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import javax.ws.rs.core.GenericType; + +@javax.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.8.0") +public class FaxApi { + private ApiClient apiClient; + + public FaxApi() { + this(Configuration.getDefaultApiClient()); + } + + public FaxApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API client + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API client + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Delete Fax. Deletes the specified Fax from the system. + * + * @param faxId Fax ID (required) + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
204 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public void faxDelete(String faxId) throws ApiException { + faxDeleteWithHttpInfo(faxId); + } + + /** + * Delete Fax. Deletes the specified Fax from the system. + * + * @param faxId Fax ID (required) + * @return ApiResponse<Void> + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
204 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException { + + // Check required parameters + if (faxId == null) { + throw new ApiException( + 400, "Missing the required parameter 'faxId' when calling faxDelete"); + } + + // Path parameters + String localVarPath = + "/fax/{fax_id}".replaceAll("\\{fax_id}", apiClient.escapeString(faxId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = new HashMap(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = + isFileTypeFound ? "multipart/form-data" : apiClient.selectHeaderContentType(); + String[] localVarAuthNames = new String[] {"api_key"}; + return apiClient.invokeAPI( + "FaxApi.faxDelete", + localVarPath, + "DELETE", + new ArrayList<>(), + null, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + null, + false); + } + + /** + * List Fax Files. Returns list of fax files + * + * @param faxId Fax ID (required) + * @return File + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public File faxFiles(String faxId) throws ApiException { + return faxFilesWithHttpInfo(faxId).getData(); + } + + /** + * List Fax Files. Returns list of fax files + * + * @param faxId Fax ID (required) + * @return ApiResponse<File> + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse faxFilesWithHttpInfo(String faxId) throws ApiException { + + // Check required parameters + if (faxId == null) { + throw new ApiException( + 400, "Missing the required parameter 'faxId' when calling faxFiles"); + } + + // Path parameters + String localVarPath = + "/fax/files/{fax_id}" + .replaceAll("\\{fax_id}", apiClient.escapeString(faxId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/pdf", "application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = new HashMap(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = + isFileTypeFound ? "multipart/form-data" : apiClient.selectHeaderContentType(); + String[] localVarAuthNames = new String[] {"api_key"}; + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI( + "FaxApi.faxFiles", + localVarPath, + "GET", + new ArrayList<>(), + null, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false); + } + + /** + * Get Fax. Returns information about fax + * + * @param faxId Fax ID (required) + * @return FaxGetResponse + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public FaxGetResponse faxGet(String faxId) throws ApiException { + return faxGetWithHttpInfo(faxId).getData(); + } + + /** + * Get Fax. Returns information about fax + * + * @param faxId Fax ID (required) + * @return ApiResponse<FaxGetResponse> + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse faxGetWithHttpInfo(String faxId) throws ApiException { + + // Check required parameters + if (faxId == null) { + throw new ApiException( + 400, "Missing the required parameter 'faxId' when calling faxGet"); + } + + // Path parameters + String localVarPath = + "/fax/{fax_id}".replaceAll("\\{fax_id}", apiClient.escapeString(faxId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = new HashMap(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = + isFileTypeFound ? "multipart/form-data" : apiClient.selectHeaderContentType(); + String[] localVarAuthNames = new String[] {"api_key"}; + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI( + "FaxApi.faxGet", + localVarPath, + "GET", + new ArrayList<>(), + null, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false); + } + + /** + * Lists Faxes. Returns properties of multiple faxes + * + * @param page Page (optional, default to 1) + * @param pageSize Page size (optional, default to 20) + * @return FaxListResponse + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public FaxListResponse faxList(Integer page, Integer pageSize) throws ApiException { + return faxListWithHttpInfo(page, pageSize).getData(); + } + + /** + * @see FaxApi#faxList(Integer, Integer) + */ + public FaxListResponse faxList() throws ApiException { + Integer page = 1; + Integer pageSize = 20; + + return faxListWithHttpInfo(page, pageSize).getData(); + } + + /** + * @see FaxApi#faxListWithHttpInfo(Integer, Integer) + */ + public ApiResponse faxListWithHttpInfo() throws ApiException { + Integer page = 1; + Integer pageSize = 20; + + return faxListWithHttpInfo(page, pageSize); + } + + /** + * @see FaxApi#faxList(Integer, Integer) + */ + public FaxListResponse faxList(Integer page) throws ApiException { + Integer pageSize = 20; + + return faxListWithHttpInfo(page, pageSize).getData(); + } + + /** + * @see FaxApi#faxListWithHttpInfo(Integer, Integer) + */ + public ApiResponse faxListWithHttpInfo(Integer page) throws ApiException { + Integer pageSize = 20; + + return faxListWithHttpInfo(page, pageSize); + } + + /** + * Lists Faxes. Returns properties of multiple faxes + * + * @param page Page (optional, default to 1) + * @param pageSize Page size (optional, default to 20) + * @return ApiResponse<FaxListResponse> + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse faxListWithHttpInfo(Integer page, Integer pageSize) + throws ApiException { + + if (page == null) { + page = 1; + } + if (pageSize == null) { + pageSize = 20; + } + // Query parameters + List localVarQueryParams = + new ArrayList<>(apiClient.parameterToPairs("", "page", page)); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "page_size", pageSize)); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = new HashMap(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = + isFileTypeFound ? "multipart/form-data" : apiClient.selectHeaderContentType(); + String[] localVarAuthNames = new String[] {"api_key"}; + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI( + "FaxApi.faxList", + "/fax/list", + "GET", + localVarQueryParams, + null, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false); + } + + /** + * Send Fax. Action to prepare and send a fax + * + * @param faxSendRequest (required) + * @return FaxGetResponse + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public FaxGetResponse faxSend(FaxSendRequest faxSendRequest) throws ApiException { + return faxSendWithHttpInfo(faxSendRequest).getData(); + } + + /** + * Send Fax. Action to prepare and send a fax + * + * @param faxSendRequest (required) + * @return ApiResponse<FaxGetResponse> + * @throws ApiException if fails to make API call + * @http.response.details + * + * + * + * + *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse faxSendWithHttpInfo(FaxSendRequest faxSendRequest) + throws ApiException { + + // Check required parameters + if (faxSendRequest == null) { + throw new ApiException( + 400, "Missing the required parameter 'faxSendRequest' when calling faxSend"); + } + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = faxSendRequest.createFormData(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = + isFileTypeFound + ? "multipart/form-data" + : apiClient.selectHeaderContentType( + "application/json", "multipart/form-data"); + String[] localVarAuthNames = new String[] {"api_key"}; + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI( + "FaxApi.faxSend", + "/fax/send", + "POST", + new ArrayList<>(), + isFileTypeFound ? null : faxSendRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false); + } +} diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxGetResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxGetResponse.java new file mode 100644 index 000000000..c4f86dd50 --- /dev/null +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxGetResponse.java @@ -0,0 +1,221 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.dropbox.sign.model; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +/** FaxGetResponse */ +@JsonPropertyOrder({FaxGetResponse.JSON_PROPERTY_FAX, FaxGetResponse.JSON_PROPERTY_WARNINGS}) +@javax.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown = true) +public class FaxGetResponse { + public static final String JSON_PROPERTY_FAX = "fax"; + private FaxResponse fax; + + public static final String JSON_PROPERTY_WARNINGS = "warnings"; + private List warnings = null; + + public FaxGetResponse() {} + + /** + * Attempt to instantiate and hydrate a new instance of this class + * + * @param jsonData String of JSON data representing target object + */ + public static FaxGetResponse init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, FaxGetResponse.class); + } + + public static FaxGetResponse init(HashMap data) throws Exception { + return new ObjectMapper() + .readValue(new ObjectMapper().writeValueAsString(data), FaxGetResponse.class); + } + + public FaxGetResponse fax(FaxResponse fax) { + this.fax = fax; + return this; + } + + /** + * Get fax + * + * @return fax + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FAX) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public FaxResponse getFax() { + return fax; + } + + @JsonProperty(JSON_PROPERTY_FAX) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFax(FaxResponse fax) { + this.fax = fax; + } + + public FaxGetResponse warnings(List warnings) { + this.warnings = warnings; + return this; + } + + public FaxGetResponse addWarningsItem(WarningResponse warningsItem) { + if (this.warnings == null) { + this.warnings = new ArrayList<>(); + } + this.warnings.add(warningsItem); + return this; + } + + /** + * A list of warnings. + * + * @return warnings + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_WARNINGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getWarnings() { + return warnings; + } + + @JsonProperty(JSON_PROPERTY_WARNINGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setWarnings(List warnings) { + this.warnings = warnings; + } + + /** Return true if this FaxGetResponse object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FaxGetResponse faxGetResponse = (FaxGetResponse) o; + return Objects.equals(this.fax, faxGetResponse.fax) + && Objects.equals(this.warnings, faxGetResponse.warnings); + } + + @Override + public int hashCode() { + return Objects.hash(fax, warnings); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FaxGetResponse {\n"); + sb.append(" fax: ").append(toIndentedString(fax)).append("\n"); + sb.append(" warnings: ").append(toIndentedString(warnings)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (fax != null) { + if (isFileTypeOrListOfFiles(fax)) { + fileTypeFound = true; + } + + if (fax.getClass().equals(java.io.File.class) + || fax.getClass().equals(Integer.class) + || fax.getClass().equals(String.class) + || fax.getClass().isEnum()) { + map.put("fax", fax); + } else if (isListOfFile(fax)) { + for (int i = 0; i < getListSize(fax); i++) { + map.put("fax[" + i + "]", getFromList(fax, i)); + } + } else { + map.put("fax", JSON.getDefault().getMapper().writeValueAsString(fax)); + } + } + if (warnings != null) { + if (isFileTypeOrListOfFiles(warnings)) { + fileTypeFound = true; + } + + if (warnings.getClass().equals(java.io.File.class) + || warnings.getClass().equals(Integer.class) + || warnings.getClass().equals(String.class) + || warnings.getClass().isEnum()) { + map.put("warnings", warnings); + } else if (isListOfFile(warnings)) { + for (int i = 0; i < getListSize(warnings); i++) { + map.put("warnings[" + i + "]", getFromList(warnings, i)); + } + } else { + map.put("warnings", JSON.getDefault().getMapper().writeValueAsString(warnings)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List + && !isListEmpty(obj) + && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) + Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()) + .getMethod("get", int.class) + .invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxListResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxListResponse.java new file mode 100644 index 000000000..7da2189b9 --- /dev/null +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxListResponse.java @@ -0,0 +1,224 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.dropbox.sign.model; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +/** FaxListResponse */ +@JsonPropertyOrder({FaxListResponse.JSON_PROPERTY_FAXES, FaxListResponse.JSON_PROPERTY_LIST_INFO}) +@javax.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown = true) +public class FaxListResponse { + public static final String JSON_PROPERTY_FAXES = "faxes"; + private List faxes = new ArrayList<>(); + + public static final String JSON_PROPERTY_LIST_INFO = "list_info"; + private ListInfoResponse listInfo; + + public FaxListResponse() {} + + /** + * Attempt to instantiate and hydrate a new instance of this class + * + * @param jsonData String of JSON data representing target object + */ + public static FaxListResponse init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, FaxListResponse.class); + } + + public static FaxListResponse init(HashMap data) throws Exception { + return new ObjectMapper() + .readValue(new ObjectMapper().writeValueAsString(data), FaxListResponse.class); + } + + public FaxListResponse faxes(List faxes) { + this.faxes = faxes; + return this; + } + + public FaxListResponse addFaxesItem(FaxResponse faxesItem) { + if (this.faxes == null) { + this.faxes = new ArrayList<>(); + } + this.faxes.add(faxesItem); + return this; + } + + /** + * Get faxes + * + * @return faxes + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FAXES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getFaxes() { + return faxes; + } + + @JsonProperty(JSON_PROPERTY_FAXES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFaxes(List faxes) { + this.faxes = faxes; + } + + public FaxListResponse listInfo(ListInfoResponse listInfo) { + this.listInfo = listInfo; + return this; + } + + /** + * Get listInfo + * + * @return listInfo + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_LIST_INFO) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public ListInfoResponse getListInfo() { + return listInfo; + } + + @JsonProperty(JSON_PROPERTY_LIST_INFO) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setListInfo(ListInfoResponse listInfo) { + this.listInfo = listInfo; + } + + /** Return true if this FaxListResponse object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FaxListResponse faxListResponse = (FaxListResponse) o; + return Objects.equals(this.faxes, faxListResponse.faxes) + && Objects.equals(this.listInfo, faxListResponse.listInfo); + } + + @Override + public int hashCode() { + return Objects.hash(faxes, listInfo); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FaxListResponse {\n"); + sb.append(" faxes: ").append(toIndentedString(faxes)).append("\n"); + sb.append(" listInfo: ").append(toIndentedString(listInfo)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (faxes != null) { + if (isFileTypeOrListOfFiles(faxes)) { + fileTypeFound = true; + } + + if (faxes.getClass().equals(java.io.File.class) + || faxes.getClass().equals(Integer.class) + || faxes.getClass().equals(String.class) + || faxes.getClass().isEnum()) { + map.put("faxes", faxes); + } else if (isListOfFile(faxes)) { + for (int i = 0; i < getListSize(faxes); i++) { + map.put("faxes[" + i + "]", getFromList(faxes, i)); + } + } else { + map.put("faxes", JSON.getDefault().getMapper().writeValueAsString(faxes)); + } + } + if (listInfo != null) { + if (isFileTypeOrListOfFiles(listInfo)) { + fileTypeFound = true; + } + + if (listInfo.getClass().equals(java.io.File.class) + || listInfo.getClass().equals(Integer.class) + || listInfo.getClass().equals(String.class) + || listInfo.getClass().isEnum()) { + map.put("list_info", listInfo); + } else if (isListOfFile(listInfo)) { + for (int i = 0; i < getListSize(listInfo); i++) { + map.put("list_info[" + i + "]", getFromList(listInfo, i)); + } + } else { + map.put( + "list_info", + JSON.getDefault().getMapper().writeValueAsString(listInfo)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List + && !isListEmpty(obj) + && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) + Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()) + .getMethod("get", int.class) + .invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxResponse.java new file mode 100644 index 000000000..bbe2dcde4 --- /dev/null +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxResponse.java @@ -0,0 +1,627 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.dropbox.sign.model; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +/** FaxResponse */ +@JsonPropertyOrder({ + FaxResponse.JSON_PROPERTY_FAX_ID, + FaxResponse.JSON_PROPERTY_TITLE, + FaxResponse.JSON_PROPERTY_ORIGINAL_TITLE, + FaxResponse.JSON_PROPERTY_SUBJECT, + FaxResponse.JSON_PROPERTY_MESSAGE, + FaxResponse.JSON_PROPERTY_METADATA, + FaxResponse.JSON_PROPERTY_CREATED_AT, + FaxResponse.JSON_PROPERTY_SENDER, + FaxResponse.JSON_PROPERTY_TRANSMISSIONS, + FaxResponse.JSON_PROPERTY_FILES_URL +}) +@javax.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown = true) +public class FaxResponse { + public static final String JSON_PROPERTY_FAX_ID = "fax_id"; + private String faxId; + + public static final String JSON_PROPERTY_TITLE = "title"; + private String title; + + public static final String JSON_PROPERTY_ORIGINAL_TITLE = "original_title"; + private String originalTitle; + + public static final String JSON_PROPERTY_SUBJECT = "subject"; + private String subject; + + public static final String JSON_PROPERTY_MESSAGE = "message"; + private String message; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + private Map metadata = new HashMap<>(); + + public static final String JSON_PROPERTY_CREATED_AT = "created_at"; + private Integer createdAt; + + public static final String JSON_PROPERTY_SENDER = "sender"; + private String sender; + + public static final String JSON_PROPERTY_TRANSMISSIONS = "transmissions"; + private List transmissions = new ArrayList<>(); + + public static final String JSON_PROPERTY_FILES_URL = "files_url"; + private String filesUrl; + + public FaxResponse() {} + + /** + * Attempt to instantiate and hydrate a new instance of this class + * + * @param jsonData String of JSON data representing target object + */ + public static FaxResponse init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, FaxResponse.class); + } + + public static FaxResponse init(HashMap data) throws Exception { + return new ObjectMapper() + .readValue(new ObjectMapper().writeValueAsString(data), FaxResponse.class); + } + + public FaxResponse faxId(String faxId) { + this.faxId = faxId; + return this; + } + + /** + * Fax ID + * + * @return faxId + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FAX_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getFaxId() { + return faxId; + } + + @JsonProperty(JSON_PROPERTY_FAX_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFaxId(String faxId) { + this.faxId = faxId; + } + + public FaxResponse title(String title) { + this.title = title; + return this; + } + + /** + * Fax Title + * + * @return title + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getTitle() { + return title; + } + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setTitle(String title) { + this.title = title; + } + + public FaxResponse originalTitle(String originalTitle) { + this.originalTitle = originalTitle; + return this; + } + + /** + * Fax Original Title + * + * @return originalTitle + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ORIGINAL_TITLE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getOriginalTitle() { + return originalTitle; + } + + @JsonProperty(JSON_PROPERTY_ORIGINAL_TITLE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setOriginalTitle(String originalTitle) { + this.originalTitle = originalTitle; + } + + public FaxResponse subject(String subject) { + this.subject = subject; + return this; + } + + /** + * Fax Subject + * + * @return subject + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getSubject() { + return subject; + } + + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSubject(String subject) { + this.subject = subject; + } + + public FaxResponse message(String message) { + this.message = message; + return this; + } + + /** + * Fax Message + * + * @return message + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getMessage() { + return message; + } + + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setMessage(String message) { + this.message = message; + } + + public FaxResponse metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public FaxResponse putMetadataItem(String key, Object metadataItem) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Fax Metadata + * + * @return metadata + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.ALWAYS) + public Map getMetadata() { + return metadata; + } + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.ALWAYS) + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + + public FaxResponse createdAt(Integer createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + * Fax Created At Timestamp + * + * @return createdAt + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CREATED_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public Integer getCreatedAt() { + return createdAt; + } + + @JsonProperty(JSON_PROPERTY_CREATED_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setCreatedAt(Integer createdAt) { + this.createdAt = createdAt; + } + + public FaxResponse sender(String sender) { + this.sender = sender; + return this; + } + + /** + * Fax Sender Email + * + * @return sender + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SENDER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getSender() { + return sender; + } + + @JsonProperty(JSON_PROPERTY_SENDER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSender(String sender) { + this.sender = sender; + } + + public FaxResponse transmissions(List transmissions) { + this.transmissions = transmissions; + return this; + } + + public FaxResponse addTransmissionsItem(FaxResponseTransmission transmissionsItem) { + if (this.transmissions == null) { + this.transmissions = new ArrayList<>(); + } + this.transmissions.add(transmissionsItem); + return this; + } + + /** + * Fax Transmissions List + * + * @return transmissions + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TRANSMISSIONS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getTransmissions() { + return transmissions; + } + + @JsonProperty(JSON_PROPERTY_TRANSMISSIONS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setTransmissions(List transmissions) { + this.transmissions = transmissions; + } + + public FaxResponse filesUrl(String filesUrl) { + this.filesUrl = filesUrl; + return this; + } + + /** + * Fax Files URL + * + * @return filesUrl + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FILES_URL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getFilesUrl() { + return filesUrl; + } + + @JsonProperty(JSON_PROPERTY_FILES_URL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFilesUrl(String filesUrl) { + this.filesUrl = filesUrl; + } + + /** Return true if this FaxResponse object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FaxResponse faxResponse = (FaxResponse) o; + return Objects.equals(this.faxId, faxResponse.faxId) + && Objects.equals(this.title, faxResponse.title) + && Objects.equals(this.originalTitle, faxResponse.originalTitle) + && Objects.equals(this.subject, faxResponse.subject) + && Objects.equals(this.message, faxResponse.message) + && Objects.equals(this.metadata, faxResponse.metadata) + && Objects.equals(this.createdAt, faxResponse.createdAt) + && Objects.equals(this.sender, faxResponse.sender) + && Objects.equals(this.transmissions, faxResponse.transmissions) + && Objects.equals(this.filesUrl, faxResponse.filesUrl); + } + + @Override + public int hashCode() { + return Objects.hash( + faxId, + title, + originalTitle, + subject, + message, + metadata, + createdAt, + sender, + transmissions, + filesUrl); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FaxResponse {\n"); + sb.append(" faxId: ").append(toIndentedString(faxId)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" originalTitle: ").append(toIndentedString(originalTitle)).append("\n"); + sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n"); + sb.append(" sender: ").append(toIndentedString(sender)).append("\n"); + sb.append(" transmissions: ").append(toIndentedString(transmissions)).append("\n"); + sb.append(" filesUrl: ").append(toIndentedString(filesUrl)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (faxId != null) { + if (isFileTypeOrListOfFiles(faxId)) { + fileTypeFound = true; + } + + if (faxId.getClass().equals(java.io.File.class) + || faxId.getClass().equals(Integer.class) + || faxId.getClass().equals(String.class) + || faxId.getClass().isEnum()) { + map.put("fax_id", faxId); + } else if (isListOfFile(faxId)) { + for (int i = 0; i < getListSize(faxId); i++) { + map.put("fax_id[" + i + "]", getFromList(faxId, i)); + } + } else { + map.put("fax_id", JSON.getDefault().getMapper().writeValueAsString(faxId)); + } + } + if (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) + || title.getClass().equals(Integer.class) + || title.getClass().equals(String.class) + || title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for (int i = 0; i < getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + if (originalTitle != null) { + if (isFileTypeOrListOfFiles(originalTitle)) { + fileTypeFound = true; + } + + if (originalTitle.getClass().equals(java.io.File.class) + || originalTitle.getClass().equals(Integer.class) + || originalTitle.getClass().equals(String.class) + || originalTitle.getClass().isEnum()) { + map.put("original_title", originalTitle); + } else if (isListOfFile(originalTitle)) { + for (int i = 0; i < getListSize(originalTitle); i++) { + map.put("original_title[" + i + "]", getFromList(originalTitle, i)); + } + } else { + map.put( + "original_title", + JSON.getDefault().getMapper().writeValueAsString(originalTitle)); + } + } + if (subject != null) { + if (isFileTypeOrListOfFiles(subject)) { + fileTypeFound = true; + } + + if (subject.getClass().equals(java.io.File.class) + || subject.getClass().equals(Integer.class) + || subject.getClass().equals(String.class) + || subject.getClass().isEnum()) { + map.put("subject", subject); + } else if (isListOfFile(subject)) { + for (int i = 0; i < getListSize(subject); i++) { + map.put("subject[" + i + "]", getFromList(subject, i)); + } + } else { + map.put("subject", JSON.getDefault().getMapper().writeValueAsString(subject)); + } + } + if (message != null) { + if (isFileTypeOrListOfFiles(message)) { + fileTypeFound = true; + } + + if (message.getClass().equals(java.io.File.class) + || message.getClass().equals(Integer.class) + || message.getClass().equals(String.class) + || message.getClass().isEnum()) { + map.put("message", message); + } else if (isListOfFile(message)) { + for (int i = 0; i < getListSize(message); i++) { + map.put("message[" + i + "]", getFromList(message, i)); + } + } else { + map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); + } + } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) + || metadata.getClass().equals(Integer.class) + || metadata.getClass().equals(String.class) + || metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for (int i = 0; i < getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (createdAt != null) { + if (isFileTypeOrListOfFiles(createdAt)) { + fileTypeFound = true; + } + + if (createdAt.getClass().equals(java.io.File.class) + || createdAt.getClass().equals(Integer.class) + || createdAt.getClass().equals(String.class) + || createdAt.getClass().isEnum()) { + map.put("created_at", createdAt); + } else if (isListOfFile(createdAt)) { + for (int i = 0; i < getListSize(createdAt); i++) { + map.put("created_at[" + i + "]", getFromList(createdAt, i)); + } + } else { + map.put( + "created_at", + JSON.getDefault().getMapper().writeValueAsString(createdAt)); + } + } + if (sender != null) { + if (isFileTypeOrListOfFiles(sender)) { + fileTypeFound = true; + } + + if (sender.getClass().equals(java.io.File.class) + || sender.getClass().equals(Integer.class) + || sender.getClass().equals(String.class) + || sender.getClass().isEnum()) { + map.put("sender", sender); + } else if (isListOfFile(sender)) { + for (int i = 0; i < getListSize(sender); i++) { + map.put("sender[" + i + "]", getFromList(sender, i)); + } + } else { + map.put("sender", JSON.getDefault().getMapper().writeValueAsString(sender)); + } + } + if (transmissions != null) { + if (isFileTypeOrListOfFiles(transmissions)) { + fileTypeFound = true; + } + + if (transmissions.getClass().equals(java.io.File.class) + || transmissions.getClass().equals(Integer.class) + || transmissions.getClass().equals(String.class) + || transmissions.getClass().isEnum()) { + map.put("transmissions", transmissions); + } else if (isListOfFile(transmissions)) { + for (int i = 0; i < getListSize(transmissions); i++) { + map.put("transmissions[" + i + "]", getFromList(transmissions, i)); + } + } else { + map.put( + "transmissions", + JSON.getDefault().getMapper().writeValueAsString(transmissions)); + } + } + if (filesUrl != null) { + if (isFileTypeOrListOfFiles(filesUrl)) { + fileTypeFound = true; + } + + if (filesUrl.getClass().equals(java.io.File.class) + || filesUrl.getClass().equals(Integer.class) + || filesUrl.getClass().equals(String.class) + || filesUrl.getClass().isEnum()) { + map.put("files_url", filesUrl); + } else if (isListOfFile(filesUrl)) { + for (int i = 0; i < getListSize(filesUrl); i++) { + map.put("files_url[" + i + "]", getFromList(filesUrl, i)); + } + } else { + map.put( + "files_url", + JSON.getDefault().getMapper().writeValueAsString(filesUrl)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List + && !isListEmpty(obj) + && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) + Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()) + .getMethod("get", int.class) + .invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxResponseTransmission.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxResponseTransmission.java new file mode 100644 index 000000000..8ab92887f --- /dev/null +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxResponseTransmission.java @@ -0,0 +1,360 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.dropbox.sign.model; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +/** FaxResponseTransmission */ +@JsonPropertyOrder({ + FaxResponseTransmission.JSON_PROPERTY_RECIPIENT, + FaxResponseTransmission.JSON_PROPERTY_SENDER, + FaxResponseTransmission.JSON_PROPERTY_STATUS_CODE, + FaxResponseTransmission.JSON_PROPERTY_SENT_AT +}) +@javax.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown = true) +public class FaxResponseTransmission { + public static final String JSON_PROPERTY_RECIPIENT = "recipient"; + private String recipient; + + public static final String JSON_PROPERTY_SENDER = "sender"; + private String sender; + + /** Fax Transmission Status Code */ + public enum StatusCodeEnum { + SUCCESS("success"), + + TRANSMITTING("transmitting"), + + ERROR_COULD_NOT_FAX("error_could_not_fax"), + + ERROR_UNKNOWN("error_unknown"), + + ERROR_BUSY("error_busy"), + + ERROR_NO_ANSWER("error_no_answer"), + + ERROR_DISCONNECTED("error_disconnected"), + + ERROR_BAD_DESTINATION("error_bad_destination"); + + private String value; + + StatusCodeEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static StatusCodeEnum fromValue(String value) { + for (StatusCodeEnum b : StatusCodeEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_STATUS_CODE = "status_code"; + private StatusCodeEnum statusCode; + + public static final String JSON_PROPERTY_SENT_AT = "sent_at"; + private Integer sentAt; + + public FaxResponseTransmission() {} + + /** + * Attempt to instantiate and hydrate a new instance of this class + * + * @param jsonData String of JSON data representing target object + */ + public static FaxResponseTransmission init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, FaxResponseTransmission.class); + } + + public static FaxResponseTransmission init(HashMap data) throws Exception { + return new ObjectMapper() + .readValue( + new ObjectMapper().writeValueAsString(data), FaxResponseTransmission.class); + } + + public FaxResponseTransmission recipient(String recipient) { + this.recipient = recipient; + return this; + } + + /** + * Fax Transmission Recipient + * + * @return recipient + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_RECIPIENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getRecipient() { + return recipient; + } + + @JsonProperty(JSON_PROPERTY_RECIPIENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setRecipient(String recipient) { + this.recipient = recipient; + } + + public FaxResponseTransmission sender(String sender) { + this.sender = sender; + return this; + } + + /** + * Fax Transmission Sender + * + * @return sender + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SENDER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getSender() { + return sender; + } + + @JsonProperty(JSON_PROPERTY_SENDER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSender(String sender) { + this.sender = sender; + } + + public FaxResponseTransmission statusCode(StatusCodeEnum statusCode) { + this.statusCode = statusCode; + return this; + } + + /** + * Fax Transmission Status Code + * + * @return statusCode + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_STATUS_CODE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public StatusCodeEnum getStatusCode() { + return statusCode; + } + + @JsonProperty(JSON_PROPERTY_STATUS_CODE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setStatusCode(StatusCodeEnum statusCode) { + this.statusCode = statusCode; + } + + public FaxResponseTransmission sentAt(Integer sentAt) { + this.sentAt = sentAt; + return this; + } + + /** + * Fax Transmission Sent Timestamp + * + * @return sentAt + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SENT_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Integer getSentAt() { + return sentAt; + } + + @JsonProperty(JSON_PROPERTY_SENT_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSentAt(Integer sentAt) { + this.sentAt = sentAt; + } + + /** Return true if this FaxResponseTransmission object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FaxResponseTransmission faxResponseTransmission = (FaxResponseTransmission) o; + return Objects.equals(this.recipient, faxResponseTransmission.recipient) + && Objects.equals(this.sender, faxResponseTransmission.sender) + && Objects.equals(this.statusCode, faxResponseTransmission.statusCode) + && Objects.equals(this.sentAt, faxResponseTransmission.sentAt); + } + + @Override + public int hashCode() { + return Objects.hash(recipient, sender, statusCode, sentAt); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FaxResponseTransmission {\n"); + sb.append(" recipient: ").append(toIndentedString(recipient)).append("\n"); + sb.append(" sender: ").append(toIndentedString(sender)).append("\n"); + sb.append(" statusCode: ").append(toIndentedString(statusCode)).append("\n"); + sb.append(" sentAt: ").append(toIndentedString(sentAt)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (recipient != null) { + if (isFileTypeOrListOfFiles(recipient)) { + fileTypeFound = true; + } + + if (recipient.getClass().equals(java.io.File.class) + || recipient.getClass().equals(Integer.class) + || recipient.getClass().equals(String.class) + || recipient.getClass().isEnum()) { + map.put("recipient", recipient); + } else if (isListOfFile(recipient)) { + for (int i = 0; i < getListSize(recipient); i++) { + map.put("recipient[" + i + "]", getFromList(recipient, i)); + } + } else { + map.put( + "recipient", + JSON.getDefault().getMapper().writeValueAsString(recipient)); + } + } + if (sender != null) { + if (isFileTypeOrListOfFiles(sender)) { + fileTypeFound = true; + } + + if (sender.getClass().equals(java.io.File.class) + || sender.getClass().equals(Integer.class) + || sender.getClass().equals(String.class) + || sender.getClass().isEnum()) { + map.put("sender", sender); + } else if (isListOfFile(sender)) { + for (int i = 0; i < getListSize(sender); i++) { + map.put("sender[" + i + "]", getFromList(sender, i)); + } + } else { + map.put("sender", JSON.getDefault().getMapper().writeValueAsString(sender)); + } + } + if (statusCode != null) { + if (isFileTypeOrListOfFiles(statusCode)) { + fileTypeFound = true; + } + + if (statusCode.getClass().equals(java.io.File.class) + || statusCode.getClass().equals(Integer.class) + || statusCode.getClass().equals(String.class) + || statusCode.getClass().isEnum()) { + map.put("status_code", statusCode); + } else if (isListOfFile(statusCode)) { + for (int i = 0; i < getListSize(statusCode); i++) { + map.put("status_code[" + i + "]", getFromList(statusCode, i)); + } + } else { + map.put( + "status_code", + JSON.getDefault().getMapper().writeValueAsString(statusCode)); + } + } + if (sentAt != null) { + if (isFileTypeOrListOfFiles(sentAt)) { + fileTypeFound = true; + } + + if (sentAt.getClass().equals(java.io.File.class) + || sentAt.getClass().equals(Integer.class) + || sentAt.getClass().equals(String.class) + || sentAt.getClass().isEnum()) { + map.put("sent_at", sentAt); + } else if (isListOfFile(sentAt)) { + for (int i = 0; i < getListSize(sentAt); i++) { + map.put("sent_at[" + i + "]", getFromList(sentAt, i)); + } + } else { + map.put("sent_at", JSON.getDefault().getMapper().writeValueAsString(sentAt)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List + && !isListEmpty(obj) + && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) + Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()) + .getMethod("get", int.class) + .invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java new file mode 100644 index 000000000..571ba92f8 --- /dev/null +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java @@ -0,0 +1,576 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.dropbox.sign.model; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.io.File; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +/** FaxSendRequest */ +@JsonPropertyOrder({ + FaxSendRequest.JSON_PROPERTY_RECIPIENT, + FaxSendRequest.JSON_PROPERTY_SENDER, + FaxSendRequest.JSON_PROPERTY_FILES, + FaxSendRequest.JSON_PROPERTY_FILE_URLS, + FaxSendRequest.JSON_PROPERTY_TEST_MODE, + FaxSendRequest.JSON_PROPERTY_COVER_PAGE_TO, + FaxSendRequest.JSON_PROPERTY_COVER_PAGE_FROM, + FaxSendRequest.JSON_PROPERTY_COVER_PAGE_MESSAGE, + FaxSendRequest.JSON_PROPERTY_TITLE +}) +@javax.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown = true) +public class FaxSendRequest { + public static final String JSON_PROPERTY_RECIPIENT = "recipient"; + private String recipient; + + public static final String JSON_PROPERTY_SENDER = "sender"; + private String sender; + + public static final String JSON_PROPERTY_FILES = "files"; + private List files = null; + + public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + private List fileUrls = null; + + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + private Boolean testMode = false; + + public static final String JSON_PROPERTY_COVER_PAGE_TO = "cover_page_to"; + private String coverPageTo; + + public static final String JSON_PROPERTY_COVER_PAGE_FROM = "cover_page_from"; + private String coverPageFrom; + + public static final String JSON_PROPERTY_COVER_PAGE_MESSAGE = "cover_page_message"; + private String coverPageMessage; + + public static final String JSON_PROPERTY_TITLE = "title"; + private String title; + + public FaxSendRequest() {} + + /** + * Attempt to instantiate and hydrate a new instance of this class + * + * @param jsonData String of JSON data representing target object + */ + public static FaxSendRequest init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, FaxSendRequest.class); + } + + public static FaxSendRequest init(HashMap data) throws Exception { + return new ObjectMapper() + .readValue(new ObjectMapper().writeValueAsString(data), FaxSendRequest.class); + } + + public FaxSendRequest recipient(String recipient) { + this.recipient = recipient; + return this; + } + + /** + * Fax Send To Recipient + * + * @return recipient + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_RECIPIENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getRecipient() { + return recipient; + } + + @JsonProperty(JSON_PROPERTY_RECIPIENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setRecipient(String recipient) { + this.recipient = recipient; + } + + public FaxSendRequest sender(String sender) { + this.sender = sender; + return this; + } + + /** + * Fax Send From Sender (used only with fax number) + * + * @return sender + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SENDER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getSender() { + return sender; + } + + @JsonProperty(JSON_PROPERTY_SENDER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSender(String sender) { + this.sender = sender; + } + + public FaxSendRequest files(List files) { + this.files = files; + return this; + } + + public FaxSendRequest addFilesItem(File filesItem) { + if (this.files == null) { + this.files = new ArrayList<>(); + } + this.files.add(filesItem); + return this; + } + + /** + * Fax File to Send + * + * @return files + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFiles() { + return files; + } + + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFiles(List files) { + this.files = files; + } + + public FaxSendRequest fileUrls(List fileUrls) { + this.fileUrls = fileUrls; + return this; + } + + public FaxSendRequest addFileUrlsItem(String fileUrlsItem) { + if (this.fileUrls == null) { + this.fileUrls = new ArrayList<>(); + } + this.fileUrls.add(fileUrlsItem); + return this; + } + + /** + * Fax File URL to Send + * + * @return fileUrls + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public List getFileUrls() { + return fileUrls; + } + + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrls(List fileUrls) { + this.fileUrls = fileUrls; + } + + public FaxSendRequest testMode(Boolean testMode) { + this.testMode = testMode; + return this; + } + + /** + * API Test Mode Setting + * + * @return testMode + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getTestMode() { + return testMode; + } + + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTestMode(Boolean testMode) { + this.testMode = testMode; + } + + public FaxSendRequest coverPageTo(String coverPageTo) { + this.coverPageTo = coverPageTo; + return this; + } + + /** + * Fax Cover Page for Recipient + * + * @return coverPageTo + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_COVER_PAGE_TO) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getCoverPageTo() { + return coverPageTo; + } + + @JsonProperty(JSON_PROPERTY_COVER_PAGE_TO) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCoverPageTo(String coverPageTo) { + this.coverPageTo = coverPageTo; + } + + public FaxSendRequest coverPageFrom(String coverPageFrom) { + this.coverPageFrom = coverPageFrom; + return this; + } + + /** + * Fax Cover Page for Sender + * + * @return coverPageFrom + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_COVER_PAGE_FROM) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getCoverPageFrom() { + return coverPageFrom; + } + + @JsonProperty(JSON_PROPERTY_COVER_PAGE_FROM) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCoverPageFrom(String coverPageFrom) { + this.coverPageFrom = coverPageFrom; + } + + public FaxSendRequest coverPageMessage(String coverPageMessage) { + this.coverPageMessage = coverPageMessage; + return this; + } + + /** + * Fax Cover Page Message + * + * @return coverPageMessage + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_COVER_PAGE_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getCoverPageMessage() { + return coverPageMessage; + } + + @JsonProperty(JSON_PROPERTY_COVER_PAGE_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCoverPageMessage(String coverPageMessage) { + this.coverPageMessage = coverPageMessage; + } + + public FaxSendRequest title(String title) { + this.title = title; + return this; + } + + /** + * Fax Title + * + * @return title + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getTitle() { + return title; + } + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTitle(String title) { + this.title = title; + } + + /** Return true if this FaxSendRequest object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FaxSendRequest faxSendRequest = (FaxSendRequest) o; + return Objects.equals(this.recipient, faxSendRequest.recipient) + && Objects.equals(this.sender, faxSendRequest.sender) + && Objects.equals(this.files, faxSendRequest.files) + && Objects.equals(this.fileUrls, faxSendRequest.fileUrls) + && Objects.equals(this.testMode, faxSendRequest.testMode) + && Objects.equals(this.coverPageTo, faxSendRequest.coverPageTo) + && Objects.equals(this.coverPageFrom, faxSendRequest.coverPageFrom) + && Objects.equals(this.coverPageMessage, faxSendRequest.coverPageMessage) + && Objects.equals(this.title, faxSendRequest.title); + } + + @Override + public int hashCode() { + return Objects.hash( + recipient, + sender, + files, + fileUrls, + testMode, + coverPageTo, + coverPageFrom, + coverPageMessage, + title); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FaxSendRequest {\n"); + sb.append(" recipient: ").append(toIndentedString(recipient)).append("\n"); + sb.append(" sender: ").append(toIndentedString(sender)).append("\n"); + sb.append(" files: ").append(toIndentedString(files)).append("\n"); + sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); + sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); + sb.append(" coverPageTo: ").append(toIndentedString(coverPageTo)).append("\n"); + sb.append(" coverPageFrom: ").append(toIndentedString(coverPageFrom)).append("\n"); + sb.append(" coverPageMessage: ").append(toIndentedString(coverPageMessage)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (recipient != null) { + if (isFileTypeOrListOfFiles(recipient)) { + fileTypeFound = true; + } + + if (recipient.getClass().equals(java.io.File.class) + || recipient.getClass().equals(Integer.class) + || recipient.getClass().equals(String.class) + || recipient.getClass().isEnum()) { + map.put("recipient", recipient); + } else if (isListOfFile(recipient)) { + for (int i = 0; i < getListSize(recipient); i++) { + map.put("recipient[" + i + "]", getFromList(recipient, i)); + } + } else { + map.put( + "recipient", + JSON.getDefault().getMapper().writeValueAsString(recipient)); + } + } + if (sender != null) { + if (isFileTypeOrListOfFiles(sender)) { + fileTypeFound = true; + } + + if (sender.getClass().equals(java.io.File.class) + || sender.getClass().equals(Integer.class) + || sender.getClass().equals(String.class) + || sender.getClass().isEnum()) { + map.put("sender", sender); + } else if (isListOfFile(sender)) { + for (int i = 0; i < getListSize(sender); i++) { + map.put("sender[" + i + "]", getFromList(sender, i)); + } + } else { + map.put("sender", JSON.getDefault().getMapper().writeValueAsString(sender)); + } + } + if (files != null) { + if (isFileTypeOrListOfFiles(files)) { + fileTypeFound = true; + } + + if (files.getClass().equals(java.io.File.class) + || files.getClass().equals(Integer.class) + || files.getClass().equals(String.class) + || files.getClass().isEnum()) { + map.put("files", files); + } else if (isListOfFile(files)) { + for (int i = 0; i < getListSize(files); i++) { + map.put("files[" + i + "]", getFromList(files, i)); + } + } else { + map.put("files", JSON.getDefault().getMapper().writeValueAsString(files)); + } + } + if (fileUrls != null) { + if (isFileTypeOrListOfFiles(fileUrls)) { + fileTypeFound = true; + } + + if (fileUrls.getClass().equals(java.io.File.class) + || fileUrls.getClass().equals(Integer.class) + || fileUrls.getClass().equals(String.class) + || fileUrls.getClass().isEnum()) { + map.put("file_urls", fileUrls); + } else if (isListOfFile(fileUrls)) { + for (int i = 0; i < getListSize(fileUrls); i++) { + map.put("file_urls[" + i + "]", getFromList(fileUrls, i)); + } + } else { + map.put( + "file_urls", + JSON.getDefault().getMapper().writeValueAsString(fileUrls)); + } + } + if (testMode != null) { + if (isFileTypeOrListOfFiles(testMode)) { + fileTypeFound = true; + } + + if (testMode.getClass().equals(java.io.File.class) + || testMode.getClass().equals(Integer.class) + || testMode.getClass().equals(String.class) + || testMode.getClass().isEnum()) { + map.put("test_mode", testMode); + } else if (isListOfFile(testMode)) { + for (int i = 0; i < getListSize(testMode); i++) { + map.put("test_mode[" + i + "]", getFromList(testMode, i)); + } + } else { + map.put( + "test_mode", + JSON.getDefault().getMapper().writeValueAsString(testMode)); + } + } + if (coverPageTo != null) { + if (isFileTypeOrListOfFiles(coverPageTo)) { + fileTypeFound = true; + } + + if (coverPageTo.getClass().equals(java.io.File.class) + || coverPageTo.getClass().equals(Integer.class) + || coverPageTo.getClass().equals(String.class) + || coverPageTo.getClass().isEnum()) { + map.put("cover_page_to", coverPageTo); + } else if (isListOfFile(coverPageTo)) { + for (int i = 0; i < getListSize(coverPageTo); i++) { + map.put("cover_page_to[" + i + "]", getFromList(coverPageTo, i)); + } + } else { + map.put( + "cover_page_to", + JSON.getDefault().getMapper().writeValueAsString(coverPageTo)); + } + } + if (coverPageFrom != null) { + if (isFileTypeOrListOfFiles(coverPageFrom)) { + fileTypeFound = true; + } + + if (coverPageFrom.getClass().equals(java.io.File.class) + || coverPageFrom.getClass().equals(Integer.class) + || coverPageFrom.getClass().equals(String.class) + || coverPageFrom.getClass().isEnum()) { + map.put("cover_page_from", coverPageFrom); + } else if (isListOfFile(coverPageFrom)) { + for (int i = 0; i < getListSize(coverPageFrom); i++) { + map.put("cover_page_from[" + i + "]", getFromList(coverPageFrom, i)); + } + } else { + map.put( + "cover_page_from", + JSON.getDefault().getMapper().writeValueAsString(coverPageFrom)); + } + } + if (coverPageMessage != null) { + if (isFileTypeOrListOfFiles(coverPageMessage)) { + fileTypeFound = true; + } + + if (coverPageMessage.getClass().equals(java.io.File.class) + || coverPageMessage.getClass().equals(Integer.class) + || coverPageMessage.getClass().equals(String.class) + || coverPageMessage.getClass().isEnum()) { + map.put("cover_page_message", coverPageMessage); + } else if (isListOfFile(coverPageMessage)) { + for (int i = 0; i < getListSize(coverPageMessage); i++) { + map.put("cover_page_message[" + i + "]", getFromList(coverPageMessage, i)); + } + } else { + map.put( + "cover_page_message", + JSON.getDefault().getMapper().writeValueAsString(coverPageMessage)); + } + } + if (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) + || title.getClass().equals(Integer.class) + || title.getClass().equals(String.class) + || title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for (int i = 0; i < getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List + && !isListEmpty(obj) + && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) + Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()) + .getMethod("get", int.class) + .invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} diff --git a/sdks/java-v2/README.md b/sdks/java-v2/README.md index 2733d9f9e..3ac47cd18 100644 --- a/sdks/java-v2/README.md +++ b/sdks/java-v2/README.md @@ -153,6 +153,11 @@ Class | Method | HTTP request | Description *BulkSendJobApi* | [**bulkSendJobList**](docs/BulkSendJobApi.md#bulkSendJobList) | **GET** /bulk_send_job/list | List Bulk Send Jobs *EmbeddedApi* | [**embeddedEditUrl**](docs/EmbeddedApi.md#embeddedEditUrl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL *EmbeddedApi* | [**embeddedSignUrl**](docs/EmbeddedApi.md#embeddedSignUrl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL +*FaxApi* | [**faxDelete**](docs/FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax +*FaxApi* | [**faxFiles**](docs/FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files +*FaxApi* | [**faxGet**](docs/FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax +*FaxApi* | [**faxList**](docs/FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes +*FaxApi* | [**faxSend**](docs/FaxApi.md#faxSend) | **POST** /fax/send | Send Fax *FaxLineApi* | [**faxLineAddUser**](docs/FaxLineApi.md#faxLineAddUser) | **PUT** /fax_line/add_user | Add Fax Line User *FaxLineApi* | [**faxLineAreaCodeGet**](docs/FaxLineApi.md#faxLineAreaCodeGet) | **GET** /fax_line/area_codes | Get Available Fax Line Area Codes *FaxLineApi* | [**faxLineCreate**](docs/FaxLineApi.md#faxLineCreate) | **POST** /fax_line/create | Purchase Fax Line @@ -242,6 +247,7 @@ Class | Method | HTTP request | Description - [EventCallbackRequest](docs/EventCallbackRequest.md) - [EventCallbackRequestEvent](docs/EventCallbackRequestEvent.md) - [EventCallbackRequestEventMetadata](docs/EventCallbackRequestEventMetadata.md) + - [FaxGetResponse](docs/FaxGetResponse.md) - [FaxLineAddUserRequest](docs/FaxLineAddUserRequest.md) - [FaxLineAreaCodeGetCountryEnum](docs/FaxLineAreaCodeGetCountryEnum.md) - [FaxLineAreaCodeGetProvinceEnum](docs/FaxLineAreaCodeGetProvinceEnum.md) @@ -253,6 +259,10 @@ Class | Method | HTTP request | Description - [FaxLineRemoveUserRequest](docs/FaxLineRemoveUserRequest.md) - [FaxLineResponse](docs/FaxLineResponse.md) - [FaxLineResponseFaxLine](docs/FaxLineResponseFaxLine.md) + - [FaxListResponse](docs/FaxListResponse.md) + - [FaxResponse](docs/FaxResponse.md) + - [FaxResponseTransmission](docs/FaxResponseTransmission.md) + - [FaxSendRequest](docs/FaxSendRequest.md) - [FileResponse](docs/FileResponse.md) - [FileResponseDataUri](docs/FileResponseDataUri.md) - [ListInfoResponse](docs/ListInfoResponse.md) diff --git a/sdks/java-v2/docs/FaxApi.md b/sdks/java-v2/docs/FaxApi.md new file mode 100644 index 000000000..a3d9baef9 --- /dev/null +++ b/sdks/java-v2/docs/FaxApi.md @@ -0,0 +1,364 @@ +# FaxApi + +All URIs are relative to *https://api.hellosign.com/v3* + +| Method | HTTP request | Description | +|------------- | ------------- | -------------| +[**faxDelete**](FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax +[**faxFiles**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files +[**faxGet**](FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax +[**faxList**](FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes +[**faxSend**](FaxApi.md#faxSend) | **POST** /fax/send | Send Fax + + + +## faxDelete + +> faxDelete(faxId) + +Delete Fax + +Deletes the specified Fax from the system. + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.util.List; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + try { + faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + } catch (ApiException e) { + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **faxId** | **String**| Fax ID | + +### Return type + +null (empty response body) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **204** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + + +## faxFiles + +> File faxFiles(faxId) + +List Fax Files + +Returns list of fax files + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.io.File; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + + try { + File result = faxApi.faxFiles(faxId); + result.renameTo(new File("file_response.pdf"));; + } catch (ApiException e) { + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **faxId** | **String**| Fax ID | + +### Return type + +[**File**](File.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/pdf, application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + + +## faxGet + +> FaxGetResponse faxGet(faxId) + +Get Fax + +Returns information about fax + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + + try { + FaxGetResponse result = faxApi.faxGet(faxId); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **faxId** | **String**| Fax ID | + +### Return type + +[**FaxGetResponse**](FaxGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + + +## faxList + +> FaxListResponse faxList(page, pageSize) + +Lists Faxes + +Returns properties of multiple faxes + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + var page = 1; + var pageSize = 2; + + try { + FaxListResponse result = faxApi.faxList(page, pageSize); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **page** | **Integer**| Page | [optional] [default to 1] + **pageSize** | **Integer**| Page size | [optional] [default to 20] + +### Return type + +[**FaxListResponse**](FaxListResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + + +## faxSend + +> FaxGetResponse faxSend(faxSendRequest) + +Send Fax + +Action to prepare and send a fax + +### Example + +```java +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.model.*; + +import java.util.List; + +public class Example { + public static void main(String[] args) { + var apiClient = Configuration.getDefaultApiClient() + .setApiKey("YOUR_API_KEY"); + + var faxApi = new FaxApi(apiClient); + + + var data = new FaxSendRequest() + .addFilesItem(new File("example_fax.pdf")) + .testMode(true) + .recipient("16690000001") + .sender("16690000000") + .coverPageTo("Jill Fax") + .coverPageMessage("I'm sending you a fax!") + .coverPageFrom("Faxer Faxerson") + .title("This is what the fax is about!"); + + try { + FaxCreateResponse result = faxApi.faxSend(data); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} + +``` + +### Parameters + + +| Name | Type | Description | Notes | +|------------- | ------------- | ------------- | -------------| + **faxSendRequest** | [**FaxSendRequest**](FaxSendRequest.md)| | + +### Return type + +[**FaxGetResponse**](FaxGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: application/json, multipart/form-data +- **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + diff --git a/sdks/java-v2/docs/FaxGetResponse.md b/sdks/java-v2/docs/FaxGetResponse.md new file mode 100644 index 000000000..cc9dc6e57 --- /dev/null +++ b/sdks/java-v2/docs/FaxGetResponse.md @@ -0,0 +1,15 @@ + + +# FaxGetResponse + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `fax`*_required_ | [```FaxResponse```](FaxResponse.md) | | | +| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | + + + diff --git a/sdks/java-v2/docs/FaxListResponse.md b/sdks/java-v2/docs/FaxListResponse.md new file mode 100644 index 000000000..f25379a27 --- /dev/null +++ b/sdks/java-v2/docs/FaxListResponse.md @@ -0,0 +1,15 @@ + + +# FaxListResponse + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `faxes`*_required_ | [```List```](FaxResponse.md) | | | +| `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | + + + diff --git a/sdks/java-v2/docs/FaxResponse.md b/sdks/java-v2/docs/FaxResponse.md new file mode 100644 index 000000000..77ec7eb10 --- /dev/null +++ b/sdks/java-v2/docs/FaxResponse.md @@ -0,0 +1,23 @@ + + +# FaxResponse + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `faxId`*_required_ | ```String``` | Fax ID | | +| `title`*_required_ | ```String``` | Fax Title | | +| `originalTitle`*_required_ | ```String``` | Fax Original Title | | +| `subject`*_required_ | ```String``` | Fax Subject | | +| `message`*_required_ | ```String``` | Fax Message | | +| `metadata`*_required_ | ```Map``` | Fax Metadata | | +| `createdAt`*_required_ | ```Integer``` | Fax Created At Timestamp | | +| `sender`*_required_ | ```String``` | Fax Sender Email | | +| `transmissions`*_required_ | [```List```](FaxResponseTransmission.md) | Fax Transmissions List | | +| `filesUrl`*_required_ | ```String``` | Fax Files URL | | + + + diff --git a/sdks/java-v2/docs/FaxResponseTransmission.md b/sdks/java-v2/docs/FaxResponseTransmission.md new file mode 100644 index 000000000..09db223e9 --- /dev/null +++ b/sdks/java-v2/docs/FaxResponseTransmission.md @@ -0,0 +1,32 @@ + + +# FaxResponseTransmission + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `recipient`*_required_ | ```String``` | Fax Transmission Recipient | | +| `sender`*_required_ | ```String``` | Fax Transmission Sender | | +| `statusCode`*_required_ | [```StatusCodeEnum```](#StatusCodeEnum) | Fax Transmission Status Code | | +| `sentAt` | ```Integer``` | Fax Transmission Sent Timestamp | | + + + +## Enum: StatusCodeEnum + +| Name | Value | +---- | ----- +| SUCCESS | "success" | +| TRANSMITTING | "transmitting" | +| ERROR_COULD_NOT_FAX | "error_could_not_fax" | +| ERROR_UNKNOWN | "error_unknown" | +| ERROR_BUSY | "error_busy" | +| ERROR_NO_ANSWER | "error_no_answer" | +| ERROR_DISCONNECTED | "error_disconnected" | +| ERROR_BAD_DESTINATION | "error_bad_destination" | + + + diff --git a/sdks/java-v2/docs/FaxSendRequest.md b/sdks/java-v2/docs/FaxSendRequest.md new file mode 100644 index 000000000..5b939a0af --- /dev/null +++ b/sdks/java-v2/docs/FaxSendRequest.md @@ -0,0 +1,22 @@ + + +# FaxSendRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `recipient`*_required_ | ```String``` | Fax Send To Recipient | | +| `sender` | ```String``` | Fax Send From Sender (used only with fax number) | | +| `files` | ```List``` | Fax File to Send | | +| `fileUrls` | ```List``` | Fax File URL to Send | | +| `testMode` | ```Boolean``` | API Test Mode Setting | | +| `coverPageTo` | ```String``` | Fax Cover Page for Recipient | | +| `coverPageFrom` | ```String``` | Fax Cover Page for Sender | | +| `coverPageMessage` | ```String``` | Fax Cover Page Message | | +| `title` | ```String``` | Fax Title | | + + + diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java new file mode 100644 index 000000000..e010c8323 --- /dev/null +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java @@ -0,0 +1,416 @@ +package com.dropbox.sign.api; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.ApiClient; +import com.dropbox.sign.ApiResponse; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.Pair; + +import jakarta.ws.rs.core.GenericType; + +import com.dropbox.sign.model.ErrorResponse; +import com.dropbox.sign.model.FaxGetResponse; +import com.dropbox.sign.model.FaxListResponse; +import com.dropbox.sign.model.FaxSendRequest; +import java.io.File; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +public class FaxApi { + private ApiClient apiClient; + + public FaxApi() { + this(Configuration.getDefaultApiClient()); + } + + public FaxApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API client + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API client + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Delete Fax. + * Deletes the specified Fax from the system. + * @param faxId Fax ID (required) + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
204 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public void faxDelete(String faxId) throws ApiException { + faxDeleteWithHttpInfo(faxId); + } + + + /** + * Delete Fax. + * Deletes the specified Fax from the system. + * @param faxId Fax ID (required) + * @return ApiResponse<Void> + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
204 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException { + + // Check required parameters + if (faxId == null) { + throw new ApiException(400, "Missing the required parameter 'faxId' when calling faxDelete"); + } + + // Path parameters + String localVarPath = "/fax/{fax_id}" + .replaceAll("\\{fax_id}", apiClient.escapeString(faxId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = new HashMap(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType(); + String[] localVarAuthNames = new String[] {"api_key"}; + return apiClient.invokeAPI( + "FaxApi.faxDelete", + localVarPath, + "DELETE", + new ArrayList<>(), + null, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + null, + false + ); + } + /** + * List Fax Files. + * Returns list of fax files + * @param faxId Fax ID (required) + * @return File + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public File faxFiles(String faxId) throws ApiException { + return faxFilesWithHttpInfo(faxId).getData(); + } + + + /** + * List Fax Files. + * Returns list of fax files + * @param faxId Fax ID (required) + * @return ApiResponse<File> + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse faxFilesWithHttpInfo(String faxId) throws ApiException { + + // Check required parameters + if (faxId == null) { + throw new ApiException(400, "Missing the required parameter 'faxId' when calling faxFiles"); + } + + // Path parameters + String localVarPath = "/fax/files/{fax_id}" + .replaceAll("\\{fax_id}", apiClient.escapeString(faxId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/pdf", "application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = new HashMap(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType(); + String[] localVarAuthNames = new String[] {"api_key"}; + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI( + "FaxApi.faxFiles", + localVarPath, + "GET", + new ArrayList<>(), + null, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false + ); + } + /** + * Get Fax. + * Returns information about fax + * @param faxId Fax ID (required) + * @return FaxGetResponse + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public FaxGetResponse faxGet(String faxId) throws ApiException { + return faxGetWithHttpInfo(faxId).getData(); + } + + + /** + * Get Fax. + * Returns information about fax + * @param faxId Fax ID (required) + * @return ApiResponse<FaxGetResponse> + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse faxGetWithHttpInfo(String faxId) throws ApiException { + + // Check required parameters + if (faxId == null) { + throw new ApiException(400, "Missing the required parameter 'faxId' when calling faxGet"); + } + + // Path parameters + String localVarPath = "/fax/{fax_id}" + .replaceAll("\\{fax_id}", apiClient.escapeString(faxId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = new HashMap(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType(); + String[] localVarAuthNames = new String[] {"api_key"}; + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI( + "FaxApi.faxGet", + localVarPath, + "GET", + new ArrayList<>(), + null, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false + ); + } + /** + * Lists Faxes. + * Returns properties of multiple faxes + * @param page Page (optional, default to 1) + * @param pageSize Page size (optional, default to 20) + * @return FaxListResponse + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public FaxListResponse faxList(Integer page, Integer pageSize) throws ApiException { + return faxListWithHttpInfo(page, pageSize).getData(); + } + + + /** + * @see FaxApi#faxList(Integer, Integer) + */ + public FaxListResponse faxList() throws ApiException { + Integer page = 1; + Integer pageSize = 20; + + return faxListWithHttpInfo(page, pageSize).getData(); + } + + /** + * @see FaxApi#faxListWithHttpInfo(Integer, Integer) + */ + public ApiResponse faxListWithHttpInfo() throws ApiException { + Integer page = 1; + Integer pageSize = 20; + + return faxListWithHttpInfo(page, pageSize); + } + + /** + * @see FaxApi#faxList(Integer, Integer) + */ + public FaxListResponse faxList(Integer page) throws ApiException { + Integer pageSize = 20; + + return faxListWithHttpInfo(page, pageSize).getData(); + } + + /** + * @see FaxApi#faxListWithHttpInfo(Integer, Integer) + */ + public ApiResponse faxListWithHttpInfo(Integer page) throws ApiException { + Integer pageSize = 20; + + return faxListWithHttpInfo(page, pageSize); + } + + + /** + * Lists Faxes. + * Returns properties of multiple faxes + * @param page Page (optional, default to 1) + * @param pageSize Page size (optional, default to 20) + * @return ApiResponse<FaxListResponse> + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse faxListWithHttpInfo(Integer page, Integer pageSize) throws ApiException { + + if (page == null) { + page = 1; + } + if (pageSize == null) { + pageSize = 20; + } + // Query parameters + List localVarQueryParams = new ArrayList<>( + apiClient.parameterToPairs("", "page", page) + ); + localVarQueryParams.addAll(apiClient.parameterToPairs("", "page_size", pageSize)); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = new HashMap(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType(); + String[] localVarAuthNames = new String[] {"api_key"}; + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI( + "FaxApi.faxList", + "/fax/list", + "GET", + localVarQueryParams, + null, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false + ); + } + /** + * Send Fax. + * Action to prepare and send a fax + * @param faxSendRequest (required) + * @return FaxGetResponse + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public FaxGetResponse faxSend(FaxSendRequest faxSendRequest) throws ApiException { + return faxSendWithHttpInfo(faxSendRequest).getData(); + } + + + /** + * Send Fax. + * Action to prepare and send a fax + * @param faxSendRequest (required) + * @return ApiResponse<FaxGetResponse> + * @throws ApiException if fails to make API call + * @http.response.details + + + + +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse faxSendWithHttpInfo(FaxSendRequest faxSendRequest) throws ApiException { + + // Check required parameters + if (faxSendRequest == null) { + throw new ApiException(400, "Missing the required parameter 'faxSendRequest' when calling faxSend"); + } + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = faxSendRequest.createFormData(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType("application/json", "multipart/form-data"); + String[] localVarAuthNames = new String[] {"api_key"}; + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI( + "FaxApi.faxSend", + "/fax/send", + "POST", + new ArrayList<>(), + isFileTypeFound ? null : faxSendRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false + ); + } +} \ No newline at end of file diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxGetResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxGetResponse.java new file mode 100644 index 000000000..7b08c8e76 --- /dev/null +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxGetResponse.java @@ -0,0 +1,240 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.dropbox.sign.model.FaxResponse; +import com.dropbox.sign.model.WarningResponse; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; + + +import com.dropbox.sign.ApiException; +/** + * FaxGetResponse + */ +@JsonPropertyOrder({ + FaxGetResponse.JSON_PROPERTY_FAX, + FaxGetResponse.JSON_PROPERTY_WARNINGS +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class FaxGetResponse { + public static final String JSON_PROPERTY_FAX = "fax"; + private FaxResponse fax; + + public static final String JSON_PROPERTY_WARNINGS = "warnings"; + private List warnings = null; + + public FaxGetResponse() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public FaxGetResponse init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, FaxGetResponse.class); + } + + static public FaxGetResponse init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + FaxGetResponse.class + ); + } + + public FaxGetResponse fax(FaxResponse fax) { + this.fax = fax; + return this; + } + + /** + * Get fax + * @return fax + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FAX) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public FaxResponse getFax() { + return fax; + } + + + @JsonProperty(JSON_PROPERTY_FAX) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFax(FaxResponse fax) { + this.fax = fax; + } + + + public FaxGetResponse warnings(List warnings) { + this.warnings = warnings; + return this; + } + + public FaxGetResponse addWarningsItem(WarningResponse warningsItem) { + if (this.warnings == null) { + this.warnings = new ArrayList<>(); + } + this.warnings.add(warningsItem); + return this; + } + + /** + * A list of warnings. + * @return warnings + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_WARNINGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getWarnings() { + return warnings; + } + + + @JsonProperty(JSON_PROPERTY_WARNINGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setWarnings(List warnings) { + this.warnings = warnings; + } + + + /** + * Return true if this FaxGetResponse object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FaxGetResponse faxGetResponse = (FaxGetResponse) o; + return Objects.equals(this.fax, faxGetResponse.fax) && + Objects.equals(this.warnings, faxGetResponse.warnings); + } + + @Override + public int hashCode() { + return Objects.hash(fax, warnings); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FaxGetResponse {\n"); + sb.append(" fax: ").append(toIndentedString(fax)).append("\n"); + sb.append(" warnings: ").append(toIndentedString(warnings)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (fax != null) { + if (isFileTypeOrListOfFiles(fax)) { + fileTypeFound = true; + } + + if (fax.getClass().equals(java.io.File.class) || + fax.getClass().equals(Integer.class) || + fax.getClass().equals(String.class) || + fax.getClass().isEnum()) { + map.put("fax", fax); + } else if (isListOfFile(fax)) { + for(int i = 0; i< getListSize(fax); i++) { + map.put("fax[" + i + "]", getFromList(fax, i)); + } + } + else { + map.put("fax", JSON.getDefault().getMapper().writeValueAsString(fax)); + } + } + if (warnings != null) { + if (isFileTypeOrListOfFiles(warnings)) { + fileTypeFound = true; + } + + if (warnings.getClass().equals(java.io.File.class) || + warnings.getClass().equals(Integer.class) || + warnings.getClass().equals(String.class) || + warnings.getClass().isEnum()) { + map.put("warnings", warnings); + } else if (isListOfFile(warnings)) { + for(int i = 0; i< getListSize(warnings); i++) { + map.put("warnings[" + i + "]", getFromList(warnings, i)); + } + } + else { + map.put("warnings", JSON.getDefault().getMapper().writeValueAsString(warnings)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxListResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxListResponse.java new file mode 100644 index 000000000..13c0d94e3 --- /dev/null +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxListResponse.java @@ -0,0 +1,240 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.dropbox.sign.model.FaxResponse; +import com.dropbox.sign.model.ListInfoResponse; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; + + +import com.dropbox.sign.ApiException; +/** + * FaxListResponse + */ +@JsonPropertyOrder({ + FaxListResponse.JSON_PROPERTY_FAXES, + FaxListResponse.JSON_PROPERTY_LIST_INFO +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class FaxListResponse { + public static final String JSON_PROPERTY_FAXES = "faxes"; + private List faxes = new ArrayList<>(); + + public static final String JSON_PROPERTY_LIST_INFO = "list_info"; + private ListInfoResponse listInfo; + + public FaxListResponse() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public FaxListResponse init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, FaxListResponse.class); + } + + static public FaxListResponse init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + FaxListResponse.class + ); + } + + public FaxListResponse faxes(List faxes) { + this.faxes = faxes; + return this; + } + + public FaxListResponse addFaxesItem(FaxResponse faxesItem) { + if (this.faxes == null) { + this.faxes = new ArrayList<>(); + } + this.faxes.add(faxesItem); + return this; + } + + /** + * Get faxes + * @return faxes + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FAXES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getFaxes() { + return faxes; + } + + + @JsonProperty(JSON_PROPERTY_FAXES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFaxes(List faxes) { + this.faxes = faxes; + } + + + public FaxListResponse listInfo(ListInfoResponse listInfo) { + this.listInfo = listInfo; + return this; + } + + /** + * Get listInfo + * @return listInfo + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_LIST_INFO) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public ListInfoResponse getListInfo() { + return listInfo; + } + + + @JsonProperty(JSON_PROPERTY_LIST_INFO) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setListInfo(ListInfoResponse listInfo) { + this.listInfo = listInfo; + } + + + /** + * Return true if this FaxListResponse object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FaxListResponse faxListResponse = (FaxListResponse) o; + return Objects.equals(this.faxes, faxListResponse.faxes) && + Objects.equals(this.listInfo, faxListResponse.listInfo); + } + + @Override + public int hashCode() { + return Objects.hash(faxes, listInfo); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FaxListResponse {\n"); + sb.append(" faxes: ").append(toIndentedString(faxes)).append("\n"); + sb.append(" listInfo: ").append(toIndentedString(listInfo)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (faxes != null) { + if (isFileTypeOrListOfFiles(faxes)) { + fileTypeFound = true; + } + + if (faxes.getClass().equals(java.io.File.class) || + faxes.getClass().equals(Integer.class) || + faxes.getClass().equals(String.class) || + faxes.getClass().isEnum()) { + map.put("faxes", faxes); + } else if (isListOfFile(faxes)) { + for(int i = 0; i< getListSize(faxes); i++) { + map.put("faxes[" + i + "]", getFromList(faxes, i)); + } + } + else { + map.put("faxes", JSON.getDefault().getMapper().writeValueAsString(faxes)); + } + } + if (listInfo != null) { + if (isFileTypeOrListOfFiles(listInfo)) { + fileTypeFound = true; + } + + if (listInfo.getClass().equals(java.io.File.class) || + listInfo.getClass().equals(Integer.class) || + listInfo.getClass().equals(String.class) || + listInfo.getClass().isEnum()) { + map.put("list_info", listInfo); + } else if (isListOfFile(listInfo)) { + for(int i = 0; i< getListSize(listInfo); i++) { + map.put("list_info[" + i + "]", getFromList(listInfo, i)); + } + } + else { + map.put("list_info", JSON.getDefault().getMapper().writeValueAsString(listInfo)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxResponse.java new file mode 100644 index 000000000..35f4ffc6a --- /dev/null +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxResponse.java @@ -0,0 +1,649 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.dropbox.sign.model.FaxResponseTransmission; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; + + +import com.dropbox.sign.ApiException; +/** + * FaxResponse + */ +@JsonPropertyOrder({ + FaxResponse.JSON_PROPERTY_FAX_ID, + FaxResponse.JSON_PROPERTY_TITLE, + FaxResponse.JSON_PROPERTY_ORIGINAL_TITLE, + FaxResponse.JSON_PROPERTY_SUBJECT, + FaxResponse.JSON_PROPERTY_MESSAGE, + FaxResponse.JSON_PROPERTY_METADATA, + FaxResponse.JSON_PROPERTY_CREATED_AT, + FaxResponse.JSON_PROPERTY_SENDER, + FaxResponse.JSON_PROPERTY_TRANSMISSIONS, + FaxResponse.JSON_PROPERTY_FILES_URL +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class FaxResponse { + public static final String JSON_PROPERTY_FAX_ID = "fax_id"; + private String faxId; + + public static final String JSON_PROPERTY_TITLE = "title"; + private String title; + + public static final String JSON_PROPERTY_ORIGINAL_TITLE = "original_title"; + private String originalTitle; + + public static final String JSON_PROPERTY_SUBJECT = "subject"; + private String subject; + + public static final String JSON_PROPERTY_MESSAGE = "message"; + private String message; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + private Map metadata = new HashMap<>(); + + public static final String JSON_PROPERTY_CREATED_AT = "created_at"; + private Integer createdAt; + + public static final String JSON_PROPERTY_SENDER = "sender"; + private String sender; + + public static final String JSON_PROPERTY_TRANSMISSIONS = "transmissions"; + private List transmissions = new ArrayList<>(); + + public static final String JSON_PROPERTY_FILES_URL = "files_url"; + private String filesUrl; + + public FaxResponse() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public FaxResponse init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, FaxResponse.class); + } + + static public FaxResponse init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + FaxResponse.class + ); + } + + public FaxResponse faxId(String faxId) { + this.faxId = faxId; + return this; + } + + /** + * Fax ID + * @return faxId + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FAX_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getFaxId() { + return faxId; + } + + + @JsonProperty(JSON_PROPERTY_FAX_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFaxId(String faxId) { + this.faxId = faxId; + } + + + public FaxResponse title(String title) { + this.title = title; + return this; + } + + /** + * Fax Title + * @return title + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getTitle() { + return title; + } + + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setTitle(String title) { + this.title = title; + } + + + public FaxResponse originalTitle(String originalTitle) { + this.originalTitle = originalTitle; + return this; + } + + /** + * Fax Original Title + * @return originalTitle + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ORIGINAL_TITLE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getOriginalTitle() { + return originalTitle; + } + + + @JsonProperty(JSON_PROPERTY_ORIGINAL_TITLE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setOriginalTitle(String originalTitle) { + this.originalTitle = originalTitle; + } + + + public FaxResponse subject(String subject) { + this.subject = subject; + return this; + } + + /** + * Fax Subject + * @return subject + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getSubject() { + return subject; + } + + + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSubject(String subject) { + this.subject = subject; + } + + + public FaxResponse message(String message) { + this.message = message; + return this; + } + + /** + * Fax Message + * @return message + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getMessage() { + return message; + } + + + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setMessage(String message) { + this.message = message; + } + + + public FaxResponse metadata(Map metadata) { + this.metadata = metadata; + return this; + } + + public FaxResponse putMetadataItem(String key, Object metadataItem) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Fax Metadata + * @return metadata + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.ALWAYS) + + public Map getMetadata() { + return metadata; + } + + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.ALWAYS) + public void setMetadata(Map metadata) { + this.metadata = metadata; + } + + + public FaxResponse createdAt(Integer createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + * Fax Created At Timestamp + * @return createdAt + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CREATED_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public Integer getCreatedAt() { + return createdAt; + } + + + @JsonProperty(JSON_PROPERTY_CREATED_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setCreatedAt(Integer createdAt) { + this.createdAt = createdAt; + } + + + public FaxResponse sender(String sender) { + this.sender = sender; + return this; + } + + /** + * Fax Sender Email + * @return sender + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SENDER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getSender() { + return sender; + } + + + @JsonProperty(JSON_PROPERTY_SENDER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSender(String sender) { + this.sender = sender; + } + + + public FaxResponse transmissions(List transmissions) { + this.transmissions = transmissions; + return this; + } + + public FaxResponse addTransmissionsItem(FaxResponseTransmission transmissionsItem) { + if (this.transmissions == null) { + this.transmissions = new ArrayList<>(); + } + this.transmissions.add(transmissionsItem); + return this; + } + + /** + * Fax Transmissions List + * @return transmissions + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TRANSMISSIONS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getTransmissions() { + return transmissions; + } + + + @JsonProperty(JSON_PROPERTY_TRANSMISSIONS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setTransmissions(List transmissions) { + this.transmissions = transmissions; + } + + + public FaxResponse filesUrl(String filesUrl) { + this.filesUrl = filesUrl; + return this; + } + + /** + * Fax Files URL + * @return filesUrl + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FILES_URL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getFilesUrl() { + return filesUrl; + } + + + @JsonProperty(JSON_PROPERTY_FILES_URL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFilesUrl(String filesUrl) { + this.filesUrl = filesUrl; + } + + + /** + * Return true if this FaxResponse object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FaxResponse faxResponse = (FaxResponse) o; + return Objects.equals(this.faxId, faxResponse.faxId) && + Objects.equals(this.title, faxResponse.title) && + Objects.equals(this.originalTitle, faxResponse.originalTitle) && + Objects.equals(this.subject, faxResponse.subject) && + Objects.equals(this.message, faxResponse.message) && + Objects.equals(this.metadata, faxResponse.metadata) && + Objects.equals(this.createdAt, faxResponse.createdAt) && + Objects.equals(this.sender, faxResponse.sender) && + Objects.equals(this.transmissions, faxResponse.transmissions) && + Objects.equals(this.filesUrl, faxResponse.filesUrl); + } + + @Override + public int hashCode() { + return Objects.hash(faxId, title, originalTitle, subject, message, metadata, createdAt, sender, transmissions, filesUrl); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FaxResponse {\n"); + sb.append(" faxId: ").append(toIndentedString(faxId)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" originalTitle: ").append(toIndentedString(originalTitle)).append("\n"); + sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n"); + sb.append(" sender: ").append(toIndentedString(sender)).append("\n"); + sb.append(" transmissions: ").append(toIndentedString(transmissions)).append("\n"); + sb.append(" filesUrl: ").append(toIndentedString(filesUrl)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (faxId != null) { + if (isFileTypeOrListOfFiles(faxId)) { + fileTypeFound = true; + } + + if (faxId.getClass().equals(java.io.File.class) || + faxId.getClass().equals(Integer.class) || + faxId.getClass().equals(String.class) || + faxId.getClass().isEnum()) { + map.put("fax_id", faxId); + } else if (isListOfFile(faxId)) { + for(int i = 0; i< getListSize(faxId); i++) { + map.put("fax_id[" + i + "]", getFromList(faxId, i)); + } + } + else { + map.put("fax_id", JSON.getDefault().getMapper().writeValueAsString(faxId)); + } + } + if (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) || + title.getClass().equals(Integer.class) || + title.getClass().equals(String.class) || + title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for(int i = 0; i< getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } + else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + if (originalTitle != null) { + if (isFileTypeOrListOfFiles(originalTitle)) { + fileTypeFound = true; + } + + if (originalTitle.getClass().equals(java.io.File.class) || + originalTitle.getClass().equals(Integer.class) || + originalTitle.getClass().equals(String.class) || + originalTitle.getClass().isEnum()) { + map.put("original_title", originalTitle); + } else if (isListOfFile(originalTitle)) { + for(int i = 0; i< getListSize(originalTitle); i++) { + map.put("original_title[" + i + "]", getFromList(originalTitle, i)); + } + } + else { + map.put("original_title", JSON.getDefault().getMapper().writeValueAsString(originalTitle)); + } + } + if (subject != null) { + if (isFileTypeOrListOfFiles(subject)) { + fileTypeFound = true; + } + + if (subject.getClass().equals(java.io.File.class) || + subject.getClass().equals(Integer.class) || + subject.getClass().equals(String.class) || + subject.getClass().isEnum()) { + map.put("subject", subject); + } else if (isListOfFile(subject)) { + for(int i = 0; i< getListSize(subject); i++) { + map.put("subject[" + i + "]", getFromList(subject, i)); + } + } + else { + map.put("subject", JSON.getDefault().getMapper().writeValueAsString(subject)); + } + } + if (message != null) { + if (isFileTypeOrListOfFiles(message)) { + fileTypeFound = true; + } + + if (message.getClass().equals(java.io.File.class) || + message.getClass().equals(Integer.class) || + message.getClass().equals(String.class) || + message.getClass().isEnum()) { + map.put("message", message); + } else if (isListOfFile(message)) { + for(int i = 0; i< getListSize(message); i++) { + map.put("message[" + i + "]", getFromList(message, i)); + } + } + else { + map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); + } + } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) || + metadata.getClass().equals(Integer.class) || + metadata.getClass().equals(String.class) || + metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for(int i = 0; i< getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } + else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (createdAt != null) { + if (isFileTypeOrListOfFiles(createdAt)) { + fileTypeFound = true; + } + + if (createdAt.getClass().equals(java.io.File.class) || + createdAt.getClass().equals(Integer.class) || + createdAt.getClass().equals(String.class) || + createdAt.getClass().isEnum()) { + map.put("created_at", createdAt); + } else if (isListOfFile(createdAt)) { + for(int i = 0; i< getListSize(createdAt); i++) { + map.put("created_at[" + i + "]", getFromList(createdAt, i)); + } + } + else { + map.put("created_at", JSON.getDefault().getMapper().writeValueAsString(createdAt)); + } + } + if (sender != null) { + if (isFileTypeOrListOfFiles(sender)) { + fileTypeFound = true; + } + + if (sender.getClass().equals(java.io.File.class) || + sender.getClass().equals(Integer.class) || + sender.getClass().equals(String.class) || + sender.getClass().isEnum()) { + map.put("sender", sender); + } else if (isListOfFile(sender)) { + for(int i = 0; i< getListSize(sender); i++) { + map.put("sender[" + i + "]", getFromList(sender, i)); + } + } + else { + map.put("sender", JSON.getDefault().getMapper().writeValueAsString(sender)); + } + } + if (transmissions != null) { + if (isFileTypeOrListOfFiles(transmissions)) { + fileTypeFound = true; + } + + if (transmissions.getClass().equals(java.io.File.class) || + transmissions.getClass().equals(Integer.class) || + transmissions.getClass().equals(String.class) || + transmissions.getClass().isEnum()) { + map.put("transmissions", transmissions); + } else if (isListOfFile(transmissions)) { + for(int i = 0; i< getListSize(transmissions); i++) { + map.put("transmissions[" + i + "]", getFromList(transmissions, i)); + } + } + else { + map.put("transmissions", JSON.getDefault().getMapper().writeValueAsString(transmissions)); + } + } + if (filesUrl != null) { + if (isFileTypeOrListOfFiles(filesUrl)) { + fileTypeFound = true; + } + + if (filesUrl.getClass().equals(java.io.File.class) || + filesUrl.getClass().equals(Integer.class) || + filesUrl.getClass().equals(String.class) || + filesUrl.getClass().isEnum()) { + map.put("files_url", filesUrl); + } else if (isListOfFile(filesUrl)) { + for(int i = 0; i< getListSize(filesUrl); i++) { + map.put("files_url[" + i + "]", getFromList(filesUrl, i)); + } + } + else { + map.put("files_url", JSON.getDefault().getMapper().writeValueAsString(filesUrl)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxResponseTransmission.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxResponseTransmission.java new file mode 100644 index 000000000..dc7bb06a4 --- /dev/null +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxResponseTransmission.java @@ -0,0 +1,375 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; + + +import com.dropbox.sign.ApiException; +/** + * FaxResponseTransmission + */ +@JsonPropertyOrder({ + FaxResponseTransmission.JSON_PROPERTY_RECIPIENT, + FaxResponseTransmission.JSON_PROPERTY_SENDER, + FaxResponseTransmission.JSON_PROPERTY_STATUS_CODE, + FaxResponseTransmission.JSON_PROPERTY_SENT_AT +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class FaxResponseTransmission { + public static final String JSON_PROPERTY_RECIPIENT = "recipient"; + private String recipient; + + public static final String JSON_PROPERTY_SENDER = "sender"; + private String sender; + + /** + * Fax Transmission Status Code + */ + public enum StatusCodeEnum { + SUCCESS("success"), + + TRANSMITTING("transmitting"), + + ERROR_COULD_NOT_FAX("error_could_not_fax"), + + ERROR_UNKNOWN("error_unknown"), + + ERROR_BUSY("error_busy"), + + ERROR_NO_ANSWER("error_no_answer"), + + ERROR_DISCONNECTED("error_disconnected"), + + ERROR_BAD_DESTINATION("error_bad_destination"); + + private String value; + + StatusCodeEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static StatusCodeEnum fromValue(String value) { + for (StatusCodeEnum b : StatusCodeEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_STATUS_CODE = "status_code"; + private StatusCodeEnum statusCode; + + public static final String JSON_PROPERTY_SENT_AT = "sent_at"; + private Integer sentAt; + + public FaxResponseTransmission() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public FaxResponseTransmission init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, FaxResponseTransmission.class); + } + + static public FaxResponseTransmission init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + FaxResponseTransmission.class + ); + } + + public FaxResponseTransmission recipient(String recipient) { + this.recipient = recipient; + return this; + } + + /** + * Fax Transmission Recipient + * @return recipient + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_RECIPIENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getRecipient() { + return recipient; + } + + + @JsonProperty(JSON_PROPERTY_RECIPIENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setRecipient(String recipient) { + this.recipient = recipient; + } + + + public FaxResponseTransmission sender(String sender) { + this.sender = sender; + return this; + } + + /** + * Fax Transmission Sender + * @return sender + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SENDER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getSender() { + return sender; + } + + + @JsonProperty(JSON_PROPERTY_SENDER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSender(String sender) { + this.sender = sender; + } + + + public FaxResponseTransmission statusCode(StatusCodeEnum statusCode) { + this.statusCode = statusCode; + return this; + } + + /** + * Fax Transmission Status Code + * @return statusCode + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_STATUS_CODE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public StatusCodeEnum getStatusCode() { + return statusCode; + } + + + @JsonProperty(JSON_PROPERTY_STATUS_CODE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setStatusCode(StatusCodeEnum statusCode) { + this.statusCode = statusCode; + } + + + public FaxResponseTransmission sentAt(Integer sentAt) { + this.sentAt = sentAt; + return this; + } + + /** + * Fax Transmission Sent Timestamp + * @return sentAt + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SENT_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getSentAt() { + return sentAt; + } + + + @JsonProperty(JSON_PROPERTY_SENT_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSentAt(Integer sentAt) { + this.sentAt = sentAt; + } + + + /** + * Return true if this FaxResponseTransmission object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FaxResponseTransmission faxResponseTransmission = (FaxResponseTransmission) o; + return Objects.equals(this.recipient, faxResponseTransmission.recipient) && + Objects.equals(this.sender, faxResponseTransmission.sender) && + Objects.equals(this.statusCode, faxResponseTransmission.statusCode) && + Objects.equals(this.sentAt, faxResponseTransmission.sentAt); + } + + @Override + public int hashCode() { + return Objects.hash(recipient, sender, statusCode, sentAt); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FaxResponseTransmission {\n"); + sb.append(" recipient: ").append(toIndentedString(recipient)).append("\n"); + sb.append(" sender: ").append(toIndentedString(sender)).append("\n"); + sb.append(" statusCode: ").append(toIndentedString(statusCode)).append("\n"); + sb.append(" sentAt: ").append(toIndentedString(sentAt)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (recipient != null) { + if (isFileTypeOrListOfFiles(recipient)) { + fileTypeFound = true; + } + + if (recipient.getClass().equals(java.io.File.class) || + recipient.getClass().equals(Integer.class) || + recipient.getClass().equals(String.class) || + recipient.getClass().isEnum()) { + map.put("recipient", recipient); + } else if (isListOfFile(recipient)) { + for(int i = 0; i< getListSize(recipient); i++) { + map.put("recipient[" + i + "]", getFromList(recipient, i)); + } + } + else { + map.put("recipient", JSON.getDefault().getMapper().writeValueAsString(recipient)); + } + } + if (sender != null) { + if (isFileTypeOrListOfFiles(sender)) { + fileTypeFound = true; + } + + if (sender.getClass().equals(java.io.File.class) || + sender.getClass().equals(Integer.class) || + sender.getClass().equals(String.class) || + sender.getClass().isEnum()) { + map.put("sender", sender); + } else if (isListOfFile(sender)) { + for(int i = 0; i< getListSize(sender); i++) { + map.put("sender[" + i + "]", getFromList(sender, i)); + } + } + else { + map.put("sender", JSON.getDefault().getMapper().writeValueAsString(sender)); + } + } + if (statusCode != null) { + if (isFileTypeOrListOfFiles(statusCode)) { + fileTypeFound = true; + } + + if (statusCode.getClass().equals(java.io.File.class) || + statusCode.getClass().equals(Integer.class) || + statusCode.getClass().equals(String.class) || + statusCode.getClass().isEnum()) { + map.put("status_code", statusCode); + } else if (isListOfFile(statusCode)) { + for(int i = 0; i< getListSize(statusCode); i++) { + map.put("status_code[" + i + "]", getFromList(statusCode, i)); + } + } + else { + map.put("status_code", JSON.getDefault().getMapper().writeValueAsString(statusCode)); + } + } + if (sentAt != null) { + if (isFileTypeOrListOfFiles(sentAt)) { + fileTypeFound = true; + } + + if (sentAt.getClass().equals(java.io.File.class) || + sentAt.getClass().equals(Integer.class) || + sentAt.getClass().equals(String.class) || + sentAt.getClass().isEnum()) { + map.put("sent_at", sentAt); + } else if (isListOfFile(sentAt)) { + for(int i = 0; i< getListSize(sentAt); i++) { + map.put("sent_at[" + i + "]", getFromList(sentAt, i)); + } + } + else { + map.put("sent_at", JSON.getDefault().getMapper().writeValueAsString(sentAt)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java new file mode 100644 index 000000000..bb4a6e8a1 --- /dev/null +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java @@ -0,0 +1,597 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.io.File; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; + + +import com.dropbox.sign.ApiException; +/** + * FaxSendRequest + */ +@JsonPropertyOrder({ + FaxSendRequest.JSON_PROPERTY_RECIPIENT, + FaxSendRequest.JSON_PROPERTY_SENDER, + FaxSendRequest.JSON_PROPERTY_FILES, + FaxSendRequest.JSON_PROPERTY_FILE_URLS, + FaxSendRequest.JSON_PROPERTY_TEST_MODE, + FaxSendRequest.JSON_PROPERTY_COVER_PAGE_TO, + FaxSendRequest.JSON_PROPERTY_COVER_PAGE_FROM, + FaxSendRequest.JSON_PROPERTY_COVER_PAGE_MESSAGE, + FaxSendRequest.JSON_PROPERTY_TITLE +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class FaxSendRequest { + public static final String JSON_PROPERTY_RECIPIENT = "recipient"; + private String recipient; + + public static final String JSON_PROPERTY_SENDER = "sender"; + private String sender; + + public static final String JSON_PROPERTY_FILES = "files"; + private List files = null; + + public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + private List fileUrls = null; + + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + private Boolean testMode = false; + + public static final String JSON_PROPERTY_COVER_PAGE_TO = "cover_page_to"; + private String coverPageTo; + + public static final String JSON_PROPERTY_COVER_PAGE_FROM = "cover_page_from"; + private String coverPageFrom; + + public static final String JSON_PROPERTY_COVER_PAGE_MESSAGE = "cover_page_message"; + private String coverPageMessage; + + public static final String JSON_PROPERTY_TITLE = "title"; + private String title; + + public FaxSendRequest() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public FaxSendRequest init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, FaxSendRequest.class); + } + + static public FaxSendRequest init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + FaxSendRequest.class + ); + } + + public FaxSendRequest recipient(String recipient) { + this.recipient = recipient; + return this; + } + + /** + * Fax Send To Recipient + * @return recipient + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_RECIPIENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getRecipient() { + return recipient; + } + + + @JsonProperty(JSON_PROPERTY_RECIPIENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setRecipient(String recipient) { + this.recipient = recipient; + } + + + public FaxSendRequest sender(String sender) { + this.sender = sender; + return this; + } + + /** + * Fax Send From Sender (used only with fax number) + * @return sender + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SENDER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSender() { + return sender; + } + + + @JsonProperty(JSON_PROPERTY_SENDER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSender(String sender) { + this.sender = sender; + } + + + public FaxSendRequest files(List files) { + this.files = files; + return this; + } + + public FaxSendRequest addFilesItem(File filesItem) { + if (this.files == null) { + this.files = new ArrayList<>(); + } + this.files.add(filesItem); + return this; + } + + /** + * Fax File to Send + * @return files + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFiles() { + return files; + } + + + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFiles(List files) { + this.files = files; + } + + + public FaxSendRequest fileUrls(List fileUrls) { + this.fileUrls = fileUrls; + return this; + } + + public FaxSendRequest addFileUrlsItem(String fileUrlsItem) { + if (this.fileUrls == null) { + this.fileUrls = new ArrayList<>(); + } + this.fileUrls.add(fileUrlsItem); + return this; + } + + /** + * Fax File URL to Send + * @return fileUrls + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFileUrls() { + return fileUrls; + } + + + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrls(List fileUrls) { + this.fileUrls = fileUrls; + } + + + public FaxSendRequest testMode(Boolean testMode) { + this.testMode = testMode; + return this; + } + + /** + * API Test Mode Setting + * @return testMode + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getTestMode() { + return testMode; + } + + + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTestMode(Boolean testMode) { + this.testMode = testMode; + } + + + public FaxSendRequest coverPageTo(String coverPageTo) { + this.coverPageTo = coverPageTo; + return this; + } + + /** + * Fax Cover Page for Recipient + * @return coverPageTo + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_COVER_PAGE_TO) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCoverPageTo() { + return coverPageTo; + } + + + @JsonProperty(JSON_PROPERTY_COVER_PAGE_TO) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCoverPageTo(String coverPageTo) { + this.coverPageTo = coverPageTo; + } + + + public FaxSendRequest coverPageFrom(String coverPageFrom) { + this.coverPageFrom = coverPageFrom; + return this; + } + + /** + * Fax Cover Page for Sender + * @return coverPageFrom + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_COVER_PAGE_FROM) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCoverPageFrom() { + return coverPageFrom; + } + + + @JsonProperty(JSON_PROPERTY_COVER_PAGE_FROM) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCoverPageFrom(String coverPageFrom) { + this.coverPageFrom = coverPageFrom; + } + + + public FaxSendRequest coverPageMessage(String coverPageMessage) { + this.coverPageMessage = coverPageMessage; + return this; + } + + /** + * Fax Cover Page Message + * @return coverPageMessage + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_COVER_PAGE_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCoverPageMessage() { + return coverPageMessage; + } + + + @JsonProperty(JSON_PROPERTY_COVER_PAGE_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCoverPageMessage(String coverPageMessage) { + this.coverPageMessage = coverPageMessage; + } + + + public FaxSendRequest title(String title) { + this.title = title; + return this; + } + + /** + * Fax Title + * @return title + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTitle() { + return title; + } + + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTitle(String title) { + this.title = title; + } + + + /** + * Return true if this FaxSendRequest object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FaxSendRequest faxSendRequest = (FaxSendRequest) o; + return Objects.equals(this.recipient, faxSendRequest.recipient) && + Objects.equals(this.sender, faxSendRequest.sender) && + Objects.equals(this.files, faxSendRequest.files) && + Objects.equals(this.fileUrls, faxSendRequest.fileUrls) && + Objects.equals(this.testMode, faxSendRequest.testMode) && + Objects.equals(this.coverPageTo, faxSendRequest.coverPageTo) && + Objects.equals(this.coverPageFrom, faxSendRequest.coverPageFrom) && + Objects.equals(this.coverPageMessage, faxSendRequest.coverPageMessage) && + Objects.equals(this.title, faxSendRequest.title); + } + + @Override + public int hashCode() { + return Objects.hash(recipient, sender, files, fileUrls, testMode, coverPageTo, coverPageFrom, coverPageMessage, title); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FaxSendRequest {\n"); + sb.append(" recipient: ").append(toIndentedString(recipient)).append("\n"); + sb.append(" sender: ").append(toIndentedString(sender)).append("\n"); + sb.append(" files: ").append(toIndentedString(files)).append("\n"); + sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); + sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); + sb.append(" coverPageTo: ").append(toIndentedString(coverPageTo)).append("\n"); + sb.append(" coverPageFrom: ").append(toIndentedString(coverPageFrom)).append("\n"); + sb.append(" coverPageMessage: ").append(toIndentedString(coverPageMessage)).append("\n"); + sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (recipient != null) { + if (isFileTypeOrListOfFiles(recipient)) { + fileTypeFound = true; + } + + if (recipient.getClass().equals(java.io.File.class) || + recipient.getClass().equals(Integer.class) || + recipient.getClass().equals(String.class) || + recipient.getClass().isEnum()) { + map.put("recipient", recipient); + } else if (isListOfFile(recipient)) { + for(int i = 0; i< getListSize(recipient); i++) { + map.put("recipient[" + i + "]", getFromList(recipient, i)); + } + } + else { + map.put("recipient", JSON.getDefault().getMapper().writeValueAsString(recipient)); + } + } + if (sender != null) { + if (isFileTypeOrListOfFiles(sender)) { + fileTypeFound = true; + } + + if (sender.getClass().equals(java.io.File.class) || + sender.getClass().equals(Integer.class) || + sender.getClass().equals(String.class) || + sender.getClass().isEnum()) { + map.put("sender", sender); + } else if (isListOfFile(sender)) { + for(int i = 0; i< getListSize(sender); i++) { + map.put("sender[" + i + "]", getFromList(sender, i)); + } + } + else { + map.put("sender", JSON.getDefault().getMapper().writeValueAsString(sender)); + } + } + if (files != null) { + if (isFileTypeOrListOfFiles(files)) { + fileTypeFound = true; + } + + if (files.getClass().equals(java.io.File.class) || + files.getClass().equals(Integer.class) || + files.getClass().equals(String.class) || + files.getClass().isEnum()) { + map.put("files", files); + } else if (isListOfFile(files)) { + for(int i = 0; i< getListSize(files); i++) { + map.put("files[" + i + "]", getFromList(files, i)); + } + } + else { + map.put("files", JSON.getDefault().getMapper().writeValueAsString(files)); + } + } + if (fileUrls != null) { + if (isFileTypeOrListOfFiles(fileUrls)) { + fileTypeFound = true; + } + + if (fileUrls.getClass().equals(java.io.File.class) || + fileUrls.getClass().equals(Integer.class) || + fileUrls.getClass().equals(String.class) || + fileUrls.getClass().isEnum()) { + map.put("file_urls", fileUrls); + } else if (isListOfFile(fileUrls)) { + for(int i = 0; i< getListSize(fileUrls); i++) { + map.put("file_urls[" + i + "]", getFromList(fileUrls, i)); + } + } + else { + map.put("file_urls", JSON.getDefault().getMapper().writeValueAsString(fileUrls)); + } + } + if (testMode != null) { + if (isFileTypeOrListOfFiles(testMode)) { + fileTypeFound = true; + } + + if (testMode.getClass().equals(java.io.File.class) || + testMode.getClass().equals(Integer.class) || + testMode.getClass().equals(String.class) || + testMode.getClass().isEnum()) { + map.put("test_mode", testMode); + } else if (isListOfFile(testMode)) { + for(int i = 0; i< getListSize(testMode); i++) { + map.put("test_mode[" + i + "]", getFromList(testMode, i)); + } + } + else { + map.put("test_mode", JSON.getDefault().getMapper().writeValueAsString(testMode)); + } + } + if (coverPageTo != null) { + if (isFileTypeOrListOfFiles(coverPageTo)) { + fileTypeFound = true; + } + + if (coverPageTo.getClass().equals(java.io.File.class) || + coverPageTo.getClass().equals(Integer.class) || + coverPageTo.getClass().equals(String.class) || + coverPageTo.getClass().isEnum()) { + map.put("cover_page_to", coverPageTo); + } else if (isListOfFile(coverPageTo)) { + for(int i = 0; i< getListSize(coverPageTo); i++) { + map.put("cover_page_to[" + i + "]", getFromList(coverPageTo, i)); + } + } + else { + map.put("cover_page_to", JSON.getDefault().getMapper().writeValueAsString(coverPageTo)); + } + } + if (coverPageFrom != null) { + if (isFileTypeOrListOfFiles(coverPageFrom)) { + fileTypeFound = true; + } + + if (coverPageFrom.getClass().equals(java.io.File.class) || + coverPageFrom.getClass().equals(Integer.class) || + coverPageFrom.getClass().equals(String.class) || + coverPageFrom.getClass().isEnum()) { + map.put("cover_page_from", coverPageFrom); + } else if (isListOfFile(coverPageFrom)) { + for(int i = 0; i< getListSize(coverPageFrom); i++) { + map.put("cover_page_from[" + i + "]", getFromList(coverPageFrom, i)); + } + } + else { + map.put("cover_page_from", JSON.getDefault().getMapper().writeValueAsString(coverPageFrom)); + } + } + if (coverPageMessage != null) { + if (isFileTypeOrListOfFiles(coverPageMessage)) { + fileTypeFound = true; + } + + if (coverPageMessage.getClass().equals(java.io.File.class) || + coverPageMessage.getClass().equals(Integer.class) || + coverPageMessage.getClass().equals(String.class) || + coverPageMessage.getClass().isEnum()) { + map.put("cover_page_message", coverPageMessage); + } else if (isListOfFile(coverPageMessage)) { + for(int i = 0; i< getListSize(coverPageMessage); i++) { + map.put("cover_page_message[" + i + "]", getFromList(coverPageMessage, i)); + } + } + else { + map.put("cover_page_message", JSON.getDefault().getMapper().writeValueAsString(coverPageMessage)); + } + } + if (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) || + title.getClass().equals(Integer.class) || + title.getClass().equals(String.class) || + title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for(int i = 0; i< getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } + else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/sdks/node/README.md b/sdks/node/README.md index 542d01e29..bfee7884f 100644 --- a/sdks/node/README.md +++ b/sdks/node/README.md @@ -120,6 +120,11 @@ All URIs are relative to *https://api.hellosign.com/v3* | *BulkSendJobApi* | [**bulkSendJobList**](./docs/api/BulkSendJobApi.md#bulksendjoblist) | **GET** /bulk_send_job/list | List Bulk Send Jobs | | *EmbeddedApi* | [**embeddedEditUrl**](./docs/api/EmbeddedApi.md#embeddedediturl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL | | *EmbeddedApi* | [**embeddedSignUrl**](./docs/api/EmbeddedApi.md#embeddedsignurl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL | +| *FaxApi* | [**faxDelete**](./docs/api/FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax | +| *FaxApi* | [**faxFiles**](./docs/api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files | +| *FaxApi* | [**faxGet**](./docs/api/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax | +| *FaxApi* | [**faxList**](./docs/api/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes | +| *FaxApi* | [**faxSend**](./docs/api/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax | | *FaxLineApi* | [**faxLineAddUser**](./docs/api/FaxLineApi.md#faxlineadduser) | **PUT** /fax_line/add_user | Add Fax Line User | | *FaxLineApi* | [**faxLineAreaCodeGet**](./docs/api/FaxLineApi.md#faxlineareacodeget) | **GET** /fax_line/area_codes | Get Available Fax Line Area Codes | | *FaxLineApi* | [**faxLineCreate**](./docs/api/FaxLineApi.md#faxlinecreate) | **POST** /fax_line/create | Purchase Fax Line | @@ -208,6 +213,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [EventCallbackRequest](./docs/model/EventCallbackRequest.md) - [EventCallbackRequestEvent](./docs/model/EventCallbackRequestEvent.md) - [EventCallbackRequestEventMetadata](./docs/model/EventCallbackRequestEventMetadata.md) +- [FaxGetResponse](./docs/model/FaxGetResponse.md) - [FaxLineAddUserRequest](./docs/model/FaxLineAddUserRequest.md) - [FaxLineAreaCodeGetCountryEnum](./docs/model/FaxLineAreaCodeGetCountryEnum.md) - [FaxLineAreaCodeGetProvinceEnum](./docs/model/FaxLineAreaCodeGetProvinceEnum.md) @@ -219,6 +225,10 @@ All URIs are relative to *https://api.hellosign.com/v3* - [FaxLineRemoveUserRequest](./docs/model/FaxLineRemoveUserRequest.md) - [FaxLineResponse](./docs/model/FaxLineResponse.md) - [FaxLineResponseFaxLine](./docs/model/FaxLineResponseFaxLine.md) +- [FaxListResponse](./docs/model/FaxListResponse.md) +- [FaxResponse](./docs/model/FaxResponse.md) +- [FaxResponseTransmission](./docs/model/FaxResponseTransmission.md) +- [FaxSendRequest](./docs/model/FaxSendRequest.md) - [FileResponse](./docs/model/FileResponse.md) - [FileResponseDataUri](./docs/model/FileResponseDataUri.md) - [ListInfoResponse](./docs/model/ListInfoResponse.md) diff --git a/sdks/node/api/faxApi.ts b/sdks/node/api/faxApi.ts new file mode 100644 index 000000000..dd9c6df2a --- /dev/null +++ b/sdks/node/api/faxApi.ts @@ -0,0 +1,779 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import axios, { AxiosError, AxiosRequestConfig, AxiosResponse } from "axios"; + +import { + Authentication, + FaxGetResponse, + FaxListResponse, + FaxSendRequest, + HttpBasicAuth, + HttpBearerAuth, + Interceptor, + ObjectSerializer, + VoidAuth, +} from "../model"; + +import { + generateFormData, + HttpError, + optionsI, + queryParamsSerializer, + returnTypeI, + returnTypeT, + toFormData, + USER_AGENT, +} from "./"; + +let defaultBasePath = "https://api.hellosign.com/v3"; + +// =============================================== +// This file is autogenerated - Please do not edit +// =============================================== + +export enum FaxApiApiKeys {} + +export class FaxApi { + protected _basePath = defaultBasePath; + protected _defaultHeaders: any = { "User-Agent": USER_AGENT }; + protected _useQuerystring: boolean = false; + + protected authentications = { + default: new VoidAuth(), + api_key: new HttpBasicAuth(), + oauth2: new HttpBearerAuth(), + }; + + protected interceptors: Interceptor[] = []; + + constructor(basePath?: string) { + if (basePath) { + this.basePath = basePath; + } + } + + set useQuerystring(value: boolean) { + this._useQuerystring = value; + } + + set basePath(basePath: string) { + this._basePath = basePath; + } + + set defaultHeaders(defaultHeaders: any) { + this._defaultHeaders = { ...defaultHeaders, "User-Agent": USER_AGENT }; + } + + get defaultHeaders() { + return this._defaultHeaders; + } + + get basePath() { + return this._basePath; + } + + public setDefaultAuthentication(auth: Authentication) { + this.authentications.default = auth; + } + + public setApiKey(key: string) { + this.authentications.api_key.username = key; + } + + set username(username: string) { + this.authentications.api_key.username = username; + } + + set password(password: string) { + this.authentications.api_key.password = password; + } + + set accessToken(accessToken: string | (() => string)) { + this.authentications.oauth2.accessToken = accessToken; + } + + public addInterceptor(interceptor: Interceptor) { + this.interceptors.push(interceptor); + } + + /** + * Deletes the specified Fax from the system. + * @summary Delete Fax + * @param faxId Fax ID + * @param options + */ + public async faxDelete( + faxId: string, + options: optionsI = { headers: {} } + ): Promise { + const localVarPath = + this.basePath + + "/fax/{fax_id}".replace( + "{" + "fax_id" + "}", + encodeURIComponent(String(faxId)) + ); + let localVarQueryParameters: any = {}; + let localVarHeaderParams: any = (Object).assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + // give precedence to 'application/json' + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams: any = {}; + let localVarBodyParams: any = undefined; + + // verify required parameter 'faxId' is not null or undefined + if (faxId === null || faxId === undefined) { + throw new Error( + "Required parameter faxId was null or undefined when calling faxDelete." + ); + } + + (Object).assign(localVarHeaderParams, options.headers); + + let localVarUseFormData = false; + + let localVarRequestOptions: AxiosRequestConfig = { + method: "DELETE", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring + ? queryParamsSerializer + : undefined, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + }; + + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then(() => + this.authentications.default.applyToRequest(localVarRequestOptions) + ); + + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then(() => + interceptor(localVarRequestOptions) + ); + } + + return interceptorPromise.then(() => { + return new Promise((resolve, reject) => { + axios.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse(resolve, reject, response); + }, + (error: AxiosError) => { + if (error.response == null) { + reject(error); + return; + } + + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + + reject(error); + } + ); + }); + }); + } + /** + * Returns list of fax files + * @summary List Fax Files + * @param faxId Fax ID + * @param options + */ + public async faxFiles( + faxId: string, + options: optionsI = { headers: {} } + ): Promise> { + const localVarPath = + this.basePath + + "/fax/files/{fax_id}".replace( + "{" + "fax_id" + "}", + encodeURIComponent(String(faxId)) + ); + let localVarQueryParameters: any = {}; + let localVarHeaderParams: any = (Object).assign( + {}, + this._defaultHeaders + ); + const produces = ["application/pdf", "application/json"]; + // give precedence to 'application/json' + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams: any = {}; + let localVarBodyParams: any = undefined; + + // verify required parameter 'faxId' is not null or undefined + if (faxId === null || faxId === undefined) { + throw new Error( + "Required parameter faxId was null or undefined when calling faxFiles." + ); + } + + (Object).assign(localVarHeaderParams, options.headers); + + let localVarUseFormData = false; + + let localVarRequestOptions: AxiosRequestConfig = { + method: "GET", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring + ? queryParamsSerializer + : undefined, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "arraybuffer", + }; + + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then(() => + this.authentications.default.applyToRequest(localVarRequestOptions) + ); + + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then(() => + interceptor(localVarRequestOptions) + ); + } + + return interceptorPromise.then(() => { + return new Promise>((resolve, reject) => { + axios.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse( + resolve, + reject, + response, + "Buffer" + ); + }, + (error: AxiosError) => { + if (error.response == null) { + reject(error); + return; + } + + if ( + handleErrorCodeResponse( + reject, + error.response, + 200, + "RequestFile" + ) + ) { + return; + } + + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + + reject(error); + } + ); + }); + }); + } + /** + * Returns information about fax + * @summary Get Fax + * @param faxId Fax ID + * @param options + */ + public async faxGet( + faxId: string, + options: optionsI = { headers: {} } + ): Promise> { + const localVarPath = + this.basePath + + "/fax/{fax_id}".replace( + "{" + "fax_id" + "}", + encodeURIComponent(String(faxId)) + ); + let localVarQueryParameters: any = {}; + let localVarHeaderParams: any = (Object).assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + // give precedence to 'application/json' + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams: any = {}; + let localVarBodyParams: any = undefined; + + // verify required parameter 'faxId' is not null or undefined + if (faxId === null || faxId === undefined) { + throw new Error( + "Required parameter faxId was null or undefined when calling faxGet." + ); + } + + (Object).assign(localVarHeaderParams, options.headers); + + let localVarUseFormData = false; + + let localVarRequestOptions: AxiosRequestConfig = { + method: "GET", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring + ? queryParamsSerializer + : undefined, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + }; + + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then(() => + this.authentications.default.applyToRequest(localVarRequestOptions) + ); + + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then(() => + interceptor(localVarRequestOptions) + ); + } + + return interceptorPromise.then(() => { + return new Promise>((resolve, reject) => { + axios.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse( + resolve, + reject, + response, + "FaxGetResponse" + ); + }, + (error: AxiosError) => { + if (error.response == null) { + reject(error); + return; + } + + if ( + handleErrorCodeResponse( + reject, + error.response, + 200, + "FaxGetResponse" + ) + ) { + return; + } + + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + + reject(error); + } + ); + }); + }); + } + /** + * Returns properties of multiple faxes + * @summary Lists Faxes + * @param page Page + * @param pageSize Page size + * @param options + */ + public async faxList( + page?: number, + pageSize?: number, + options: optionsI = { headers: {} } + ): Promise> { + const localVarPath = this.basePath + "/fax/list"; + let localVarQueryParameters: any = {}; + let localVarHeaderParams: any = (Object).assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + // give precedence to 'application/json' + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams: any = {}; + let localVarBodyParams: any = undefined; + + if (page !== undefined) { + localVarQueryParameters["page"] = ObjectSerializer.serialize( + page, + "number" + ); + } + + if (pageSize !== undefined) { + localVarQueryParameters["page_size"] = ObjectSerializer.serialize( + pageSize, + "number" + ); + } + + (Object).assign(localVarHeaderParams, options.headers); + + let localVarUseFormData = false; + + let localVarRequestOptions: AxiosRequestConfig = { + method: "GET", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring + ? queryParamsSerializer + : undefined, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + }; + + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then(() => + this.authentications.default.applyToRequest(localVarRequestOptions) + ); + + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then(() => + interceptor(localVarRequestOptions) + ); + } + + return interceptorPromise.then(() => { + return new Promise>((resolve, reject) => { + axios.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse( + resolve, + reject, + response, + "FaxListResponse" + ); + }, + (error: AxiosError) => { + if (error.response == null) { + reject(error); + return; + } + + if ( + handleErrorCodeResponse( + reject, + error.response, + 200, + "FaxListResponse" + ) + ) { + return; + } + + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + + reject(error); + } + ); + }); + }); + } + /** + * Action to prepare and send a fax + * @summary Send Fax + * @param faxSendRequest + * @param options + */ + public async faxSend( + faxSendRequest: FaxSendRequest, + options: optionsI = { headers: {} } + ): Promise> { + faxSendRequest = deserializeIfNeeded(faxSendRequest, "FaxSendRequest"); + const localVarPath = this.basePath + "/fax/send"; + let localVarQueryParameters: any = {}; + let localVarHeaderParams: any = (Object).assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + // give precedence to 'application/json' + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams: any = {}; + let localVarBodyParams: any = undefined; + + // verify required parameter 'faxSendRequest' is not null or undefined + if (faxSendRequest === null || faxSendRequest === undefined) { + throw new Error( + "Required parameter faxSendRequest was null or undefined when calling faxSend." + ); + } + + (Object).assign(localVarHeaderParams, options.headers); + + let localVarUseFormData = false; + + const result = generateFormData( + faxSendRequest, + FaxSendRequest.attributeTypeMap + ); + localVarUseFormData = result.localVarUseFormData; + + let data = {}; + if (localVarUseFormData) { + const formData = toFormData(result.data); + data = formData; + localVarHeaderParams = { + ...localVarHeaderParams, + ...formData.getHeaders(), + }; + } else { + data = ObjectSerializer.serialize(faxSendRequest, "FaxSendRequest"); + } + + let localVarRequestOptions: AxiosRequestConfig = { + method: "POST", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring + ? queryParamsSerializer + : undefined, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + data, + }; + + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then(() => + this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then(() => + this.authentications.default.applyToRequest(localVarRequestOptions) + ); + + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then(() => + interceptor(localVarRequestOptions) + ); + } + + return interceptorPromise.then(() => { + return new Promise>((resolve, reject) => { + axios.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse( + resolve, + reject, + response, + "FaxGetResponse" + ); + }, + (error: AxiosError) => { + if (error.response == null) { + reject(error); + return; + } + + if ( + handleErrorCodeResponse( + reject, + error.response, + 200, + "FaxGetResponse" + ) + ) { + return; + } + + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + + reject(error); + } + ); + }); + }); + } +} + +function deserializeIfNeeded(obj: T, classname: string): T { + if (obj !== null && obj !== undefined && obj.constructor.name !== classname) { + return ObjectSerializer.deserialize(obj, classname); + } + + return obj; +} + +type AxiosResolve = ( + value: returnTypeT | PromiseLike> +) => void; + +type AxiosReject = (reason?: any) => void; + +function handleSuccessfulResponse( + resolve: AxiosResolve, + reject: AxiosReject, + response: AxiosResponse, + returnType?: string +) { + let body = response.data; + + if (response.status && response.status >= 200 && response.status <= 299) { + if (returnType) { + body = ObjectSerializer.deserialize(body, returnType); + } + + resolve({ response: response, body: body }); + } else { + reject(new HttpError(response, body, response.status)); + } +} + +function handleErrorCodeResponse( + reject: AxiosReject, + response: AxiosResponse, + code: number, + returnType: string +): boolean { + if (response.status !== code) { + return false; + } + + const body = ObjectSerializer.deserialize(response.data, returnType); + + reject(new HttpError(response, body, response.status)); + + return true; +} + +function handleErrorRangeResponse( + reject: AxiosReject, + response: AxiosResponse, + code: string, + returnType: string +): boolean { + let rangeCodeLeft = Number(code[0] + "00"); + let rangeCodeRight = Number(code[0] + "99"); + + if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { + const body = ObjectSerializer.deserialize(response.data, returnType); + + reject(new HttpError(response, body, response.status)); + + return true; + } + + return false; +} diff --git a/sdks/node/api/index.ts b/sdks/node/api/index.ts index 1304b009a..d32b5b1b7 100644 --- a/sdks/node/api/index.ts +++ b/sdks/node/api/index.ts @@ -2,6 +2,7 @@ import { AccountApi } from "./accountApi"; import { ApiAppApi } from "./apiAppApi"; import { BulkSendJobApi } from "./bulkSendJobApi"; import { EmbeddedApi } from "./embeddedApi"; +import { FaxApi } from "./faxApi"; import { FaxLineApi } from "./faxLineApi"; import { OAuthApi } from "./oAuthApi"; import { ReportApi } from "./reportApi"; @@ -15,6 +16,7 @@ export { ApiAppApi, BulkSendJobApi, EmbeddedApi, + FaxApi, FaxLineApi, OAuthApi, ReportApi, @@ -40,6 +42,7 @@ export const APIS = [ ApiAppApi, BulkSendJobApi, EmbeddedApi, + FaxApi, FaxLineApi, OAuthApi, ReportApi, diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index e24c2e532..43069c7ca 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -12976,6 +12976,8 @@ __export(api_exports, { EventCallbackRequest: () => EventCallbackRequest, EventCallbackRequestEvent: () => EventCallbackRequestEvent, EventCallbackRequestEventMetadata: () => EventCallbackRequestEventMetadata, + FaxApi: () => FaxApi, + FaxGetResponse: () => FaxGetResponse, FaxLineAddUserRequest: () => FaxLineAddUserRequest, FaxLineApi: () => FaxLineApi, FaxLineAreaCodeGetCountryEnum: () => FaxLineAreaCodeGetCountryEnum, @@ -12988,6 +12990,10 @@ __export(api_exports, { FaxLineRemoveUserRequest: () => FaxLineRemoveUserRequest, FaxLineResponse: () => FaxLineResponse, FaxLineResponseFaxLine: () => FaxLineResponseFaxLine, + FaxListResponse: () => FaxListResponse, + FaxResponse: () => FaxResponse, + FaxResponseTransmission: () => FaxResponseTransmission, + FaxSendRequest: () => FaxSendRequest, FileResponse: () => FileResponse, FileResponseDataUri: () => FileResponseDataUri, HttpBasicAuth: () => HttpBasicAuth, @@ -17703,6 +17709,30 @@ EventCallbackRequestEventMetadata.attributeTypeMap = [ } ]; +// model/faxGetResponse.ts +var _FaxGetResponse = class { + static getAttributeTypeMap() { + return _FaxGetResponse.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize(data, "FaxGetResponse"); + } +}; +var FaxGetResponse = _FaxGetResponse; +FaxGetResponse.discriminator = void 0; +FaxGetResponse.attributeTypeMap = [ + { + name: "fax", + baseName: "fax", + type: "FaxResponse" + }, + { + name: "warnings", + baseName: "warnings", + type: "Array" + } +]; + // model/faxLineAddUserRequest.ts var _FaxLineAddUserRequest = class { static getAttributeTypeMap() { @@ -18010,6 +18040,203 @@ FaxLineResponseFaxLine.attributeTypeMap = [ } ]; +// model/faxListResponse.ts +var _FaxListResponse = class { + static getAttributeTypeMap() { + return _FaxListResponse.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize(data, "FaxListResponse"); + } +}; +var FaxListResponse = _FaxListResponse; +FaxListResponse.discriminator = void 0; +FaxListResponse.attributeTypeMap = [ + { + name: "faxes", + baseName: "faxes", + type: "Array" + }, + { + name: "listInfo", + baseName: "list_info", + type: "ListInfoResponse" + } +]; + +// model/faxResponse.ts +var _FaxResponse = class { + static getAttributeTypeMap() { + return _FaxResponse.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize(data, "FaxResponse"); + } +}; +var FaxResponse = _FaxResponse; +FaxResponse.discriminator = void 0; +FaxResponse.attributeTypeMap = [ + { + name: "faxId", + baseName: "fax_id", + type: "string" + }, + { + name: "title", + baseName: "title", + type: "string" + }, + { + name: "originalTitle", + baseName: "original_title", + type: "string" + }, + { + name: "subject", + baseName: "subject", + type: "string" + }, + { + name: "message", + baseName: "message", + type: "string" + }, + { + name: "metadata", + baseName: "metadata", + type: "{ [key: string]: any; }" + }, + { + name: "createdAt", + baseName: "created_at", + type: "number" + }, + { + name: "sender", + baseName: "sender", + type: "string" + }, + { + name: "transmissions", + baseName: "transmissions", + type: "Array" + }, + { + name: "filesUrl", + baseName: "files_url", + type: "string" + } +]; + +// model/faxResponseTransmission.ts +var _FaxResponseTransmission = class { + static getAttributeTypeMap() { + return _FaxResponseTransmission.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize(data, "FaxResponseTransmission"); + } +}; +var FaxResponseTransmission = _FaxResponseTransmission; +FaxResponseTransmission.discriminator = void 0; +FaxResponseTransmission.attributeTypeMap = [ + { + name: "recipient", + baseName: "recipient", + type: "string" + }, + { + name: "sender", + baseName: "sender", + type: "string" + }, + { + name: "statusCode", + baseName: "status_code", + type: "FaxResponseTransmission.StatusCodeEnum" + }, + { + name: "sentAt", + baseName: "sent_at", + type: "number" + } +]; +((FaxResponseTransmission2) => { + let StatusCodeEnum; + ((StatusCodeEnum2) => { + StatusCodeEnum2["Success"] = "success"; + StatusCodeEnum2["Transmitting"] = "transmitting"; + StatusCodeEnum2["ErrorCouldNotFax"] = "error_could_not_fax"; + StatusCodeEnum2["ErrorUnknown"] = "error_unknown"; + StatusCodeEnum2["ErrorBusy"] = "error_busy"; + StatusCodeEnum2["ErrorNoAnswer"] = "error_no_answer"; + StatusCodeEnum2["ErrorDisconnected"] = "error_disconnected"; + StatusCodeEnum2["ErrorBadDestination"] = "error_bad_destination"; + })(StatusCodeEnum = FaxResponseTransmission2.StatusCodeEnum || (FaxResponseTransmission2.StatusCodeEnum = {})); +})(FaxResponseTransmission || (FaxResponseTransmission = {})); + +// model/faxSendRequest.ts +var _FaxSendRequest = class { + constructor() { + this["testMode"] = false; + } + static getAttributeTypeMap() { + return _FaxSendRequest.attributeTypeMap; + } + static init(data) { + return ObjectSerializer.deserialize(data, "FaxSendRequest"); + } +}; +var FaxSendRequest = _FaxSendRequest; +FaxSendRequest.discriminator = void 0; +FaxSendRequest.attributeTypeMap = [ + { + name: "recipient", + baseName: "recipient", + type: "string" + }, + { + name: "sender", + baseName: "sender", + type: "string" + }, + { + name: "files", + baseName: "files", + type: "Array" + }, + { + name: "fileUrls", + baseName: "file_urls", + type: "Array" + }, + { + name: "testMode", + baseName: "test_mode", + type: "boolean" + }, + { + name: "coverPageTo", + baseName: "cover_page_to", + type: "string" + }, + { + name: "coverPageFrom", + baseName: "cover_page_from", + type: "string" + }, + { + name: "coverPageMessage", + baseName: "cover_page_message", + type: "string" + }, + { + name: "title", + baseName: "title", + type: "string" + } +]; + // model/fileResponse.ts var _FileResponse = class { static getAttributeTypeMap() { @@ -24473,6 +24700,7 @@ var enumsMap = { FaxLineAreaCodeGetProvinceEnum, FaxLineAreaCodeGetStateEnum, "FaxLineCreateRequest.CountryEnum": FaxLineCreateRequest.CountryEnum, + "FaxResponseTransmission.StatusCodeEnum": FaxResponseTransmission.StatusCodeEnum, "ReportCreateRequest.ReportTypeEnum": ReportCreateRequest.ReportTypeEnum, "ReportResponse.ReportTypeEnum": ReportResponse.ReportTypeEnum, SignatureRequestResponseCustomFieldTypeEnum, @@ -24535,6 +24763,7 @@ var typeMap = { EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, + FaxGetResponse, FaxLineAddUserRequest, FaxLineAreaCodeGetResponse, FaxLineCreateRequest, @@ -24543,6 +24772,10 @@ var typeMap = { FaxLineRemoveUserRequest, FaxLineResponse, FaxLineResponseFaxLine, + FaxListResponse, + FaxResponse, + FaxResponseTransmission, + FaxSendRequest, FileResponse, FileResponseDataUri, ListInfoResponse, @@ -26403,9 +26636,9 @@ function handleErrorRangeResponse4(reject, response, code, returnType) { return false; } -// api/faxLineApi.ts +// api/faxApi.ts var defaultBasePath5 = "https://api.hellosign.com/v3"; -var FaxLineApi = class { +var FaxApi = class { constructor(basePath) { this._basePath = defaultBasePath5; this._defaultHeaders = { "User-Agent": USER_AGENT }; @@ -26453,13 +26686,12 @@ var FaxLineApi = class { addInterceptor(interceptor) { this.interceptors.push(interceptor); } - faxLineAddUser(_0) { - return __async(this, arguments, function* (faxLineAddUserRequest, options = { headers: {} }) { - faxLineAddUserRequest = deserializeIfNeeded4( - faxLineAddUserRequest, - "FaxLineAddUserRequest" + faxDelete(_0) { + return __async(this, arguments, function* (faxId, options = { headers: {} }) { + const localVarPath = this.basePath + "/fax/{fax_id}".replace( + "{fax_id}", + encodeURIComponent(String(faxId)) ); - const localVarPath = this.basePath + "/fax_line/add_user"; let localVarQueryParameters = {}; let localVarHeaderParams = Object.assign( {}, @@ -26473,39 +26705,22 @@ var FaxLineApi = class { } let localVarFormParams = {}; let localVarBodyParams = void 0; - if (faxLineAddUserRequest === null || faxLineAddUserRequest === void 0) { + if (faxId === null || faxId === void 0) { throw new Error( - "Required parameter faxLineAddUserRequest was null or undefined when calling faxLineAddUser." + "Required parameter faxId was null or undefined when calling faxDelete." ); } Object.assign(localVarHeaderParams, options.headers); let localVarUseFormData = false; - const result = generateFormData( - faxLineAddUserRequest, - FaxLineAddUserRequest.attributeTypeMap - ); - localVarUseFormData = result.localVarUseFormData; - let data = {}; - if (localVarUseFormData) { - const formData2 = toFormData3(result.data); - data = formData2; - localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); - } else { - data = ObjectSerializer.serialize( - faxLineAddUserRequest, - "FaxLineAddUserRequest" - ); - } let localVarRequestOptions = { - method: "PUT", + method: "DELETE", params: localVarQueryParameters, headers: localVarHeaderParams, url: localVarPath, paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, maxContentLength: Infinity, maxBodyLength: Infinity, - responseType: "json", - data + responseType: "json" }; let authenticationPromise = Promise.resolve(); if (this.authentications.api_key.username) { @@ -26526,26 +26741,13 @@ var FaxLineApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse5( - resolve, - reject, - response, - "FaxLineResponse" - ); + handleSuccessfulResponse5(resolve, reject, response); }, (error) => { if (error.response == null) { reject(error); return; } - if (handleErrorCodeResponse5( - reject, - error.response, - 200, - "FaxLineResponse" - )) { - return; - } if (handleErrorRangeResponse5( reject, error.response, @@ -26561,15 +26763,18 @@ var FaxLineApi = class { }); }); } - faxLineAreaCodeGet(_0, _1, _2, _3) { - return __async(this, arguments, function* (country, state, province, city, options = { headers: {} }) { - const localVarPath = this.basePath + "/fax_line/area_codes"; + faxFiles(_0) { + return __async(this, arguments, function* (faxId, options = { headers: {} }) { + const localVarPath = this.basePath + "/fax/files/{fax_id}".replace( + "{fax_id}", + encodeURIComponent(String(faxId)) + ); let localVarQueryParameters = {}; let localVarHeaderParams = Object.assign( {}, this._defaultHeaders ); - const produces = ["application/json"]; + const produces = ["application/pdf", "application/json"]; if (produces.indexOf("application/json") >= 0) { localVarHeaderParams["content-type"] = "application/json"; } else { @@ -26577,33 +26782,9 @@ var FaxLineApi = class { } let localVarFormParams = {}; let localVarBodyParams = void 0; - if (country === null || country === void 0) { + if (faxId === null || faxId === void 0) { throw new Error( - "Required parameter country was null or undefined when calling faxLineAreaCodeGet." - ); - } - if (country !== void 0) { - localVarQueryParameters["country"] = ObjectSerializer.serialize( - country, - "'CA' | 'US' | 'UK'" - ); - } - if (state !== void 0) { - localVarQueryParameters["state"] = ObjectSerializer.serialize( - state, - "'AK' | 'AL' | 'AR' | 'AZ' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'GA' | 'HI' | 'IA' | 'ID' | 'IL' | 'IN' | 'KS' | 'KY' | 'LA' | 'MA' | 'MD' | 'ME' | 'MI' | 'MN' | 'MO' | 'MS' | 'MT' | 'NC' | 'ND' | 'NE' | 'NH' | 'NJ' | 'NM' | 'NV' | 'NY' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VA' | 'VT' | 'WA' | 'WI' | 'WV' | 'WY'" - ); - } - if (province !== void 0) { - localVarQueryParameters["province"] = ObjectSerializer.serialize( - province, - "'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NT' | 'NS' | 'NU' | 'ON' | 'PE' | 'QC' | 'SK' | 'YT'" - ); - } - if (city !== void 0) { - localVarQueryParameters["city"] = ObjectSerializer.serialize( - city, - "string" + "Required parameter faxId was null or undefined when calling faxFiles." ); } Object.assign(localVarHeaderParams, options.headers); @@ -26616,7 +26797,7 @@ var FaxLineApi = class { paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, maxContentLength: Infinity, maxBodyLength: Infinity, - responseType: "json" + responseType: "arraybuffer" }; let authenticationPromise = Promise.resolve(); if (this.authentications.api_key.username) { @@ -26634,49 +26815,641 @@ var FaxLineApi = class { ); } return interceptorPromise.then(() => { - return new Promise( - (resolve, reject) => { - axios_default.request(localVarRequestOptions).then( - (response) => { - handleSuccessfulResponse5( - resolve, - reject, - response, - "FaxLineAreaCodeGetResponse" - ); - }, - (error) => { - if (error.response == null) { - reject(error); - return; - } - if (handleErrorCodeResponse5( - reject, - error.response, - 200, - "FaxLineAreaCodeGetResponse" - )) { - return; - } - if (handleErrorRangeResponse5( - reject, - error.response, - "4XX", - "ErrorResponse" - )) { - return; - } - reject(error); - } - ); - } - ); + return new Promise((resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse5( + resolve, + reject, + response, + "Buffer" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse5( + reject, + error.response, + 200, + "RequestFile" + )) { + return; + } + if (handleErrorRangeResponse5( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + }); + }); + }); + } + faxGet(_0) { + return __async(this, arguments, function* (faxId, options = { headers: {} }) { + const localVarPath = this.basePath + "/fax/{fax_id}".replace( + "{fax_id}", + encodeURIComponent(String(faxId)) + ); + let localVarQueryParameters = {}; + let localVarHeaderParams = Object.assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams = {}; + let localVarBodyParams = void 0; + if (faxId === null || faxId === void 0) { + throw new Error( + "Required parameter faxId was null or undefined when calling faxGet." + ); + } + Object.assign(localVarHeaderParams, options.headers); + let localVarUseFormData = false; + let localVarRequestOptions = { + method: "GET", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json" + }; + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then( + () => this.authentications.default.applyToRequest(localVarRequestOptions) + ); + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then( + () => interceptor(localVarRequestOptions) + ); + } + return interceptorPromise.then(() => { + return new Promise((resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse5( + resolve, + reject, + response, + "FaxGetResponse" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse5( + reject, + error.response, + 200, + "FaxGetResponse" + )) { + return; + } + if (handleErrorRangeResponse5( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + }); + }); + }); + } + faxList(_0, _1) { + return __async(this, arguments, function* (page, pageSize, options = { headers: {} }) { + const localVarPath = this.basePath + "/fax/list"; + let localVarQueryParameters = {}; + let localVarHeaderParams = Object.assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams = {}; + let localVarBodyParams = void 0; + if (page !== void 0) { + localVarQueryParameters["page"] = ObjectSerializer.serialize( + page, + "number" + ); + } + if (pageSize !== void 0) { + localVarQueryParameters["page_size"] = ObjectSerializer.serialize( + pageSize, + "number" + ); + } + Object.assign(localVarHeaderParams, options.headers); + let localVarUseFormData = false; + let localVarRequestOptions = { + method: "GET", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json" + }; + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then( + () => this.authentications.default.applyToRequest(localVarRequestOptions) + ); + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then( + () => interceptor(localVarRequestOptions) + ); + } + return interceptorPromise.then(() => { + return new Promise((resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse5( + resolve, + reject, + response, + "FaxListResponse" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse5( + reject, + error.response, + 200, + "FaxListResponse" + )) { + return; + } + if (handleErrorRangeResponse5( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + }); + }); + }); + } + faxSend(_0) { + return __async(this, arguments, function* (faxSendRequest, options = { headers: {} }) { + faxSendRequest = deserializeIfNeeded4(faxSendRequest, "FaxSendRequest"); + const localVarPath = this.basePath + "/fax/send"; + let localVarQueryParameters = {}; + let localVarHeaderParams = Object.assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams = {}; + let localVarBodyParams = void 0; + if (faxSendRequest === null || faxSendRequest === void 0) { + throw new Error( + "Required parameter faxSendRequest was null or undefined when calling faxSend." + ); + } + Object.assign(localVarHeaderParams, options.headers); + let localVarUseFormData = false; + const result = generateFormData( + faxSendRequest, + FaxSendRequest.attributeTypeMap + ); + localVarUseFormData = result.localVarUseFormData; + let data = {}; + if (localVarUseFormData) { + const formData2 = toFormData3(result.data); + data = formData2; + localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); + } else { + data = ObjectSerializer.serialize(faxSendRequest, "FaxSendRequest"); + } + let localVarRequestOptions = { + method: "POST", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + data + }; + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then( + () => this.authentications.default.applyToRequest(localVarRequestOptions) + ); + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then( + () => interceptor(localVarRequestOptions) + ); + } + return interceptorPromise.then(() => { + return new Promise((resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse5( + resolve, + reject, + response, + "FaxGetResponse" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse5( + reject, + error.response, + 200, + "FaxGetResponse" + )) { + return; + } + if (handleErrorRangeResponse5( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + }); + }); + }); + } +}; +function deserializeIfNeeded4(obj, classname) { + if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { + return ObjectSerializer.deserialize(obj, classname); + } + return obj; +} +function handleSuccessfulResponse5(resolve, reject, response, returnType) { + let body = response.data; + if (response.status && response.status >= 200 && response.status <= 299) { + if (returnType) { + body = ObjectSerializer.deserialize(body, returnType); + } + resolve({ response, body }); + } else { + reject(new HttpError(response, body, response.status)); + } +} +function handleErrorCodeResponse5(reject, response, code, returnType) { + if (response.status !== code) { + return false; + } + const body = ObjectSerializer.deserialize(response.data, returnType); + reject(new HttpError(response, body, response.status)); + return true; +} +function handleErrorRangeResponse5(reject, response, code, returnType) { + let rangeCodeLeft = Number(code[0] + "00"); + let rangeCodeRight = Number(code[0] + "99"); + if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { + const body = ObjectSerializer.deserialize(response.data, returnType); + reject(new HttpError(response, body, response.status)); + return true; + } + return false; +} + +// api/faxLineApi.ts +var defaultBasePath6 = "https://api.hellosign.com/v3"; +var FaxLineApi = class { + constructor(basePath) { + this._basePath = defaultBasePath6; + this._defaultHeaders = { "User-Agent": USER_AGENT }; + this._useQuerystring = false; + this.authentications = { + default: new VoidAuth(), + api_key: new HttpBasicAuth(), + oauth2: new HttpBearerAuth() + }; + this.interceptors = []; + if (basePath) { + this.basePath = basePath; + } + } + set useQuerystring(value) { + this._useQuerystring = value; + } + set basePath(basePath) { + this._basePath = basePath; + } + set defaultHeaders(defaultHeaders) { + this._defaultHeaders = __spreadProps(__spreadValues({}, defaultHeaders), { "User-Agent": USER_AGENT }); + } + get defaultHeaders() { + return this._defaultHeaders; + } + get basePath() { + return this._basePath; + } + setDefaultAuthentication(auth) { + this.authentications.default = auth; + } + setApiKey(key) { + this.authentications.api_key.username = key; + } + set username(username) { + this.authentications.api_key.username = username; + } + set password(password) { + this.authentications.api_key.password = password; + } + set accessToken(accessToken) { + this.authentications.oauth2.accessToken = accessToken; + } + addInterceptor(interceptor) { + this.interceptors.push(interceptor); + } + faxLineAddUser(_0) { + return __async(this, arguments, function* (faxLineAddUserRequest, options = { headers: {} }) { + faxLineAddUserRequest = deserializeIfNeeded5( + faxLineAddUserRequest, + "FaxLineAddUserRequest" + ); + const localVarPath = this.basePath + "/fax_line/add_user"; + let localVarQueryParameters = {}; + let localVarHeaderParams = Object.assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams = {}; + let localVarBodyParams = void 0; + if (faxLineAddUserRequest === null || faxLineAddUserRequest === void 0) { + throw new Error( + "Required parameter faxLineAddUserRequest was null or undefined when calling faxLineAddUser." + ); + } + Object.assign(localVarHeaderParams, options.headers); + let localVarUseFormData = false; + const result = generateFormData( + faxLineAddUserRequest, + FaxLineAddUserRequest.attributeTypeMap + ); + localVarUseFormData = result.localVarUseFormData; + let data = {}; + if (localVarUseFormData) { + const formData2 = toFormData3(result.data); + data = formData2; + localVarHeaderParams = __spreadValues(__spreadValues({}, localVarHeaderParams), formData2.getHeaders()); + } else { + data = ObjectSerializer.serialize( + faxLineAddUserRequest, + "FaxLineAddUserRequest" + ); + } + let localVarRequestOptions = { + method: "PUT", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json", + data + }; + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then( + () => this.authentications.default.applyToRequest(localVarRequestOptions) + ); + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then( + () => interceptor(localVarRequestOptions) + ); + } + return interceptorPromise.then(() => { + return new Promise((resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse6( + resolve, + reject, + response, + "FaxLineResponse" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse6( + reject, + error.response, + 200, + "FaxLineResponse" + )) { + return; + } + if (handleErrorRangeResponse6( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + }); + }); + }); + } + faxLineAreaCodeGet(_0, _1, _2, _3) { + return __async(this, arguments, function* (country, state, province, city, options = { headers: {} }) { + const localVarPath = this.basePath + "/fax_line/area_codes"; + let localVarQueryParameters = {}; + let localVarHeaderParams = Object.assign( + {}, + this._defaultHeaders + ); + const produces = ["application/json"]; + if (produces.indexOf("application/json") >= 0) { + localVarHeaderParams["content-type"] = "application/json"; + } else { + localVarHeaderParams["content-type"] = produces.join(","); + } + let localVarFormParams = {}; + let localVarBodyParams = void 0; + if (country === null || country === void 0) { + throw new Error( + "Required parameter country was null or undefined when calling faxLineAreaCodeGet." + ); + } + if (country !== void 0) { + localVarQueryParameters["country"] = ObjectSerializer.serialize( + country, + "'CA' | 'US' | 'UK'" + ); + } + if (state !== void 0) { + localVarQueryParameters["state"] = ObjectSerializer.serialize( + state, + "'AK' | 'AL' | 'AR' | 'AZ' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'GA' | 'HI' | 'IA' | 'ID' | 'IL' | 'IN' | 'KS' | 'KY' | 'LA' | 'MA' | 'MD' | 'ME' | 'MI' | 'MN' | 'MO' | 'MS' | 'MT' | 'NC' | 'ND' | 'NE' | 'NH' | 'NJ' | 'NM' | 'NV' | 'NY' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VA' | 'VT' | 'WA' | 'WI' | 'WV' | 'WY'" + ); + } + if (province !== void 0) { + localVarQueryParameters["province"] = ObjectSerializer.serialize( + province, + "'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NT' | 'NS' | 'NU' | 'ON' | 'PE' | 'QC' | 'SK' | 'YT'" + ); + } + if (city !== void 0) { + localVarQueryParameters["city"] = ObjectSerializer.serialize( + city, + "string" + ); + } + Object.assign(localVarHeaderParams, options.headers); + let localVarUseFormData = false; + let localVarRequestOptions = { + method: "GET", + params: localVarQueryParameters, + headers: localVarHeaderParams, + url: localVarPath, + paramsSerializer: this._useQuerystring ? queryParamsSerializer : void 0, + maxContentLength: Infinity, + maxBodyLength: Infinity, + responseType: "json" + }; + let authenticationPromise = Promise.resolve(); + if (this.authentications.api_key.username) { + authenticationPromise = authenticationPromise.then( + () => this.authentications.api_key.applyToRequest(localVarRequestOptions) + ); + } + authenticationPromise = authenticationPromise.then( + () => this.authentications.default.applyToRequest(localVarRequestOptions) + ); + let interceptorPromise = authenticationPromise; + for (const interceptor of this.interceptors) { + interceptorPromise = interceptorPromise.then( + () => interceptor(localVarRequestOptions) + ); + } + return interceptorPromise.then(() => { + return new Promise( + (resolve, reject) => { + axios_default.request(localVarRequestOptions).then( + (response) => { + handleSuccessfulResponse6( + resolve, + reject, + response, + "FaxLineAreaCodeGetResponse" + ); + }, + (error) => { + if (error.response == null) { + reject(error); + return; + } + if (handleErrorCodeResponse6( + reject, + error.response, + 200, + "FaxLineAreaCodeGetResponse" + )) { + return; + } + if (handleErrorRangeResponse6( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } + reject(error); + } + ); + } + ); }); }); } faxLineCreate(_0) { return __async(this, arguments, function* (faxLineCreateRequest, options = { headers: {} }) { - faxLineCreateRequest = deserializeIfNeeded4( + faxLineCreateRequest = deserializeIfNeeded5( faxLineCreateRequest, "FaxLineCreateRequest" ); @@ -26747,7 +27520,7 @@ var FaxLineApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse5( + handleSuccessfulResponse6( resolve, reject, response, @@ -26759,7 +27532,7 @@ var FaxLineApi = class { reject(error); return; } - if (handleErrorCodeResponse5( + if (handleErrorCodeResponse6( reject, error.response, 200, @@ -26767,7 +27540,7 @@ var FaxLineApi = class { )) { return; } - if (handleErrorRangeResponse5( + if (handleErrorRangeResponse6( reject, error.response, "4XX", @@ -26784,7 +27557,7 @@ var FaxLineApi = class { } faxLineDelete(_0) { return __async(this, arguments, function* (faxLineDeleteRequest, options = { headers: {} }) { - faxLineDeleteRequest = deserializeIfNeeded4( + faxLineDeleteRequest = deserializeIfNeeded5( faxLineDeleteRequest, "FaxLineDeleteRequest" ); @@ -26855,14 +27628,14 @@ var FaxLineApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse5(resolve, reject, response); + handleSuccessfulResponse6(resolve, reject, response); }, (error) => { if (error.response == null) { reject(error); return; } - if (handleErrorRangeResponse5( + if (handleErrorRangeResponse6( reject, error.response, "4XX", @@ -26935,7 +27708,7 @@ var FaxLineApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse5( + handleSuccessfulResponse6( resolve, reject, response, @@ -26947,7 +27720,7 @@ var FaxLineApi = class { reject(error); return; } - if (handleErrorCodeResponse5( + if (handleErrorCodeResponse6( reject, error.response, 200, @@ -26955,7 +27728,7 @@ var FaxLineApi = class { )) { return; } - if (handleErrorRangeResponse5( + if (handleErrorRangeResponse6( reject, error.response, "4XX", @@ -27042,7 +27815,7 @@ var FaxLineApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse5( + handleSuccessfulResponse6( resolve, reject, response, @@ -27054,7 +27827,7 @@ var FaxLineApi = class { reject(error); return; } - if (handleErrorCodeResponse5( + if (handleErrorCodeResponse6( reject, error.response, 200, @@ -27062,7 +27835,7 @@ var FaxLineApi = class { )) { return; } - if (handleErrorRangeResponse5( + if (handleErrorRangeResponse6( reject, error.response, "4XX", @@ -27080,7 +27853,7 @@ var FaxLineApi = class { } faxLineRemoveUser(_0) { return __async(this, arguments, function* (faxLineRemoveUserRequest, options = { headers: {} }) { - faxLineRemoveUserRequest = deserializeIfNeeded4( + faxLineRemoveUserRequest = deserializeIfNeeded5( faxLineRemoveUserRequest, "FaxLineRemoveUserRequest" ); @@ -27151,7 +27924,7 @@ var FaxLineApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse5( + handleSuccessfulResponse6( resolve, reject, response, @@ -27163,7 +27936,7 @@ var FaxLineApi = class { reject(error); return; } - if (handleErrorCodeResponse5( + if (handleErrorCodeResponse6( reject, error.response, 200, @@ -27171,7 +27944,7 @@ var FaxLineApi = class { )) { return; } - if (handleErrorRangeResponse5( + if (handleErrorRangeResponse6( reject, error.response, "4XX", @@ -27187,13 +27960,13 @@ var FaxLineApi = class { }); } }; -function deserializeIfNeeded4(obj, classname) { +function deserializeIfNeeded5(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse5(resolve, reject, response, returnType) { +function handleSuccessfulResponse6(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -27204,7 +27977,7 @@ function handleSuccessfulResponse5(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse5(reject, response, code, returnType) { +function handleErrorCodeResponse6(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -27212,7 +27985,7 @@ function handleErrorCodeResponse5(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse5(reject, response, code, returnType) { +function handleErrorRangeResponse6(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -27224,10 +27997,10 @@ function handleErrorRangeResponse5(reject, response, code, returnType) { } // api/oAuthApi.ts -var defaultBasePath6 = "https://app.hellosign.com"; +var defaultBasePath7 = "https://app.hellosign.com"; var OAuthApi = class { constructor(basePath) { - this._basePath = defaultBasePath6; + this._basePath = defaultBasePath7; this._defaultHeaders = { "User-Agent": USER_AGENT }; this._useQuerystring = false; this.authentications = { @@ -27275,7 +28048,7 @@ var OAuthApi = class { } oauthTokenGenerate(_0) { return __async(this, arguments, function* (oAuthTokenGenerateRequest, options = { headers: {} }) { - oAuthTokenGenerateRequest = deserializeIfNeeded5( + oAuthTokenGenerateRequest = deserializeIfNeeded6( oAuthTokenGenerateRequest, "OAuthTokenGenerateRequest" ); @@ -27341,7 +28114,7 @@ var OAuthApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse6( + handleSuccessfulResponse7( resolve, reject, response, @@ -27353,7 +28126,7 @@ var OAuthApi = class { reject(error); return; } - if (handleErrorCodeResponse6( + if (handleErrorCodeResponse7( reject, error.response, 200, @@ -27361,7 +28134,7 @@ var OAuthApi = class { )) { return; } - if (handleErrorRangeResponse6( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -27378,7 +28151,7 @@ var OAuthApi = class { } oauthTokenRefresh(_0) { return __async(this, arguments, function* (oAuthTokenRefreshRequest, options = { headers: {} }) { - oAuthTokenRefreshRequest = deserializeIfNeeded5( + oAuthTokenRefreshRequest = deserializeIfNeeded6( oAuthTokenRefreshRequest, "OAuthTokenRefreshRequest" ); @@ -27444,7 +28217,7 @@ var OAuthApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse6( + handleSuccessfulResponse7( resolve, reject, response, @@ -27456,7 +28229,7 @@ var OAuthApi = class { reject(error); return; } - if (handleErrorCodeResponse6( + if (handleErrorCodeResponse7( reject, error.response, 200, @@ -27464,7 +28237,7 @@ var OAuthApi = class { )) { return; } - if (handleErrorRangeResponse6( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -27480,13 +28253,13 @@ var OAuthApi = class { }); } }; -function deserializeIfNeeded5(obj, classname) { +function deserializeIfNeeded6(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse6(resolve, reject, response, returnType) { +function handleSuccessfulResponse7(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -27497,7 +28270,7 @@ function handleSuccessfulResponse6(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse6(reject, response, code, returnType) { +function handleErrorCodeResponse7(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -27505,7 +28278,7 @@ function handleErrorCodeResponse6(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse6(reject, response, code, returnType) { +function handleErrorRangeResponse7(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -27517,10 +28290,10 @@ function handleErrorRangeResponse6(reject, response, code, returnType) { } // api/reportApi.ts -var defaultBasePath7 = "https://api.hellosign.com/v3"; +var defaultBasePath8 = "https://api.hellosign.com/v3"; var ReportApi = class { constructor(basePath) { - this._basePath = defaultBasePath7; + this._basePath = defaultBasePath8; this._defaultHeaders = { "User-Agent": USER_AGENT }; this._useQuerystring = false; this.authentications = { @@ -27568,7 +28341,7 @@ var ReportApi = class { } reportCreate(_0) { return __async(this, arguments, function* (reportCreateRequest, options = { headers: {} }) { - reportCreateRequest = deserializeIfNeeded6( + reportCreateRequest = deserializeIfNeeded7( reportCreateRequest, "ReportCreateRequest" ); @@ -27640,7 +28413,7 @@ var ReportApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse7( + handleSuccessfulResponse8( resolve, reject, response, @@ -27652,7 +28425,7 @@ var ReportApi = class { reject(error); return; } - if (handleErrorCodeResponse7( + if (handleErrorCodeResponse8( reject, error.response, 200, @@ -27660,7 +28433,7 @@ var ReportApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -27677,13 +28450,13 @@ var ReportApi = class { }); } }; -function deserializeIfNeeded6(obj, classname) { +function deserializeIfNeeded7(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse7(resolve, reject, response, returnType) { +function handleSuccessfulResponse8(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -27694,7 +28467,7 @@ function handleSuccessfulResponse7(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse7(reject, response, code, returnType) { +function handleErrorCodeResponse8(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -27702,7 +28475,7 @@ function handleErrorCodeResponse7(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse7(reject, response, code, returnType) { +function handleErrorRangeResponse8(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -27714,10 +28487,10 @@ function handleErrorRangeResponse7(reject, response, code, returnType) { } // api/signatureRequestApi.ts -var defaultBasePath8 = "https://api.hellosign.com/v3"; +var defaultBasePath9 = "https://api.hellosign.com/v3"; var SignatureRequestApi = class { constructor(basePath) { - this._basePath = defaultBasePath8; + this._basePath = defaultBasePath9; this._defaultHeaders = { "User-Agent": USER_AGENT }; this._useQuerystring = false; this.authentications = { @@ -27765,7 +28538,7 @@ var SignatureRequestApi = class { } signatureRequestBulkCreateEmbeddedWithTemplate(_0) { return __async(this, arguments, function* (signatureRequestBulkCreateEmbeddedWithTemplateRequest, options = { headers: {} }) { - signatureRequestBulkCreateEmbeddedWithTemplateRequest = deserializeIfNeeded7( + signatureRequestBulkCreateEmbeddedWithTemplateRequest = deserializeIfNeeded8( signatureRequestBulkCreateEmbeddedWithTemplateRequest, "SignatureRequestBulkCreateEmbeddedWithTemplateRequest" ); @@ -27837,7 +28610,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -27849,7 +28622,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -27857,7 +28630,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -27875,7 +28648,7 @@ var SignatureRequestApi = class { } signatureRequestBulkSendWithTemplate(_0) { return __async(this, arguments, function* (signatureRequestBulkSendWithTemplateRequest, options = { headers: {} }) { - signatureRequestBulkSendWithTemplateRequest = deserializeIfNeeded7( + signatureRequestBulkSendWithTemplateRequest = deserializeIfNeeded8( signatureRequestBulkSendWithTemplateRequest, "SignatureRequestBulkSendWithTemplateRequest" ); @@ -27952,7 +28725,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -27964,7 +28737,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -27972,7 +28745,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28048,14 +28821,14 @@ var SignatureRequestApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8(resolve, reject, response); + handleSuccessfulResponse9(resolve, reject, response); }, (error) => { if (error.response == null) { reject(error); return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28072,7 +28845,7 @@ var SignatureRequestApi = class { } signatureRequestCreateEmbedded(_0) { return __async(this, arguments, function* (signatureRequestCreateEmbeddedRequest, options = { headers: {} }) { - signatureRequestCreateEmbeddedRequest = deserializeIfNeeded7( + signatureRequestCreateEmbeddedRequest = deserializeIfNeeded8( signatureRequestCreateEmbeddedRequest, "SignatureRequestCreateEmbeddedRequest" ); @@ -28149,7 +28922,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28161,7 +28934,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28169,7 +28942,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28187,7 +28960,7 @@ var SignatureRequestApi = class { } signatureRequestCreateEmbeddedWithTemplate(_0) { return __async(this, arguments, function* (signatureRequestCreateEmbeddedWithTemplateRequest, options = { headers: {} }) { - signatureRequestCreateEmbeddedWithTemplateRequest = deserializeIfNeeded7( + signatureRequestCreateEmbeddedWithTemplateRequest = deserializeIfNeeded8( signatureRequestCreateEmbeddedWithTemplateRequest, "SignatureRequestCreateEmbeddedWithTemplateRequest" ); @@ -28264,7 +29037,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28276,7 +29049,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28284,7 +29057,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28366,7 +29139,7 @@ var SignatureRequestApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28378,7 +29151,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28386,7 +29159,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28462,7 +29235,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28474,7 +29247,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28482,7 +29255,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28564,7 +29337,7 @@ var SignatureRequestApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28576,7 +29349,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28584,7 +29357,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28660,7 +29433,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28672,7 +29445,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28680,7 +29453,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28773,7 +29546,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28785,7 +29558,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28793,7 +29566,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28870,7 +29643,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -28882,7 +29655,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -28890,7 +29663,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -28908,7 +29681,7 @@ var SignatureRequestApi = class { } signatureRequestRemind(_0, _1) { return __async(this, arguments, function* (signatureRequestId, signatureRequestRemindRequest, options = { headers: {} }) { - signatureRequestRemindRequest = deserializeIfNeeded7( + signatureRequestRemindRequest = deserializeIfNeeded8( signatureRequestRemindRequest, "SignatureRequestRemindRequest" ); @@ -28993,7 +29766,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -29005,7 +29778,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -29013,7 +29786,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29084,14 +29857,14 @@ var SignatureRequestApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8(resolve, reject, response); + handleSuccessfulResponse9(resolve, reject, response); }, (error) => { if (error.response == null) { reject(error); return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29108,7 +29881,7 @@ var SignatureRequestApi = class { } signatureRequestSend(_0) { return __async(this, arguments, function* (signatureRequestSendRequest, options = { headers: {} }) { - signatureRequestSendRequest = deserializeIfNeeded7( + signatureRequestSendRequest = deserializeIfNeeded8( signatureRequestSendRequest, "SignatureRequestSendRequest" ); @@ -29185,7 +29958,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -29197,7 +29970,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -29205,7 +29978,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29223,7 +29996,7 @@ var SignatureRequestApi = class { } signatureRequestSendWithTemplate(_0) { return __async(this, arguments, function* (signatureRequestSendWithTemplateRequest, options = { headers: {} }) { - signatureRequestSendWithTemplateRequest = deserializeIfNeeded7( + signatureRequestSendWithTemplateRequest = deserializeIfNeeded8( signatureRequestSendWithTemplateRequest, "SignatureRequestSendWithTemplateRequest" ); @@ -29300,7 +30073,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -29312,7 +30085,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -29320,7 +30093,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29338,7 +30111,7 @@ var SignatureRequestApi = class { } signatureRequestUpdate(_0, _1) { return __async(this, arguments, function* (signatureRequestId, signatureRequestUpdateRequest, options = { headers: {} }) { - signatureRequestUpdateRequest = deserializeIfNeeded7( + signatureRequestUpdateRequest = deserializeIfNeeded8( signatureRequestUpdateRequest, "SignatureRequestUpdateRequest" ); @@ -29423,7 +30196,7 @@ var SignatureRequestApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse8( + handleSuccessfulResponse9( resolve, reject, response, @@ -29435,7 +30208,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorCodeResponse8( + if (handleErrorCodeResponse9( reject, error.response, 200, @@ -29443,7 +30216,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29460,13 +30233,13 @@ var SignatureRequestApi = class { }); } }; -function deserializeIfNeeded7(obj, classname) { +function deserializeIfNeeded8(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse8(resolve, reject, response, returnType) { +function handleSuccessfulResponse9(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -29477,7 +30250,7 @@ function handleSuccessfulResponse8(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse8(reject, response, code, returnType) { +function handleErrorCodeResponse9(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -29485,7 +30258,7 @@ function handleErrorCodeResponse8(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse8(reject, response, code, returnType) { +function handleErrorRangeResponse9(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -29497,10 +30270,10 @@ function handleErrorRangeResponse8(reject, response, code, returnType) { } // api/teamApi.ts -var defaultBasePath9 = "https://api.hellosign.com/v3"; +var defaultBasePath10 = "https://api.hellosign.com/v3"; var TeamApi = class { constructor(basePath) { - this._basePath = defaultBasePath9; + this._basePath = defaultBasePath10; this._defaultHeaders = { "User-Agent": USER_AGENT }; this._useQuerystring = false; this.authentications = { @@ -29548,7 +30321,7 @@ var TeamApi = class { } teamAddMember(_0, _1) { return __async(this, arguments, function* (teamAddMemberRequest, teamId, options = { headers: {} }) { - teamAddMemberRequest = deserializeIfNeeded8( + teamAddMemberRequest = deserializeIfNeeded9( teamAddMemberRequest, "TeamAddMemberRequest" ); @@ -29630,7 +30403,7 @@ var TeamApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -29642,7 +30415,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -29650,7 +30423,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -29667,7 +30440,7 @@ var TeamApi = class { } teamCreate(_0) { return __async(this, arguments, function* (teamCreateRequest, options = { headers: {} }) { - teamCreateRequest = deserializeIfNeeded8( + teamCreateRequest = deserializeIfNeeded9( teamCreateRequest, "TeamCreateRequest" ); @@ -29740,7 +30513,7 @@ var TeamApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -29752,7 +30525,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -29760,7 +30533,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -29827,14 +30600,14 @@ var TeamApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9(resolve, reject, response); + handleSuccessfulResponse10(resolve, reject, response); }, (error) => { if (error.response == null) { reject(error); return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -29901,7 +30674,7 @@ var TeamApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -29913,7 +30686,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -29921,7 +30694,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -29995,7 +30768,7 @@ var TeamApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -30007,7 +30780,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -30015,7 +30788,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30090,7 +30863,7 @@ var TeamApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -30102,7 +30875,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -30110,7 +30883,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30199,7 +30972,7 @@ var TeamApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -30211,7 +30984,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -30219,7 +30992,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30237,7 +31010,7 @@ var TeamApi = class { } teamRemoveMember(_0) { return __async(this, arguments, function* (teamRemoveMemberRequest, options = { headers: {} }) { - teamRemoveMemberRequest = deserializeIfNeeded8( + teamRemoveMemberRequest = deserializeIfNeeded9( teamRemoveMemberRequest, "TeamRemoveMemberRequest" ); @@ -30313,7 +31086,7 @@ var TeamApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -30325,7 +31098,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 201, @@ -30333,7 +31106,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30421,7 +31194,7 @@ var TeamApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -30433,7 +31206,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -30441,7 +31214,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30459,7 +31232,7 @@ var TeamApi = class { } teamUpdate(_0) { return __async(this, arguments, function* (teamUpdateRequest, options = { headers: {} }) { - teamUpdateRequest = deserializeIfNeeded8( + teamUpdateRequest = deserializeIfNeeded9( teamUpdateRequest, "TeamUpdateRequest" ); @@ -30532,7 +31305,7 @@ var TeamApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse9( + handleSuccessfulResponse10( resolve, reject, response, @@ -30544,7 +31317,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorCodeResponse9( + if (handleErrorCodeResponse10( reject, error.response, 200, @@ -30552,7 +31325,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30568,13 +31341,13 @@ var TeamApi = class { }); } }; -function deserializeIfNeeded8(obj, classname) { +function deserializeIfNeeded9(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse9(resolve, reject, response, returnType) { +function handleSuccessfulResponse10(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -30585,7 +31358,7 @@ function handleSuccessfulResponse9(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse9(reject, response, code, returnType) { +function handleErrorCodeResponse10(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -30593,7 +31366,7 @@ function handleErrorCodeResponse9(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse9(reject, response, code, returnType) { +function handleErrorRangeResponse10(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -30605,10 +31378,10 @@ function handleErrorRangeResponse9(reject, response, code, returnType) { } // api/templateApi.ts -var defaultBasePath10 = "https://api.hellosign.com/v3"; +var defaultBasePath11 = "https://api.hellosign.com/v3"; var TemplateApi = class { constructor(basePath) { - this._basePath = defaultBasePath10; + this._basePath = defaultBasePath11; this._defaultHeaders = { "User-Agent": USER_AGENT }; this._useQuerystring = false; this.authentications = { @@ -30656,7 +31429,7 @@ var TemplateApi = class { } templateAddUser(_0, _1) { return __async(this, arguments, function* (templateId, templateAddUserRequest, options = { headers: {} }) { - templateAddUserRequest = deserializeIfNeeded9( + templateAddUserRequest = deserializeIfNeeded10( templateAddUserRequest, "TemplateAddUserRequest" ); @@ -30741,7 +31514,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -30753,7 +31526,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -30761,7 +31534,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -30779,7 +31552,7 @@ var TemplateApi = class { } templateCreate(_0) { return __async(this, arguments, function* (templateCreateRequest, options = { headers: {} }) { - templateCreateRequest = deserializeIfNeeded9( + templateCreateRequest = deserializeIfNeeded10( templateCreateRequest, "TemplateCreateRequest" ); @@ -30856,7 +31629,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -30868,7 +31641,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -30876,7 +31649,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -30894,7 +31667,7 @@ var TemplateApi = class { } templateCreateEmbeddedDraft(_0) { return __async(this, arguments, function* (templateCreateEmbeddedDraftRequest, options = { headers: {} }) { - templateCreateEmbeddedDraftRequest = deserializeIfNeeded9( + templateCreateEmbeddedDraftRequest = deserializeIfNeeded10( templateCreateEmbeddedDraftRequest, "TemplateCreateEmbeddedDraftRequest" ); @@ -30971,7 +31744,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -30983,7 +31756,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -30991,7 +31764,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31067,14 +31840,14 @@ var TemplateApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10(resolve, reject, response); + handleSuccessfulResponse11(resolve, reject, response); }, (error) => { if (error.response == null) { reject(error); return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31155,7 +31928,7 @@ var TemplateApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -31167,7 +31940,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -31175,7 +31948,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31251,7 +32024,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -31263,7 +32036,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -31271,7 +32044,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31353,7 +32126,7 @@ var TemplateApi = class { return new Promise((resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -31365,7 +32138,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -31373,7 +32146,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31449,7 +32222,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -31461,7 +32234,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -31469,7 +32242,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31562,7 +32335,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -31574,7 +32347,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -31582,7 +32355,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31600,7 +32373,7 @@ var TemplateApi = class { } templateRemoveUser(_0, _1) { return __async(this, arguments, function* (templateId, templateRemoveUserRequest, options = { headers: {} }) { - templateRemoveUserRequest = deserializeIfNeeded9( + templateRemoveUserRequest = deserializeIfNeeded10( templateRemoveUserRequest, "TemplateRemoveUserRequest" ); @@ -31685,7 +32458,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -31697,7 +32470,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -31705,7 +32478,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31723,7 +32496,7 @@ var TemplateApi = class { } templateUpdateFiles(_0, _1) { return __async(this, arguments, function* (templateId, templateUpdateFilesRequest, options = { headers: {} }) { - templateUpdateFilesRequest = deserializeIfNeeded9( + templateUpdateFilesRequest = deserializeIfNeeded10( templateUpdateFilesRequest, "TemplateUpdateFilesRequest" ); @@ -31808,7 +32581,7 @@ var TemplateApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse10( + handleSuccessfulResponse11( resolve, reject, response, @@ -31820,7 +32593,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorCodeResponse10( + if (handleErrorCodeResponse11( reject, error.response, 200, @@ -31828,7 +32601,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -31845,13 +32618,13 @@ var TemplateApi = class { }); } }; -function deserializeIfNeeded9(obj, classname) { +function deserializeIfNeeded10(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse10(resolve, reject, response, returnType) { +function handleSuccessfulResponse11(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -31862,7 +32635,7 @@ function handleSuccessfulResponse10(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse10(reject, response, code, returnType) { +function handleErrorCodeResponse11(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -31870,7 +32643,7 @@ function handleErrorCodeResponse10(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse10(reject, response, code, returnType) { +function handleErrorRangeResponse11(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -31882,10 +32655,10 @@ function handleErrorRangeResponse10(reject, response, code, returnType) { } // api/unclaimedDraftApi.ts -var defaultBasePath11 = "https://api.hellosign.com/v3"; +var defaultBasePath12 = "https://api.hellosign.com/v3"; var UnclaimedDraftApi = class { constructor(basePath) { - this._basePath = defaultBasePath11; + this._basePath = defaultBasePath12; this._defaultHeaders = { "User-Agent": USER_AGENT }; this._useQuerystring = false; this.authentications = { @@ -31933,7 +32706,7 @@ var UnclaimedDraftApi = class { } unclaimedDraftCreate(_0) { return __async(this, arguments, function* (unclaimedDraftCreateRequest, options = { headers: {} }) { - unclaimedDraftCreateRequest = deserializeIfNeeded10( + unclaimedDraftCreateRequest = deserializeIfNeeded11( unclaimedDraftCreateRequest, "UnclaimedDraftCreateRequest" ); @@ -32010,7 +32783,7 @@ var UnclaimedDraftApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse11( + handleSuccessfulResponse12( resolve, reject, response, @@ -32022,7 +32795,7 @@ var UnclaimedDraftApi = class { reject(error); return; } - if (handleErrorCodeResponse11( + if (handleErrorCodeResponse12( reject, error.response, 200, @@ -32030,7 +32803,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse11( + if (handleErrorRangeResponse12( reject, error.response, "4XX", @@ -32048,7 +32821,7 @@ var UnclaimedDraftApi = class { } unclaimedDraftCreateEmbedded(_0) { return __async(this, arguments, function* (unclaimedDraftCreateEmbeddedRequest, options = { headers: {} }) { - unclaimedDraftCreateEmbeddedRequest = deserializeIfNeeded10( + unclaimedDraftCreateEmbeddedRequest = deserializeIfNeeded11( unclaimedDraftCreateEmbeddedRequest, "UnclaimedDraftCreateEmbeddedRequest" ); @@ -32125,7 +32898,7 @@ var UnclaimedDraftApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse11( + handleSuccessfulResponse12( resolve, reject, response, @@ -32137,7 +32910,7 @@ var UnclaimedDraftApi = class { reject(error); return; } - if (handleErrorCodeResponse11( + if (handleErrorCodeResponse12( reject, error.response, 200, @@ -32145,7 +32918,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse11( + if (handleErrorRangeResponse12( reject, error.response, "4XX", @@ -32163,7 +32936,7 @@ var UnclaimedDraftApi = class { } unclaimedDraftCreateEmbeddedWithTemplate(_0) { return __async(this, arguments, function* (unclaimedDraftCreateEmbeddedWithTemplateRequest, options = { headers: {} }) { - unclaimedDraftCreateEmbeddedWithTemplateRequest = deserializeIfNeeded10( + unclaimedDraftCreateEmbeddedWithTemplateRequest = deserializeIfNeeded11( unclaimedDraftCreateEmbeddedWithTemplateRequest, "UnclaimedDraftCreateEmbeddedWithTemplateRequest" ); @@ -32240,7 +33013,7 @@ var UnclaimedDraftApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse11( + handleSuccessfulResponse12( resolve, reject, response, @@ -32252,7 +33025,7 @@ var UnclaimedDraftApi = class { reject(error); return; } - if (handleErrorCodeResponse11( + if (handleErrorCodeResponse12( reject, error.response, 200, @@ -32260,7 +33033,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse11( + if (handleErrorRangeResponse12( reject, error.response, "4XX", @@ -32278,7 +33051,7 @@ var UnclaimedDraftApi = class { } unclaimedDraftEditAndResend(_0, _1) { return __async(this, arguments, function* (signatureRequestId, unclaimedDraftEditAndResendRequest, options = { headers: {} }) { - unclaimedDraftEditAndResendRequest = deserializeIfNeeded10( + unclaimedDraftEditAndResendRequest = deserializeIfNeeded11( unclaimedDraftEditAndResendRequest, "UnclaimedDraftEditAndResendRequest" ); @@ -32363,7 +33136,7 @@ var UnclaimedDraftApi = class { (resolve, reject) => { axios_default.request(localVarRequestOptions).then( (response) => { - handleSuccessfulResponse11( + handleSuccessfulResponse12( resolve, reject, response, @@ -32375,7 +33148,7 @@ var UnclaimedDraftApi = class { reject(error); return; } - if (handleErrorCodeResponse11( + if (handleErrorCodeResponse12( reject, error.response, 200, @@ -32383,7 +33156,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse11( + if (handleErrorRangeResponse12( reject, error.response, "4XX", @@ -32400,13 +33173,13 @@ var UnclaimedDraftApi = class { }); } }; -function deserializeIfNeeded10(obj, classname) { +function deserializeIfNeeded11(obj, classname) { if (obj !== null && obj !== void 0 && obj.constructor.name !== classname) { return ObjectSerializer.deserialize(obj, classname); } return obj; } -function handleSuccessfulResponse11(resolve, reject, response, returnType) { +function handleSuccessfulResponse12(resolve, reject, response, returnType) { let body = response.data; if (response.status && response.status >= 200 && response.status <= 299) { if (returnType) { @@ -32417,7 +33190,7 @@ function handleSuccessfulResponse11(resolve, reject, response, returnType) { reject(new HttpError(response, body, response.status)); } } -function handleErrorCodeResponse11(reject, response, code, returnType) { +function handleErrorCodeResponse12(reject, response, code, returnType) { if (response.status !== code) { return false; } @@ -32425,7 +33198,7 @@ function handleErrorCodeResponse11(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse11(reject, response, code, returnType) { +function handleErrorRangeResponse12(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -32515,6 +33288,7 @@ var APIS = [ ApiAppApi, BulkSendJobApi, EmbeddedApi, + FaxApi, FaxLineApi, OAuthApi, ReportApi, @@ -32566,6 +33340,8 @@ var APIS = [ EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, + FaxApi, + FaxGetResponse, FaxLineAddUserRequest, FaxLineApi, FaxLineAreaCodeGetCountryEnum, @@ -32578,6 +33354,10 @@ var APIS = [ FaxLineRemoveUserRequest, FaxLineResponse, FaxLineResponseFaxLine, + FaxListResponse, + FaxResponse, + FaxResponseTransmission, + FaxSendRequest, FileResponse, FileResponseDataUri, HttpBasicAuth, diff --git a/sdks/node/docs/api/FaxApi.md b/sdks/node/docs/api/FaxApi.md new file mode 100644 index 000000000..84ccc7b39 --- /dev/null +++ b/sdks/node/docs/api/FaxApi.md @@ -0,0 +1,458 @@ +# FaxApi + +All URIs are relative to https://api.hellosign.com/v3. + +| Method | HTTP request | Description | +| ------------- | ------------- | ------------- | +| [**faxDelete()**](FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax | +| [**faxFiles()**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files | +| [**faxGet()**](FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax | +| [**faxList()**](FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes | +| [**faxSend()**](FaxApi.md#faxSend) | **POST** /fax/send | Send Fax | + + +## `faxDelete()` + +```typescript +faxDelete(faxId: string) +``` + +Delete Fax + +Deletes the specified Fax from the system. + +### TypeScript Example + +```typescript +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const result = faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + +result.catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### JavaScript Example + +```javascript +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const result = faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + +result.catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **faxId** | **string**| Fax ID | | + +### Return type + +void (empty response body) + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `faxFiles()` + +```typescript +faxFiles(faxId: string): Buffer +``` + +List Fax Files + +Returns list of fax files + +### TypeScript Example + +```typescript +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +const result = faxApi.faxFiles(faxId); +result.then(response => { + fs.createWriteStream('file_response.pdf').write(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### JavaScript Example + +```javascript +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +const result = faxApi.faxFiles(faxId); +result.then(response => { + fs.createWriteStream('file_response.pdf').write(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **faxId** | **string**| Fax ID | | + +### Return type + +**Buffer** + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/pdf`, `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `faxGet()` + +```typescript +faxGet(faxId: string): FaxGetResponse +``` + +Get Fax + +Returns information about fax + +### TypeScript Example + +```typescript +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.ApiAppApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + +const result = faxApi.faxGet(faxId); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### JavaScript Example + +```javascript +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + +const result = faxApi.faxGet(faxId); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **faxId** | **string**| Fax ID | | + +### Return type + +[**FaxGetResponse**](../model/FaxGetResponse.md) + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `faxList()` + +```typescript +faxList(page: number, pageSize: number): FaxListResponse +``` + +Lists Faxes + +Returns properties of multiple faxes + +### TypeScript Example + +```typescript +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const page = 1; +const pageSize = 2; + +const result = faxApi.faxList(page, pageSize); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### JavaScript Example + +```javascript +import * as DropboxSign from "@dropbox/sign"; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +const page = 1; +const pageSize = 2; + +const result = faxApi.faxList(page, pageSize); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **page** | **number**| Page | [optional] [default to 1] | +| **pageSize** | **number**| Page size | [optional] [default to 20] | + +### Return type + +[**FaxListResponse**](../model/FaxListResponse.md) + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `faxSend()` + +```typescript +faxSend(faxSendRequest: FaxSendRequest): FaxGetResponse +``` + +Send Fax + +Action to prepare and send a fax + +### TypeScript Example + +```typescript +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +// Upload a local file +const file = fs.createReadStream("example_signature_request.pdf"); + +// or, upload from buffer +const fileBuffer: DropboxSign.RequestDetailedFile = { + value: fs.readFileSync("example_signature_request.pdf"), + options: { + filename: "example_signature_request.pdf", + contentType: "application/pdf", + }, +}; + +// or, upload from buffer alternative +const fileBufferAlt: DropboxSign.RequestDetailedFile = { + value: Buffer.from("abc-123"), + options: { + filename: "txt-sample.txt", + contentType: "text/plain", + }, +}; + +const data: DropboxSign.FaxSendRequest = { + files: [ file, fileBuffer, fileBufferAlt ], + testMode: true, + recipient: "16690000001", + sender: "16690000000", + coverPageTo: "Jill Fax", + coverPageMessage: "I'm sending you a fax!", + coverPageFrom: "Faxer Faxerson", + title: "This is what the fax is about!", +}; + +const result = faxApi.faxSend(data); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### JavaScript Example + +```javascript +import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; + +const faxApi = new DropboxSign.FaxApi(); + +// Configure HTTP basic authorization: api_key +faxApi.username = "YOUR_API_KEY"; + +// Upload a local file +const file = fs.createReadStream("example_signature_request.pdf"); + +// or, upload from buffer +const fileBuffer = { + value: fs.readFileSync("example_signature_request.pdf"), + options: { + filename: "example_signature_request.pdf", + contentType: "application/pdf", + }, +}; + +// or, upload from buffer alternative +const fileBufferAlt = { + value: Buffer.from("abc-123"), + options: { + filename: "txt-sample.txt", + contentType: "text/plain", + }, +}; + +const data = { + files: [ file, fileBuffer, fileBufferAlt ], + testMode: true, + recipient: "16690000001", + sender: "16690000000", + coverPageTo: "Jill Fax", + coverPageMessage: "I'm sending you a fax!", + coverPageFrom: "Faxer Faxerson", + title: "This is what the fax is about!", +}; + +const result = faxApi.faxSend(data); +result.then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling Dropbox Sign API:"); + console.log(error.body); +}); + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **faxSendRequest** | [**FaxSendRequest**](../model/FaxSendRequest.md)| | | + +### Return type + +[**FaxGetResponse**](../model/FaxGetResponse.md) + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: `application/json`, `multipart/form-data` +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/FaxGetResponse.md b/sdks/node/docs/model/FaxGetResponse.md new file mode 100644 index 000000000..d688d55b8 --- /dev/null +++ b/sdks/node/docs/model/FaxGetResponse.md @@ -0,0 +1,12 @@ +# # FaxGetResponse + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `fax`*_required_ | [```FaxResponse```](FaxResponse.md) | | | +| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | + +[[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/FaxListResponse.md b/sdks/node/docs/model/FaxListResponse.md new file mode 100644 index 000000000..53d9cf57c --- /dev/null +++ b/sdks/node/docs/model/FaxListResponse.md @@ -0,0 +1,12 @@ +# # FaxListResponse + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `faxes`*_required_ | [```Array```](FaxResponse.md) | | | +| `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | + +[[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/FaxResponse.md b/sdks/node/docs/model/FaxResponse.md new file mode 100644 index 000000000..413a36b71 --- /dev/null +++ b/sdks/node/docs/model/FaxResponse.md @@ -0,0 +1,20 @@ +# # FaxResponse + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `faxId`*_required_ | ```string``` | Fax ID | | +| `title`*_required_ | ```string``` | Fax Title | | +| `originalTitle`*_required_ | ```string``` | Fax Original Title | | +| `subject`*_required_ | ```string``` | Fax Subject | | +| `message`*_required_ | ```string``` | Fax Message | | +| `metadata`*_required_ | ```{ [key: string]: any; }``` | Fax Metadata | | +| `createdAt`*_required_ | ```number``` | Fax Created At Timestamp | | +| `sender`*_required_ | ```string``` | Fax Sender Email | | +| `transmissions`*_required_ | [```Array```](FaxResponseTransmission.md) | Fax Transmissions List | | +| `filesUrl`*_required_ | ```string``` | Fax Files URL | | + +[[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/FaxResponseTransmission.md b/sdks/node/docs/model/FaxResponseTransmission.md new file mode 100644 index 000000000..c0d8491c0 --- /dev/null +++ b/sdks/node/docs/model/FaxResponseTransmission.md @@ -0,0 +1,14 @@ +# # FaxResponseTransmission + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `recipient`*_required_ | ```string``` | Fax Transmission Recipient | | +| `sender`*_required_ | ```string``` | Fax Transmission Sender | | +| `statusCode`*_required_ | ```string``` | Fax Transmission Status Code | | +| `sentAt` | ```number``` | Fax Transmission Sent Timestamp | | + +[[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/FaxSendRequest.md b/sdks/node/docs/model/FaxSendRequest.md new file mode 100644 index 000000000..72ebb6fb0 --- /dev/null +++ b/sdks/node/docs/model/FaxSendRequest.md @@ -0,0 +1,19 @@ +# # FaxSendRequest + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `recipient`*_required_ | ```string``` | Fax Send To Recipient | | +| `sender` | ```string``` | Fax Send From Sender (used only with fax number) | | +| `files` | ```Array``` | Fax File to Send | | +| `fileUrls` | ```Array``` | Fax File URL to Send | | +| `testMode` | ```boolean``` | API Test Mode Setting | [default to false] | +| `coverPageTo` | ```string``` | Fax Cover Page for Recipient | | +| `coverPageFrom` | ```string``` | Fax Cover Page for Sender | | +| `coverPageMessage` | ```string``` | Fax Cover Page Message | | +| `title` | ```string``` | Fax Title | | + +[[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/faxGetResponse.ts b/sdks/node/model/faxGetResponse.ts new file mode 100644 index 000000000..aa016746a --- /dev/null +++ b/sdks/node/model/faxGetResponse.ts @@ -0,0 +1,59 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer } from "./"; +import { FaxResponse } from "./faxResponse"; +import { WarningResponse } from "./warningResponse"; + +export class FaxGetResponse { + "fax": FaxResponse; + /** + * A list of warnings. + */ + "warnings"?: Array; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "fax", + baseName: "fax", + type: "FaxResponse", + }, + { + name: "warnings", + baseName: "warnings", + type: "Array", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return FaxGetResponse.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): FaxGetResponse { + return ObjectSerializer.deserialize(data, "FaxGetResponse"); + } +} diff --git a/sdks/node/model/faxListResponse.ts b/sdks/node/model/faxListResponse.ts new file mode 100644 index 000000000..f3bb7bec7 --- /dev/null +++ b/sdks/node/model/faxListResponse.ts @@ -0,0 +1,56 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer } from "./"; +import { FaxResponse } from "./faxResponse"; +import { ListInfoResponse } from "./listInfoResponse"; + +export class FaxListResponse { + "faxes": Array; + "listInfo": ListInfoResponse; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "faxes", + baseName: "faxes", + type: "Array", + }, + { + name: "listInfo", + baseName: "list_info", + type: "ListInfoResponse", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return FaxListResponse.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): FaxListResponse { + return ObjectSerializer.deserialize(data, "FaxListResponse"); + } +} diff --git a/sdks/node/model/faxResponse.ts b/sdks/node/model/faxResponse.ts new file mode 100644 index 000000000..1697d212a --- /dev/null +++ b/sdks/node/model/faxResponse.ts @@ -0,0 +1,133 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer } from "./"; +import { FaxResponseTransmission } from "./faxResponseTransmission"; + +export class FaxResponse { + /** + * Fax ID + */ + "faxId": string; + /** + * Fax Title + */ + "title": string; + /** + * Fax Original Title + */ + "originalTitle": string; + /** + * Fax Subject + */ + "subject": string; + /** + * Fax Message + */ + "message": string; + /** + * Fax Metadata + */ + "metadata": { [key: string]: any }; + /** + * Fax Created At Timestamp + */ + "createdAt": number; + /** + * Fax Sender Email + */ + "sender": string; + /** + * Fax Transmissions List + */ + "transmissions": Array; + /** + * Fax Files URL + */ + "filesUrl": string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "faxId", + baseName: "fax_id", + type: "string", + }, + { + name: "title", + baseName: "title", + type: "string", + }, + { + name: "originalTitle", + baseName: "original_title", + type: "string", + }, + { + name: "subject", + baseName: "subject", + type: "string", + }, + { + name: "message", + baseName: "message", + type: "string", + }, + { + name: "metadata", + baseName: "metadata", + type: "{ [key: string]: any; }", + }, + { + name: "createdAt", + baseName: "created_at", + type: "number", + }, + { + name: "sender", + baseName: "sender", + type: "string", + }, + { + name: "transmissions", + baseName: "transmissions", + type: "Array", + }, + { + name: "filesUrl", + baseName: "files_url", + type: "string", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return FaxResponse.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): FaxResponse { + return ObjectSerializer.deserialize(data, "FaxResponse"); + } +} diff --git a/sdks/node/model/faxResponseTransmission.ts b/sdks/node/model/faxResponseTransmission.ts new file mode 100644 index 000000000..f43034a9d --- /dev/null +++ b/sdks/node/model/faxResponseTransmission.ts @@ -0,0 +1,91 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer } from "./"; + +export class FaxResponseTransmission { + /** + * Fax Transmission Recipient + */ + "recipient": string; + /** + * Fax Transmission Sender + */ + "sender": string; + /** + * Fax Transmission Status Code + */ + "statusCode": FaxResponseTransmission.StatusCodeEnum; + /** + * Fax Transmission Sent Timestamp + */ + "sentAt"?: number; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "recipient", + baseName: "recipient", + type: "string", + }, + { + name: "sender", + baseName: "sender", + type: "string", + }, + { + name: "statusCode", + baseName: "status_code", + type: "FaxResponseTransmission.StatusCodeEnum", + }, + { + name: "sentAt", + baseName: "sent_at", + type: "number", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return FaxResponseTransmission.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): FaxResponseTransmission { + return ObjectSerializer.deserialize(data, "FaxResponseTransmission"); + } +} + +export namespace FaxResponseTransmission { + export enum StatusCodeEnum { + Success = "success", + Transmitting = "transmitting", + ErrorCouldNotFax = "error_could_not_fax", + ErrorUnknown = "error_unknown", + ErrorBusy = "error_busy", + ErrorNoAnswer = "error_no_answer", + ErrorDisconnected = "error_disconnected", + ErrorBadDestination = "error_bad_destination", + } +} diff --git a/sdks/node/model/faxSendRequest.ts b/sdks/node/model/faxSendRequest.ts new file mode 100644 index 000000000..11ee71ef4 --- /dev/null +++ b/sdks/node/model/faxSendRequest.ts @@ -0,0 +1,123 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer, RequestFile } from "./"; + +export class FaxSendRequest { + /** + * Fax Send To Recipient + */ + "recipient": string; + /** + * Fax Send From Sender (used only with fax number) + */ + "sender"?: string; + /** + * Fax File to Send + */ + "files"?: Array; + /** + * Fax File URL to Send + */ + "fileUrls"?: Array; + /** + * API Test Mode Setting + */ + "testMode"?: boolean = false; + /** + * Fax Cover Page for Recipient + */ + "coverPageTo"?: string; + /** + * Fax Cover Page for Sender + */ + "coverPageFrom"?: string; + /** + * Fax Cover Page Message + */ + "coverPageMessage"?: string; + /** + * Fax Title + */ + "title"?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "recipient", + baseName: "recipient", + type: "string", + }, + { + name: "sender", + baseName: "sender", + type: "string", + }, + { + name: "files", + baseName: "files", + type: "Array", + }, + { + name: "fileUrls", + baseName: "file_urls", + type: "Array", + }, + { + name: "testMode", + baseName: "test_mode", + type: "boolean", + }, + { + name: "coverPageTo", + baseName: "cover_page_to", + type: "string", + }, + { + name: "coverPageFrom", + baseName: "cover_page_from", + type: "string", + }, + { + name: "coverPageMessage", + baseName: "cover_page_message", + type: "string", + }, + { + name: "title", + baseName: "title", + type: "string", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return FaxSendRequest.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): FaxSendRequest { + return ObjectSerializer.deserialize(data, "FaxSendRequest"); + } +} diff --git a/sdks/node/model/index.ts b/sdks/node/model/index.ts index c59b28024..7813c02fc 100644 --- a/sdks/node/model/index.ts +++ b/sdks/node/model/index.ts @@ -33,6 +33,7 @@ import { EventCallbackHelper } from "./eventCallbackHelper"; import { EventCallbackRequest } from "./eventCallbackRequest"; import { EventCallbackRequestEvent } from "./eventCallbackRequestEvent"; import { EventCallbackRequestEventMetadata } from "./eventCallbackRequestEventMetadata"; +import { FaxGetResponse } from "./faxGetResponse"; import { FaxLineAddUserRequest } from "./faxLineAddUserRequest"; import { FaxLineAreaCodeGetCountryEnum } from "./faxLineAreaCodeGetCountryEnum"; import { FaxLineAreaCodeGetProvinceEnum } from "./faxLineAreaCodeGetProvinceEnum"; @@ -44,6 +45,10 @@ import { FaxLineListResponse } from "./faxLineListResponse"; import { FaxLineRemoveUserRequest } from "./faxLineRemoveUserRequest"; import { FaxLineResponse } from "./faxLineResponse"; import { FaxLineResponseFaxLine } from "./faxLineResponseFaxLine"; +import { FaxListResponse } from "./faxListResponse"; +import { FaxResponse } from "./faxResponse"; +import { FaxResponseTransmission } from "./faxResponseTransmission"; +import { FaxSendRequest } from "./faxSendRequest"; import { FileResponse } from "./fileResponse"; import { FileResponseDataUri } from "./fileResponseDataUri"; import { ListInfoResponse } from "./listInfoResponse"; @@ -203,6 +208,8 @@ export let enumsMap: { [index: string]: any } = { FaxLineAreaCodeGetProvinceEnum: FaxLineAreaCodeGetProvinceEnum, FaxLineAreaCodeGetStateEnum: FaxLineAreaCodeGetStateEnum, "FaxLineCreateRequest.CountryEnum": FaxLineCreateRequest.CountryEnum, + "FaxResponseTransmission.StatusCodeEnum": + FaxResponseTransmission.StatusCodeEnum, "ReportCreateRequest.ReportTypeEnum": ReportCreateRequest.ReportTypeEnum, "ReportResponse.ReportTypeEnum": ReportResponse.ReportTypeEnum, SignatureRequestResponseCustomFieldTypeEnum: @@ -279,6 +286,7 @@ export let typeMap: { [index: string]: any } = { EventCallbackRequest: EventCallbackRequest, EventCallbackRequestEvent: EventCallbackRequestEvent, EventCallbackRequestEventMetadata: EventCallbackRequestEventMetadata, + FaxGetResponse: FaxGetResponse, FaxLineAddUserRequest: FaxLineAddUserRequest, FaxLineAreaCodeGetResponse: FaxLineAreaCodeGetResponse, FaxLineCreateRequest: FaxLineCreateRequest, @@ -287,6 +295,10 @@ export let typeMap: { [index: string]: any } = { FaxLineRemoveUserRequest: FaxLineRemoveUserRequest, FaxLineResponse: FaxLineResponse, FaxLineResponseFaxLine: FaxLineResponseFaxLine, + FaxListResponse: FaxListResponse, + FaxResponse: FaxResponse, + FaxResponseTransmission: FaxResponseTransmission, + FaxSendRequest: FaxSendRequest, FileResponse: FileResponse, FileResponseDataUri: FileResponseDataUri, ListInfoResponse: ListInfoResponse, @@ -499,6 +511,7 @@ export { EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, + FaxGetResponse, FaxLineAddUserRequest, FaxLineAreaCodeGetCountryEnum, FaxLineAreaCodeGetProvinceEnum, @@ -510,6 +523,10 @@ export { FaxLineRemoveUserRequest, FaxLineResponse, FaxLineResponseFaxLine, + FaxListResponse, + FaxResponse, + FaxResponseTransmission, + FaxSendRequest, FileResponse, FileResponseDataUri, HttpBasicAuth, diff --git a/sdks/node/types/api/faxApi.d.ts b/sdks/node/types/api/faxApi.d.ts new file mode 100644 index 000000000..f18e42259 --- /dev/null +++ b/sdks/node/types/api/faxApi.d.ts @@ -0,0 +1,32 @@ +import { Authentication, FaxGetResponse, FaxListResponse, FaxSendRequest, HttpBasicAuth, HttpBearerAuth, Interceptor } from "../model"; +import { optionsI, returnTypeI, returnTypeT } from "./"; +export declare enum FaxApiApiKeys { +} +export declare class FaxApi { + protected _basePath: string; + protected _defaultHeaders: any; + protected _useQuerystring: boolean; + protected authentications: { + default: Authentication; + api_key: HttpBasicAuth; + oauth2: HttpBearerAuth; + }; + protected interceptors: Interceptor[]; + constructor(basePath?: string); + set useQuerystring(value: boolean); + set basePath(basePath: string); + set defaultHeaders(defaultHeaders: any); + get defaultHeaders(): any; + get basePath(): string; + setDefaultAuthentication(auth: Authentication): void; + setApiKey(key: string): void; + set username(username: string); + set password(password: string); + set accessToken(accessToken: string | (() => string)); + addInterceptor(interceptor: Interceptor): void; + faxDelete(faxId: string, options?: optionsI): Promise; + faxFiles(faxId: string, options?: optionsI): Promise>; + faxGet(faxId: string, options?: optionsI): Promise>; + faxList(page?: number, pageSize?: number, options?: optionsI): Promise>; + faxSend(faxSendRequest: FaxSendRequest, options?: optionsI): Promise>; +} diff --git a/sdks/node/types/api/index.d.ts b/sdks/node/types/api/index.d.ts index 567248c08..4fb28dcef 100644 --- a/sdks/node/types/api/index.d.ts +++ b/sdks/node/types/api/index.d.ts @@ -2,6 +2,7 @@ import { AccountApi } from "./accountApi"; import { ApiAppApi } from "./apiAppApi"; import { BulkSendJobApi } from "./bulkSendJobApi"; import { EmbeddedApi } from "./embeddedApi"; +import { FaxApi } from "./faxApi"; import { FaxLineApi } from "./faxLineApi"; import { OAuthApi } from "./oAuthApi"; import { ReportApi } from "./reportApi"; @@ -9,6 +10,6 @@ import { SignatureRequestApi } from "./signatureRequestApi"; import { TeamApi } from "./teamApi"; import { TemplateApi } from "./templateApi"; import { UnclaimedDraftApi } from "./unclaimedDraftApi"; -export { AccountApi, ApiAppApi, BulkSendJobApi, EmbeddedApi, FaxLineApi, OAuthApi, ReportApi, SignatureRequestApi, TeamApi, TemplateApi, UnclaimedDraftApi, }; +export { AccountApi, ApiAppApi, BulkSendJobApi, EmbeddedApi, FaxApi, FaxLineApi, OAuthApi, ReportApi, SignatureRequestApi, TeamApi, TemplateApi, UnclaimedDraftApi, }; export { generateFormData, HttpError, optionsI, queryParamsSerializer, returnTypeI, returnTypeT, toFormData, USER_AGENT, } from "./apis"; -export declare const APIS: (typeof AccountApi | typeof ApiAppApi | typeof BulkSendJobApi | typeof EmbeddedApi | typeof FaxLineApi | typeof OAuthApi | typeof ReportApi | typeof SignatureRequestApi | typeof TeamApi | typeof TemplateApi | typeof UnclaimedDraftApi)[]; +export declare const APIS: (typeof AccountApi | typeof ApiAppApi | typeof BulkSendJobApi | typeof EmbeddedApi | typeof FaxApi | typeof FaxLineApi | typeof OAuthApi | typeof ReportApi | typeof SignatureRequestApi | typeof TeamApi | typeof TemplateApi | typeof UnclaimedDraftApi)[]; diff --git a/sdks/node/types/model/faxGetResponse.d.ts b/sdks/node/types/model/faxGetResponse.d.ts new file mode 100644 index 000000000..05b6196dd --- /dev/null +++ b/sdks/node/types/model/faxGetResponse.d.ts @@ -0,0 +1,11 @@ +import { AttributeTypeMap } from "./"; +import { FaxResponse } from "./faxResponse"; +import { WarningResponse } from "./warningResponse"; +export declare class FaxGetResponse { + "fax": FaxResponse; + "warnings"?: Array; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): FaxGetResponse; +} diff --git a/sdks/node/types/model/faxListResponse.d.ts b/sdks/node/types/model/faxListResponse.d.ts new file mode 100644 index 000000000..e36e8a061 --- /dev/null +++ b/sdks/node/types/model/faxListResponse.d.ts @@ -0,0 +1,11 @@ +import { AttributeTypeMap } from "./"; +import { FaxResponse } from "./faxResponse"; +import { ListInfoResponse } from "./listInfoResponse"; +export declare class FaxListResponse { + "faxes": Array; + "listInfo": ListInfoResponse; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): FaxListResponse; +} diff --git a/sdks/node/types/model/faxResponse.d.ts b/sdks/node/types/model/faxResponse.d.ts new file mode 100644 index 000000000..6aa5f2d0a --- /dev/null +++ b/sdks/node/types/model/faxResponse.d.ts @@ -0,0 +1,20 @@ +import { AttributeTypeMap } from "./"; +import { FaxResponseTransmission } from "./faxResponseTransmission"; +export declare class FaxResponse { + "faxId": string; + "title": string; + "originalTitle": string; + "subject": string; + "message": string; + "metadata": { + [key: string]: any; + }; + "createdAt": number; + "sender": string; + "transmissions": Array; + "filesUrl": string; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): FaxResponse; +} diff --git a/sdks/node/types/model/faxResponseTransmission.d.ts b/sdks/node/types/model/faxResponseTransmission.d.ts new file mode 100644 index 000000000..f1d587fc4 --- /dev/null +++ b/sdks/node/types/model/faxResponseTransmission.d.ts @@ -0,0 +1,23 @@ +import { AttributeTypeMap } from "./"; +export declare class FaxResponseTransmission { + "recipient": string; + "sender": string; + "statusCode": FaxResponseTransmission.StatusCodeEnum; + "sentAt"?: number; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): FaxResponseTransmission; +} +export declare namespace FaxResponseTransmission { + enum StatusCodeEnum { + Success = "success", + Transmitting = "transmitting", + ErrorCouldNotFax = "error_could_not_fax", + ErrorUnknown = "error_unknown", + ErrorBusy = "error_busy", + ErrorNoAnswer = "error_no_answer", + ErrorDisconnected = "error_disconnected", + ErrorBadDestination = "error_bad_destination" + } +} diff --git a/sdks/node/types/model/faxSendRequest.d.ts b/sdks/node/types/model/faxSendRequest.d.ts new file mode 100644 index 000000000..95454724e --- /dev/null +++ b/sdks/node/types/model/faxSendRequest.d.ts @@ -0,0 +1,16 @@ +import { AttributeTypeMap, RequestFile } from "./"; +export declare class FaxSendRequest { + "recipient": string; + "sender"?: string; + "files"?: Array; + "fileUrls"?: Array; + "testMode"?: boolean; + "coverPageTo"?: string; + "coverPageFrom"?: string; + "coverPageMessage"?: string; + "title"?: string; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): FaxSendRequest; +} diff --git a/sdks/node/types/model/index.d.ts b/sdks/node/types/model/index.d.ts index ad7859941..664b47950 100644 --- a/sdks/node/types/model/index.d.ts +++ b/sdks/node/types/model/index.d.ts @@ -33,6 +33,7 @@ import { EventCallbackHelper } from "./eventCallbackHelper"; import { EventCallbackRequest } from "./eventCallbackRequest"; import { EventCallbackRequestEvent } from "./eventCallbackRequestEvent"; import { EventCallbackRequestEventMetadata } from "./eventCallbackRequestEventMetadata"; +import { FaxGetResponse } from "./faxGetResponse"; import { FaxLineAddUserRequest } from "./faxLineAddUserRequest"; import { FaxLineAreaCodeGetCountryEnum } from "./faxLineAreaCodeGetCountryEnum"; import { FaxLineAreaCodeGetProvinceEnum } from "./faxLineAreaCodeGetProvinceEnum"; @@ -44,6 +45,10 @@ import { FaxLineListResponse } from "./faxLineListResponse"; import { FaxLineRemoveUserRequest } from "./faxLineRemoveUserRequest"; import { FaxLineResponse } from "./faxLineResponse"; import { FaxLineResponseFaxLine } from "./faxLineResponseFaxLine"; +import { FaxListResponse } from "./faxListResponse"; +import { FaxResponse } from "./faxResponse"; +import { FaxResponseTransmission } from "./faxResponseTransmission"; +import { FaxSendRequest } from "./faxSendRequest"; import { FileResponse } from "./fileResponse"; import { FileResponseDataUri } from "./fileResponseDataUri"; import { ListInfoResponse } from "./listInfoResponse"; @@ -189,4 +194,4 @@ export declare let enumsMap: { export declare let typeMap: { [index: string]: any; }; -export { AccountCreateRequest, AccountCreateResponse, AccountGetResponse, AccountResponse, AccountResponseQuotas, AccountResponseUsage, AccountUpdateRequest, AccountVerifyRequest, AccountVerifyResponse, AccountVerifyResponseAccount, ApiAppCreateRequest, ApiAppGetResponse, ApiAppListResponse, ApiAppResponse, ApiAppResponseOAuth, ApiAppResponseOptions, ApiAppResponseOwnerAccount, ApiAppResponseWhiteLabelingOptions, ApiAppUpdateRequest, ApiKeyAuth, AttributeTypeMap, Authentication, BulkSendJobGetResponse, BulkSendJobGetResponseSignatureRequests, BulkSendJobListResponse, BulkSendJobResponse, BulkSendJobSendResponse, EmbeddedEditUrlRequest, EmbeddedEditUrlResponse, EmbeddedEditUrlResponseEmbedded, EmbeddedSignUrlResponse, EmbeddedSignUrlResponseEmbedded, ErrorResponse, ErrorResponseError, EventCallbackHelper, EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, FaxLineAddUserRequest, FaxLineAreaCodeGetCountryEnum, FaxLineAreaCodeGetProvinceEnum, FaxLineAreaCodeGetResponse, FaxLineAreaCodeGetStateEnum, FaxLineCreateRequest, FaxLineDeleteRequest, FaxLineListResponse, FaxLineRemoveUserRequest, FaxLineResponse, FaxLineResponseFaxLine, FileResponse, FileResponseDataUri, HttpBasicAuth, HttpBearerAuth, Interceptor, ListInfoResponse, OAuth, OAuthTokenGenerateRequest, OAuthTokenRefreshRequest, OAuthTokenResponse, ObjectSerializer, ReportCreateRequest, ReportCreateResponse, ReportResponse, RequestDetailedFile, RequestFile, SignatureRequestBulkCreateEmbeddedWithTemplateRequest, SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, SignatureRequestResponse, SignatureRequestResponseAttachment, SignatureRequestResponseCustomFieldBase, SignatureRequestResponseCustomFieldCheckbox, SignatureRequestResponseCustomFieldText, SignatureRequestResponseCustomFieldTypeEnum, SignatureRequestResponseDataBase, SignatureRequestResponseDataTypeEnum, SignatureRequestResponseDataValueCheckbox, SignatureRequestResponseDataValueCheckboxMerge, SignatureRequestResponseDataValueDateSigned, SignatureRequestResponseDataValueDropdown, SignatureRequestResponseDataValueInitials, SignatureRequestResponseDataValueRadio, SignatureRequestResponseDataValueSignature, SignatureRequestResponseDataValueText, SignatureRequestResponseDataValueTextMerge, SignatureRequestResponseSignatures, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, SignatureRequestUpdateRequest, SubAttachment, SubBulkSignerList, SubBulkSignerListCustomField, SubCC, SubCustomField, SubEditorOptions, SubFieldOptions, SubFormFieldGroup, SubFormFieldRule, SubFormFieldRuleAction, SubFormFieldRuleTrigger, SubFormFieldsPerDocumentBase, SubFormFieldsPerDocumentCheckbox, SubFormFieldsPerDocumentCheckboxMerge, SubFormFieldsPerDocumentDateSigned, SubFormFieldsPerDocumentDropdown, SubFormFieldsPerDocumentFontEnum, SubFormFieldsPerDocumentHyperlink, SubFormFieldsPerDocumentInitials, SubFormFieldsPerDocumentRadio, SubFormFieldsPerDocumentSignature, SubFormFieldsPerDocumentText, SubFormFieldsPerDocumentTextMerge, SubFormFieldsPerDocumentTypeEnum, SubMergeField, SubOAuth, SubOptions, SubSignatureRequestGroupedSigners, SubSignatureRequestSigner, SubSignatureRequestTemplateSigner, SubSigningOptions, SubTeamResponse, SubTemplateRole, SubUnclaimedDraftSigner, SubUnclaimedDraftTemplateSigner, SubWhiteLabelingOptions, TeamAddMemberRequest, TeamCreateRequest, TeamGetInfoResponse, TeamGetResponse, TeamInfoResponse, TeamInviteResponse, TeamInvitesResponse, TeamMemberResponse, TeamMembersResponse, TeamParentResponse, TeamRemoveMemberRequest, TeamResponse, TeamSubTeamsResponse, TeamUpdateRequest, TemplateAddUserRequest, TemplateCreateEmbeddedDraftRequest, TemplateCreateEmbeddedDraftResponse, TemplateCreateEmbeddedDraftResponseTemplate, TemplateCreateRequest, TemplateCreateResponse, TemplateCreateResponseTemplate, TemplateEditResponse, TemplateGetResponse, TemplateListResponse, TemplateRemoveUserRequest, TemplateResponse, TemplateResponseAccount, TemplateResponseAccountQuota, TemplateResponseCCRole, TemplateResponseDocument, TemplateResponseDocumentCustomFieldBase, TemplateResponseDocumentCustomFieldCheckbox, TemplateResponseDocumentCustomFieldText, TemplateResponseDocumentFieldGroup, TemplateResponseDocumentFieldGroupRule, TemplateResponseDocumentFormFieldBase, TemplateResponseDocumentFormFieldCheckbox, TemplateResponseDocumentFormFieldDateSigned, TemplateResponseDocumentFormFieldDropdown, TemplateResponseDocumentFormFieldHyperlink, TemplateResponseDocumentFormFieldInitials, TemplateResponseDocumentFormFieldRadio, TemplateResponseDocumentFormFieldSignature, TemplateResponseDocumentFormFieldText, TemplateResponseDocumentStaticFieldBase, TemplateResponseDocumentStaticFieldCheckbox, TemplateResponseDocumentStaticFieldDateSigned, TemplateResponseDocumentStaticFieldDropdown, TemplateResponseDocumentStaticFieldHyperlink, TemplateResponseDocumentStaticFieldInitials, TemplateResponseDocumentStaticFieldRadio, TemplateResponseDocumentStaticFieldSignature, TemplateResponseDocumentStaticFieldText, TemplateResponseFieldAvgTextLength, TemplateResponseSignerRole, TemplateUpdateFilesRequest, TemplateUpdateFilesResponse, TemplateUpdateFilesResponseTemplate, UnclaimedDraftCreateEmbeddedRequest, UnclaimedDraftCreateEmbeddedWithTemplateRequest, UnclaimedDraftCreateRequest, UnclaimedDraftCreateResponse, UnclaimedDraftEditAndResendRequest, UnclaimedDraftResponse, VoidAuth, WarningResponse, }; +export { AccountCreateRequest, AccountCreateResponse, AccountGetResponse, AccountResponse, AccountResponseQuotas, AccountResponseUsage, AccountUpdateRequest, AccountVerifyRequest, AccountVerifyResponse, AccountVerifyResponseAccount, ApiAppCreateRequest, ApiAppGetResponse, ApiAppListResponse, ApiAppResponse, ApiAppResponseOAuth, ApiAppResponseOptions, ApiAppResponseOwnerAccount, ApiAppResponseWhiteLabelingOptions, ApiAppUpdateRequest, ApiKeyAuth, AttributeTypeMap, Authentication, BulkSendJobGetResponse, BulkSendJobGetResponseSignatureRequests, BulkSendJobListResponse, BulkSendJobResponse, BulkSendJobSendResponse, EmbeddedEditUrlRequest, EmbeddedEditUrlResponse, EmbeddedEditUrlResponseEmbedded, EmbeddedSignUrlResponse, EmbeddedSignUrlResponseEmbedded, ErrorResponse, ErrorResponseError, EventCallbackHelper, EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, FaxGetResponse, FaxLineAddUserRequest, FaxLineAreaCodeGetCountryEnum, FaxLineAreaCodeGetProvinceEnum, FaxLineAreaCodeGetResponse, FaxLineAreaCodeGetStateEnum, FaxLineCreateRequest, FaxLineDeleteRequest, FaxLineListResponse, FaxLineRemoveUserRequest, FaxLineResponse, FaxLineResponseFaxLine, FaxListResponse, FaxResponse, FaxResponseTransmission, FaxSendRequest, FileResponse, FileResponseDataUri, HttpBasicAuth, HttpBearerAuth, Interceptor, ListInfoResponse, OAuth, OAuthTokenGenerateRequest, OAuthTokenRefreshRequest, OAuthTokenResponse, ObjectSerializer, ReportCreateRequest, ReportCreateResponse, ReportResponse, RequestDetailedFile, RequestFile, SignatureRequestBulkCreateEmbeddedWithTemplateRequest, SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, SignatureRequestResponse, SignatureRequestResponseAttachment, SignatureRequestResponseCustomFieldBase, SignatureRequestResponseCustomFieldCheckbox, SignatureRequestResponseCustomFieldText, SignatureRequestResponseCustomFieldTypeEnum, SignatureRequestResponseDataBase, SignatureRequestResponseDataTypeEnum, SignatureRequestResponseDataValueCheckbox, SignatureRequestResponseDataValueCheckboxMerge, SignatureRequestResponseDataValueDateSigned, SignatureRequestResponseDataValueDropdown, SignatureRequestResponseDataValueInitials, SignatureRequestResponseDataValueRadio, SignatureRequestResponseDataValueSignature, SignatureRequestResponseDataValueText, SignatureRequestResponseDataValueTextMerge, SignatureRequestResponseSignatures, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, SignatureRequestUpdateRequest, SubAttachment, SubBulkSignerList, SubBulkSignerListCustomField, SubCC, SubCustomField, SubEditorOptions, SubFieldOptions, SubFormFieldGroup, SubFormFieldRule, SubFormFieldRuleAction, SubFormFieldRuleTrigger, SubFormFieldsPerDocumentBase, SubFormFieldsPerDocumentCheckbox, SubFormFieldsPerDocumentCheckboxMerge, SubFormFieldsPerDocumentDateSigned, SubFormFieldsPerDocumentDropdown, SubFormFieldsPerDocumentFontEnum, SubFormFieldsPerDocumentHyperlink, SubFormFieldsPerDocumentInitials, SubFormFieldsPerDocumentRadio, SubFormFieldsPerDocumentSignature, SubFormFieldsPerDocumentText, SubFormFieldsPerDocumentTextMerge, SubFormFieldsPerDocumentTypeEnum, SubMergeField, SubOAuth, SubOptions, SubSignatureRequestGroupedSigners, SubSignatureRequestSigner, SubSignatureRequestTemplateSigner, SubSigningOptions, SubTeamResponse, SubTemplateRole, SubUnclaimedDraftSigner, SubUnclaimedDraftTemplateSigner, SubWhiteLabelingOptions, TeamAddMemberRequest, TeamCreateRequest, TeamGetInfoResponse, TeamGetResponse, TeamInfoResponse, TeamInviteResponse, TeamInvitesResponse, TeamMemberResponse, TeamMembersResponse, TeamParentResponse, TeamRemoveMemberRequest, TeamResponse, TeamSubTeamsResponse, TeamUpdateRequest, TemplateAddUserRequest, TemplateCreateEmbeddedDraftRequest, TemplateCreateEmbeddedDraftResponse, TemplateCreateEmbeddedDraftResponseTemplate, TemplateCreateRequest, TemplateCreateResponse, TemplateCreateResponseTemplate, TemplateEditResponse, TemplateGetResponse, TemplateListResponse, TemplateRemoveUserRequest, TemplateResponse, TemplateResponseAccount, TemplateResponseAccountQuota, TemplateResponseCCRole, TemplateResponseDocument, TemplateResponseDocumentCustomFieldBase, TemplateResponseDocumentCustomFieldCheckbox, TemplateResponseDocumentCustomFieldText, TemplateResponseDocumentFieldGroup, TemplateResponseDocumentFieldGroupRule, TemplateResponseDocumentFormFieldBase, TemplateResponseDocumentFormFieldCheckbox, TemplateResponseDocumentFormFieldDateSigned, TemplateResponseDocumentFormFieldDropdown, TemplateResponseDocumentFormFieldHyperlink, TemplateResponseDocumentFormFieldInitials, TemplateResponseDocumentFormFieldRadio, TemplateResponseDocumentFormFieldSignature, TemplateResponseDocumentFormFieldText, TemplateResponseDocumentStaticFieldBase, TemplateResponseDocumentStaticFieldCheckbox, TemplateResponseDocumentStaticFieldDateSigned, TemplateResponseDocumentStaticFieldDropdown, TemplateResponseDocumentStaticFieldHyperlink, TemplateResponseDocumentStaticFieldInitials, TemplateResponseDocumentStaticFieldRadio, TemplateResponseDocumentStaticFieldSignature, TemplateResponseDocumentStaticFieldText, TemplateResponseFieldAvgTextLength, TemplateResponseSignerRole, TemplateUpdateFilesRequest, TemplateUpdateFilesResponse, TemplateUpdateFilesResponseTemplate, UnclaimedDraftCreateEmbeddedRequest, UnclaimedDraftCreateEmbeddedWithTemplateRequest, UnclaimedDraftCreateRequest, UnclaimedDraftCreateResponse, UnclaimedDraftEditAndResendRequest, UnclaimedDraftResponse, VoidAuth, WarningResponse, }; diff --git a/sdks/php/README.md b/sdks/php/README.md index 11d7e67f7..c07ea3300 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -160,6 +160,11 @@ All URIs are relative to *https://api.hellosign.com/v3* | *BulkSendJobApi* | [**bulkSendJobList**](docs/Api/BulkSendJobApi.md#bulksendjoblist) | **GET** /bulk_send_job/list | List Bulk Send Jobs | | *EmbeddedApi* | [**embeddedEditUrl**](docs/Api/EmbeddedApi.md#embeddedediturl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL | | *EmbeddedApi* | [**embeddedSignUrl**](docs/Api/EmbeddedApi.md#embeddedsignurl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL | +| *FaxApi* | [**faxDelete**](docs/Api/FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax | +| *FaxApi* | [**faxFiles**](docs/Api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files | +| *FaxApi* | [**faxGet**](docs/Api/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax | +| *FaxApi* | [**faxList**](docs/Api/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes | +| *FaxApi* | [**faxSend**](docs/Api/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax | | *FaxLineApi* | [**faxLineAddUser**](docs/Api/FaxLineApi.md#faxlineadduser) | **PUT** /fax_line/add_user | Add Fax Line User | | *FaxLineApi* | [**faxLineAreaCodeGet**](docs/Api/FaxLineApi.md#faxlineareacodeget) | **GET** /fax_line/area_codes | Get Available Fax Line Area Codes | | *FaxLineApi* | [**faxLineCreate**](docs/Api/FaxLineApi.md#faxlinecreate) | **POST** /fax_line/create | Purchase Fax Line | @@ -249,6 +254,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [EventCallbackRequest](docs/Model/EventCallbackRequest.md) - [EventCallbackRequestEvent](docs/Model/EventCallbackRequestEvent.md) - [EventCallbackRequestEventMetadata](docs/Model/EventCallbackRequestEventMetadata.md) +- [FaxGetResponse](docs/Model/FaxGetResponse.md) - [FaxLineAddUserRequest](docs/Model/FaxLineAddUserRequest.md) - [FaxLineAreaCodeGetCountryEnum](docs/Model/FaxLineAreaCodeGetCountryEnum.md) - [FaxLineAreaCodeGetProvinceEnum](docs/Model/FaxLineAreaCodeGetProvinceEnum.md) @@ -260,6 +266,10 @@ All URIs are relative to *https://api.hellosign.com/v3* - [FaxLineRemoveUserRequest](docs/Model/FaxLineRemoveUserRequest.md) - [FaxLineResponse](docs/Model/FaxLineResponse.md) - [FaxLineResponseFaxLine](docs/Model/FaxLineResponseFaxLine.md) +- [FaxListResponse](docs/Model/FaxListResponse.md) +- [FaxResponse](docs/Model/FaxResponse.md) +- [FaxResponseTransmission](docs/Model/FaxResponseTransmission.md) +- [FaxSendRequest](docs/Model/FaxSendRequest.md) - [FileResponse](docs/Model/FileResponse.md) - [FileResponseDataUri](docs/Model/FileResponseDataUri.md) - [ListInfoResponse](docs/Model/ListInfoResponse.md) diff --git a/sdks/php/docs/Api/FaxApi.md b/sdks/php/docs/Api/FaxApi.md new file mode 100644 index 000000000..8b68458c6 --- /dev/null +++ b/sdks/php/docs/Api/FaxApi.md @@ -0,0 +1,314 @@ +# Dropbox\Sign\FaxApi + +All URIs are relative to https://api.hellosign.com/v3. + +| Method | HTTP request | Description | +| ------------- | ------------- | ------------- | +| [**faxDelete()**](FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax | +| [**faxFiles()**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files | +| [**faxGet()**](FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax | +| [**faxList()**](FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes | +| [**faxSend()**](FaxApi.md#faxSend) | **POST** /fax/send | Send Fax | + + +## `faxDelete()` + +```php +faxDelete($fax_id) +``` +Delete Fax + +Deletes the specified Fax from the system. + +### Example + +```php +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +try { + $faxApi->faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **fax_id** | **string**| Fax ID | | + +### Return type + +void (empty response body) + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `faxFiles()` + +```php +faxFiles($fax_id): \SplFileObject +``` +List Fax Files + +Returns list of fax files + +### Example + +```php +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +try { + $result = $faxApi->faxFiles($faxId); + copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **fax_id** | **string**| Fax ID | | + +### Return type + +**\SplFileObject** + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/pdf`, `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `faxGet()` + +```php +faxGet($fax_id): \Dropbox\Sign\Model\FaxGetResponse +``` +Get Fax + +Returns information about fax + +### Example + +```php +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + +try { + $result = $faxApi->faxGet($faxId); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **fax_id** | **string**| Fax ID | | + +### Return type + +[**\Dropbox\Sign\Model\FaxGetResponse**](../Model/FaxGetResponse.md) + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `faxList()` + +```php +faxList($page, $page_size): \Dropbox\Sign\Model\FaxListResponse +``` +Lists Faxes + +Returns properties of multiple faxes + +### Example + +```php +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +$page = 1; +$pageSize = 2; + +try { + $result = $faxApi->faxList($page, $pageSize); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **page** | **int**| Page | [optional] [default to 1] | +| **page_size** | **int**| Page size | [optional] [default to 20] | + +### Return type + +[**\Dropbox\Sign\Model\FaxListResponse**](../Model/FaxListResponse.md) + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `faxSend()` + +```php +faxSend($fax_send_request): \Dropbox\Sign\Model\FaxGetResponse +``` +Send Fax + +Action to prepare and send a fax + +### Example + +```php +setUsername("YOUR_API_KEY"); + +$faxApi = new Dropbox\Sign\Api\FaxApi($config); + +$data = new Dropbox\Sign\Model\FaxSendRequest(); +$data->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) + ->setTestMode(true) + ->setRecipient("16690000001") + ->setSender("16690000000") + ->setCoverPageTo("Jill Fax") + ->setCoverPageMessage("I'm sending you a fax!") + ->setCoverPageFrom("Faxer Faxerson") + ->setTitle("This is what the fax is about!"); + +try { + $result = $faxApi->faxSend($data); + print_r($result); +} catch (Dropbox\Sign\ApiException $e) { + $error = $e->getResponseObject(); + echo "Exception when calling Dropbox Sign API: " + . print_r($error->getError()); +} + +``` + +### Parameters + +|Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **fax_send_request** | [**\Dropbox\Sign\Model\FaxSendRequest**](../Model/FaxSendRequest.md)| | | + +### Return type + +[**\Dropbox\Sign\Model\FaxGetResponse**](../Model/FaxGetResponse.md) + +### Authorization + +[api_key](../../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: `application/json`, `multipart/form-data` +- **Accept**: `application/json` + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxGetResponse.md b/sdks/php/docs/Model/FaxGetResponse.md new file mode 100644 index 000000000..59bea7dc3 --- /dev/null +++ b/sdks/php/docs/Model/FaxGetResponse.md @@ -0,0 +1,12 @@ +# # FaxGetResponse + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `fax`*_required_ | [```\Dropbox\Sign\Model\FaxResponse```](FaxResponse.md) | | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | + +[[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/FaxListResponse.md b/sdks/php/docs/Model/FaxListResponse.md new file mode 100644 index 000000000..5ccdafc91 --- /dev/null +++ b/sdks/php/docs/Model/FaxListResponse.md @@ -0,0 +1,12 @@ +# # FaxListResponse + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `faxes`*_required_ | [```\Dropbox\Sign\Model\FaxResponse[]```](FaxResponse.md) | | | +| `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | + +[[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/FaxResponse.md b/sdks/php/docs/Model/FaxResponse.md new file mode 100644 index 000000000..5ee5930ca --- /dev/null +++ b/sdks/php/docs/Model/FaxResponse.md @@ -0,0 +1,20 @@ +# # FaxResponse + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `fax_id`*_required_ | ```string``` | Fax ID | | +| `title`*_required_ | ```string``` | Fax Title | | +| `original_title`*_required_ | ```string``` | Fax Original Title | | +| `subject`*_required_ | ```string``` | Fax Subject | | +| `message`*_required_ | ```string``` | Fax Message | | +| `metadata`*_required_ | ```array``` | Fax Metadata | | +| `created_at`*_required_ | ```int``` | Fax Created At Timestamp | | +| `sender`*_required_ | ```string``` | Fax Sender Email | | +| `transmissions`*_required_ | [```\Dropbox\Sign\Model\FaxResponseTransmission[]```](FaxResponseTransmission.md) | Fax Transmissions List | | +| `files_url`*_required_ | ```string``` | Fax Files URL | | + +[[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/FaxResponseTransmission.md b/sdks/php/docs/Model/FaxResponseTransmission.md new file mode 100644 index 000000000..421181a32 --- /dev/null +++ b/sdks/php/docs/Model/FaxResponseTransmission.md @@ -0,0 +1,14 @@ +# # FaxResponseTransmission + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `recipient`*_required_ | ```string``` | Fax Transmission Recipient | | +| `sender`*_required_ | ```string``` | Fax Transmission Sender | | +| `status_code`*_required_ | ```string``` | Fax Transmission Status Code | | +| `sent_at` | ```int``` | Fax Transmission Sent Timestamp | | + +[[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/FaxSendRequest.md b/sdks/php/docs/Model/FaxSendRequest.md new file mode 100644 index 000000000..dcbf730c4 --- /dev/null +++ b/sdks/php/docs/Model/FaxSendRequest.md @@ -0,0 +1,19 @@ +# # FaxSendRequest + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `recipient`*_required_ | ```string``` | Fax Send To Recipient | | +| `sender` | ```string``` | Fax Send From Sender (used only with fax number) | | +| `files` | ```\SplFileObject[]``` | Fax File to Send | | +| `file_urls` | ```string[]``` | Fax File URL to Send | | +| `test_mode` | ```bool``` | API Test Mode Setting | [default to false] | +| `cover_page_to` | ```string``` | Fax Cover Page for Recipient | | +| `cover_page_from` | ```string``` | Fax Cover Page for Sender | | +| `cover_page_message` | ```string``` | Fax Cover Page Message | | +| `title` | ```string``` | Fax Title | | + +[[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/FaxApi.php b/sdks/php/src/Api/FaxApi.php new file mode 100644 index 000000000..0ae0cf38d --- /dev/null +++ b/sdks/php/src/Api/FaxApi.php @@ -0,0 +1,1803 @@ + [ + 'application/json', + ], + 'faxFiles' => [ + 'application/json', + ], + 'faxGet' => [ + 'application/json', + ], + 'faxList' => [ + 'application/json', + ], + 'faxSend' => [ + 'application/json', + 'multipart/form-data', + ], + ]; + + /** @var ResponseInterface|null */ + protected $response; + + /** + * @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec + */ + public function __construct( + Configuration $config = null, + ClientInterface $client = null, + HeaderSelector $selector = null, + int $hostIndex = 0 + ) { + $this->client = $client ?: new Client(); + $this->config = $config ?: new Configuration(); + $this->headerSelector = $selector ?: new HeaderSelector(); + $this->hostIndex = $hostIndex; + } + + /** + * Set the host index + * + * @param int $hostIndex Host index (required) + * @deprecated To be made private in the future + */ + public function setHostIndex(int $hostIndex): void + { + $this->hostIndex = $hostIndex; + } + + /** + * Get the host index + * + * @return int Host index + * @deprecated To be made private in the future + */ + public function getHostIndex() + { + return $this->hostIndex; + } + + /** + * @return Configuration + */ + public function getConfig() + { + return $this->config; + } + + /** + * @return ResponseInterface|null + */ + public function getResponse() + { + return $this->response; + } + + /** + * Operation faxDelete + * + * Delete Fax + * + * @param string $fax_id Fax ID (required) + * + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + */ + public function faxDelete(string $fax_id) + { + $this->faxDeleteWithHttpInfo($fax_id); + } + + /** + * Operation faxDeleteWithHttpInfo + * + * Delete Fax + * + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation + * + * @return array of null, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxDelete. This method will eventually become unavailable + */ + public function faxDeleteWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxDelete'][0]) + { + $request = $this->faxDeleteRequest($fax_id, $contentType); + + try { + $options = $this->createHttpClientOption(); + try { + $response = $this->client->send($request, $options); + $this->response = $response; + } catch (RequestException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + $e->getResponse() ? $e->getResponse()->getHeaders() : null, + $e->getResponse() ? (string)$e->getResponse()->getBody() : null + ); + } catch (ConnectException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + null, + null + ); + } + + $statusCode = $response->getStatusCode(); + + if ($statusCode < 200 || $statusCode > 299) { + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + (string)$request->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + + return [null, $statusCode, $response->getHeaders()]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { + throw $e; + } + switch ($e->getCode()) { + } + throw $e; + } + } + + /** + * Operation faxDeleteAsync + * + * Delete Fax + * + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxDelete. This method will eventually become unavailable + */ + public function faxDeleteAsync(string $fax_id, string $contentType = self::contentTypes['faxDelete'][0]) + { + return $this->faxDeleteAsyncWithHttpInfo($fax_id, $contentType) + ->then( + function ($response) { + return $response[0]; + } + ); + } + + /** + * Operation faxDeleteAsyncWithHttpInfo + * + * Delete Fax + * + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxDelete. This method will eventually become unavailable + */ + public function faxDeleteAsyncWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxDelete'][0]) + { + $returnType = ''; + $request = $this->faxDeleteRequest($fax_id, $contentType); + + return $this->client + ->sendAsync($request, $this->createHttpClientOption()) + ->then( + function ($response) { + return [null, $response->getStatusCode(), $response->getHeaders()]; + }, + function ($exception) { + $response = $exception->getResponse(); + $statusCode = $response->getStatusCode(); + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + $exception->getRequest()->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + ); + } + + /** + * Create request for operation 'faxDelete' + * + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxDelete'] to see the possible values for this operation + * + * @return Request + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxDelete. This method will eventually become unavailable + */ + public function faxDeleteRequest(string $fax_id, string $contentType = self::contentTypes['faxDelete'][0]) + { + // verify the required parameter 'fax_id' is set + if ($fax_id === null || (is_array($fax_id) && count($fax_id) === 0)) { + throw new InvalidArgumentException( + 'Missing the required parameter $fax_id when calling faxDelete' + ); + } + + $resourcePath = '/fax/{fax_id}'; + $formParams = []; + $queryParams = []; + $headerParams = []; + $httpBody = ''; + $multipart = false; + + // path params + if ($fax_id !== null) { + $resourcePath = str_replace( + '{fax_id}', + ObjectSerializer::toPathValue($fax_id), + $resourcePath + ); + } + + $headers = $this->headerSelector->selectHeaders( + $multipart ? ['multipart/form-data'] : ['application/json'], + $contentType, + $multipart + ); + + // for model (json/xml) + if (count($formParams) > 0) { + if ($multipart) { + $multipartContents = []; + foreach ($formParams as $formParamName => $formParamValue) { + $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; + foreach ($formParamValueItems as $formParamValueItem) { + $multipartContents[] = [ + 'name' => $formParamName, + 'contents' => $formParamValueItem, + ]; + } + } + // for HTTP post (form) + if (!empty($body)) { + $multipartContents[] = [ + 'name' => 'body', + 'contents' => $body, + 'headers' => ['Content-Type' => 'application/json'], + ]; + } + + $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { + // if Content-Type contains "application/json", json_encode the form parameters + $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); + } else { + // for HTTP post (form) + $httpBody = ObjectSerializer::buildQuery($formParams); + } + } + + // this endpoint requires HTTP basic authentication + if (!empty($this->config->getUsername())) { + $headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ':'); + } + + $defaultHeaders = []; + if ($this->config->getUserAgent()) { + $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); + } + + $headers = array_merge( + $defaultHeaders, + $headerParams, + $headers + ); + + $operationHost = $this->config->getHost(); + $query = ObjectSerializer::buildQuery($queryParams); + return new Request( + 'DELETE', + $operationHost . $resourcePath . ($query ? "?{$query}" : ''), + $headers, + $httpBody + ); + } + + /** + * Operation faxFiles + * + * List Fax Files + * + * @param string $fax_id Fax ID (required) + * + * @return SplFileObject + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + */ + public function faxFiles(string $fax_id) + { + list($response) = $this->faxFilesWithHttpInfo($fax_id); + return $response; + } + + /** + * Operation faxFilesWithHttpInfo + * + * List Fax Files + * + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation + * + * @return array of \SplFileObject|\Dropbox\Sign\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxFiles. This method will eventually become unavailable + */ + public function faxFilesWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxFiles'][0]) + { + $request = $this->faxFilesRequest($fax_id, $contentType); + + try { + $options = $this->createHttpClientOption(); + try { + $response = $this->client->send($request, $options); + $this->response = $response; + } catch (RequestException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + $e->getResponse() ? $e->getResponse()->getHeaders() : null, + $e->getResponse() ? (string)$e->getResponse()->getBody() : null + ); + } catch (ConnectException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + null, + null + ); + } + + $statusCode = $response->getStatusCode(); + + if ($statusCode < 200 || $statusCode > 299) { + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + (string)$request->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + + $result = $this->handleRangeCodeResponse( + $response, + '4XX', + '\Dropbox\Sign\Model\ErrorResponse' + ); + if ($result) { + return $result; + } + + switch ($statusCode) { + case 200: + if ('\SplFileObject' === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ('\SplFileObject' !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, '\SplFileObject', []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } + + $returnType = '\SplFileObject'; + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { + throw $e; + } + switch ($e->getCode()) { + case 200: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + '\SplFileObject', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + break; + } + throw $e; + } + } + + /** + * Operation faxFilesAsync + * + * List Fax Files + * + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxFiles. This method will eventually become unavailable + */ + public function faxFilesAsync(string $fax_id, string $contentType = self::contentTypes['faxFiles'][0]) + { + return $this->faxFilesAsyncWithHttpInfo($fax_id, $contentType) + ->then( + function ($response) { + return $response[0]; + } + ); + } + + /** + * Operation faxFilesAsyncWithHttpInfo + * + * List Fax Files + * + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxFiles. This method will eventually become unavailable + */ + public function faxFilesAsyncWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxFiles'][0]) + { + $returnType = '\SplFileObject'; + $request = $this->faxFilesRequest($fax_id, $contentType); + + return $this->client + ->sendAsync($request, $this->createHttpClientOption()) + ->then( + function ($response) use ($returnType) { + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + $content = json_decode($content); + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + }, + function ($exception) { + $response = $exception->getResponse(); + $statusCode = $response->getStatusCode(); + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + $exception->getRequest()->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + ); + } + + /** + * Create request for operation 'faxFiles' + * + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation + * + * @return Request + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxFiles. This method will eventually become unavailable + */ + public function faxFilesRequest(string $fax_id, string $contentType = self::contentTypes['faxFiles'][0]) + { + // verify the required parameter 'fax_id' is set + if ($fax_id === null || (is_array($fax_id) && count($fax_id) === 0)) { + throw new InvalidArgumentException( + 'Missing the required parameter $fax_id when calling faxFiles' + ); + } + + $resourcePath = '/fax/files/{fax_id}'; + $formParams = []; + $queryParams = []; + $headerParams = []; + $httpBody = ''; + $multipart = false; + + // path params + if ($fax_id !== null) { + $resourcePath = str_replace( + '{fax_id}', + ObjectSerializer::toPathValue($fax_id), + $resourcePath + ); + } + + $headers = $this->headerSelector->selectHeaders( + $multipart ? ['multipart/form-data'] : ['application/pdf', 'application/json'], + $contentType, + $multipart + ); + + // for model (json/xml) + if (count($formParams) > 0) { + if ($multipart) { + $multipartContents = []; + foreach ($formParams as $formParamName => $formParamValue) { + $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; + foreach ($formParamValueItems as $formParamValueItem) { + $multipartContents[] = [ + 'name' => $formParamName, + 'contents' => $formParamValueItem, + ]; + } + } + // for HTTP post (form) + if (!empty($body)) { + $multipartContents[] = [ + 'name' => 'body', + 'contents' => $body, + 'headers' => ['Content-Type' => 'application/json'], + ]; + } + + $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { + // if Content-Type contains "application/json", json_encode the form parameters + $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); + } else { + // for HTTP post (form) + $httpBody = ObjectSerializer::buildQuery($formParams); + } + } + + // this endpoint requires HTTP basic authentication + if (!empty($this->config->getUsername())) { + $headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ':'); + } + + $defaultHeaders = []; + if ($this->config->getUserAgent()) { + $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); + } + + $headers = array_merge( + $defaultHeaders, + $headerParams, + $headers + ); + + $operationHost = $this->config->getHost(); + $query = ObjectSerializer::buildQuery($queryParams); + return new Request( + 'GET', + $operationHost . $resourcePath . ($query ? "?{$query}" : ''), + $headers, + $httpBody + ); + } + + /** + * Operation faxGet + * + * Get Fax + * + * @param string $fax_id Fax ID (required) + * + * @return Model\FaxGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + */ + public function faxGet(string $fax_id) + { + list($response) = $this->faxGetWithHttpInfo($fax_id); + return $response; + } + + /** + * Operation faxGetWithHttpInfo + * + * Get Fax + * + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation + * + * @return array of Model\FaxGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxGet. This method will eventually become unavailable + */ + public function faxGetWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxGet'][0]) + { + $request = $this->faxGetRequest($fax_id, $contentType); + + try { + $options = $this->createHttpClientOption(); + try { + $response = $this->client->send($request, $options); + $this->response = $response; + } catch (RequestException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + $e->getResponse() ? $e->getResponse()->getHeaders() : null, + $e->getResponse() ? (string)$e->getResponse()->getBody() : null + ); + } catch (ConnectException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + null, + null + ); + } + + $statusCode = $response->getStatusCode(); + + if ($statusCode < 200 || $statusCode > 299) { + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + (string)$request->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + + $result = $this->handleRangeCodeResponse( + $response, + '4XX', + '\Dropbox\Sign\Model\ErrorResponse' + ); + if ($result) { + return $result; + } + + switch ($statusCode) { + case 200: + if ('\Dropbox\Sign\Model\FaxGetResponse' === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ('\Dropbox\Sign\Model\FaxGetResponse' !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxGetResponse', []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } + + $returnType = '\Dropbox\Sign\Model\FaxGetResponse'; + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { + throw $e; + } + switch ($e->getCode()) { + case 200: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + '\Dropbox\Sign\Model\FaxGetResponse', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + break; + } + throw $e; + } + } + + /** + * Operation faxGetAsync + * + * Get Fax + * + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxGet. This method will eventually become unavailable + */ + public function faxGetAsync(string $fax_id, string $contentType = self::contentTypes['faxGet'][0]) + { + return $this->faxGetAsyncWithHttpInfo($fax_id, $contentType) + ->then( + function ($response) { + return $response[0]; + } + ); + } + + /** + * Operation faxGetAsyncWithHttpInfo + * + * Get Fax + * + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxGet. This method will eventually become unavailable + */ + public function faxGetAsyncWithHttpInfo(string $fax_id, string $contentType = self::contentTypes['faxGet'][0]) + { + $returnType = '\Dropbox\Sign\Model\FaxGetResponse'; + $request = $this->faxGetRequest($fax_id, $contentType); + + return $this->client + ->sendAsync($request, $this->createHttpClientOption()) + ->then( + function ($response) use ($returnType) { + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + $content = json_decode($content); + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + }, + function ($exception) { + $response = $exception->getResponse(); + $statusCode = $response->getStatusCode(); + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + $exception->getRequest()->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + ); + } + + /** + * Create request for operation 'faxGet' + * + * @param string $fax_id Fax ID (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxGet'] to see the possible values for this operation + * + * @return Request + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxGet. This method will eventually become unavailable + */ + public function faxGetRequest(string $fax_id, string $contentType = self::contentTypes['faxGet'][0]) + { + // verify the required parameter 'fax_id' is set + if ($fax_id === null || (is_array($fax_id) && count($fax_id) === 0)) { + throw new InvalidArgumentException( + 'Missing the required parameter $fax_id when calling faxGet' + ); + } + + $resourcePath = '/fax/{fax_id}'; + $formParams = []; + $queryParams = []; + $headerParams = []; + $httpBody = ''; + $multipart = false; + + // path params + if ($fax_id !== null) { + $resourcePath = str_replace( + '{fax_id}', + ObjectSerializer::toPathValue($fax_id), + $resourcePath + ); + } + + $headers = $this->headerSelector->selectHeaders( + $multipart ? ['multipart/form-data'] : ['application/json'], + $contentType, + $multipart + ); + + // for model (json/xml) + if (count($formParams) > 0) { + if ($multipart) { + $multipartContents = []; + foreach ($formParams as $formParamName => $formParamValue) { + $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; + foreach ($formParamValueItems as $formParamValueItem) { + $multipartContents[] = [ + 'name' => $formParamName, + 'contents' => $formParamValueItem, + ]; + } + } + // for HTTP post (form) + if (!empty($body)) { + $multipartContents[] = [ + 'name' => 'body', + 'contents' => $body, + 'headers' => ['Content-Type' => 'application/json'], + ]; + } + + $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { + // if Content-Type contains "application/json", json_encode the form parameters + $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); + } else { + // for HTTP post (form) + $httpBody = ObjectSerializer::buildQuery($formParams); + } + } + + // this endpoint requires HTTP basic authentication + if (!empty($this->config->getUsername())) { + $headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ':'); + } + + $defaultHeaders = []; + if ($this->config->getUserAgent()) { + $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); + } + + $headers = array_merge( + $defaultHeaders, + $headerParams, + $headers + ); + + $operationHost = $this->config->getHost(); + $query = ObjectSerializer::buildQuery($queryParams); + return new Request( + 'GET', + $operationHost . $resourcePath . ($query ? "?{$query}" : ''), + $headers, + $httpBody + ); + } + + /** + * Operation faxList + * + * Lists Faxes + * + * @param int $page Page (optional, default to 1) + * @param int $page_size Page size (optional, default to 20) + * + * @return Model\FaxListResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + */ + public function faxList(int $page = 1, int $page_size = 20) + { + list($response) = $this->faxListWithHttpInfo($page, $page_size); + return $response; + } + + /** + * Operation faxListWithHttpInfo + * + * Lists Faxes + * + * @param int $page Page (optional, default to 1) + * @param int $page_size Page size (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation + * + * @return array of Model\FaxListResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxList. This method will eventually become unavailable + */ + public function faxListWithHttpInfo(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) + { + $request = $this->faxListRequest($page, $page_size, $contentType); + + try { + $options = $this->createHttpClientOption(); + try { + $response = $this->client->send($request, $options); + $this->response = $response; + } catch (RequestException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + $e->getResponse() ? $e->getResponse()->getHeaders() : null, + $e->getResponse() ? (string)$e->getResponse()->getBody() : null + ); + } catch (ConnectException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + null, + null + ); + } + + $statusCode = $response->getStatusCode(); + + if ($statusCode < 200 || $statusCode > 299) { + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + (string)$request->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + + $result = $this->handleRangeCodeResponse( + $response, + '4XX', + '\Dropbox\Sign\Model\ErrorResponse' + ); + if ($result) { + return $result; + } + + switch ($statusCode) { + case 200: + if ('\Dropbox\Sign\Model\FaxListResponse' === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ('\Dropbox\Sign\Model\FaxListResponse' !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxListResponse', []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } + + $returnType = '\Dropbox\Sign\Model\FaxListResponse'; + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { + throw $e; + } + switch ($e->getCode()) { + case 200: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + '\Dropbox\Sign\Model\FaxListResponse', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + break; + } + throw $e; + } + } + + /** + * Operation faxListAsync + * + * Lists Faxes + * + * @param int $page Page (optional, default to 1) + * @param int $page_size Page size (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxList. This method will eventually become unavailable + */ + public function faxListAsync(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) + { + return $this->faxListAsyncWithHttpInfo($page, $page_size, $contentType) + ->then( + function ($response) { + return $response[0]; + } + ); + } + + /** + * Operation faxListAsyncWithHttpInfo + * + * Lists Faxes + * + * @param int $page Page (optional, default to 1) + * @param int $page_size Page size (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxList. This method will eventually become unavailable + */ + public function faxListAsyncWithHttpInfo(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) + { + $returnType = '\Dropbox\Sign\Model\FaxListResponse'; + $request = $this->faxListRequest($page, $page_size, $contentType); + + return $this->client + ->sendAsync($request, $this->createHttpClientOption()) + ->then( + function ($response) use ($returnType) { + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + $content = json_decode($content); + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + }, + function ($exception) { + $response = $exception->getResponse(); + $statusCode = $response->getStatusCode(); + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + $exception->getRequest()->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + ); + } + + /** + * Create request for operation 'faxList' + * + * @param int $page Page (optional, default to 1) + * @param int $page_size Page size (optional, default to 20) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation + * + * @return Request + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxList. This method will eventually become unavailable + */ + public function faxListRequest(int $page = 1, int $page_size = 20, string $contentType = self::contentTypes['faxList'][0]) + { + if ($page !== null && $page < 1) { + throw new InvalidArgumentException('invalid value for "$page" when calling FaxApi.faxList, must be bigger than or equal to 1.'); + } + + if ($page_size !== null && $page_size > 100) { + throw new InvalidArgumentException('invalid value for "$page_size" when calling FaxApi.faxList, must be smaller than or equal to 100.'); + } + if ($page_size !== null && $page_size < 1) { + throw new InvalidArgumentException('invalid value for "$page_size" when calling FaxApi.faxList, must be bigger than or equal to 1.'); + } + + $resourcePath = '/fax/list'; + $formParams = []; + $queryParams = []; + $headerParams = []; + $httpBody = ''; + $multipart = false; + + // query params + $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue( + $page, + 'page', // param base name + 'integer', // openApiType + 'form', // style + true, // explode + false // required + ) ?? []); + // query params + $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue( + $page_size, + 'page_size', // param base name + 'integer', // openApiType + 'form', // style + true, // explode + false // required + ) ?? []); + + $headers = $this->headerSelector->selectHeaders( + $multipart ? ['multipart/form-data'] : ['application/json'], + $contentType, + $multipart + ); + + // for model (json/xml) + if (count($formParams) > 0) { + if ($multipart) { + $multipartContents = []; + foreach ($formParams as $formParamName => $formParamValue) { + $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; + foreach ($formParamValueItems as $formParamValueItem) { + $multipartContents[] = [ + 'name' => $formParamName, + 'contents' => $formParamValueItem, + ]; + } + } + // for HTTP post (form) + if (!empty($body)) { + $multipartContents[] = [ + 'name' => 'body', + 'contents' => $body, + 'headers' => ['Content-Type' => 'application/json'], + ]; + } + + $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { + // if Content-Type contains "application/json", json_encode the form parameters + $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); + } else { + // for HTTP post (form) + $httpBody = ObjectSerializer::buildQuery($formParams); + } + } + + // this endpoint requires HTTP basic authentication + if (!empty($this->config->getUsername())) { + $headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ':'); + } + + $defaultHeaders = []; + if ($this->config->getUserAgent()) { + $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); + } + + $headers = array_merge( + $defaultHeaders, + $headerParams, + $headers + ); + + $operationHost = $this->config->getHost(); + $query = ObjectSerializer::buildQuery($queryParams); + return new Request( + 'GET', + $operationHost . $resourcePath . ($query ? "?{$query}" : ''), + $headers, + $httpBody + ); + } + + /** + * Operation faxSend + * + * Send Fax + * + * @param Model\FaxSendRequest $fax_send_request fax_send_request (required) + * + * @return Model\FaxGetResponse + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + */ + public function faxSend(Model\FaxSendRequest $fax_send_request) + { + list($response) = $this->faxSendWithHttpInfo($fax_send_request); + return $response; + } + + /** + * Operation faxSendWithHttpInfo + * + * Send Fax + * + * @param Model\FaxSendRequest $fax_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation + * + * @return array of Model\FaxGetResponse, HTTP status code, HTTP response headers (array of strings) + * @throws ApiException on non-2xx response or if the response body is not in the expected format + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxSend. This method will eventually become unavailable + */ + public function faxSendWithHttpInfo(Model\FaxSendRequest $fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) + { + $request = $this->faxSendRequest($fax_send_request, $contentType); + + try { + $options = $this->createHttpClientOption(); + try { + $response = $this->client->send($request, $options); + $this->response = $response; + } catch (RequestException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + $e->getResponse() ? $e->getResponse()->getHeaders() : null, + $e->getResponse() ? (string)$e->getResponse()->getBody() : null + ); + } catch (ConnectException $e) { + throw new ApiException( + "[{$e->getCode()}] {$e->getMessage()}", + (int)$e->getCode(), + null, + null + ); + } + + $statusCode = $response->getStatusCode(); + + if ($statusCode < 200 || $statusCode > 299) { + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + (string)$request->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + + $result = $this->handleRangeCodeResponse( + $response, + '4XX', + '\Dropbox\Sign\Model\ErrorResponse' + ); + if ($result) { + return $result; + } + + switch ($statusCode) { + case 200: + if ('\Dropbox\Sign\Model\FaxGetResponse' === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ('\Dropbox\Sign\Model\FaxGetResponse' !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\FaxGetResponse', []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } + + $returnType = '\Dropbox\Sign\Model\FaxGetResponse'; + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + try { + $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR); + } catch (JsonException $exception) { + throw new ApiException( + sprintf( + 'Error JSON decoding server response (%s)', + $request->getUri() + ), + $statusCode, + $response->getHeaders(), + $content + ); + } + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { + throw $e; + } + switch ($e->getCode()) { + case 200: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + '\Dropbox\Sign\Model\FaxGetResponse', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + break; + } + throw $e; + } + } + + /** + * Operation faxSendAsync + * + * Send Fax + * + * @param Model\FaxSendRequest $fax_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxSend. This method will eventually become unavailable + */ + public function faxSendAsync(Model\FaxSendRequest $fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) + { + return $this->faxSendAsyncWithHttpInfo($fax_send_request, $contentType) + ->then( + function ($response) { + return $response[0]; + } + ); + } + + /** + * Operation faxSendAsyncWithHttpInfo + * + * Send Fax + * + * @param Model\FaxSendRequest $fax_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation + * + * @return \GuzzleHttp\Promise\PromiseInterface + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxSend. This method will eventually become unavailable + */ + public function faxSendAsyncWithHttpInfo(Model\FaxSendRequest $fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) + { + $returnType = '\Dropbox\Sign\Model\FaxGetResponse'; + $request = $this->faxSendRequest($fax_send_request, $contentType); + + return $this->client + ->sendAsync($request, $this->createHttpClientOption()) + ->then( + function ($response) use ($returnType) { + if ($returnType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + if ($returnType !== 'string') { + $content = json_decode($content); + } + } + + return [ + ObjectSerializer::deserialize($content, $returnType, []), + $response->getStatusCode(), + $response->getHeaders(), + ]; + }, + function ($exception) { + $response = $exception->getResponse(); + $statusCode = $response->getStatusCode(); + throw new ApiException( + sprintf( + '[%d] Error connecting to the API (%s)', + $statusCode, + $exception->getRequest()->getUri() + ), + $statusCode, + $response->getHeaders(), + (string)$response->getBody() + ); + } + ); + } + + /** + * Create request for operation 'faxSend' + * + * @param Model\FaxSendRequest $fax_send_request (required) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxSend'] to see the possible values for this operation + * + * @return Request + * @throws InvalidArgumentException + * @deprecated Prefer to use ::faxSend. This method will eventually become unavailable + */ + public function faxSendRequest(Model\FaxSendRequest $fax_send_request, string $contentType = self::contentTypes['faxSend'][0]) + { + // verify the required parameter 'fax_send_request' is set + if ($fax_send_request === null || (is_array($fax_send_request) && count($fax_send_request) === 0)) { + throw new InvalidArgumentException( + 'Missing the required parameter $fax_send_request when calling faxSend' + ); + } + + $resourcePath = '/fax/send'; + $formParams = []; + $queryParams = []; + $headerParams = []; + $httpBody = ''; + $multipart = false; + + $formParams = ObjectSerializer::getFormParams( + $fax_send_request + ); + + $multipart = !empty($formParams); + + $headers = $this->headerSelector->selectHeaders( + $multipart ? ['multipart/form-data'] : ['application/json'], + $contentType, + $multipart + ); + + // for model (json/xml) + if (count($formParams) === 0) { + if (stripos($headers['Content-Type'], 'application/json') !== false) { + // if Content-Type contains "application/json", json_encode the body + $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($fax_send_request)); + } else { + $httpBody = $fax_send_request; + } + } elseif (count($formParams) > 0) { + if ($multipart) { + $multipartContents = []; + foreach ($formParams as $formParamName => $formParamValue) { + $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue]; + foreach ($formParamValueItems as $formParamValueItem) { + $multipartContents[] = [ + 'name' => $formParamName, + 'contents' => $formParamValueItem, + ]; + } + } + // for HTTP post (form) + if (!empty($body)) { + $multipartContents[] = [ + 'name' => 'body', + 'contents' => $body, + 'headers' => ['Content-Type' => 'application/json'], + ]; + } + + if ($payloadHook = $this->config->getPayloadHook()) { + $payloadHook('multipart', $multipartContents, $fax_send_request); + } + $httpBody = new MultipartStream($multipartContents); + } elseif (stripos($headers['Content-Type'], 'application/json') !== false) { + // if Content-Type contains "application/json", json_encode the form parameters + $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams); + } else { + // for HTTP post (form) + $httpBody = ObjectSerializer::buildQuery($formParams); + } + } + + // this endpoint requires HTTP basic authentication + if (!empty($this->config->getUsername())) { + $headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ':'); + } + + $defaultHeaders = []; + if ($this->config->getUserAgent()) { + $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); + } + + $headers = array_merge( + $defaultHeaders, + $headerParams, + $headers + ); + + $operationHost = $this->config->getHost(); + $query = ObjectSerializer::buildQuery($queryParams); + return new Request( + 'POST', + $operationHost . $resourcePath . ($query ? "?{$query}" : ''), + $headers, + $httpBody + ); + } + + /** + * Create http client option + * + * @return array of http client options + * @throws RuntimeException on file opening failure + */ + protected function createHttpClientOption() + { + $options = $this->config->getOptions(); + if ($this->config->getDebug()) { + $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); + if (!$options[RequestOptions::DEBUG]) { + throw new RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); + } + } + + return $options; + } + + /** + * @return object|array|null + */ + private function handleRangeCodeResponse( + ResponseInterface $response, + string $rangeCode, + string $returnDataType + ) { + $statusCode = $response->getStatusCode(); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + + if ( + $statusCode < $rangeCodeLeft + || $statusCode > $rangeCodeRight + ) { + return null; + } + + if ($returnDataType === '\SplFileObject') { + $content = $response->getBody(); // stream goes to serializer + } else { + $content = (string)$response->getBody(); + } + + return [ + ObjectSerializer::deserialize($content, $returnDataType, []), + $statusCode, + $response->getHeaders(), + ]; + } + + /** + * @return object|array|null + */ + private function handleRangeCodeException( + ApiException $e, + string $rangeCode, + string $exceptionDataType + ): bool { + $statusCode = $e->getCode(); + $rangeCodeLeft = (int)(substr($rangeCode, 0, 1) . '00'); + $rangeCodeRight = (int)(substr($rangeCode, 0, 1) . '99'); + + if ( + $statusCode < $rangeCodeLeft + || $statusCode > $rangeCodeRight + ) { + return false; + } + + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + $exceptionDataType, + $e->getResponseHeaders() + ); + + $e->setResponseObject($data); + + return true; + } +} diff --git a/sdks/php/src/Model/FaxGetResponse.php b/sdks/php/src/Model/FaxGetResponse.php new file mode 100644 index 000000000..232943492 --- /dev/null +++ b/sdks/php/src/Model/FaxGetResponse.php @@ -0,0 +1,450 @@ + + */ +class FaxGetResponse implements ModelInterface, ArrayAccess, JsonSerializable +{ + public const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $openAPIModelName = 'FaxGetResponse'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $openAPITypes = [ + 'fax' => '\Dropbox\Sign\Model\FaxResponse', + 'warnings' => '\Dropbox\Sign\Model\WarningResponse[]', + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ + protected static $openAPIFormats = [ + 'fax' => null, + 'warnings' => null, + ]; + + /** + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ + protected static array $openAPINullables = [ + 'fax' => false, + 'warnings' => false, + ]; + + /** + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ + protected array $openAPINullablesSetToNull = []; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPITypes() + { + return self::$openAPITypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPIFormats() + { + return self::$openAPIFormats; + } + + /** + * Array of nullable properties + */ + protected static function openAPINullables(): array + { + return self::$openAPINullables; + } + + /** + * Array of nullable field names deliberately set to null + * + * @return bool[] + */ + private function getOpenAPINullablesSetToNull(): array + { + return $this->openAPINullablesSetToNull; + } + + /** + * Setter - Array of nullable field names deliberately set to null + * + * @param bool[] $openAPINullablesSetToNull + */ + private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void + { + $this->openAPINullablesSetToNull = $openAPINullablesSetToNull; + } + + /** + * Checks if a property is nullable + */ + public static function isNullable(string $property): bool + { + return self::openAPINullables()[$property] ?? false; + } + + /** + * Checks if a nullable property is set to null. + */ + public function isNullableSetToNull(string $property): bool + { + return in_array($property, $this->getOpenAPINullablesSetToNull(), true); + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'fax' => 'fax', + 'warnings' => 'warnings', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'fax' => 'setFax', + 'warnings' => 'setWarnings', + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'fax' => 'getFax', + 'warnings' => 'getWarnings', + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$openAPIModelName; + } + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->setIfExists('fax', $data ?? [], null); + $this->setIfExists('warnings', $data ?? [], null); + } + + /** + * @deprecated use ::init() + */ + public static function fromArray(array $data): FaxGetResponse + { + return self::init($data); + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + */ + public static function init(array $data): FaxGetResponse + { + /** @var FaxGetResponse */ + return ObjectSerializer::deserialize( + $data, + FaxGetResponse::class, + ); + } + + /** + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ + private function setIfExists(string $variableName, array $fields, $defaultValue): void + { + if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { + $this->openAPINullablesSetToNull[] = $variableName; + } + + $this->container[$variableName] = $fields[$variableName] ?? $defaultValue; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + if ($this->container['fax'] === null) { + $invalidProperties[] = "'fax' can't be null"; + } + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + /** + * Gets fax + * + * @return FaxResponse + */ + public function getFax() + { + return $this->container['fax']; + } + + /** + * Sets fax + * + * @param FaxResponse $fax fax + * + * @return self + */ + public function setFax(FaxResponse $fax) + { + if (is_null($fax)) { + throw new InvalidArgumentException('non-nullable fax cannot be null'); + } + $this->container['fax'] = $fax; + + return $this; + } + + /** + * Gets warnings + * + * @return WarningResponse[]|null + */ + public function getWarnings() + { + return $this->container['warnings']; + } + + /** + * Sets warnings + * + * @param WarningResponse[]|null $warnings a list of warnings + * + * @return self + */ + public function setWarnings(?array $warnings) + { + if (is_null($warnings)) { + throw new InvalidArgumentException('non-nullable warnings cannot be null'); + } + $this->container['warnings'] = $warnings; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetExists($offset): bool + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param int $offset Offset + * + * @return mixed|null + */ + #[ReturnTypeWillChange] + public function offsetGet($offset) + { + return $this->container[$offset] ?? null; + } + + /** + * Sets value based on offset. + * + * @param int|null $offset Offset + * @param mixed $value Value to be set + */ + #[ReturnTypeWillChange] + public function offsetSet($offset, $value): void + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetUnset($offset): void + { + unset($this->container[$offset]); + } + + /** + * Serializes the object to a value that can be serialized natively by json_encode(). + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource + */ + #[ReturnTypeWillChange] + public function jsonSerialize() + { + return ObjectSerializer::sanitizeForSerialization($this); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_UNESCAPED_SLASHES + ); + } + + /** + * Gets a header-safe presentation of the object + * + * @return string + */ + public function toHeaderValue() + { + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} diff --git a/sdks/php/src/Model/FaxListResponse.php b/sdks/php/src/Model/FaxListResponse.php new file mode 100644 index 000000000..21e89d342 --- /dev/null +++ b/sdks/php/src/Model/FaxListResponse.php @@ -0,0 +1,453 @@ + + */ +class FaxListResponse implements ModelInterface, ArrayAccess, JsonSerializable +{ + public const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $openAPIModelName = 'FaxListResponse'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $openAPITypes = [ + 'faxes' => '\Dropbox\Sign\Model\FaxResponse[]', + 'list_info' => '\Dropbox\Sign\Model\ListInfoResponse', + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ + protected static $openAPIFormats = [ + 'faxes' => null, + 'list_info' => null, + ]; + + /** + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ + protected static array $openAPINullables = [ + 'faxes' => false, + 'list_info' => false, + ]; + + /** + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ + protected array $openAPINullablesSetToNull = []; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPITypes() + { + return self::$openAPITypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPIFormats() + { + return self::$openAPIFormats; + } + + /** + * Array of nullable properties + */ + protected static function openAPINullables(): array + { + return self::$openAPINullables; + } + + /** + * Array of nullable field names deliberately set to null + * + * @return bool[] + */ + private function getOpenAPINullablesSetToNull(): array + { + return $this->openAPINullablesSetToNull; + } + + /** + * Setter - Array of nullable field names deliberately set to null + * + * @param bool[] $openAPINullablesSetToNull + */ + private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void + { + $this->openAPINullablesSetToNull = $openAPINullablesSetToNull; + } + + /** + * Checks if a property is nullable + */ + public static function isNullable(string $property): bool + { + return self::openAPINullables()[$property] ?? false; + } + + /** + * Checks if a nullable property is set to null. + */ + public function isNullableSetToNull(string $property): bool + { + return in_array($property, $this->getOpenAPINullablesSetToNull(), true); + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'faxes' => 'faxes', + 'list_info' => 'list_info', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'faxes' => 'setFaxes', + 'list_info' => 'setListInfo', + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'faxes' => 'getFaxes', + 'list_info' => 'getListInfo', + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$openAPIModelName; + } + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->setIfExists('faxes', $data ?? [], null); + $this->setIfExists('list_info', $data ?? [], null); + } + + /** + * @deprecated use ::init() + */ + public static function fromArray(array $data): FaxListResponse + { + return self::init($data); + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + */ + public static function init(array $data): FaxListResponse + { + /** @var FaxListResponse */ + return ObjectSerializer::deserialize( + $data, + FaxListResponse::class, + ); + } + + /** + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ + private function setIfExists(string $variableName, array $fields, $defaultValue): void + { + if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { + $this->openAPINullablesSetToNull[] = $variableName; + } + + $this->container[$variableName] = $fields[$variableName] ?? $defaultValue; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + if ($this->container['faxes'] === null) { + $invalidProperties[] = "'faxes' can't be null"; + } + if ($this->container['list_info'] === null) { + $invalidProperties[] = "'list_info' can't be null"; + } + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + /** + * Gets faxes + * + * @return FaxResponse[] + */ + public function getFaxes() + { + return $this->container['faxes']; + } + + /** + * Sets faxes + * + * @param FaxResponse[] $faxes faxes + * + * @return self + */ + public function setFaxes(array $faxes) + { + if (is_null($faxes)) { + throw new InvalidArgumentException('non-nullable faxes cannot be null'); + } + $this->container['faxes'] = $faxes; + + return $this; + } + + /** + * Gets list_info + * + * @return ListInfoResponse + */ + public function getListInfo() + { + return $this->container['list_info']; + } + + /** + * Sets list_info + * + * @param ListInfoResponse $list_info list_info + * + * @return self + */ + public function setListInfo(ListInfoResponse $list_info) + { + if (is_null($list_info)) { + throw new InvalidArgumentException('non-nullable list_info cannot be null'); + } + $this->container['list_info'] = $list_info; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetExists($offset): bool + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param int $offset Offset + * + * @return mixed|null + */ + #[ReturnTypeWillChange] + public function offsetGet($offset) + { + return $this->container[$offset] ?? null; + } + + /** + * Sets value based on offset. + * + * @param int|null $offset Offset + * @param mixed $value Value to be set + */ + #[ReturnTypeWillChange] + public function offsetSet($offset, $value): void + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetUnset($offset): void + { + unset($this->container[$offset]); + } + + /** + * Serializes the object to a value that can be serialized natively by json_encode(). + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource + */ + #[ReturnTypeWillChange] + public function jsonSerialize() + { + return ObjectSerializer::sanitizeForSerialization($this); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_UNESCAPED_SLASHES + ); + } + + /** + * Gets a header-safe presentation of the object + * + * @return string + */ + public function toHeaderValue() + { + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} diff --git a/sdks/php/src/Model/FaxResponse.php b/sdks/php/src/Model/FaxResponse.php new file mode 100644 index 000000000..b60d54baa --- /dev/null +++ b/sdks/php/src/Model/FaxResponse.php @@ -0,0 +1,749 @@ + + */ +class FaxResponse implements ModelInterface, ArrayAccess, JsonSerializable +{ + public const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $openAPIModelName = 'FaxResponse'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $openAPITypes = [ + 'fax_id' => 'string', + 'title' => 'string', + 'original_title' => 'string', + 'subject' => 'string', + 'message' => 'string', + 'metadata' => 'array', + 'created_at' => 'int', + 'sender' => 'string', + 'transmissions' => '\Dropbox\Sign\Model\FaxResponseTransmission[]', + 'files_url' => 'string', + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ + protected static $openAPIFormats = [ + 'fax_id' => null, + 'title' => null, + 'original_title' => null, + 'subject' => null, + 'message' => null, + 'metadata' => null, + 'created_at' => null, + 'sender' => null, + 'transmissions' => null, + 'files_url' => null, + ]; + + /** + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ + protected static array $openAPINullables = [ + 'fax_id' => false, + 'title' => false, + 'original_title' => false, + 'subject' => false, + 'message' => false, + 'metadata' => false, + 'created_at' => false, + 'sender' => false, + 'transmissions' => false, + 'files_url' => false, + ]; + + /** + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ + protected array $openAPINullablesSetToNull = []; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPITypes() + { + return self::$openAPITypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPIFormats() + { + return self::$openAPIFormats; + } + + /** + * Array of nullable properties + */ + protected static function openAPINullables(): array + { + return self::$openAPINullables; + } + + /** + * Array of nullable field names deliberately set to null + * + * @return bool[] + */ + private function getOpenAPINullablesSetToNull(): array + { + return $this->openAPINullablesSetToNull; + } + + /** + * Setter - Array of nullable field names deliberately set to null + * + * @param bool[] $openAPINullablesSetToNull + */ + private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void + { + $this->openAPINullablesSetToNull = $openAPINullablesSetToNull; + } + + /** + * Checks if a property is nullable + */ + public static function isNullable(string $property): bool + { + return self::openAPINullables()[$property] ?? false; + } + + /** + * Checks if a nullable property is set to null. + */ + public function isNullableSetToNull(string $property): bool + { + return in_array($property, $this->getOpenAPINullablesSetToNull(), true); + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'fax_id' => 'fax_id', + 'title' => 'title', + 'original_title' => 'original_title', + 'subject' => 'subject', + 'message' => 'message', + 'metadata' => 'metadata', + 'created_at' => 'created_at', + 'sender' => 'sender', + 'transmissions' => 'transmissions', + 'files_url' => 'files_url', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'fax_id' => 'setFaxId', + 'title' => 'setTitle', + 'original_title' => 'setOriginalTitle', + 'subject' => 'setSubject', + 'message' => 'setMessage', + 'metadata' => 'setMetadata', + 'created_at' => 'setCreatedAt', + 'sender' => 'setSender', + 'transmissions' => 'setTransmissions', + 'files_url' => 'setFilesUrl', + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'fax_id' => 'getFaxId', + 'title' => 'getTitle', + 'original_title' => 'getOriginalTitle', + 'subject' => 'getSubject', + 'message' => 'getMessage', + 'metadata' => 'getMetadata', + 'created_at' => 'getCreatedAt', + 'sender' => 'getSender', + 'transmissions' => 'getTransmissions', + 'files_url' => 'getFilesUrl', + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$openAPIModelName; + } + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->setIfExists('fax_id', $data ?? [], null); + $this->setIfExists('title', $data ?? [], null); + $this->setIfExists('original_title', $data ?? [], null); + $this->setIfExists('subject', $data ?? [], null); + $this->setIfExists('message', $data ?? [], null); + $this->setIfExists('metadata', $data ?? [], null); + $this->setIfExists('created_at', $data ?? [], null); + $this->setIfExists('sender', $data ?? [], null); + $this->setIfExists('transmissions', $data ?? [], null); + $this->setIfExists('files_url', $data ?? [], null); + } + + /** + * @deprecated use ::init() + */ + public static function fromArray(array $data): FaxResponse + { + return self::init($data); + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + */ + public static function init(array $data): FaxResponse + { + /** @var FaxResponse */ + return ObjectSerializer::deserialize( + $data, + FaxResponse::class, + ); + } + + /** + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ + private function setIfExists(string $variableName, array $fields, $defaultValue): void + { + if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { + $this->openAPINullablesSetToNull[] = $variableName; + } + + $this->container[$variableName] = $fields[$variableName] ?? $defaultValue; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + if ($this->container['fax_id'] === null) { + $invalidProperties[] = "'fax_id' can't be null"; + } + if ($this->container['title'] === null) { + $invalidProperties[] = "'title' can't be null"; + } + if ($this->container['original_title'] === null) { + $invalidProperties[] = "'original_title' can't be null"; + } + if ($this->container['subject'] === null) { + $invalidProperties[] = "'subject' can't be null"; + } + if ($this->container['message'] === null) { + $invalidProperties[] = "'message' can't be null"; + } + if ($this->container['metadata'] === null) { + $invalidProperties[] = "'metadata' can't be null"; + } + if ($this->container['created_at'] === null) { + $invalidProperties[] = "'created_at' can't be null"; + } + if ($this->container['sender'] === null) { + $invalidProperties[] = "'sender' can't be null"; + } + if ($this->container['transmissions'] === null) { + $invalidProperties[] = "'transmissions' can't be null"; + } + if ($this->container['files_url'] === null) { + $invalidProperties[] = "'files_url' can't be null"; + } + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + /** + * Gets fax_id + * + * @return string + */ + public function getFaxId() + { + return $this->container['fax_id']; + } + + /** + * Sets fax_id + * + * @param string $fax_id Fax ID + * + * @return self + */ + public function setFaxId(string $fax_id) + { + if (is_null($fax_id)) { + throw new InvalidArgumentException('non-nullable fax_id cannot be null'); + } + $this->container['fax_id'] = $fax_id; + + return $this; + } + + /** + * Gets title + * + * @return string + */ + public function getTitle() + { + return $this->container['title']; + } + + /** + * Sets title + * + * @param string $title Fax Title + * + * @return self + */ + public function setTitle(string $title) + { + if (is_null($title)) { + throw new InvalidArgumentException('non-nullable title cannot be null'); + } + $this->container['title'] = $title; + + return $this; + } + + /** + * Gets original_title + * + * @return string + */ + public function getOriginalTitle() + { + return $this->container['original_title']; + } + + /** + * Sets original_title + * + * @param string $original_title Fax Original Title + * + * @return self + */ + public function setOriginalTitle(string $original_title) + { + if (is_null($original_title)) { + throw new InvalidArgumentException('non-nullable original_title cannot be null'); + } + $this->container['original_title'] = $original_title; + + return $this; + } + + /** + * Gets subject + * + * @return string + */ + public function getSubject() + { + return $this->container['subject']; + } + + /** + * Sets subject + * + * @param string $subject Fax Subject + * + * @return self + */ + public function setSubject(string $subject) + { + if (is_null($subject)) { + throw new InvalidArgumentException('non-nullable subject cannot be null'); + } + $this->container['subject'] = $subject; + + return $this; + } + + /** + * Gets message + * + * @return string + */ + public function getMessage() + { + return $this->container['message']; + } + + /** + * Sets message + * + * @param string $message Fax Message + * + * @return self + */ + public function setMessage(string $message) + { + if (is_null($message)) { + throw new InvalidArgumentException('non-nullable message cannot be null'); + } + $this->container['message'] = $message; + + return $this; + } + + /** + * Gets metadata + * + * @return array + */ + public function getMetadata() + { + return $this->container['metadata']; + } + + /** + * Sets metadata + * + * @param array $metadata Fax Metadata + * + * @return self + */ + public function setMetadata(array $metadata) + { + if (is_null($metadata)) { + throw new InvalidArgumentException('non-nullable metadata cannot be null'); + } + $this->container['metadata'] = $metadata; + + return $this; + } + + /** + * Gets created_at + * + * @return int + */ + public function getCreatedAt() + { + return $this->container['created_at']; + } + + /** + * Sets created_at + * + * @param int $created_at Fax Created At Timestamp + * + * @return self + */ + public function setCreatedAt(int $created_at) + { + if (is_null($created_at)) { + throw new InvalidArgumentException('non-nullable created_at cannot be null'); + } + $this->container['created_at'] = $created_at; + + return $this; + } + + /** + * Gets sender + * + * @return string + */ + public function getSender() + { + return $this->container['sender']; + } + + /** + * Sets sender + * + * @param string $sender Fax Sender Email + * + * @return self + */ + public function setSender(string $sender) + { + if (is_null($sender)) { + throw new InvalidArgumentException('non-nullable sender cannot be null'); + } + $this->container['sender'] = $sender; + + return $this; + } + + /** + * Gets transmissions + * + * @return FaxResponseTransmission[] + */ + public function getTransmissions() + { + return $this->container['transmissions']; + } + + /** + * Sets transmissions + * + * @param FaxResponseTransmission[] $transmissions Fax Transmissions List + * + * @return self + */ + public function setTransmissions(array $transmissions) + { + if (is_null($transmissions)) { + throw new InvalidArgumentException('non-nullable transmissions cannot be null'); + } + $this->container['transmissions'] = $transmissions; + + return $this; + } + + /** + * Gets files_url + * + * @return string + */ + public function getFilesUrl() + { + return $this->container['files_url']; + } + + /** + * Sets files_url + * + * @param string $files_url Fax Files URL + * + * @return self + */ + public function setFilesUrl(string $files_url) + { + if (is_null($files_url)) { + throw new InvalidArgumentException('non-nullable files_url cannot be null'); + } + $this->container['files_url'] = $files_url; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetExists($offset): bool + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param int $offset Offset + * + * @return mixed|null + */ + #[ReturnTypeWillChange] + public function offsetGet($offset) + { + return $this->container[$offset] ?? null; + } + + /** + * Sets value based on offset. + * + * @param int|null $offset Offset + * @param mixed $value Value to be set + */ + #[ReturnTypeWillChange] + public function offsetSet($offset, $value): void + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetUnset($offset): void + { + unset($this->container[$offset]); + } + + /** + * Serializes the object to a value that can be serialized natively by json_encode(). + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource + */ + #[ReturnTypeWillChange] + public function jsonSerialize() + { + return ObjectSerializer::sanitizeForSerialization($this); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_UNESCAPED_SLASHES + ); + } + + /** + * Gets a header-safe presentation of the object + * + * @return string + */ + public function toHeaderValue() + { + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} diff --git a/sdks/php/src/Model/FaxResponseTransmission.php b/sdks/php/src/Model/FaxResponseTransmission.php new file mode 100644 index 000000000..049c5b407 --- /dev/null +++ b/sdks/php/src/Model/FaxResponseTransmission.php @@ -0,0 +1,571 @@ + + */ +class FaxResponseTransmission implements ModelInterface, ArrayAccess, JsonSerializable +{ + public const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $openAPIModelName = 'FaxResponseTransmission'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $openAPITypes = [ + 'recipient' => 'string', + 'sender' => 'string', + 'status_code' => 'string', + 'sent_at' => 'int', + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ + protected static $openAPIFormats = [ + 'recipient' => null, + 'sender' => null, + 'status_code' => null, + 'sent_at' => null, + ]; + + /** + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ + protected static array $openAPINullables = [ + 'recipient' => false, + 'sender' => false, + 'status_code' => false, + 'sent_at' => false, + ]; + + /** + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ + protected array $openAPINullablesSetToNull = []; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPITypes() + { + return self::$openAPITypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPIFormats() + { + return self::$openAPIFormats; + } + + /** + * Array of nullable properties + */ + protected static function openAPINullables(): array + { + return self::$openAPINullables; + } + + /** + * Array of nullable field names deliberately set to null + * + * @return bool[] + */ + private function getOpenAPINullablesSetToNull(): array + { + return $this->openAPINullablesSetToNull; + } + + /** + * Setter - Array of nullable field names deliberately set to null + * + * @param bool[] $openAPINullablesSetToNull + */ + private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void + { + $this->openAPINullablesSetToNull = $openAPINullablesSetToNull; + } + + /** + * Checks if a property is nullable + */ + public static function isNullable(string $property): bool + { + return self::openAPINullables()[$property] ?? false; + } + + /** + * Checks if a nullable property is set to null. + */ + public function isNullableSetToNull(string $property): bool + { + return in_array($property, $this->getOpenAPINullablesSetToNull(), true); + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'recipient' => 'recipient', + 'sender' => 'sender', + 'status_code' => 'status_code', + 'sent_at' => 'sent_at', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'recipient' => 'setRecipient', + 'sender' => 'setSender', + 'status_code' => 'setStatusCode', + 'sent_at' => 'setSentAt', + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'recipient' => 'getRecipient', + 'sender' => 'getSender', + 'status_code' => 'getStatusCode', + 'sent_at' => 'getSentAt', + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$openAPIModelName; + } + + public const STATUS_CODE_SUCCESS = 'success'; + public const STATUS_CODE_TRANSMITTING = 'transmitting'; + public const STATUS_CODE_ERROR_COULD_NOT_FAX = 'error_could_not_fax'; + public const STATUS_CODE_ERROR_UNKNOWN = 'error_unknown'; + public const STATUS_CODE_ERROR_BUSY = 'error_busy'; + public const STATUS_CODE_ERROR_NO_ANSWER = 'error_no_answer'; + public const STATUS_CODE_ERROR_DISCONNECTED = 'error_disconnected'; + public const STATUS_CODE_ERROR_BAD_DESTINATION = 'error_bad_destination'; + + /** + * Gets allowable values of the enum + * + * @return string[] + */ + public function getStatusCodeAllowableValues() + { + return [ + self::STATUS_CODE_SUCCESS, + self::STATUS_CODE_TRANSMITTING, + self::STATUS_CODE_ERROR_COULD_NOT_FAX, + self::STATUS_CODE_ERROR_UNKNOWN, + self::STATUS_CODE_ERROR_BUSY, + self::STATUS_CODE_ERROR_NO_ANSWER, + self::STATUS_CODE_ERROR_DISCONNECTED, + self::STATUS_CODE_ERROR_BAD_DESTINATION, + ]; + } + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->setIfExists('recipient', $data ?? [], null); + $this->setIfExists('sender', $data ?? [], null); + $this->setIfExists('status_code', $data ?? [], null); + $this->setIfExists('sent_at', $data ?? [], null); + } + + /** + * @deprecated use ::init() + */ + public static function fromArray(array $data): FaxResponseTransmission + { + return self::init($data); + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + */ + public static function init(array $data): FaxResponseTransmission + { + /** @var FaxResponseTransmission */ + return ObjectSerializer::deserialize( + $data, + FaxResponseTransmission::class, + ); + } + + /** + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ + private function setIfExists(string $variableName, array $fields, $defaultValue): void + { + if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { + $this->openAPINullablesSetToNull[] = $variableName; + } + + $this->container[$variableName] = $fields[$variableName] ?? $defaultValue; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + if ($this->container['recipient'] === null) { + $invalidProperties[] = "'recipient' can't be null"; + } + if ($this->container['sender'] === null) { + $invalidProperties[] = "'sender' can't be null"; + } + if ($this->container['status_code'] === null) { + $invalidProperties[] = "'status_code' can't be null"; + } + $allowedValues = $this->getStatusCodeAllowableValues(); + if (!is_null($this->container['status_code']) && !in_array($this->container['status_code'], $allowedValues, true)) { + $invalidProperties[] = sprintf( + "invalid value '%s' for 'status_code', must be one of '%s'", + $this->container['status_code'], + implode("', '", $allowedValues) + ); + } + + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + /** + * Gets recipient + * + * @return string + */ + public function getRecipient() + { + return $this->container['recipient']; + } + + /** + * Sets recipient + * + * @param string $recipient Fax Transmission Recipient + * + * @return self + */ + public function setRecipient(string $recipient) + { + if (is_null($recipient)) { + throw new InvalidArgumentException('non-nullable recipient cannot be null'); + } + $this->container['recipient'] = $recipient; + + return $this; + } + + /** + * Gets sender + * + * @return string + */ + public function getSender() + { + return $this->container['sender']; + } + + /** + * Sets sender + * + * @param string $sender Fax Transmission Sender + * + * @return self + */ + public function setSender(string $sender) + { + if (is_null($sender)) { + throw new InvalidArgumentException('non-nullable sender cannot be null'); + } + $this->container['sender'] = $sender; + + return $this; + } + + /** + * Gets status_code + * + * @return string + */ + public function getStatusCode() + { + return $this->container['status_code']; + } + + /** + * Sets status_code + * + * @param string $status_code Fax Transmission Status Code + * + * @return self + */ + public function setStatusCode(string $status_code) + { + if (is_null($status_code)) { + throw new InvalidArgumentException('non-nullable status_code cannot be null'); + } + $allowedValues = $this->getStatusCodeAllowableValues(); + if (!in_array($status_code, $allowedValues, true)) { + throw new InvalidArgumentException( + sprintf( + "Invalid value '%s' for 'status_code', must be one of '%s'", + $status_code, + implode("', '", $allowedValues) + ) + ); + } + $this->container['status_code'] = $status_code; + + return $this; + } + + /** + * Gets sent_at + * + * @return int|null + */ + public function getSentAt() + { + return $this->container['sent_at']; + } + + /** + * Sets sent_at + * + * @param int|null $sent_at Fax Transmission Sent Timestamp + * + * @return self + */ + public function setSentAt(?int $sent_at) + { + if (is_null($sent_at)) { + throw new InvalidArgumentException('non-nullable sent_at cannot be null'); + } + $this->container['sent_at'] = $sent_at; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetExists($offset): bool + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param int $offset Offset + * + * @return mixed|null + */ + #[ReturnTypeWillChange] + public function offsetGet($offset) + { + return $this->container[$offset] ?? null; + } + + /** + * Sets value based on offset. + * + * @param int|null $offset Offset + * @param mixed $value Value to be set + */ + #[ReturnTypeWillChange] + public function offsetSet($offset, $value): void + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetUnset($offset): void + { + unset($this->container[$offset]); + } + + /** + * Serializes the object to a value that can be serialized natively by json_encode(). + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource + */ + #[ReturnTypeWillChange] + public function jsonSerialize() + { + return ObjectSerializer::sanitizeForSerialization($this); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_UNESCAPED_SLASHES + ); + } + + /** + * Gets a header-safe presentation of the object + * + * @return string + */ + public function toHeaderValue() + { + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} diff --git a/sdks/php/src/Model/FaxSendRequest.php b/sdks/php/src/Model/FaxSendRequest.php new file mode 100644 index 000000000..d09573478 --- /dev/null +++ b/sdks/php/src/Model/FaxSendRequest.php @@ -0,0 +1,689 @@ + + */ +class FaxSendRequest implements ModelInterface, ArrayAccess, JsonSerializable +{ + public const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $openAPIModelName = 'FaxSendRequest'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $openAPITypes = [ + 'recipient' => 'string', + 'sender' => 'string', + 'files' => '\SplFileObject[]', + 'file_urls' => 'string[]', + 'test_mode' => 'bool', + 'cover_page_to' => 'string', + 'cover_page_from' => 'string', + 'cover_page_message' => 'string', + 'title' => 'string', + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ + protected static $openAPIFormats = [ + 'recipient' => null, + 'sender' => null, + 'files' => 'binary', + 'file_urls' => null, + 'test_mode' => null, + 'cover_page_to' => null, + 'cover_page_from' => null, + 'cover_page_message' => null, + 'title' => null, + ]; + + /** + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ + protected static array $openAPINullables = [ + 'recipient' => false, + 'sender' => false, + 'files' => false, + 'file_urls' => false, + 'test_mode' => false, + 'cover_page_to' => false, + 'cover_page_from' => false, + 'cover_page_message' => false, + 'title' => false, + ]; + + /** + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ + protected array $openAPINullablesSetToNull = []; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPITypes() + { + return self::$openAPITypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPIFormats() + { + return self::$openAPIFormats; + } + + /** + * Array of nullable properties + */ + protected static function openAPINullables(): array + { + return self::$openAPINullables; + } + + /** + * Array of nullable field names deliberately set to null + * + * @return bool[] + */ + private function getOpenAPINullablesSetToNull(): array + { + return $this->openAPINullablesSetToNull; + } + + /** + * Setter - Array of nullable field names deliberately set to null + * + * @param bool[] $openAPINullablesSetToNull + */ + private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void + { + $this->openAPINullablesSetToNull = $openAPINullablesSetToNull; + } + + /** + * Checks if a property is nullable + */ + public static function isNullable(string $property): bool + { + return self::openAPINullables()[$property] ?? false; + } + + /** + * Checks if a nullable property is set to null. + */ + public function isNullableSetToNull(string $property): bool + { + return in_array($property, $this->getOpenAPINullablesSetToNull(), true); + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'recipient' => 'recipient', + 'sender' => 'sender', + 'files' => 'files', + 'file_urls' => 'file_urls', + 'test_mode' => 'test_mode', + 'cover_page_to' => 'cover_page_to', + 'cover_page_from' => 'cover_page_from', + 'cover_page_message' => 'cover_page_message', + 'title' => 'title', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'recipient' => 'setRecipient', + 'sender' => 'setSender', + 'files' => 'setFiles', + 'file_urls' => 'setFileUrls', + 'test_mode' => 'setTestMode', + 'cover_page_to' => 'setCoverPageTo', + 'cover_page_from' => 'setCoverPageFrom', + 'cover_page_message' => 'setCoverPageMessage', + 'title' => 'setTitle', + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'recipient' => 'getRecipient', + 'sender' => 'getSender', + 'files' => 'getFiles', + 'file_urls' => 'getFileUrls', + 'test_mode' => 'getTestMode', + 'cover_page_to' => 'getCoverPageTo', + 'cover_page_from' => 'getCoverPageFrom', + 'cover_page_message' => 'getCoverPageMessage', + 'title' => 'getTitle', + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$openAPIModelName; + } + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[] $data Associated array of property values + * initializing the model + */ + public function __construct(array $data = null) + { + $this->setIfExists('recipient', $data ?? [], null); + $this->setIfExists('sender', $data ?? [], null); + $this->setIfExists('files', $data ?? [], null); + $this->setIfExists('file_urls', $data ?? [], null); + $this->setIfExists('test_mode', $data ?? [], false); + $this->setIfExists('cover_page_to', $data ?? [], null); + $this->setIfExists('cover_page_from', $data ?? [], null); + $this->setIfExists('cover_page_message', $data ?? [], null); + $this->setIfExists('title', $data ?? [], null); + } + + /** + * @deprecated use ::init() + */ + public static function fromArray(array $data): FaxSendRequest + { + return self::init($data); + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + */ + public static function init(array $data): FaxSendRequest + { + /** @var FaxSendRequest */ + return ObjectSerializer::deserialize( + $data, + FaxSendRequest::class, + ); + } + + /** + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ + private function setIfExists(string $variableName, array $fields, $defaultValue): void + { + if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { + $this->openAPINullablesSetToNull[] = $variableName; + } + + $this->container[$variableName] = $fields[$variableName] ?? $defaultValue; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + if ($this->container['recipient'] === null) { + $invalidProperties[] = "'recipient' can't be null"; + } + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + /** + * Gets recipient + * + * @return string + */ + public function getRecipient() + { + return $this->container['recipient']; + } + + /** + * Sets recipient + * + * @param string $recipient Fax Send To Recipient + * + * @return self + */ + public function setRecipient(string $recipient) + { + if (is_null($recipient)) { + throw new InvalidArgumentException('non-nullable recipient cannot be null'); + } + $this->container['recipient'] = $recipient; + + return $this; + } + + /** + * Gets sender + * + * @return string|null + */ + public function getSender() + { + return $this->container['sender']; + } + + /** + * Sets sender + * + * @param string|null $sender Fax Send From Sender (used only with fax number) + * + * @return self + */ + public function setSender(?string $sender) + { + if (is_null($sender)) { + throw new InvalidArgumentException('non-nullable sender cannot be null'); + } + $this->container['sender'] = $sender; + + return $this; + } + + /** + * Gets files + * + * @return SplFileObject[]|null + */ + public function getFiles() + { + return $this->container['files']; + } + + /** + * Sets files + * + * @param SplFileObject[]|null $files Fax File to Send + * + * @return self + */ + public function setFiles(?array $files) + { + if (is_null($files)) { + throw new InvalidArgumentException('non-nullable files cannot be null'); + } + $this->container['files'] = $files; + + return $this; + } + + /** + * Gets file_urls + * + * @return string[]|null + */ + public function getFileUrls() + { + return $this->container['file_urls']; + } + + /** + * Sets file_urls + * + * @param string[]|null $file_urls Fax File URL to Send + * + * @return self + */ + public function setFileUrls(?array $file_urls) + { + if (is_null($file_urls)) { + throw new InvalidArgumentException('non-nullable file_urls cannot be null'); + } + $this->container['file_urls'] = $file_urls; + + return $this; + } + + /** + * Gets test_mode + * + * @return bool|null + */ + public function getTestMode() + { + return $this->container['test_mode']; + } + + /** + * Sets test_mode + * + * @param bool|null $test_mode API Test Mode Setting + * + * @return self + */ + public function setTestMode(?bool $test_mode) + { + if (is_null($test_mode)) { + throw new InvalidArgumentException('non-nullable test_mode cannot be null'); + } + $this->container['test_mode'] = $test_mode; + + return $this; + } + + /** + * Gets cover_page_to + * + * @return string|null + */ + public function getCoverPageTo() + { + return $this->container['cover_page_to']; + } + + /** + * Sets cover_page_to + * + * @param string|null $cover_page_to Fax Cover Page for Recipient + * + * @return self + */ + public function setCoverPageTo(?string $cover_page_to) + { + if (is_null($cover_page_to)) { + throw new InvalidArgumentException('non-nullable cover_page_to cannot be null'); + } + $this->container['cover_page_to'] = $cover_page_to; + + return $this; + } + + /** + * Gets cover_page_from + * + * @return string|null + */ + public function getCoverPageFrom() + { + return $this->container['cover_page_from']; + } + + /** + * Sets cover_page_from + * + * @param string|null $cover_page_from Fax Cover Page for Sender + * + * @return self + */ + public function setCoverPageFrom(?string $cover_page_from) + { + if (is_null($cover_page_from)) { + throw new InvalidArgumentException('non-nullable cover_page_from cannot be null'); + } + $this->container['cover_page_from'] = $cover_page_from; + + return $this; + } + + /** + * Gets cover_page_message + * + * @return string|null + */ + public function getCoverPageMessage() + { + return $this->container['cover_page_message']; + } + + /** + * Sets cover_page_message + * + * @param string|null $cover_page_message Fax Cover Page Message + * + * @return self + */ + public function setCoverPageMessage(?string $cover_page_message) + { + if (is_null($cover_page_message)) { + throw new InvalidArgumentException('non-nullable cover_page_message cannot be null'); + } + $this->container['cover_page_message'] = $cover_page_message; + + return $this; + } + + /** + * Gets title + * + * @return string|null + */ + public function getTitle() + { + return $this->container['title']; + } + + /** + * Sets title + * + * @param string|null $title Fax Title + * + * @return self + */ + public function setTitle(?string $title) + { + if (is_null($title)) { + throw new InvalidArgumentException('non-nullable title cannot be null'); + } + $this->container['title'] = $title; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetExists($offset): bool + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param int $offset Offset + * + * @return mixed|null + */ + #[ReturnTypeWillChange] + public function offsetGet($offset) + { + return $this->container[$offset] ?? null; + } + + /** + * Sets value based on offset. + * + * @param int|null $offset Offset + * @param mixed $value Value to be set + */ + #[ReturnTypeWillChange] + public function offsetSet($offset, $value): void + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetUnset($offset): void + { + unset($this->container[$offset]); + } + + /** + * Serializes the object to a value that can be serialized natively by json_encode(). + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource + */ + #[ReturnTypeWillChange] + public function jsonSerialize() + { + return ObjectSerializer::sanitizeForSerialization($this); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_UNESCAPED_SLASHES + ); + } + + /** + * Gets a header-safe presentation of the object + * + * @return string + */ + public function toHeaderValue() + { + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} diff --git a/sdks/python/README.md b/sdks/python/README.md index 2ace00b7b..c8c415603 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -115,6 +115,11 @@ Class | Method | HTTP request | Description ```BulkSendJobApi``` | [```bulk_send_job_list```](docs/BulkSendJobApi.md#bulk_send_job_list) | ```GET /bulk_send_job/list``` | List Bulk Send Jobs| |```EmbeddedApi``` | [```embedded_edit_url```](docs/EmbeddedApi.md#embedded_edit_url) | ```POST /embedded/edit_url/{template_id}``` | Get Embedded Template Edit URL| ```EmbeddedApi``` | [```embedded_sign_url```](docs/EmbeddedApi.md#embedded_sign_url) | ```GET /embedded/sign_url/{signature_id}``` | Get Embedded Sign URL| +|```FaxApi``` | [```fax_delete```](docs/FaxApi.md#fax_delete) | ```DELETE /fax/{fax_id}``` | Delete Fax| +```FaxApi``` | [```fax_files```](docs/FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | List Fax Files| +```FaxApi``` | [```fax_get```](docs/FaxApi.md#fax_get) | ```GET /fax/{fax_id}``` | Get Fax| +```FaxApi``` | [```fax_list```](docs/FaxApi.md#fax_list) | ```GET /fax/list``` | Lists Faxes| +```FaxApi``` | [```fax_send```](docs/FaxApi.md#fax_send) | ```POST /fax/send``` | Send Fax| |```FaxLineApi``` | [```fax_line_add_user```](docs/FaxLineApi.md#fax_line_add_user) | ```PUT /fax_line/add_user``` | Add Fax Line User| ```FaxLineApi``` | [```fax_line_area_code_get```](docs/FaxLineApi.md#fax_line_area_code_get) | ```GET /fax_line/area_codes``` | Get Available Fax Line Area Codes| ```FaxLineApi``` | [```fax_line_create```](docs/FaxLineApi.md#fax_line_create) | ```POST /fax_line/create``` | Purchase Fax Line| @@ -204,6 +209,7 @@ Class | Method | HTTP request | Description - [EventCallbackRequest](docs/EventCallbackRequest.md) - [EventCallbackRequestEvent](docs/EventCallbackRequestEvent.md) - [EventCallbackRequestEventMetadata](docs/EventCallbackRequestEventMetadata.md) + - [FaxGetResponse](docs/FaxGetResponse.md) - [FaxLineAddUserRequest](docs/FaxLineAddUserRequest.md) - [FaxLineAreaCodeGetCountryEnum](docs/FaxLineAreaCodeGetCountryEnum.md) - [FaxLineAreaCodeGetProvinceEnum](docs/FaxLineAreaCodeGetProvinceEnum.md) @@ -215,6 +221,10 @@ Class | Method | HTTP request | Description - [FaxLineRemoveUserRequest](docs/FaxLineRemoveUserRequest.md) - [FaxLineResponse](docs/FaxLineResponse.md) - [FaxLineResponseFaxLine](docs/FaxLineResponseFaxLine.md) + - [FaxListResponse](docs/FaxListResponse.md) + - [FaxResponse](docs/FaxResponse.md) + - [FaxResponseTransmission](docs/FaxResponseTransmission.md) + - [FaxSendRequest](docs/FaxSendRequest.md) - [FileResponse](docs/FileResponse.md) - [FileResponseDataUri](docs/FileResponseDataUri.md) - [ListInfoResponse](docs/ListInfoResponse.md) diff --git a/sdks/python/docs/FaxApi.md b/sdks/python/docs/FaxApi.md new file mode 100644 index 000000000..a0b2cbd12 --- /dev/null +++ b/sdks/python/docs/FaxApi.md @@ -0,0 +1,334 @@ +# ```dropbox_sign.FaxApi``` + +All URIs are relative to *https://api.hellosign.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +|[```fax_delete```](FaxApi.md#fax_delete) | ```DELETE /fax/{fax_id}``` | Delete Fax| +|[```fax_files```](FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | List Fax Files| +|[```fax_get```](FaxApi.md#fax_get) | ```GET /fax/{fax_id}``` | Get Fax| +|[```fax_list```](FaxApi.md#fax_list) | ```GET /fax/list``` | Lists Faxes| +|[```fax_send```](FaxApi.md#fax_send) | ```POST /fax/send``` | Send Fax| + + +# ```fax_delete``` +> ```fax_delete(fax_id)``` + +Delete Fax + +Deletes the specified Fax from the system. + +### Example + +* Basic Authentication (api_key): + +```python +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, apis, models + +configuration = Configuration( + # Configure HTTP basic authorization: api_key + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_api = apis.FaxApi(api_client) + + try: + fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967") + except ApiException as e: + print("Exception when calling Dropbox Sign API: %s\n" % e) + +``` +``` + +### Parameters +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `fax_id` | **str** | Fax ID | | + +### Return type + +void (empty response body) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +**4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# ```fax_files``` +> ```io.IOBase fax_files(fax_id)``` + +List Fax Files + +Returns list of fax files + +### Example + +* Basic Authentication (api_key): + +```python +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, apis, models + +configuration = Configuration( + # Configure HTTP basic authorization: api_key + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_api = apis.FaxApi(api_client) + + fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + + try: + response = fax_api.fax_files(fax_id) + open("file_response.pdf", "wb").write(response.read()) + except ApiException as e: + print("Exception when calling Dropbox Sign API: %s\n" % e) + +``` +``` + +### Parameters +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `fax_id` | **str** | Fax ID | | + +### Return type + +**io.IOBase** + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/pdf, application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +**4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# ```fax_get``` +> ```FaxGetResponse fax_get(fax_id)``` + +Get Fax + +Returns information about fax + +### Example + +* Basic Authentication (api_key): + +```python +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, apis + +configuration = Configuration( + # Configure HTTP basic authorization: api_key + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_api = apis.FaxApi(api_client) + + fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + + try: + response = fax_api.fax_get(fax_id) + pprint(response) + except ApiException as e: + print("Exception when calling Dropbox Sign API: %s\n" % e) + +``` +``` + +### Parameters +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `fax_id` | **str** | Fax ID | | + +### Return type + +[**FaxGetResponse**](FaxGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +**4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# ```fax_list``` +> ```FaxListResponse fax_list()``` + +Lists Faxes + +Returns properties of multiple faxes + +### Example + +* Basic Authentication (api_key): + +```python +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, apis + +configuration = Configuration( + # Configure HTTP basic authorization: api_key + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_api = apis.FaxApi(api_client) + + page = 1 + page_size = 2 + + try: + response = fax_api.fax_list( + page=page, + page_size=page_size, + ) + pprint(response) + except ApiException as e: + print("Exception when calling Dropbox Sign API: %s\n" % e) + +``` +``` + +### Parameters +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `page` | **int** | Page | [optional][default to 1] | +| `page_size` | **int** | Page size | [optional][default to 20] | + +### Return type + +[**FaxListResponse**](FaxListResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +**4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# ```fax_send``` +> ```FaxGetResponse fax_send(fax_send_request)``` + +Send Fax + +Action to prepare and send a fax + +### Example + +* Basic Authentication (api_key): + +```python +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, apis, models + +configuration = Configuration( + # Configure HTTP basic authorization: api_key + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_api = apis.FaxApi(api_client) + + data = models.FaxSendRequest( + files=[open("example_signature_request.pdf", "rb")], + test_mode=True, + recipient="16690000001", + sender="16690000000", + cover_page_to="Jill Fax", + cover_page_message="I'm sending you a fax!", + cover_page_from="Faxer Faxerson", + title="This is what the fax is about!", + ) + + try: + response = fax_api.fax_send(data) + pprint(response) + except ApiException as e: + print("Exception when calling Dropbox Sign API: %s\n" % e) + +``` +``` + +### Parameters +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `fax_send_request` | [**FaxSendRequest**](FaxSendRequest.md) | | | + +### Return type + +[**FaxGetResponse**](FaxGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +**4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/sdks/python/docs/FaxGetResponse.md b/sdks/python/docs/FaxGetResponse.md new file mode 100644 index 000000000..02b92d68d --- /dev/null +++ b/sdks/python/docs/FaxGetResponse.md @@ -0,0 +1,12 @@ +# FaxGetResponse + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `fax`*_required_ | [```FaxResponse```](FaxResponse.md) | | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | + +[[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/FaxListResponse.md b/sdks/python/docs/FaxListResponse.md new file mode 100644 index 000000000..e57c1881e --- /dev/null +++ b/sdks/python/docs/FaxListResponse.md @@ -0,0 +1,12 @@ +# FaxListResponse + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `faxes`*_required_ | [```List[FaxResponse]```](FaxResponse.md) | | | +| `list_info`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | + +[[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/FaxResponse.md b/sdks/python/docs/FaxResponse.md new file mode 100644 index 000000000..d531f5d0a --- /dev/null +++ b/sdks/python/docs/FaxResponse.md @@ -0,0 +1,20 @@ +# FaxResponse + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `fax_id`*_required_ | ```str``` | Fax ID | | +| `title`*_required_ | ```str``` | Fax Title | | +| `original_title`*_required_ | ```str``` | Fax Original Title | | +| `subject`*_required_ | ```str``` | Fax Subject | | +| `message`*_required_ | ```str``` | Fax Message | | +| `metadata`*_required_ | ```Dict[str, object]``` | Fax Metadata | | +| `created_at`*_required_ | ```int``` | Fax Created At Timestamp | | +| `sender`*_required_ | ```str``` | Fax Sender Email | | +| `transmissions`*_required_ | [```List[FaxResponseTransmission]```](FaxResponseTransmission.md) | Fax Transmissions List | | +| `files_url`*_required_ | ```str``` | Fax Files URL | | + +[[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/FaxResponseTransmission.md b/sdks/python/docs/FaxResponseTransmission.md new file mode 100644 index 000000000..9ba09c130 --- /dev/null +++ b/sdks/python/docs/FaxResponseTransmission.md @@ -0,0 +1,14 @@ +# FaxResponseTransmission + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `recipient`*_required_ | ```str``` | Fax Transmission Recipient | | +| `sender`*_required_ | ```str``` | Fax Transmission Sender | | +| `status_code`*_required_ | ```str``` | Fax Transmission Status Code | | +| `sent_at` | ```int``` | Fax Transmission Sent Timestamp | | + +[[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/FaxSendRequest.md b/sdks/python/docs/FaxSendRequest.md new file mode 100644 index 000000000..cdb4f49a0 --- /dev/null +++ b/sdks/python/docs/FaxSendRequest.md @@ -0,0 +1,19 @@ +# FaxSendRequest + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `recipient`*_required_ | ```str``` | Fax Send To Recipient | | +| `sender` | ```str``` | Fax Send From Sender (used only with fax number) | | +| `files` | ```List[io.IOBase]``` | Fax File to Send | | +| `file_urls` | ```List[str]``` | Fax File URL to Send | | +| `test_mode` | ```bool``` | API Test Mode Setting | [default to False] | +| `cover_page_to` | ```str``` | Fax Cover Page for Recipient | | +| `cover_page_from` | ```str``` | Fax Cover Page for Sender | | +| `cover_page_message` | ```str``` | Fax Cover Page Message | | +| `title` | ```str``` | Fax Title | | + +[[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/__init__.py b/sdks/python/dropbox_sign/__init__.py index 15adf1c8d..c37a24fc1 100644 --- a/sdks/python/dropbox_sign/__init__.py +++ b/sdks/python/dropbox_sign/__init__.py @@ -80,6 +80,7 @@ from dropbox_sign.models.event_callback_request_event_metadata import ( EventCallbackRequestEventMetadata, ) +from dropbox_sign.models.fax_get_response import FaxGetResponse from dropbox_sign.models.fax_line_add_user_request import FaxLineAddUserRequest from dropbox_sign.models.fax_line_area_code_get_country_enum import ( FaxLineAreaCodeGetCountryEnum, @@ -99,6 +100,10 @@ from dropbox_sign.models.fax_line_remove_user_request import FaxLineRemoveUserRequest from dropbox_sign.models.fax_line_response import FaxLineResponse from dropbox_sign.models.fax_line_response_fax_line import FaxLineResponseFaxLine +from dropbox_sign.models.fax_list_response import FaxListResponse +from dropbox_sign.models.fax_response import FaxResponse +from dropbox_sign.models.fax_response_transmission import FaxResponseTransmission +from dropbox_sign.models.fax_send_request import FaxSendRequest from dropbox_sign.models.file_response import FileResponse from dropbox_sign.models.file_response_data_uri import FileResponseDataUri from dropbox_sign.models.list_info_response import ListInfoResponse diff --git a/sdks/python/dropbox_sign/api/__init__.py b/sdks/python/dropbox_sign/api/__init__.py index c861b688e..f4000e522 100644 --- a/sdks/python/dropbox_sign/api/__init__.py +++ b/sdks/python/dropbox_sign/api/__init__.py @@ -5,6 +5,7 @@ from dropbox_sign.api.api_app_api import ApiAppApi from dropbox_sign.api.bulk_send_job_api import BulkSendJobApi from dropbox_sign.api.embedded_api import EmbeddedApi +from dropbox_sign.api.fax_api import FaxApi from dropbox_sign.api.fax_line_api import FaxLineApi from dropbox_sign.api.o_auth_api import OAuthApi from dropbox_sign.api.report_api import ReportApi diff --git a/sdks/python/dropbox_sign/api/fax_api.py b/sdks/python/dropbox_sign/api/fax_api.py new file mode 100644 index 000000000..3e49a160a --- /dev/null +++ b/sdks/python/dropbox_sign/api/fax_api.py @@ -0,0 +1,1327 @@ +# coding: utf-8 + +""" + Dropbox Sign API + + Dropbox Sign v3 API + + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBytes, StrictStr +from typing import Optional, Union +from typing_extensions import Annotated +from dropbox_sign.models.fax_get_response import FaxGetResponse +from dropbox_sign.models.fax_list_response import FaxListResponse +from dropbox_sign.models.fax_send_request import FaxSendRequest + +from dropbox_sign.api_client import ApiClient, RequestSerialized +from dropbox_sign.api_response import ApiResponse +from dropbox_sign.rest import RESTResponseType +import io + + +class FaxApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + @validate_call + def fax_delete( + self, + fax_id: Annotated[StrictStr, Field(description="Fax ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete Fax + + Deletes the specified Fax from the system. + + :param fax_id: Fax ID (required) + :type fax_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_delete_serialize( + fax_id=fax_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "204": None, + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def fax_delete_with_http_info( + self, + fax_id: Annotated[StrictStr, Field(description="Fax ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete Fax + + Deletes the specified Fax from the system. + + :param fax_id: Fax ID (required) + :type fax_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_delete_serialize( + fax_id=fax_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "204": None, + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def fax_delete_without_preload_content( + self, + fax_id: Annotated[StrictStr, Field(description="Fax ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Fax + + Deletes the specified Fax from the system. + + :param fax_id: Fax ID (required) + :type fax_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_delete_serialize( + fax_id=fax_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "204": None, + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _fax_delete_serialize( + self, + fax_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if fax_id is not None: + _path_params["fax_id"] = fax_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # authentication setting + _auth_settings: List[str] = ["api_key"] + + return self.api_client.param_serialize( + method="DELETE", + resource_path="/fax/{fax_id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + + @validate_call + def fax_files( + self, + fax_id: Annotated[StrictStr, Field(description="Fax ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> io.IOBase: + """List Fax Files + + Returns list of fax files + + :param fax_id: Fax ID (required) + :type fax_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_files_serialize( + fax_id=fax_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "io.IOBase", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def fax_files_with_http_info( + self, + fax_id: Annotated[StrictStr, Field(description="Fax ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[io.IOBase]: + """List Fax Files + + Returns list of fax files + + :param fax_id: Fax ID (required) + :type fax_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_files_serialize( + fax_id=fax_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "io.IOBase", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def fax_files_without_preload_content( + self, + fax_id: Annotated[StrictStr, Field(description="Fax ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """List Fax Files + + Returns list of fax files + + :param fax_id: Fax ID (required) + :type fax_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_files_serialize( + fax_id=fax_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "io.IOBase", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _fax_files_serialize( + self, + fax_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if fax_id is not None: + _path_params["fax_id"] = fax_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept( + ["application/pdf", "application/json"] + ) + + # authentication setting + _auth_settings: List[str] = ["api_key"] + + return self.api_client.param_serialize( + method="GET", + resource_path="/fax/files/{fax_id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + + @validate_call + def fax_get( + self, + fax_id: Annotated[StrictStr, Field(description="Fax ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> FaxGetResponse: + """Get Fax + + Returns information about fax + + :param fax_id: Fax ID (required) + :type fax_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_get_serialize( + fax_id=fax_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "FaxGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def fax_get_with_http_info( + self, + fax_id: Annotated[StrictStr, Field(description="Fax ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[FaxGetResponse]: + """Get Fax + + Returns information about fax + + :param fax_id: Fax ID (required) + :type fax_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_get_serialize( + fax_id=fax_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "FaxGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def fax_get_without_preload_content( + self, + fax_id: Annotated[StrictStr, Field(description="Fax ID")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Fax + + Returns information about fax + + :param fax_id: Fax ID (required) + :type fax_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_get_serialize( + fax_id=fax_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "FaxGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _fax_get_serialize( + self, + fax_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if fax_id is not None: + _path_params["fax_id"] = fax_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # authentication setting + _auth_settings: List[str] = ["api_key"] + + return self.api_client.param_serialize( + method="GET", + resource_path="/fax/{fax_id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + + @validate_call + def fax_list( + self, + page: Annotated[ + Optional[Annotated[int, Field(strict=True, ge=1)]], + Field(description="Page"), + ] = None, + page_size: Annotated[ + Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], + Field(description="Page size"), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> FaxListResponse: + """Lists Faxes + + Returns properties of multiple faxes + + :param page: Page + :type page: int + :param page_size: Page size + :type page_size: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_list_serialize( + page=page, + page_size=page_size, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "FaxListResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def fax_list_with_http_info( + self, + page: Annotated[ + Optional[Annotated[int, Field(strict=True, ge=1)]], + Field(description="Page"), + ] = None, + page_size: Annotated[ + Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], + Field(description="Page size"), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[FaxListResponse]: + """Lists Faxes + + Returns properties of multiple faxes + + :param page: Page + :type page: int + :param page_size: Page size + :type page_size: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_list_serialize( + page=page, + page_size=page_size, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "FaxListResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def fax_list_without_preload_content( + self, + page: Annotated[ + Optional[Annotated[int, Field(strict=True, ge=1)]], + Field(description="Page"), + ] = None, + page_size: Annotated[ + Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], + Field(description="Page size"), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Lists Faxes + + Returns properties of multiple faxes + + :param page: Page + :type page: int + :param page_size: Page size + :type page_size: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_list_serialize( + page=page, + page_size=page_size, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "FaxListResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _fax_list_serialize( + self, + page, + page_size, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if page is not None: + + _query_params.append(("page", page)) + + if page_size is not None: + + _query_params.append(("page_size", page_size)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # authentication setting + _auth_settings: List[str] = ["api_key"] + + return self.api_client.param_serialize( + method="GET", + resource_path="/fax/list", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + + @validate_call + def fax_send( + self, + fax_send_request: FaxSendRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> FaxGetResponse: + """Send Fax + + Action to prepare and send a fax + + :param fax_send_request: (required) + :type fax_send_request: FaxSendRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_send_serialize( + fax_send_request=fax_send_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "FaxGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def fax_send_with_http_info( + self, + fax_send_request: FaxSendRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[FaxGetResponse]: + """Send Fax + + Action to prepare and send a fax + + :param fax_send_request: (required) + :type fax_send_request: FaxSendRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_send_serialize( + fax_send_request=fax_send_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "FaxGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def fax_send_without_preload_content( + self, + fax_send_request: FaxSendRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Send Fax + + Action to prepare and send a fax + + :param fax_send_request: (required) + :type fax_send_request: FaxSendRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._fax_send_serialize( + fax_send_request=fax_send_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "FaxGetResponse", + "4XX": "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _fax_send_serialize( + self, + fax_send_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + has_files = False + body_param = fax_send_request + excluded_json_fields = set([]) + for param_name, param_type in body_param.openapi_types().items(): + param_value = getattr(body_param, param_name) + if param_value is None: + continue + + if "io.IOBase" in param_type: + has_files = True + _content_type = "multipart/form-data" + excluded_json_fields.add(param_name) + + if isinstance(param_value, list): + for index, item in enumerate(param_value): + _files[f"{param_name}[{index}]"] = item + else: + _files[param_name] = param_value + + if has_files is True: + _form_params = body_param.to_json_form_params(excluded_json_fields) + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if fax_send_request is not None and has_files is False: + _body_params = fax_send_request + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params["Content-Type"] = _content_type + else: + _default_content_type = self.api_client.select_header_content_type( + ["application/json", "multipart/form-data"] + ) + if _default_content_type is not None: + _header_params["Content-Type"] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ["api_key"] + + return self.api_client.param_serialize( + method="POST", + resource_path="/fax/send", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) diff --git a/sdks/python/dropbox_sign/apis/__init__.py b/sdks/python/dropbox_sign/apis/__init__.py index 16344f32d..0df638089 100644 --- a/sdks/python/dropbox_sign/apis/__init__.py +++ b/sdks/python/dropbox_sign/apis/__init__.py @@ -5,6 +5,7 @@ from dropbox_sign.api.api_app_api import ApiAppApi from dropbox_sign.api.bulk_send_job_api import BulkSendJobApi from dropbox_sign.api.embedded_api import EmbeddedApi +from dropbox_sign.api.fax_api import FaxApi from dropbox_sign.api.fax_line_api import FaxLineApi from dropbox_sign.api.o_auth_api import OAuthApi from dropbox_sign.api.report_api import ReportApi diff --git a/sdks/python/dropbox_sign/models/__init__.py b/sdks/python/dropbox_sign/models/__init__.py index 919a66d9c..97af4020e 100644 --- a/sdks/python/dropbox_sign/models/__init__.py +++ b/sdks/python/dropbox_sign/models/__init__.py @@ -63,6 +63,7 @@ from dropbox_sign.models.event_callback_request_event_metadata import ( EventCallbackRequestEventMetadata, ) +from dropbox_sign.models.fax_get_response import FaxGetResponse from dropbox_sign.models.fax_line_add_user_request import FaxLineAddUserRequest from dropbox_sign.models.fax_line_area_code_get_country_enum import ( FaxLineAreaCodeGetCountryEnum, @@ -82,6 +83,10 @@ from dropbox_sign.models.fax_line_remove_user_request import FaxLineRemoveUserRequest from dropbox_sign.models.fax_line_response import FaxLineResponse from dropbox_sign.models.fax_line_response_fax_line import FaxLineResponseFaxLine +from dropbox_sign.models.fax_list_response import FaxListResponse +from dropbox_sign.models.fax_response import FaxResponse +from dropbox_sign.models.fax_response_transmission import FaxResponseTransmission +from dropbox_sign.models.fax_send_request import FaxSendRequest from dropbox_sign.models.file_response import FileResponse from dropbox_sign.models.file_response_data_uri import FileResponseDataUri from dropbox_sign.models.list_info_response import ListInfoResponse diff --git a/sdks/python/dropbox_sign/models/fax_get_response.py b/sdks/python/dropbox_sign/models/fax_get_response.py new file mode 100644 index 000000000..8c2b2249f --- /dev/null +++ b/sdks/python/dropbox_sign/models/fax_get_response.py @@ -0,0 +1,151 @@ +# coding: utf-8 + +""" + Dropbox Sign API + + Dropbox Sign v3 API + + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dropbox_sign.models.fax_response import FaxResponse +from dropbox_sign.models.warning_response import WarningResponse +from typing import Optional, Set, Tuple +from typing_extensions import Self +import io +from pydantic import StrictBool +from typing import Union + + +class FaxGetResponse(BaseModel): + """ + FaxGetResponse + """ # noqa: E501 + + fax: FaxResponse + warnings: Optional[List[WarningResponse]] = Field( + default=None, description="A list of warnings." + ) + __properties: ClassVar[List[str]] = ["fax", "warnings"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of FaxGetResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of fax + if self.fax: + _dict["fax"] = self.fax.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in warnings (list) + _items = [] + if self.warnings: + for _item_warnings in self.warnings: + if _item_warnings: + _items.append(_item_warnings.to_dict()) + _dict["warnings"] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of FaxGetResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "fax": ( + FaxResponse.from_dict(obj["fax"]) + if obj.get("fax") is not None + else None + ), + "warnings": ( + [WarningResponse.from_dict(_item) for _item in obj["warnings"]] + if obj.get("warnings") is not None + else None + ), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "fax": "(FaxResponse,)", + "warnings": "(List[WarningResponse],)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "warnings", + ] diff --git a/sdks/python/dropbox_sign/models/fax_list_response.py b/sdks/python/dropbox_sign/models/fax_list_response.py new file mode 100644 index 000000000..b62b406e1 --- /dev/null +++ b/sdks/python/dropbox_sign/models/fax_list_response.py @@ -0,0 +1,149 @@ +# coding: utf-8 + +""" + Dropbox Sign API + + Dropbox Sign v3 API + + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from dropbox_sign.models.fax_response import FaxResponse +from dropbox_sign.models.list_info_response import ListInfoResponse +from typing import Optional, Set, Tuple +from typing_extensions import Self +import io +from pydantic import StrictBool +from typing import Union + + +class FaxListResponse(BaseModel): + """ + FaxListResponse + """ # noqa: E501 + + faxes: List[FaxResponse] + list_info: ListInfoResponse + __properties: ClassVar[List[str]] = ["faxes", "list_info"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of FaxListResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in faxes (list) + _items = [] + if self.faxes: + for _item_faxes in self.faxes: + if _item_faxes: + _items.append(_item_faxes.to_dict()) + _dict["faxes"] = _items + # override the default output from pydantic by calling `to_dict()` of list_info + if self.list_info: + _dict["list_info"] = self.list_info.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of FaxListResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "faxes": ( + [FaxResponse.from_dict(_item) for _item in obj["faxes"]] + if obj.get("faxes") is not None + else None + ), + "list_info": ( + ListInfoResponse.from_dict(obj["list_info"]) + if obj.get("list_info") is not None + else None + ), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "faxes": "(List[FaxResponse],)", + "list_info": "(ListInfoResponse,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "faxes", + ] diff --git a/sdks/python/dropbox_sign/models/fax_response.py b/sdks/python/dropbox_sign/models/fax_response.py new file mode 100644 index 000000000..035993f12 --- /dev/null +++ b/sdks/python/dropbox_sign/models/fax_response.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + Dropbox Sign API + + Dropbox Sign v3 API + + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List +from dropbox_sign.models.fax_response_transmission import FaxResponseTransmission +from typing import Optional, Set, Tuple +from typing_extensions import Self +import io +from pydantic import StrictBool +from typing import Union + + +class FaxResponse(BaseModel): + """ + FaxResponse + """ # noqa: E501 + + fax_id: StrictStr = Field(description="Fax ID") + title: StrictStr = Field(description="Fax Title") + original_title: StrictStr = Field(description="Fax Original Title") + subject: StrictStr = Field(description="Fax Subject") + message: StrictStr = Field(description="Fax Message") + metadata: Dict[str, Any] = Field(description="Fax Metadata") + created_at: StrictInt = Field(description="Fax Created At Timestamp") + sender: StrictStr = Field(description="Fax Sender Email") + transmissions: List[FaxResponseTransmission] = Field( + description="Fax Transmissions List" + ) + files_url: StrictStr = Field(description="Fax Files URL") + __properties: ClassVar[List[str]] = [ + "fax_id", + "title", + "original_title", + "subject", + "message", + "metadata", + "created_at", + "sender", + "transmissions", + "files_url", + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of FaxResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in transmissions (list) + _items = [] + if self.transmissions: + for _item_transmissions in self.transmissions: + if _item_transmissions: + _items.append(_item_transmissions.to_dict()) + _dict["transmissions"] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of FaxResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "fax_id": obj.get("fax_id"), + "title": obj.get("title"), + "original_title": obj.get("original_title"), + "subject": obj.get("subject"), + "message": obj.get("message"), + "metadata": obj.get("metadata"), + "created_at": obj.get("created_at"), + "sender": obj.get("sender"), + "transmissions": ( + [ + FaxResponseTransmission.from_dict(_item) + for _item in obj["transmissions"] + ] + if obj.get("transmissions") is not None + else None + ), + "files_url": obj.get("files_url"), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "fax_id": "(str,)", + "title": "(str,)", + "original_title": "(str,)", + "subject": "(str,)", + "message": "(str,)", + "metadata": "(Dict[str, object],)", + "created_at": "(int,)", + "sender": "(str,)", + "transmissions": "(List[FaxResponseTransmission],)", + "files_url": "(str,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "transmissions", + ] diff --git a/sdks/python/dropbox_sign/models/fax_response_fax.py b/sdks/python/dropbox_sign/models/fax_response_fax.py new file mode 100644 index 000000000..e66df9880 --- /dev/null +++ b/sdks/python/dropbox_sign/models/fax_response_fax.py @@ -0,0 +1,187 @@ +# coding: utf-8 + +""" + Dropbox Sign API + + Dropbox Sign v3 API + + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from dropbox_sign.models.fax_response_fax_transmission import FaxResponseFaxTransmission +from typing import Optional, Set, Tuple +from typing_extensions import Self +import io +from pydantic import StrictBool +from typing import Union + + +class FaxResponseFax(BaseModel): + """ + FaxResponseFax + """ # noqa: E501 + + fax_id: Optional[StrictStr] = Field(default=None, description="Fax ID") + title: Optional[StrictStr] = Field(default=None, description="Fax Title") + original_title: Optional[StrictStr] = Field( + default=None, description="Fax Original Title" + ) + subject: Optional[StrictStr] = Field(default=None, description="Fax Subject") + message: Optional[StrictStr] = Field(default=None, description="Fax Message") + metadata: Optional[Dict[str, Any]] = Field(default=None, description="Fax Metadata") + created_at: Optional[StrictInt] = Field( + default=None, description="Fax Created At Timestamp" + ) + var_from: Optional[StrictStr] = Field( + default=None, description="Fax Sender Email", alias="from" + ) + transmissions: Optional[List[FaxResponseFaxTransmission]] = Field( + default=None, description="Fax Transmissions List" + ) + files_url: Optional[StrictStr] = Field(default=None, description="Fax Files URL") + __properties: ClassVar[List[str]] = [ + "fax_id", + "title", + "original_title", + "subject", + "message", + "metadata", + "created_at", + "from", + "transmissions", + "files_url", + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of FaxResponseFax from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in transmissions (list) + _items = [] + if self.transmissions: + for _item_transmissions in self.transmissions: + if _item_transmissions: + _items.append(_item_transmissions.to_dict()) + _dict["transmissions"] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of FaxResponseFax from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "fax_id": obj.get("fax_id"), + "title": obj.get("title"), + "original_title": obj.get("original_title"), + "subject": obj.get("subject"), + "message": obj.get("message"), + "metadata": obj.get("metadata"), + "created_at": obj.get("created_at"), + "from": obj.get("from"), + "transmissions": ( + [ + FaxResponseFaxTransmission.from_dict(_item) + for _item in obj["transmissions"] + ] + if obj.get("transmissions") is not None + else None + ), + "files_url": obj.get("files_url"), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "fax_id": "(str,)", + "title": "(str,)", + "original_title": "(str,)", + "subject": "(str,)", + "message": "(str,)", + "metadata": "(object,)", + "created_at": "(int,)", + "var_from": "(str,)", + "transmissions": "(List[FaxResponseFaxTransmission],)", + "files_url": "(str,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "transmissions", + ] diff --git a/sdks/python/dropbox_sign/models/fax_response_fax_transmission.py b/sdks/python/dropbox_sign/models/fax_response_fax_transmission.py new file mode 100644 index 000000000..0c47a93f0 --- /dev/null +++ b/sdks/python/dropbox_sign/models/fax_response_fax_transmission.py @@ -0,0 +1,146 @@ +# coding: utf-8 + +""" + Dropbox Sign API + + Dropbox Sign v3 API + + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set, Tuple +from typing_extensions import Self +import io +from pydantic import StrictBool +from typing import Union + + +class FaxResponseFaxTransmission(BaseModel): + """ + FaxResponseFaxTransmission + """ # noqa: E501 + + recipient: Optional[StrictStr] = Field( + default=None, description="Fax Transmission Recipient" + ) + sender: Optional[StrictStr] = Field( + default=None, description="Fax Transmission Sender" + ) + status_code: Optional[StrictStr] = Field( + default=None, description="Fax Transmission Status Code" + ) + sent_at: Optional[StrictInt] = Field( + default=None, description="Fax Transmission Sent Timestamp" + ) + __properties: ClassVar[List[str]] = [ + "recipient", + "sender", + "status_code", + "sent_at", + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of FaxResponseFaxTransmission from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of FaxResponseFaxTransmission from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "recipient": obj.get("recipient"), + "sender": obj.get("sender"), + "status_code": obj.get("status_code"), + "sent_at": obj.get("sent_at"), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "recipient": "(str,)", + "sender": "(str,)", + "status_code": "(str,)", + "sent_at": "(int,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [] diff --git a/sdks/python/dropbox_sign/models/fax_response_transmission.py b/sdks/python/dropbox_sign/models/fax_response_transmission.py new file mode 100644 index 000000000..c34d2e9ae --- /dev/null +++ b/sdks/python/dropbox_sign/models/fax_response_transmission.py @@ -0,0 +1,160 @@ +# coding: utf-8 + +""" + Dropbox Sign API + + Dropbox Sign v3 API + + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set, Tuple +from typing_extensions import Self +import io +from pydantic import StrictBool +from typing import Union + + +class FaxResponseTransmission(BaseModel): + """ + FaxResponseTransmission + """ # noqa: E501 + + recipient: StrictStr = Field(description="Fax Transmission Recipient") + sender: StrictStr = Field(description="Fax Transmission Sender") + status_code: StrictStr = Field(description="Fax Transmission Status Code") + sent_at: Optional[StrictInt] = Field( + default=None, description="Fax Transmission Sent Timestamp" + ) + __properties: ClassVar[List[str]] = [ + "recipient", + "sender", + "status_code", + "sent_at", + ] + + @field_validator("status_code") + def status_code_validate_enum(cls, value): + """Validates the enum""" + if value not in set( + [ + "success", + "transmitting", + "error_could_not_fax", + "error_unknown", + "error_busy", + "error_no_answer", + "error_disconnected", + "error_bad_destination", + ] + ): + raise ValueError( + "must be one of enum values ('success', 'transmitting', 'error_could_not_fax', 'error_unknown', 'error_busy', 'error_no_answer', 'error_disconnected', 'error_bad_destination')" + ) + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of FaxResponseTransmission from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of FaxResponseTransmission from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "recipient": obj.get("recipient"), + "sender": obj.get("sender"), + "status_code": obj.get("status_code"), + "sent_at": obj.get("sent_at"), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "recipient": "(str,)", + "sender": "(str,)", + "status_code": "(str,)", + "sent_at": "(int,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [] diff --git a/sdks/python/dropbox_sign/models/fax_send_request.py b/sdks/python/dropbox_sign/models/fax_send_request.py new file mode 100644 index 000000000..9fe6c54a3 --- /dev/null +++ b/sdks/python/dropbox_sign/models/fax_send_request.py @@ -0,0 +1,177 @@ +# coding: utf-8 + +""" + Dropbox Sign API + + Dropbox Sign v3 API + + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set, Tuple +from typing_extensions import Self +import io +from pydantic import StrictBool +from typing import Union + + +class FaxSendRequest(BaseModel): + """ + FaxSendRequest + """ # noqa: E501 + + recipient: StrictStr = Field(description="Fax Send To Recipient") + sender: Optional[StrictStr] = Field( + default=None, description="Fax Send From Sender (used only with fax number)" + ) + files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( + default=None, description="Fax File to Send" + ) + file_urls: Optional[List[StrictStr]] = Field( + default=None, description="Fax File URL to Send" + ) + test_mode: Optional[StrictBool] = Field( + default=False, description="API Test Mode Setting" + ) + cover_page_to: Optional[StrictStr] = Field( + default=None, description="Fax Cover Page for Recipient" + ) + cover_page_from: Optional[StrictStr] = Field( + default=None, description="Fax Cover Page for Sender" + ) + cover_page_message: Optional[StrictStr] = Field( + default=None, description="Fax Cover Page Message" + ) + title: Optional[StrictStr] = Field(default=None, description="Fax Title") + __properties: ClassVar[List[str]] = [ + "recipient", + "sender", + "files", + "file_urls", + "test_mode", + "cover_page_to", + "cover_page_from", + "cover_page_message", + "title", + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of FaxSendRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of FaxSendRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "recipient": obj.get("recipient"), + "sender": obj.get("sender"), + "files": obj.get("files"), + "file_urls": obj.get("file_urls"), + "test_mode": ( + obj.get("test_mode") if obj.get("test_mode") is not None else False + ), + "cover_page_to": obj.get("cover_page_to"), + "cover_page_from": obj.get("cover_page_from"), + "cover_page_message": obj.get("cover_page_message"), + "title": obj.get("title"), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "recipient": "(str,)", + "sender": "(str,)", + "files": "(List[io.IOBase],)", + "file_urls": "(List[str],)", + "test_mode": "(bool,)", + "cover_page_to": "(str,)", + "cover_page_from": "(str,)", + "cover_page_message": "(str,)", + "title": "(str,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "files", + "file_urls", + ] diff --git a/sdks/python/dropbox_sign/models/sub_file.py b/sdks/python/dropbox_sign/models/sub_file.py new file mode 100644 index 000000000..a3c21e4f7 --- /dev/null +++ b/sdks/python/dropbox_sign/models/sub_file.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + Dropbox Sign API + + Dropbox Sign v3 API + + The version of the OpenAPI document: 3.0.0 + Contact: apisupport@hellosign.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set, Tuple +from typing_extensions import Self +import io +from pydantic import StrictBool +from typing import Union + + +class SubFile(BaseModel): + """ + Actual uploaded physical file + """ # noqa: E501 + + name: Optional[StrictStr] = Field( + default="", + description="Actual physical uploaded file name that is derived during upload. Not settable parameter.", + ) + __properties: ClassVar[List[str]] = ["name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SubFile from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SubFile from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + {"name": obj.get("name") if obj.get("name") is not None else ""} + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "name": "(str,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [] diff --git a/sdks/ruby/README.md b/sdks/ruby/README.md index e8291bf2f..036e20a1c 100644 --- a/sdks/ruby/README.md +++ b/sdks/ruby/README.md @@ -121,6 +121,11 @@ All URIs are relative to *https://api.hellosign.com/v3* |*Dropbox::Sign::BulkSendJobApi* | [**bulk_send_job_list**](docs/BulkSendJobApi.md#bulk_send_job_list) | **GET** /bulk_send_job/list | List Bulk Send Jobs | |*Dropbox::Sign::EmbeddedApi* | [**embedded_edit_url**](docs/EmbeddedApi.md#embedded_edit_url) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL | |*Dropbox::Sign::EmbeddedApi* | [**embedded_sign_url**](docs/EmbeddedApi.md#embedded_sign_url) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL | +|*Dropbox::Sign::FaxApi* | [**fax_delete**](docs/FaxApi.md#fax_delete) | **DELETE** /fax/{fax_id} | Delete Fax | +|*Dropbox::Sign::FaxApi* | [**fax_files**](docs/FaxApi.md#fax_files) | **GET** /fax/files/{fax_id} | List Fax Files | +|*Dropbox::Sign::FaxApi* | [**fax_get**](docs/FaxApi.md#fax_get) | **GET** /fax/{fax_id} | Get Fax | +|*Dropbox::Sign::FaxApi* | [**fax_list**](docs/FaxApi.md#fax_list) | **GET** /fax/list | Lists Faxes | +|*Dropbox::Sign::FaxApi* | [**fax_send**](docs/FaxApi.md#fax_send) | **POST** /fax/send | Send Fax | |*Dropbox::Sign::FaxLineApi* | [**fax_line_add_user**](docs/FaxLineApi.md#fax_line_add_user) | **PUT** /fax_line/add_user | Add Fax Line User | |*Dropbox::Sign::FaxLineApi* | [**fax_line_area_code_get**](docs/FaxLineApi.md#fax_line_area_code_get) | **GET** /fax_line/area_codes | Get Available Fax Line Area Codes | |*Dropbox::Sign::FaxLineApi* | [**fax_line_create**](docs/FaxLineApi.md#fax_line_create) | **POST** /fax_line/create | Purchase Fax Line | @@ -210,6 +215,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [Dropbox::Sign::EventCallbackRequest](docs/EventCallbackRequest.md) - [Dropbox::Sign::EventCallbackRequestEvent](docs/EventCallbackRequestEvent.md) - [Dropbox::Sign::EventCallbackRequestEventMetadata](docs/EventCallbackRequestEventMetadata.md) + - [Dropbox::Sign::FaxGetResponse](docs/FaxGetResponse.md) - [Dropbox::Sign::FaxLineAddUserRequest](docs/FaxLineAddUserRequest.md) - [Dropbox::Sign::FaxLineAreaCodeGetCountryEnum](docs/FaxLineAreaCodeGetCountryEnum.md) - [Dropbox::Sign::FaxLineAreaCodeGetProvinceEnum](docs/FaxLineAreaCodeGetProvinceEnum.md) @@ -221,6 +227,10 @@ All URIs are relative to *https://api.hellosign.com/v3* - [Dropbox::Sign::FaxLineRemoveUserRequest](docs/FaxLineRemoveUserRequest.md) - [Dropbox::Sign::FaxLineResponse](docs/FaxLineResponse.md) - [Dropbox::Sign::FaxLineResponseFaxLine](docs/FaxLineResponseFaxLine.md) + - [Dropbox::Sign::FaxListResponse](docs/FaxListResponse.md) + - [Dropbox::Sign::FaxResponse](docs/FaxResponse.md) + - [Dropbox::Sign::FaxResponseTransmission](docs/FaxResponseTransmission.md) + - [Dropbox::Sign::FaxSendRequest](docs/FaxSendRequest.md) - [Dropbox::Sign::FileResponse](docs/FileResponse.md) - [Dropbox::Sign::FileResponseDataUri](docs/FileResponseDataUri.md) - [Dropbox::Sign::ListInfoResponse](docs/ListInfoResponse.md) diff --git a/sdks/ruby/docs/FaxApi.md b/sdks/ruby/docs/FaxApi.md new file mode 100644 index 000000000..23129b6d7 --- /dev/null +++ b/sdks/ruby/docs/FaxApi.md @@ -0,0 +1,364 @@ +# Dropbox::Sign::FaxApi + +All URIs are relative to *https://api.hellosign.com/v3* + +| Method | HTTP request | Description | +| ------ | ------------ | ----------- | +| [`fax_delete`](FaxApi.md#fax_delete) | **DELETE** `/fax/{fax_id}` | Delete Fax | +| [`fax_files`](FaxApi.md#fax_files) | **GET** `/fax/files/{fax_id}` | List Fax Files | +| [`fax_get`](FaxApi.md#fax_get) | **GET** `/fax/{fax_id}` | Get Fax | +| [`fax_list`](FaxApi.md#fax_list) | **GET** `/fax/list` | Lists Faxes | +| [`fax_send`](FaxApi.md#fax_send) | **POST** `/fax/send` | Send Fax | + + +## `fax_delete` + +> `fax_delete(fax_id)` + +Delete Fax + +Deletes the specified Fax from the system. + +### Examples + +```ruby +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" +end + +fax_api = Dropbox::Sign::FaxApi.new + +begin + fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling Dropbox Sign API: #{e}" +end + +``` + +#### Using the `fax_delete_with_http_info` variant + +This returns an Array which contains the response data (`nil` in this case), status code and headers. + +> ` fax_delete_with_http_info(fax_id)` + +```ruby +begin + # Delete Fax + data, status_code, headers = api_instance.fax_delete_with_http_info(fax_id) + p status_code # => 2xx + p headers # => { ... } + p data # => nil +rescue Dropbox::Sign::ApiError => e + puts "Error when calling FaxApi->fax_delete_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `fax_id` | **String** | Fax ID | | + +### Return type + +nil (empty response body) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## `fax_files` + +> `File fax_files(fax_id)` + +List Fax Files + +Returns list of fax files + +### Examples + +```ruby +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" +end + +fax_api = Dropbox::Sign::FaxApi.new + +faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + +begin + file_bin = fax_api.fax_files(data) + FileUtils.cp(file_bin.path, "path/to/file.pdf") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling Dropbox Sign API: #{e}" +end + +``` + +#### Using the `fax_files_with_http_info` variant + +This returns an Array which contains the response data, status code and headers. + +> ` fax_files_with_http_info(fax_id)` + +```ruby +begin + # List Fax Files + data, status_code, headers = api_instance.fax_files_with_http_info(fax_id) + p status_code # => 2xx + p headers # => { ... } + p data # => File +rescue Dropbox::Sign::ApiError => e + puts "Error when calling FaxApi->fax_files_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `fax_id` | **String** | Fax ID | | + +### Return type + +**File** + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/pdf, application/json + + +## `fax_get` + +> ` fax_get(fax_id)` + +Get Fax + +Returns information about fax + +### Examples + +```ruby +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" +end + +fax_api = Dropbox::Sign::FaxApi.new + +fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" + +begin + result = fax_api.fax_get(fax_id) + p result +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling Dropbox Sign API: #{e}" +end + +``` + +#### Using the `fax_get_with_http_info` variant + +This returns an Array which contains the response data, status code and headers. + +> `, Integer, Hash)> fax_get_with_http_info(fax_id)` + +```ruby +begin + # Get Fax + data, status_code, headers = api_instance.fax_get_with_http_info(fax_id) + p status_code # => 2xx + p headers # => { ... } + p data # => +rescue Dropbox::Sign::ApiError => e + puts "Error when calling FaxApi->fax_get_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `fax_id` | **String** | Fax ID | | + +### Return type + +[**FaxGetResponse**](FaxGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## `fax_list` + +> ` fax_list(opts)` + +Lists Faxes + +Returns properties of multiple faxes + +### Examples + +```ruby +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" +end + +fax_api = Dropbox::Sign::FaxApi.new + +page = 1 +page_size = 2 + +begin + result = fax_api.fax_list({ page: page, page_size: page_size }) + p result +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling Dropbox Sign API: #{e}" +end + +``` + +#### Using the `fax_list_with_http_info` variant + +This returns an Array which contains the response data, status code and headers. + +> `, Integer, Hash)> fax_list_with_http_info(opts)` + +```ruby +begin + # Lists Faxes + data, status_code, headers = api_instance.fax_list_with_http_info(opts) + p status_code # => 2xx + p headers # => { ... } + p data # => +rescue Dropbox::Sign::ApiError => e + puts "Error when calling FaxApi->fax_list_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `page` | **Integer** | Page | [optional][default to 1] | +| `page_size` | **Integer** | Page size | [optional][default to 20] | + +### Return type + +[**FaxListResponse**](FaxListResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## `fax_send` + +> ` fax_send(fax_send_request)` + +Send Fax + +Action to prepare and send a fax + +### Examples + +```ruby +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + # Configure HTTP basic authorization: api_key + config.username = "YOUR_API_KEY" +end + +fax_api = Dropbox::Sign::FaxApi.new + +data = Dropbox::Sign::FaxSendRequest.new +data.files = [File.new("example_signature_request.pdf", "r")] +data.test_mode = true +data.recipient = "16690000001" +data.sender = "16690000000" +data.cover_page_to = "Jill Fax" +data.cover_page_message = "I'm sending you a fax!" +data.cover_page_from = "Faxer Faxerson" +data.title = "This is what the fax is about!" + +begin + result = fax_api.fax_send(data) + p result +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling Dropbox Sign API: #{e}" +end + +``` + +#### Using the `fax_send_with_http_info` variant + +This returns an Array which contains the response data, status code and headers. + +> `, Integer, Hash)> fax_send_with_http_info(fax_send_request)` + +```ruby +begin + # Send Fax + data, status_code, headers = api_instance.fax_send_with_http_info(fax_send_request) + p status_code # => 2xx + p headers # => { ... } + p data # => +rescue Dropbox::Sign::ApiError => e + puts "Error when calling FaxApi->fax_send_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `fax_send_request` | [**FaxSendRequest**](FaxSendRequest.md) | | | + +### Return type + +[**FaxGetResponse**](FaxGetResponse.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + +- **Content-Type**: application/json, multipart/form-data +- **Accept**: application/json + diff --git a/sdks/ruby/docs/FaxGetResponse.md b/sdks/ruby/docs/FaxGetResponse.md new file mode 100644 index 000000000..397322654 --- /dev/null +++ b/sdks/ruby/docs/FaxGetResponse.md @@ -0,0 +1,11 @@ +# Dropbox::Sign::FaxGetResponse + + + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `fax`*_required_ | [```FaxResponse```](FaxResponse.md) | | | +| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | + diff --git a/sdks/ruby/docs/FaxListResponse.md b/sdks/ruby/docs/FaxListResponse.md new file mode 100644 index 000000000..4ad86e488 --- /dev/null +++ b/sdks/ruby/docs/FaxListResponse.md @@ -0,0 +1,11 @@ +# Dropbox::Sign::FaxListResponse + + + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `faxes`*_required_ | [```Array```](FaxResponse.md) | | | +| `list_info`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | + diff --git a/sdks/ruby/docs/FaxResponse.md b/sdks/ruby/docs/FaxResponse.md new file mode 100644 index 000000000..68c864bf3 --- /dev/null +++ b/sdks/ruby/docs/FaxResponse.md @@ -0,0 +1,19 @@ +# Dropbox::Sign::FaxResponse + + + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `fax_id`*_required_ | ```String``` | Fax ID | | +| `title`*_required_ | ```String``` | Fax Title | | +| `original_title`*_required_ | ```String``` | Fax Original Title | | +| `subject`*_required_ | ```String``` | Fax Subject | | +| `message`*_required_ | ```String``` | Fax Message | | +| `metadata`*_required_ | ```Hash``` | Fax Metadata | | +| `created_at`*_required_ | ```Integer``` | Fax Created At Timestamp | | +| `sender`*_required_ | ```String``` | Fax Sender Email | | +| `transmissions`*_required_ | [```Array```](FaxResponseTransmission.md) | Fax Transmissions List | | +| `files_url`*_required_ | ```String``` | Fax Files URL | | + diff --git a/sdks/ruby/docs/FaxResponseTransmission.md b/sdks/ruby/docs/FaxResponseTransmission.md new file mode 100644 index 000000000..5ec394694 --- /dev/null +++ b/sdks/ruby/docs/FaxResponseTransmission.md @@ -0,0 +1,13 @@ +# Dropbox::Sign::FaxResponseTransmission + + + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `recipient`*_required_ | ```String``` | Fax Transmission Recipient | | +| `sender`*_required_ | ```String``` | Fax Transmission Sender | | +| `status_code`*_required_ | ```String``` | Fax Transmission Status Code | | +| `sent_at` | ```Integer``` | Fax Transmission Sent Timestamp | | + diff --git a/sdks/ruby/docs/FaxSendRequest.md b/sdks/ruby/docs/FaxSendRequest.md new file mode 100644 index 000000000..6217af9f6 --- /dev/null +++ b/sdks/ruby/docs/FaxSendRequest.md @@ -0,0 +1,18 @@ +# Dropbox::Sign::FaxSendRequest + + + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `recipient`*_required_ | ```String``` | Fax Send To Recipient | | +| `sender` | ```String``` | Fax Send From Sender (used only with fax number) | | +| `files` | ```Array``` | Fax File to Send | | +| `file_urls` | ```Array``` | Fax File URL to Send | | +| `test_mode` | ```Boolean``` | API Test Mode Setting | [default to false] | +| `cover_page_to` | ```String``` | Fax Cover Page for Recipient | | +| `cover_page_from` | ```String``` | Fax Cover Page for Sender | | +| `cover_page_message` | ```String``` | Fax Cover Page Message | | +| `title` | ```String``` | Fax Title | | + diff --git a/sdks/ruby/lib/dropbox-sign.rb b/sdks/ruby/lib/dropbox-sign.rb index 147b296a5..0921573f8 100644 --- a/sdks/ruby/lib/dropbox-sign.rb +++ b/sdks/ruby/lib/dropbox-sign.rb @@ -51,6 +51,7 @@ require 'dropbox-sign/models/event_callback_request' require 'dropbox-sign/models/event_callback_request_event' require 'dropbox-sign/models/event_callback_request_event_metadata' +require 'dropbox-sign/models/fax_get_response' require 'dropbox-sign/models/fax_line_add_user_request' require 'dropbox-sign/models/fax_line_area_code_get_country_enum' require 'dropbox-sign/models/fax_line_area_code_get_province_enum' @@ -62,6 +63,10 @@ require 'dropbox-sign/models/fax_line_remove_user_request' require 'dropbox-sign/models/fax_line_response' require 'dropbox-sign/models/fax_line_response_fax_line' +require 'dropbox-sign/models/fax_list_response' +require 'dropbox-sign/models/fax_response' +require 'dropbox-sign/models/fax_response_transmission' +require 'dropbox-sign/models/fax_send_request' require 'dropbox-sign/models/file_response' require 'dropbox-sign/models/file_response_data_uri' require 'dropbox-sign/models/list_info_response' @@ -206,6 +211,7 @@ require 'dropbox-sign/api/api_app_api' require 'dropbox-sign/api/bulk_send_job_api' require 'dropbox-sign/api/embedded_api' +require 'dropbox-sign/api/fax_api' require 'dropbox-sign/api/fax_line_api' require 'dropbox-sign/api/o_auth_api' require 'dropbox-sign/api/report_api' diff --git a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb new file mode 100644 index 000000000..17fca7916 --- /dev/null +++ b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb @@ -0,0 +1,495 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.8.0 + +=end + +require 'cgi' + +module Dropbox +end + +module Dropbox::Sign + class FaxApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Delete Fax + # Deletes the specified Fax from the system. + # @param fax_id [String] Fax ID + # @param [Hash] opts the optional parameters + # @return [nil] + def fax_delete(fax_id, opts = {}) + fax_delete_with_http_info(fax_id, opts) + nil + end + + # Delete Fax + # Deletes the specified Fax from the system. + # @param fax_id [String] Fax ID + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def fax_delete_with_http_info(fax_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: FaxApi.fax_delete ...' + end + # verify the required parameter 'fax_id' is set + if @api_client.config.client_side_validation && fax_id.nil? + fail ArgumentError, "Missing the required parameter 'fax_id' when calling FaxApi.fax_delete" + end + # resource path + local_var_path = '/fax/{fax_id}'.sub('{' + 'fax_id' + '}', CGI.escape(fax_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + + post_body = {} + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] + + # return_type + return_type = opts[:debug_return_type] + + # auth_names + auth_names = opts[:debug_auth_names] || ['api_key'] + + new_options = opts.merge( + :operation => :"FaxApi.fax_delete", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + begin + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + rescue Dropbox::Sign::ApiError => e + end + + if @api_client.config.debugging + @api_client.config.logger.debug "API called: FaxApi#fax_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # List Fax Files + # Returns list of fax files + # @param fax_id [String] Fax ID + # @param [Hash] opts the optional parameters + # @return [File] + def fax_files(fax_id, opts = {}) + data, _status_code, _headers = fax_files_with_http_info(fax_id, opts) + data + end + + # List Fax Files + # Returns list of fax files + # @param fax_id [String] Fax ID + # @param [Hash] opts the optional parameters + # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers + def fax_files_with_http_info(fax_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: FaxApi.fax_files ...' + end + # verify the required parameter 'fax_id' is set + if @api_client.config.client_side_validation && fax_id.nil? + fail ArgumentError, "Missing the required parameter 'fax_id' when calling FaxApi.fax_files" + end + # resource path + local_var_path = '/fax/files/{fax_id}'.sub('{' + 'fax_id' + '}', CGI.escape(fax_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json']) unless header_params['Accept'] + + post_body = {} + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] + + # return_type + return_type = opts[:debug_return_type] || 'File' + + # auth_names + auth_names = opts[:debug_auth_names] || ['api_key'] + + new_options = opts.merge( + :operation => :"FaxApi.fax_files", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + begin + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + rescue Dropbox::Sign::ApiError => e + if e.code === 200 + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::File" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + range_code = "4XX".split('').first + range_code_left = "#{range_code}00".to_i + range_code_right = "#{range_code}99".to_i + if e.code >= range_code_left && e.code <= range_code_right + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + end + + if @api_client.config.debugging + @api_client.config.logger.debug "API called: FaxApi#fax_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get Fax + # Returns information about fax + # @param fax_id [String] Fax ID + # @param [Hash] opts the optional parameters + # @return [FaxGetResponse] + def fax_get(fax_id, opts = {}) + data, _status_code, _headers = fax_get_with_http_info(fax_id, opts) + data + end + + # Get Fax + # Returns information about fax + # @param fax_id [String] Fax ID + # @param [Hash] opts the optional parameters + # @return [Array<(FaxGetResponse, Integer, Hash)>] FaxGetResponse data, response status code and response headers + def fax_get_with_http_info(fax_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: FaxApi.fax_get ...' + end + # verify the required parameter 'fax_id' is set + if @api_client.config.client_side_validation && fax_id.nil? + fail ArgumentError, "Missing the required parameter 'fax_id' when calling FaxApi.fax_get" + end + # resource path + local_var_path = '/fax/{fax_id}'.sub('{' + 'fax_id' + '}', CGI.escape(fax_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + + post_body = {} + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] + + # return_type + return_type = opts[:debug_return_type] || 'FaxGetResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['api_key'] + + new_options = opts.merge( + :operation => :"FaxApi.fax_get", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + begin + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + rescue Dropbox::Sign::ApiError => e + if e.code === 200 + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::FaxGetResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + range_code = "4XX".split('').first + range_code_left = "#{range_code}00".to_i + range_code_right = "#{range_code}99".to_i + if e.code >= range_code_left && e.code <= range_code_right + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + end + + if @api_client.config.debugging + @api_client.config.logger.debug "API called: FaxApi#fax_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Lists Faxes + # Returns properties of multiple faxes + # @param [Hash] opts the optional parameters + # @option opts [Integer] :page Page (default to 1) + # @option opts [Integer] :page_size Page size (default to 20) + # @return [FaxListResponse] + def fax_list(opts = {}) + data, _status_code, _headers = fax_list_with_http_info(opts) + data + end + + # Lists Faxes + # Returns properties of multiple faxes + # @param [Hash] opts the optional parameters + # @option opts [Integer] :page Page (default to 1) + # @option opts [Integer] :page_size Page size (default to 20) + # @return [Array<(FaxListResponse, Integer, Hash)>] FaxListResponse data, response status code and response headers + def fax_list_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: FaxApi.fax_list ...' + end + if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1 + fail ArgumentError, 'invalid value for "opts[:"page"]" when calling FaxApi.fax_list, must be greater than or equal to 1.' + end + + if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100 + fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FaxApi.fax_list, must be smaller than or equal to 100.' + end + + if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1 + fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FaxApi.fax_list, must be greater than or equal to 1.' + end + + # resource path + local_var_path = '/fax/list' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? + query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + + post_body = {} + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:debug_body] + + # return_type + return_type = opts[:debug_return_type] || 'FaxListResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['api_key'] + + new_options = opts.merge( + :operation => :"FaxApi.fax_list", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + begin + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + rescue Dropbox::Sign::ApiError => e + if e.code === 200 + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::FaxListResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + range_code = "4XX".split('').first + range_code_left = "#{range_code}00".to_i + range_code_right = "#{range_code}99".to_i + if e.code >= range_code_left && e.code <= range_code_right + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + end + + if @api_client.config.debugging + @api_client.config.logger.debug "API called: FaxApi#fax_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Send Fax + # Action to prepare and send a fax + # @param fax_send_request [FaxSendRequest] + # @param [Hash] opts the optional parameters + # @return [FaxGetResponse] + def fax_send(fax_send_request, opts = {}) + data, _status_code, _headers = fax_send_with_http_info(fax_send_request, opts) + data + end + + # Send Fax + # Action to prepare and send a fax + # @param fax_send_request [FaxSendRequest] + # @param [Hash] opts the optional parameters + # @return [Array<(FaxGetResponse, Integer, Hash)>] FaxGetResponse data, response status code and response headers + def fax_send_with_http_info(fax_send_request, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: FaxApi.fax_send ...' + end + # verify the required parameter 'fax_send_request' is set + if @api_client.config.client_side_validation && fax_send_request.nil? + fail ArgumentError, "Missing the required parameter 'fax_send_request' when calling FaxApi.fax_send" + end + # resource path + local_var_path = '/fax/send' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] + # HTTP header 'Content-Type' + content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) + if !content_type.nil? + header_params['Content-Type'] = content_type + end + + post_body = {} + form_params = opts[:form_params] || {} + result = @api_client.generate_form_data( + fax_send_request, + Dropbox::Sign::FaxSendRequest.openapi_types + ) + + # form parameters + if result[:has_file] + form_params = opts[:form_params] || result[:params] + header_params['Content-Type'] = 'multipart/form-data' + else + # http body (model) + post_body = opts[:debug_body] || result[:params] + end + + # return_type + return_type = opts[:debug_return_type] || 'FaxGetResponse' + + # auth_names + auth_names = opts[:debug_auth_names] || ['api_key'] + + new_options = opts.merge( + :operation => :"FaxApi.fax_send", + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + begin + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + rescue Dropbox::Sign::ApiError => e + if e.code === 200 + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::FaxGetResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + range_code = "4XX".split('').first + range_code_left = "#{range_code}00".to_i + range_code_right = "#{range_code}99".to_i + if e.code >= range_code_left && e.code <= range_code_right + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end + + end + + if @api_client.config.debugging + @api_client.config.logger.debug "API called: FaxApi#fax_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_get_response.rb b/sdks/ruby/lib/dropbox-sign/models/fax_get_response.rb new file mode 100644 index 000000000..a774af3b6 --- /dev/null +++ b/sdks/ruby/lib/dropbox-sign/models/fax_get_response.rb @@ -0,0 +1,263 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.8.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + class FaxGetResponse + # @return [FaxResponse] + attr_accessor :fax + + # A list of warnings. + # @return [Array] + attr_accessor :warnings + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'fax' => :'fax', + :'warnings' => :'warnings' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'fax' => :'FaxResponse', + :'warnings' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [FaxGetResponse] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "FaxGetResponse" + ) || FaxGetResponse.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::FaxGetResponse` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxGetResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'fax') + self.fax = attributes[:'fax'] + end + + if attributes.key?(:'warnings') + if (value = attributes[:'warnings']).is_a?(Array) + self.warnings = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @fax.nil? + invalid_properties.push('invalid value for "fax", fax 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.nil? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + fax == o.fax && + warnings == o.warnings + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [fax, warnings].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_list_response.rb b/sdks/ruby/lib/dropbox-sign/models/fax_list_response.rb new file mode 100644 index 000000000..a06e7fe82 --- /dev/null +++ b/sdks/ruby/lib/dropbox-sign/models/fax_list_response.rb @@ -0,0 +1,267 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.8.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + class FaxListResponse + # @return [Array] + attr_accessor :faxes + + # @return [ListInfoResponse] + attr_accessor :list_info + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'faxes' => :'faxes', + :'list_info' => :'list_info' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'faxes' => :'Array', + :'list_info' => :'ListInfoResponse' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [FaxListResponse] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "FaxListResponse" + ) || FaxListResponse.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::FaxListResponse` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxListResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'faxes') + if (value = attributes[:'faxes']).is_a?(Array) + self.faxes = value + end + end + + if attributes.key?(:'list_info') + self.list_info = attributes[:'list_info'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @faxes.nil? + invalid_properties.push('invalid value for "faxes", faxes cannot be nil.') + end + + if @list_info.nil? + invalid_properties.push('invalid value for "list_info", list_info 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 @faxes.nil? + return false if @list_info.nil? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + faxes == o.faxes && + list_info == o.list_info + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [faxes, list_info].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_response.rb b/sdks/ruby/lib/dropbox-sign/models/fax_response.rb new file mode 100644 index 000000000..a7c8847bf --- /dev/null +++ b/sdks/ruby/lib/dropbox-sign/models/fax_response.rb @@ -0,0 +1,399 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.8.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + class FaxResponse + # Fax ID + # @return [String] + attr_accessor :fax_id + + # Fax Title + # @return [String] + attr_accessor :title + + # Fax Original Title + # @return [String] + attr_accessor :original_title + + # Fax Subject + # @return [String] + attr_accessor :subject + + # Fax Message + # @return [String] + attr_accessor :message + + # Fax Metadata + # @return [Hash] + attr_accessor :metadata + + # Fax Created At Timestamp + # @return [Integer] + attr_accessor :created_at + + # Fax Sender Email + # @return [String] + attr_accessor :sender + + # Fax Transmissions List + # @return [Array] + attr_accessor :transmissions + + # Fax Files URL + # @return [String] + attr_accessor :files_url + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'fax_id' => :'fax_id', + :'title' => :'title', + :'original_title' => :'original_title', + :'subject' => :'subject', + :'message' => :'message', + :'metadata' => :'metadata', + :'created_at' => :'created_at', + :'sender' => :'sender', + :'transmissions' => :'transmissions', + :'files_url' => :'files_url' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'fax_id' => :'String', + :'title' => :'String', + :'original_title' => :'String', + :'subject' => :'String', + :'message' => :'String', + :'metadata' => :'Hash', + :'created_at' => :'Integer', + :'sender' => :'String', + :'transmissions' => :'Array', + :'files_url' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [FaxResponse] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "FaxResponse" + ) || FaxResponse.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::FaxResponse` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'fax_id') + self.fax_id = attributes[:'fax_id'] + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'original_title') + self.original_title = attributes[:'original_title'] + end + + if attributes.key?(:'subject') + self.subject = attributes[:'subject'] + end + + if attributes.key?(:'message') + self.message = attributes[:'message'] + end + + if attributes.key?(:'metadata') + if (value = attributes[:'metadata']).is_a?(Hash) + self.metadata = value + end + end + + if attributes.key?(:'created_at') + self.created_at = attributes[:'created_at'] + end + + if attributes.key?(:'sender') + self.sender = attributes[:'sender'] + end + + if attributes.key?(:'transmissions') + if (value = attributes[:'transmissions']).is_a?(Array) + self.transmissions = value + end + end + + if attributes.key?(:'files_url') + self.files_url = attributes[:'files_url'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @fax_id.nil? + invalid_properties.push('invalid value for "fax_id", fax_id cannot be nil.') + end + + if @title.nil? + invalid_properties.push('invalid value for "title", title cannot be nil.') + end + + if @original_title.nil? + invalid_properties.push('invalid value for "original_title", original_title cannot be nil.') + end + + if @subject.nil? + invalid_properties.push('invalid value for "subject", subject cannot be nil.') + end + + if @message.nil? + invalid_properties.push('invalid value for "message", message cannot be nil.') + end + + if @metadata.nil? + invalid_properties.push('invalid value for "metadata", metadata cannot be nil.') + end + + if @created_at.nil? + invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') + end + + if @sender.nil? + invalid_properties.push('invalid value for "sender", sender cannot be nil.') + end + + if @transmissions.nil? + invalid_properties.push('invalid value for "transmissions", transmissions cannot be nil.') + end + + if @files_url.nil? + invalid_properties.push('invalid value for "files_url", files_url 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_id.nil? + return false if @title.nil? + return false if @original_title.nil? + return false if @subject.nil? + return false if @message.nil? + return false if @metadata.nil? + return false if @created_at.nil? + return false if @sender.nil? + return false if @transmissions.nil? + return false if @files_url.nil? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + fax_id == o.fax_id && + title == o.title && + original_title == o.original_title && + subject == o.subject && + message == o.message && + metadata == o.metadata && + created_at == o.created_at && + sender == o.sender && + transmissions == o.transmissions && + files_url == o.files_url + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [fax_id, title, original_title, subject, message, metadata, created_at, sender, transmissions, files_url].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_response_transmission.rb b/sdks/ruby/lib/dropbox-sign/models/fax_response_transmission.rb new file mode 100644 index 000000000..a6c49bb3a --- /dev/null +++ b/sdks/ruby/lib/dropbox-sign/models/fax_response_transmission.rb @@ -0,0 +1,328 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.8.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + class FaxResponseTransmission + # Fax Transmission Recipient + # @return [String] + attr_accessor :recipient + + # Fax Transmission Sender + # @return [String] + attr_accessor :sender + + # Fax Transmission Status Code + # @return [String] + attr_accessor :status_code + + # Fax Transmission Sent Timestamp + # @return [Integer] + attr_accessor :sent_at + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'recipient' => :'recipient', + :'sender' => :'sender', + :'status_code' => :'status_code', + :'sent_at' => :'sent_at' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'recipient' => :'String', + :'sender' => :'String', + :'status_code' => :'String', + :'sent_at' => :'Integer' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [FaxResponseTransmission] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "FaxResponseTransmission" + ) || FaxResponseTransmission.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::FaxResponseTransmission` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxResponseTransmission`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'recipient') + self.recipient = attributes[:'recipient'] + end + + if attributes.key?(:'sender') + self.sender = attributes[:'sender'] + end + + if attributes.key?(:'status_code') + self.status_code = attributes[:'status_code'] + end + + if attributes.key?(:'sent_at') + self.sent_at = attributes[:'sent_at'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @recipient.nil? + invalid_properties.push('invalid value for "recipient", recipient cannot be nil.') + end + + if @sender.nil? + invalid_properties.push('invalid value for "sender", sender cannot be nil.') + end + + if @status_code.nil? + invalid_properties.push('invalid value for "status_code", status_code 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 @recipient.nil? + return false if @sender.nil? + return false if @status_code.nil? + status_code_validator = EnumAttributeValidator.new('String', ["success", "transmitting", "error_could_not_fax", "error_unknown", "error_busy", "error_no_answer", "error_disconnected", "error_bad_destination"]) + return false unless status_code_validator.valid?(@status_code) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] status_code Object to be assigned + def status_code=(status_code) + validator = EnumAttributeValidator.new('String', ["success", "transmitting", "error_could_not_fax", "error_unknown", "error_busy", "error_no_answer", "error_disconnected", "error_bad_destination"]) + unless validator.valid?(status_code) + fail ArgumentError, "invalid value for \"status_code\", must be one of #{validator.allowable_values}." + end + @status_code = status_code + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + recipient == o.recipient && + sender == o.sender && + status_code == o.status_code && + sent_at == o.sent_at + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [recipient, sender, status_code, sent_at].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb new file mode 100644 index 000000000..18616cee1 --- /dev/null +++ b/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb @@ -0,0 +1,345 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.8.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + class FaxSendRequest + # Fax Send To Recipient + # @return [String] + attr_accessor :recipient + + # Fax Send From Sender (used only with fax number) + # @return [String] + attr_accessor :sender + + # Fax File to Send + # @return [Array] + attr_accessor :files + + # Fax File URL to Send + # @return [Array] + attr_accessor :file_urls + + # API Test Mode Setting + # @return [Boolean] + attr_accessor :test_mode + + # Fax Cover Page for Recipient + # @return [String] + attr_accessor :cover_page_to + + # Fax Cover Page for Sender + # @return [String] + attr_accessor :cover_page_from + + # Fax Cover Page Message + # @return [String] + attr_accessor :cover_page_message + + # Fax Title + # @return [String] + attr_accessor :title + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'recipient' => :'recipient', + :'sender' => :'sender', + :'files' => :'files', + :'file_urls' => :'file_urls', + :'test_mode' => :'test_mode', + :'cover_page_to' => :'cover_page_to', + :'cover_page_from' => :'cover_page_from', + :'cover_page_message' => :'cover_page_message', + :'title' => :'title' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'recipient' => :'String', + :'sender' => :'String', + :'files' => :'Array', + :'file_urls' => :'Array', + :'test_mode' => :'Boolean', + :'cover_page_to' => :'String', + :'cover_page_from' => :'String', + :'cover_page_message' => :'String', + :'title' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [FaxSendRequest] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "FaxSendRequest" + ) || FaxSendRequest.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::FaxSendRequest` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::FaxSendRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'recipient') + self.recipient = attributes[:'recipient'] + end + + if attributes.key?(:'sender') + self.sender = attributes[:'sender'] + end + + if attributes.key?(:'files') + if (value = attributes[:'files']).is_a?(Array) + self.files = value + end + end + + if attributes.key?(:'file_urls') + if (value = attributes[:'file_urls']).is_a?(Array) + self.file_urls = value + end + end + + if attributes.key?(:'test_mode') + self.test_mode = attributes[:'test_mode'] + else + self.test_mode = false + end + + if attributes.key?(:'cover_page_to') + self.cover_page_to = attributes[:'cover_page_to'] + end + + if attributes.key?(:'cover_page_from') + self.cover_page_from = attributes[:'cover_page_from'] + end + + if attributes.key?(:'cover_page_message') + self.cover_page_message = attributes[:'cover_page_message'] + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @recipient.nil? + invalid_properties.push('invalid value for "recipient", recipient 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 @recipient.nil? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + recipient == o.recipient && + sender == o.sender && + files == o.files && + file_urls == o.file_urls && + test_mode == o.test_mode && + cover_page_to == o.cover_page_to && + cover_page_from == o.cover_page_from && + cover_page_message == o.cover_page_message && + title == o.title + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [recipient, sender, files, file_urls, test_mode, cover_page_to, cover_page_from, cover_page_message, title].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end diff --git a/test_fixtures/FaxGetResponse.json b/test_fixtures/FaxGetResponse.json new file mode 100644 index 000000000..589271954 --- /dev/null +++ b/test_fixtures/FaxGetResponse.json @@ -0,0 +1,23 @@ +{ + "default": { + "fax": { + "fax_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d", + "title": "example title", + "original_title": "example original title", + "subject": "example subject", + "message": "example message", + "metadata": [], + "created_at": 1726774555, + "sender": "me@dropboxsign.com", + "transmissions": [ + { + "recipient": "recipient@dropboxsign.com", + "sender": "me@dropboxsign.com", + "sent_at": 1723231831, + "status_code": "success" + } + ], + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + } + } +} diff --git a/test_fixtures/FaxListResponse.json b/test_fixtures/FaxListResponse.json new file mode 100644 index 000000000..bfa69cdee --- /dev/null +++ b/test_fixtures/FaxListResponse.json @@ -0,0 +1,31 @@ +{ + "default": { + "list_info": { + "num_pages": 1, + "num_results": 1, + "page": 1, + "page_size": 1 + }, + "faxes": [ + { + "fax_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d", + "title": "example title", + "original_title": "example original title", + "subject": "example subject", + "message": "example message", + "metadata": [], + "created_at": 1726774555, + "sender": "me@dropboxsign.com", + "transmissions": [ + { + "recipient": "recipient@dropboxsign.com", + "sender": "me@dropboxsign.com", + "sent_at": 1723231831, + "status_code": "success" + } + ], + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + } + ] + } +} diff --git a/test_fixtures/FaxSendRequest.json b/test_fixtures/FaxSendRequest.json new file mode 100644 index 000000000..4c418cbe4 --- /dev/null +++ b/test_fixtures/FaxSendRequest.json @@ -0,0 +1,14 @@ +{ + "default": { + "file_url": [ + "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" + ], + "test_mode": "true", + "recipient": "16690000001", + "sender": "16690000000", + "cover_page_to": "Jill Fax", + "cover_page_message": "I'm sending you a fax!", + "cover_page_from": "Faxer Faxerson", + "title": "This is what the fax is about!" + } +} diff --git a/test_fixtures/FaxSendResponse.json b/test_fixtures/FaxSendResponse.json new file mode 100644 index 000000000..b651c7836 --- /dev/null +++ b/test_fixtures/FaxSendResponse.json @@ -0,0 +1,16 @@ +{ + "default": { + "fax": { + "fax_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d", + "title": "example title", + "original_title": "example original title", + "subject": "example subject", + "message": "example message", + "metadata": [ ], + "created_at": 1726774555, + "sender": "me@dropboxsign.com", + "transmissions": [], + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" + } + } +} diff --git a/translations/en.yaml b/translations/en.yaml index 53aa2306d..6af9701d5 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -130,6 +130,45 @@ "EmbeddedSignUrl::DESCRIPTION": Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. "EmbeddedSignUrl::SIGNATURE_ID": The id of the signature to get a signature url for. +"FaxGet::SUMMARY": Get Fax +"FaxGet::DESCRIPTION": Returns information about fax +"FaxParam::FAX_ID": Fax ID +"FaxDelete::SUMMARY": Delete Fax +"FaxDelete::DESCRIPTION": Deletes the specified Fax from the system. +"FaxFiles::SUMMARY": List Fax Files +"FaxFiles::DESCRIPTION": Returns list of fax files +"FaxList::SUMMARY": Lists Faxes +"FaxList::DESCRIPTION": Returns properties of multiple faxes +"FaxList::PAGE": Page +"FaxList::PAGE_SIZE": Page size +"FaxSend::SUMMARY": Send Fax +"FaxSend::DESCRIPTION": Action to prepare and send a fax +"FaxSend::RECIPIENT": Fax Send To Recipient +"FaxSend::SENDER": Fax Send From Sender (used only with fax number) +"FaxSend::FILE": Fax File to Send +"FaxSend::FILE_URL": Fax File URL to Send +"FaxSend::FILE_URL_NAMES": Fax File URL Names +"FaxSend::TEST_MODE": API Test Mode Setting +"FaxSend::COVER_PAGE_TO": Fax Cover Page for Recipient +"FaxSend::COVER_PAGE_FROM": Fax Cover Page for Sender +"FaxSend::COVER_PAGE_MESSAGE": Fax Cover Page Message +"FaxSend::TITLE": Fax Title +"FaxGetResponseExample::SUMMARY": Fax Response +"FaxResponse::FAX_ID": Fax ID +"FaxResponse::TITLE": Fax Title +"FaxResponse::ORIGINAL_TITLE": Fax Original Title +"FaxResponse::SUBJECT": Fax Subject +"FaxResponse::MESSAGE": Fax Message +"FaxResponse::METADATA": Fax Metadata +"FaxResponse::CREATED_AT": Fax Created At Timestamp +"FaxResponse::SENDER": Fax Sender Email +"FaxResponse::TRANSMISSIONS": Fax Transmissions List +"FaxResponse::FILES_URL": Fax Files URL +"Sub::FaxResponseTransmission::RECIPIENT": Fax Transmission Recipient +"Sub::FaxResponseTransmission::SENDER": Fax Transmission Sender +"Sub::FaxResponseTransmission::STATUS_CODE": Fax Transmission Status Code +"Sub::FaxResponseTransmission::SENT_AT": Fax Transmission Sent Timestamp +"FaxListResponseExample::SUMMARY": Returns the properties and settings of multiple Faxes. "FaxLineAddUser::SUMMARY": Add Fax Line User "FaxLineAddUser::DESCRIPTION": Grants a user access to the specified Fax Line. "FaxLineAddUser::NUMBER": The Fax Line number. @@ -1661,6 +1700,16 @@ "EmbeddedEditUrl::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a template url, click here." "EmbeddedSignUrl::SEO::TITLE": "Get Embedded Sign URL | iFrame | Dropbox Sign for Developers" "EmbeddedSignUrl::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here." +"FaxGet::SEO::TITLE": "Get Fax | API Documentation | Dropbox Fax for Developers" +"FaxGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here." +"FaxDelete::SEO::TITLE": "Delete Fax | API Documentation | Dropbox Fax for Developers" +"FaxDelete::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax, click here." +"FaxFiles::SEO::TITLE": "Fax Files | API Documentation | Dropbox Fax for Developers" +"FaxFiles::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here." +"FaxList::SEO::TITLE": "List Faxes | API Documentation | Dropbox Fax for Developers" +"FaxList::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list your faxes, click here." +"FaxSend::SEO::TITLE": "Send Fax| API Documentation | Dropbox Fax for Developers" +"FaxSend::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here." "FaxLineAddUser::SEO::TITLE": "Fax Line Add User | API Documentation | Dropbox Fax for Developers" "FaxLineAddUser::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to add a user to an existing fax line, click here." "FaxLineAreaCodeGet::SEO::TITLE": "Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers" From bdd7759daa90a6dce739f928a5b3db5c503e1552 Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Tue, 29 Oct 2024 13:52:48 -0500 Subject: [PATCH 13/16] SDK version bump (#443) --- sdks/java-v1/README.md | 8 ++++---- sdks/java-v1/VERSION | 2 +- sdks/java-v1/build.gradle | 2 +- sdks/java-v1/build.sbt | 2 +- sdks/java-v1/gradle.properties | 2 +- sdks/java-v1/openapi-config.yaml | 2 +- sdks/java-v1/pom.xml | 2 +- .../java-v1/src/main/java/com/dropbox/sign/ApiClient.java | 2 +- .../src/main/java/com/dropbox/sign/Configuration.java | 2 +- sdks/java-v2/README.md | 8 ++++---- sdks/java-v2/VERSION | 2 +- sdks/java-v2/build.gradle | 2 +- sdks/java-v2/build.sbt | 2 +- sdks/java-v2/gradle.properties | 2 +- sdks/java-v2/openapi-config.yaml | 2 +- sdks/java-v2/pom.xml | 2 +- .../java-v2/src/main/java/com/dropbox/sign/ApiClient.java | 2 +- .../src/main/java/com/dropbox/sign/Configuration.java | 2 +- sdks/node/VERSION | 2 +- sdks/node/api/apis.ts | 2 +- sdks/node/dist/api.js | 2 +- sdks/node/openapi-config.yaml | 2 +- sdks/node/package-lock.json | 4 ++-- sdks/node/package.json | 2 +- sdks/node/types/api/apis.d.ts | 2 +- sdks/php/README.md | 6 +++--- sdks/php/VERSION | 2 +- sdks/php/openapi-config.yaml | 4 ++-- sdks/php/src/Configuration.php | 4 ++-- sdks/python/README.md | 4 ++-- sdks/python/VERSION | 2 +- sdks/python/dropbox_sign/__init__.py | 2 +- sdks/python/dropbox_sign/api_client.py | 2 +- sdks/python/dropbox_sign/configuration.py | 2 +- sdks/python/openapi-config.yaml | 2 +- sdks/python/pyproject.toml | 2 +- sdks/python/setup.py | 2 +- sdks/ruby/.travis.yml | 2 +- sdks/ruby/Gemfile.lock | 2 +- sdks/ruby/README.md | 8 ++++---- sdks/ruby/VERSION | 2 +- sdks/ruby/lib/dropbox-sign/version.rb | 2 +- sdks/ruby/openapi-config.yaml | 2 +- 43 files changed, 58 insertions(+), 58 deletions(-) diff --git a/sdks/java-v1/README.md b/sdks/java-v1/README.md index 5970dc30d..84f76aaad 100644 --- a/sdks/java-v1/README.md +++ b/sdks/java-v1/README.md @@ -55,7 +55,7 @@ Add this dependency to your project's POM: com.dropbox.sign dropbox-sign - 1.6-dev + 1.7-dev compile ``` @@ -71,7 +71,7 @@ Add this dependency to your project's build file: } dependencies { - implementation "com.dropbox.sign:dropbox-sign:1.6-dev" + implementation "com.dropbox.sign:dropbox-sign:1.7-dev" } ``` @@ -85,7 +85,7 @@ mvn clean package Then manually install the following JARs: -- `target/dropbox-sign-1.6-dev.jar` +- `target/dropbox-sign-1.7-dev.jar` - `target/lib/*.jar` ## Getting Started @@ -459,7 +459,7 @@ apisupport@hellosign.com This Java package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: `3.0.0` - - Package version: `1.6-dev` + - Package version: `1.7-dev` - Build package: `org.openapitools.codegen.languages.JavaClientCodegen` diff --git a/sdks/java-v1/VERSION b/sdks/java-v1/VERSION index 78ca9a102..b19f5be06 100644 --- a/sdks/java-v1/VERSION +++ b/sdks/java-v1/VERSION @@ -1 +1 @@ -1.6-dev +1.7-dev diff --git a/sdks/java-v1/build.gradle b/sdks/java-v1/build.gradle index f4a8c1cd9..5220fbaa8 100644 --- a/sdks/java-v1/build.gradle +++ b/sdks/java-v1/build.gradle @@ -21,7 +21,7 @@ apply plugin: 'signing' group = 'com.dropbox.sign' archivesBaseName = 'dropbox-sign' -version = '1.6-dev' +version = '1.7-dev' sourceCompatibility = JavaVersion.VERSION_1_8 targetCompatibility = JavaVersion.VERSION_1_8 diff --git a/sdks/java-v1/build.sbt b/sdks/java-v1/build.sbt index 9c367c976..e942aadd8 100644 --- a/sdks/java-v1/build.sbt +++ b/sdks/java-v1/build.sbt @@ -2,7 +2,7 @@ lazy val root = (project in file(".")). settings( organization := "com.dropbox.sign", name := "dropbox-sign", - version := "1.6-dev", + version := "1.7-dev", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), Compile / javacOptions ++= Seq("-Xlint:deprecation"), diff --git a/sdks/java-v1/gradle.properties b/sdks/java-v1/gradle.properties index 7e6977b54..41513d223 100644 --- a/sdks/java-v1/gradle.properties +++ b/sdks/java-v1/gradle.properties @@ -6,7 +6,7 @@ #target = android GROUP=com.dropbox.sign POM_ARTIFACT_ID=dropbox-sign -VERSION_NAME=1.6-dev +VERSION_NAME=1.7-dev POM_NAME=Dropbox Sign Java SDK POM_DESCRIPTION=Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds! diff --git a/sdks/java-v1/openapi-config.yaml b/sdks/java-v1/openapi-config.yaml index af6dae07a..a141d49ac 100644 --- a/sdks/java-v1/openapi-config.yaml +++ b/sdks/java-v1/openapi-config.yaml @@ -16,7 +16,7 @@ additionalProperties: groupId: com.dropbox.sign artifactId: dropbox-sign artifactName: Dropbox Sign Java SDK - artifactVersion: "1.6-dev" + artifactVersion: "1.7-dev" artifactUrl: https://github.com/hellosign/dropbox-sign-java artifactDescription: Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds! scmConnection: scm:git:git://github.com/hellosign/dropbox-sign-java.git diff --git a/sdks/java-v1/pom.xml b/sdks/java-v1/pom.xml index 369f64ada..09af462cf 100644 --- a/sdks/java-v1/pom.xml +++ b/sdks/java-v1/pom.xml @@ -5,7 +5,7 @@ dropbox-sign jar dropbox-sign - 1.6-dev + 1.7-dev https://github.com/hellosign/dropbox-sign-java Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds! diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/ApiClient.java b/sdks/java-v1/src/main/java/com/dropbox/sign/ApiClient.java index 01f478efa..4496fac07 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/ApiClient.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/ApiClient.java @@ -147,7 +147,7 @@ public ApiClient(Map authMap) { this.dateFormat = new RFC3339DateFormat(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/1.6-dev/java"); + setUserAgent("OpenAPI-Generator/1.7-dev/java"); // Setup authentications (key: authentication name, value: authentication). authentications = new HashMap<>(); diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/Configuration.java b/sdks/java-v1/src/main/java/com/dropbox/sign/Configuration.java index ff638c020..db1ad9bfc 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/Configuration.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/Configuration.java @@ -16,7 +16,7 @@ value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") public class Configuration { - public static final String VERSION = "1.6-dev"; + public static final String VERSION = "1.7-dev"; private static ApiClient defaultApiClient = new ApiClient(); diff --git a/sdks/java-v2/README.md b/sdks/java-v2/README.md index 3ac47cd18..3b2e2a381 100644 --- a/sdks/java-v2/README.md +++ b/sdks/java-v2/README.md @@ -56,7 +56,7 @@ Add this dependency to your project's POM: com.dropbox.sign dropbox-sign - 2.2-dev + 2.3-dev compile ``` @@ -72,7 +72,7 @@ Add this dependency to your project's build file: } dependencies { - implementation "com.dropbox.sign:dropbox-sign:2.2-dev" + implementation "com.dropbox.sign:dropbox-sign:2.3-dev" } ``` @@ -86,7 +86,7 @@ mvn clean package Then manually install the following JARs: -- `target/dropbox-sign-2.2-dev.jar` +- `target/dropbox-sign-2.3-dev.jar` - `target/lib/*.jar` ## Getting Started @@ -435,7 +435,7 @@ apisupport@hellosign.com This Java package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: `3.0.0` - - Package version: `2.2-dev` + - Package version: `2.3-dev` - Build package: `org.openapitools.codegen.languages.JavaClientCodegen` diff --git a/sdks/java-v2/VERSION b/sdks/java-v2/VERSION index c78c4fff9..69c49c721 100644 --- a/sdks/java-v2/VERSION +++ b/sdks/java-v2/VERSION @@ -1 +1 @@ -2.2-dev +2.3-dev diff --git a/sdks/java-v2/build.gradle b/sdks/java-v2/build.gradle index 9c1bda425..bc7251f00 100644 --- a/sdks/java-v2/build.gradle +++ b/sdks/java-v2/build.gradle @@ -21,7 +21,7 @@ apply plugin: 'signing' group = 'com.dropbox.sign' archivesBaseName = 'dropbox-sign' -version = '2.2-dev' +version = '2.3-dev' sourceCompatibility = JavaVersion.VERSION_1_8 targetCompatibility = JavaVersion.VERSION_1_8 diff --git a/sdks/java-v2/build.sbt b/sdks/java-v2/build.sbt index 180a4e618..cd67930d6 100644 --- a/sdks/java-v2/build.sbt +++ b/sdks/java-v2/build.sbt @@ -2,7 +2,7 @@ lazy val root = (project in file(".")). settings( organization := "com.dropbox.sign", name := "dropbox-sign", - version := "2.2-dev", + version := "2.3-dev", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), Compile / javacOptions ++= Seq("-Xlint:deprecation"), diff --git a/sdks/java-v2/gradle.properties b/sdks/java-v2/gradle.properties index 27fa3e3af..d0446faf1 100644 --- a/sdks/java-v2/gradle.properties +++ b/sdks/java-v2/gradle.properties @@ -6,7 +6,7 @@ #target = android GROUP=com.dropbox.sign POM_ARTIFACT_ID=dropbox-sign -VERSION_NAME=2.2-dev +VERSION_NAME=2.3-dev POM_NAME=Dropbox Sign Java SDK POM_DESCRIPTION=Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds! diff --git a/sdks/java-v2/openapi-config.yaml b/sdks/java-v2/openapi-config.yaml index a6d9cf26c..a48d05cd1 100644 --- a/sdks/java-v2/openapi-config.yaml +++ b/sdks/java-v2/openapi-config.yaml @@ -18,7 +18,7 @@ additionalProperties: groupId: com.dropbox.sign artifactId: dropbox-sign artifactName: Dropbox Sign Java SDK - artifactVersion: "2.2-dev" + artifactVersion: "2.3-dev" artifactUrl: https://github.com/hellosign/dropbox-sign-java artifactDescription: Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds! scmConnection: scm:git:git://github.com/hellosign/dropbox-sign-java.git diff --git a/sdks/java-v2/pom.xml b/sdks/java-v2/pom.xml index bea89462f..9979d4d6e 100644 --- a/sdks/java-v2/pom.xml +++ b/sdks/java-v2/pom.xml @@ -5,7 +5,7 @@ dropbox-sign jar dropbox-sign - 2.2-dev + 2.3-dev https://github.com/hellosign/dropbox-sign-java Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds! diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/ApiClient.java b/sdks/java-v2/src/main/java/com/dropbox/sign/ApiClient.java index 2e78822f3..43e0fb0d3 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/ApiClient.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/ApiClient.java @@ -159,7 +159,7 @@ public ApiClient(Map authMap) { this.dateFormat = new RFC3339DateFormat(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/2.2-dev/java"); + setUserAgent("OpenAPI-Generator/2.3-dev/java"); // Setup authentications (key: authentication name, value: authentication). authentications = new HashMap<>(); diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/Configuration.java b/sdks/java-v2/src/main/java/com/dropbox/sign/Configuration.java index 78b62840f..520358e53 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/Configuration.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/Configuration.java @@ -15,7 +15,7 @@ @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") public class Configuration { - public static final String VERSION = "2.2-dev"; + public static final String VERSION = "2.3-dev"; private static ApiClient defaultApiClient = new ApiClient(); diff --git a/sdks/node/VERSION b/sdks/node/VERSION index 78ca9a102..b19f5be06 100644 --- a/sdks/node/VERSION +++ b/sdks/node/VERSION @@ -1 +1 @@ -1.6-dev +1.7-dev diff --git a/sdks/node/api/apis.ts b/sdks/node/api/apis.ts index 5059bbea6..9cbae1aed 100644 --- a/sdks/node/api/apis.ts +++ b/sdks/node/api/apis.ts @@ -38,7 +38,7 @@ export const queryParamsSerializer = (params) => { return Qs.stringify(params, { arrayFormat: "brackets" }); }; -export const USER_AGENT = "OpenAPI-Generator/1.6-dev/node"; +export const USER_AGENT = "OpenAPI-Generator/1.7-dev/node"; /** * Generates an object containing form data. diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 43069c7ca..0472da342 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -33224,7 +33224,7 @@ var HttpError = class extends Error { var queryParamsSerializer = (params) => { return import_qs.default.stringify(params, { arrayFormat: "brackets" }); }; -var USER_AGENT = "OpenAPI-Generator/1.6-dev/node"; +var USER_AGENT = "OpenAPI-Generator/1.7-dev/node"; var generateFormData = (obj, typemap) => { const data = {}; let localVarUseFormData = false; diff --git a/sdks/node/openapi-config.yaml b/sdks/node/openapi-config.yaml index a2a896d93..96b59f548 100644 --- a/sdks/node/openapi-config.yaml +++ b/sdks/node/openapi-config.yaml @@ -2,7 +2,7 @@ generatorName: typescript-node typeMappings: {} additionalProperties: npmName: "@dropbox/sign" - npmVersion: 1.6-dev + npmVersion: 1.7-dev supportsES6: true apiDocPath: ./docs/api modelDocPath: ./docs/model diff --git a/sdks/node/package-lock.json b/sdks/node/package-lock.json index 6596183a2..b39abe1d3 100644 --- a/sdks/node/package-lock.json +++ b/sdks/node/package-lock.json @@ -1,12 +1,12 @@ { "name": "@dropbox/sign", - "version": "1.6-dev", + "version": "1.7-dev", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@dropbox/sign", - "version": "1.6-dev", + "version": "1.7-dev", "dependencies": { "axios": "^1.7.0", "bluebird": "^3.7.2", diff --git a/sdks/node/package.json b/sdks/node/package.json index 2468838c0..36bde1ba6 100644 --- a/sdks/node/package.json +++ b/sdks/node/package.json @@ -1,6 +1,6 @@ { "name": "@dropbox/sign", - "version": "1.6-dev", + "version": "1.7-dev", "description": "Official Node client for Dropbox Sign", "repository": { "type": "git", diff --git a/sdks/node/types/api/apis.d.ts b/sdks/node/types/api/apis.d.ts index 8530ae249..032a26ad8 100644 --- a/sdks/node/types/api/apis.d.ts +++ b/sdks/node/types/api/apis.d.ts @@ -23,7 +23,7 @@ export interface returnTypeI { body?: any; } export declare const queryParamsSerializer: (params: any) => string; -export declare const USER_AGENT = "OpenAPI-Generator/1.6-dev/node"; +export declare const USER_AGENT = "OpenAPI-Generator/1.7-dev/node"; export declare const generateFormData: (obj: any, typemap: AttributeTypeMap) => { localVarUseFormData: boolean; data: object; diff --git a/sdks/php/README.md b/sdks/php/README.md index c07ea3300..a37c54fe5 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -53,7 +53,7 @@ To install the bindings via [Composer](https://getcomposer.org/), add the follow ```json { "require": { - "dropbox/sign": "^1.3.0" + "dropbox/sign": "^1.7.0" }, "minimum-stability": "dev" } @@ -64,7 +64,7 @@ Then run `composer install` Alternatively, install directly with ``` -composer require dropbox/sign:^1.3.0 +composer require dropbox/sign:^1.7.0 ``` ## Getting Started @@ -439,6 +439,6 @@ apisupport@hellosign.com This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: `3.0.0` - - Package version: `1.6-dev` + - Package version: `1.7-dev` - Generator version: `7.8.0` - Build package: `org.openapitools.codegen.languages.PhpClientCodegen` diff --git a/sdks/php/VERSION b/sdks/php/VERSION index 78ca9a102..b19f5be06 100644 --- a/sdks/php/VERSION +++ b/sdks/php/VERSION @@ -1 +1 @@ -1.6-dev +1.7-dev diff --git a/sdks/php/openapi-config.yaml b/sdks/php/openapi-config.yaml index b7a3b76d5..a86f11b5b 100644 --- a/sdks/php/openapi-config.yaml +++ b/sdks/php/openapi-config.yaml @@ -3,8 +3,8 @@ typeMappings: "object": "array" additionalProperties: packageName: dropbox/sign - packageVersion: "^1.3.0" - artifactVersion: 1.6-dev + packageVersion: "^1.7.0" + artifactVersion: 1.7-dev invokerPackage: "Dropbox\\Sign" sortModelPropertiesByRequiredFlag: true srcBasePath: src diff --git a/sdks/php/src/Configuration.php b/sdks/php/src/Configuration.php index 8d4d1a042..50242d164 100644 --- a/sdks/php/src/Configuration.php +++ b/sdks/php/src/Configuration.php @@ -97,7 +97,7 @@ class Configuration * * @var string */ - protected $userAgent = 'OpenAPI-Generator/1.6-dev/PHP'; + protected $userAgent = 'OpenAPI-Generator/1.7-dev/PHP'; /** * Debug switch (default set to false) @@ -438,7 +438,7 @@ public static function toDebugReport() $report .= ' OS: ' . php_uname() . PHP_EOL; $report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL; $report .= ' The version of the OpenAPI document: 3.0.0' . PHP_EOL; - $report .= ' SDK Package Version: 1.6-dev' . PHP_EOL; + $report .= ' SDK Package Version: 1.7-dev' . PHP_EOL; $report .= ' Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL; return $report; diff --git a/sdks/python/README.md b/sdks/python/README.md index c8c415603..796399702 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -49,7 +49,7 @@ Python 3.7+ Install using `pip`: ```shell -python3 -m pip install dropbox-sign==1.6-dev +python3 -m pip install dropbox-sign==1.7-dev ``` Alternatively: @@ -391,6 +391,6 @@ apisupport@hellosign.com This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 3.0.0 -- Package version: 1.6-dev +- Package version: 1.7-dev - Build package: org.openapitools.codegen.languages.PythonClientCodegen diff --git a/sdks/python/VERSION b/sdks/python/VERSION index 78ca9a102..b19f5be06 100644 --- a/sdks/python/VERSION +++ b/sdks/python/VERSION @@ -1 +1 @@ -1.6-dev +1.7-dev diff --git a/sdks/python/dropbox_sign/__init__.py b/sdks/python/dropbox_sign/__init__.py index c37a24fc1..a8df7f94f 100644 --- a/sdks/python/dropbox_sign/__init__.py +++ b/sdks/python/dropbox_sign/__init__.py @@ -15,7 +15,7 @@ """ # noqa: E501 -__version__ = "1.6-dev" +__version__ = "1.7-dev" # import apis into sdk package from dropbox_sign.apis import * diff --git a/sdks/python/dropbox_sign/api_client.py b/sdks/python/dropbox_sign/api_client.py index 3442861b9..386ef4d5b 100644 --- a/sdks/python/dropbox_sign/api_client.py +++ b/sdks/python/dropbox_sign/api_client.py @@ -89,7 +89,7 @@ def __init__( self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = "OpenAPI-Generator/1.6-dev/python" + self.user_agent = "OpenAPI-Generator/1.7-dev/python" self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/sdks/python/dropbox_sign/configuration.py b/sdks/python/dropbox_sign/configuration.py index 9e397bd27..b939da41d 100644 --- a/sdks/python/dropbox_sign/configuration.py +++ b/sdks/python/dropbox_sign/configuration.py @@ -432,7 +432,7 @@ def to_debug_report(self): "OS: {env}\n" "Python Version: {pyversion}\n" "Version of the API: 3.0.0\n" - "SDK Version: 1.6-dev".format(env=sys.platform, pyversion=sys.version) + "SDK Version: 1.7-dev".format(env=sys.platform, pyversion=sys.version) ) def get_host_settings(self): diff --git a/sdks/python/openapi-config.yaml b/sdks/python/openapi-config.yaml index 0738ddb9e..ca79487c8 100644 --- a/sdks/python/openapi-config.yaml +++ b/sdks/python/openapi-config.yaml @@ -5,7 +5,7 @@ additionalProperties: generatorLanguageVersion: ">=3.7" packageName: dropbox_sign projectName: dropbox-sign - packageVersion: 1.6-dev + packageVersion: 1.7-dev sortModelPropertiesByRequiredFlag: true legacyDiscriminatorBehavior: true packageAuthor: Dropbox Sign API Team diff --git a/sdks/python/pyproject.toml b/sdks/python/pyproject.toml index 6eefc3900..3a3145a89 100644 --- a/sdks/python/pyproject.toml +++ b/sdks/python/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "dropbox_sign" -version = "1.6-dev" +version = "1.7-dev" description = "Dropbox Sign API" authors = ["Official Python SDK for the Dropbox Sign API "] license = "MIT" diff --git a/sdks/python/setup.py b/sdks/python/setup.py index 7d3d8d385..7c18a50dd 100644 --- a/sdks/python/setup.py +++ b/sdks/python/setup.py @@ -23,7 +23,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "dropbox-sign" -VERSION = "1.6-dev" +VERSION = "1.7-dev" PYTHON_REQUIRES = ">=3.7" REQUIRES = [ "urllib3 >= 1.25.3, < 2.1.0", diff --git a/sdks/ruby/.travis.yml b/sdks/ruby/.travis.yml index 5dac9b73b..f37177039 100644 --- a/sdks/ruby/.travis.yml +++ b/sdks/ruby/.travis.yml @@ -8,4 +8,4 @@ script: - bundle install --path vendor/bundle - bundle exec rspec - gem build dropbox-sign.gemspec - - gem install ./dropbox-sign-1.6-dev.gem + - gem install ./dropbox-sign-1.7-dev.gem diff --git a/sdks/ruby/Gemfile.lock b/sdks/ruby/Gemfile.lock index c8b87fcd6..72b58ee60 100644 --- a/sdks/ruby/Gemfile.lock +++ b/sdks/ruby/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - dropbox-sign (1.6.pre.dev) + dropbox-sign (1.7.pre.dev) typhoeus (~> 1.0, >= 1.0.1) GEM diff --git a/sdks/ruby/README.md b/sdks/ruby/README.md index 036e20a1c..e93c857b9 100644 --- a/sdks/ruby/README.md +++ b/sdks/ruby/README.md @@ -25,7 +25,7 @@ directory that corresponds to the file you want updated. This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 3.0.0 -- Package version: 1.6-dev +- Package version: 1.7-dev - Generator version: 7.8.0 - Build package: org.openapitools.codegen.languages.RubyClientCodegen @@ -47,15 +47,15 @@ gem build dropbox-sign.gemspec Then install the gem locally: ```shell -gem install ./dropbox-sign-1.6-dev.gem +gem install ./dropbox-sign-1.7-dev.gem ``` -(for development, run `gem install --dev ./dropbox-sign-1.6-dev.gem` to install the development dependencies) +(for development, run `gem install --dev ./dropbox-sign-1.7-dev.gem` to install the development dependencies) Finally add this to the Gemfile: - gem 'dropbox-sign', '~> 1.6-dev' + gem 'dropbox-sign', '~> 1.7-dev' ### Install from Git diff --git a/sdks/ruby/VERSION b/sdks/ruby/VERSION index 78ca9a102..b19f5be06 100644 --- a/sdks/ruby/VERSION +++ b/sdks/ruby/VERSION @@ -1 +1 @@ -1.6-dev +1.7-dev diff --git a/sdks/ruby/lib/dropbox-sign/version.rb b/sdks/ruby/lib/dropbox-sign/version.rb index af126e37a..5b0f2adc3 100644 --- a/sdks/ruby/lib/dropbox-sign/version.rb +++ b/sdks/ruby/lib/dropbox-sign/version.rb @@ -14,5 +14,5 @@ module Dropbox end module Dropbox::Sign - VERSION = '1.6-dev' + VERSION = '1.7-dev' end diff --git a/sdks/ruby/openapi-config.yaml b/sdks/ruby/openapi-config.yaml index 21dcabc97..accddfcdb 100644 --- a/sdks/ruby/openapi-config.yaml +++ b/sdks/ruby/openapi-config.yaml @@ -9,7 +9,7 @@ additionalProperties: gemName: dropbox-sign gemRequiredRubyVersion: '>= 2.7' moduleName: "Dropbox::Sign" - gemVersion: 1.6-dev + gemVersion: 1.7-dev sortModelPropertiesByRequiredFlag: true legacyDiscriminatorBehavior: true gitUserId: hellosign From 025413289f4be979ec4e55465e7f924c5947bd83 Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Tue, 29 Oct 2024 14:04:28 -0500 Subject: [PATCH 14/16] AccountResponse AccountQuotas remove default values (#445) --- openapi-raw.yaml | 6 --- openapi-sdk.yaml | 6 --- openapi.yaml | 6 --- sdks/dotnet/docs/AccountResponseQuotas.md | 2 +- .../Model/AccountResponseQuotas.cs | 32 +++++-------- .../sign/model/AccountResponseQuotas.java | 12 ++--- .../sign/model/AccountResponseQuotas.java | 12 ++--- sdks/node/dist/api.js | 8 ---- sdks/node/docs/model/AccountResponseQuotas.md | 12 ++--- sdks/node/model/accountResponseQuotas.ts | 12 ++--- sdks/php/docs/Model/AccountResponseQuotas.md | 12 ++--- sdks/php/src/Model/AccountResponseQuotas.php | 12 ++--- sdks/python/docs/AccountResponseQuotas.md | 12 ++--- .../models/account_response_quotas.py | 48 +++++-------------- sdks/ruby/docs/AccountResponseQuotas.md | 12 ++--- .../models/account_response_quotas.rb | 12 ----- 16 files changed, 74 insertions(+), 142 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 55a0a1dfb..a99c6c809 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -10388,32 +10388,26 @@ 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 diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 93ba10ed3..2dd05ea98 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -10996,32 +10996,26 @@ components: api_signature_requests_left: description: 'API signature requests remaining.' type: integer - default: 0 nullable: true documents_left: description: 'Signature requests remaining.' type: integer - default: 0 nullable: true templates_total: description: 'Total API templates allowed.' type: integer - default: 0 nullable: true templates_left: description: 'API templates remaining.' type: integer - default: 0 nullable: true sms_verifications_left: description: 'SMS verifications remaining.' type: integer - default: 0 nullable: true num_fax_pages_left: description: 'Number of fax pages left' type: integer - default: 0 nullable: true type: object x-internal-class: true diff --git a/openapi.yaml b/openapi.yaml index cf83c56af..4bc57f3d1 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -10974,32 +10974,26 @@ components: api_signature_requests_left: description: 'API signature requests remaining.' type: integer - default: 0 nullable: true documents_left: description: 'Signature requests remaining.' type: integer - default: 0 nullable: true templates_total: description: 'Total API templates allowed.' type: integer - default: 0 nullable: true templates_left: description: 'API templates remaining.' type: integer - default: 0 nullable: true sms_verifications_left: description: 'SMS verifications remaining.' type: integer - default: 0 nullable: true num_fax_pages_left: description: 'Number of fax pages left' type: integer - default: 0 nullable: true type: object x-internal-class: true diff --git a/sdks/dotnet/docs/AccountResponseQuotas.md b/sdks/dotnet/docs/AccountResponseQuotas.md index ca716dbff..8fc9dcf9b 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] [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] +**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] [[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 8140337a2..b97d73c8e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs @@ -41,27 +41,21 @@ protected AccountResponseQuotas() { } /// /// Initializes a new instance of the class. /// - /// API signature requests remaining. (default to 0). - /// Signature requests remaining. (default to 0). - /// Total API templates allowed. (default to 0). - /// API templates remaining. (default to 0). - /// SMS verifications remaining. (default to 0). - /// Number of fax pages left (default to 0). - public AccountResponseQuotas(int? apiSignatureRequestsLeft = 0, int? documentsLeft = 0, int? templatesTotal = 0, int? templatesLeft = 0, int? smsVerificationsLeft = 0, int? numFaxPagesLeft = 0) + /// API signature requests remaining.. + /// Signature requests remaining.. + /// Total API templates allowed.. + /// API templates remaining.. + /// SMS verifications remaining.. + /// Number of fax pages left. + public AccountResponseQuotas(int? apiSignatureRequestsLeft = default(int?), int? documentsLeft = default(int?), int? templatesTotal = default(int?), int? templatesLeft = default(int?), int? smsVerificationsLeft = default(int?), int? numFaxPagesLeft = default(int?)) { - // 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; + this.ApiSignatureRequestsLeft = apiSignatureRequestsLeft; + this.DocumentsLeft = documentsLeft; + this.TemplatesTotal = templatesTotal; + this.TemplatesLeft = templatesLeft; + this.SmsVerificationsLeft = smsVerificationsLeft; + this.NumFaxPagesLeft = numFaxPagesLeft; } /// 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 bc47dc564..584917ff9 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 = 0; + private Integer apiSignatureRequestsLeft; public static final String JSON_PROPERTY_DOCUMENTS_LEFT = "documents_left"; - private Integer documentsLeft = 0; + private Integer documentsLeft; public static final String JSON_PROPERTY_TEMPLATES_TOTAL = "templates_total"; - private Integer templatesTotal = 0; + private Integer templatesTotal; public static final String JSON_PROPERTY_TEMPLATES_LEFT = "templates_left"; - private Integer templatesLeft = 0; + private Integer templatesLeft; public static final String JSON_PROPERTY_SMS_VERIFICATIONS_LEFT = "sms_verifications_left"; - private Integer smsVerificationsLeft = 0; + private Integer smsVerificationsLeft; public static final String JSON_PROPERTY_NUM_FAX_PAGES_LEFT = "num_fax_pages_left"; - private Integer numFaxPagesLeft = 0; + private Integer numFaxPagesLeft; public AccountResponseQuotas() {} 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 fd725681d..f8a7b6c2d 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 = 0; + private Integer apiSignatureRequestsLeft; public static final String JSON_PROPERTY_DOCUMENTS_LEFT = "documents_left"; - private Integer documentsLeft = 0; + private Integer documentsLeft; public static final String JSON_PROPERTY_TEMPLATES_TOTAL = "templates_total"; - private Integer templatesTotal = 0; + private Integer templatesTotal; public static final String JSON_PROPERTY_TEMPLATES_LEFT = "templates_left"; - private Integer templatesLeft = 0; + private Integer templatesLeft; public static final String JSON_PROPERTY_SMS_VERIFICATIONS_LEFT = "sms_verifications_left"; - private Integer smsVerificationsLeft = 0; + private Integer smsVerificationsLeft; public static final String JSON_PROPERTY_NUM_FAX_PAGES_LEFT = "num_fax_pages_left"; - private Integer numFaxPagesLeft = 0; + private Integer numFaxPagesLeft; public AccountResponseQuotas() { } diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 0472da342..d06b3bae1 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -16524,14 +16524,6 @@ 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; } diff --git a/sdks/node/docs/model/AccountResponseQuotas.md b/sdks/node/docs/model/AccountResponseQuotas.md index 7d6188988..bc02d3242 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. | [default to 0] | -| `documentsLeft` | ```number``` | Signature requests remaining. | [default to 0] | -| `templatesTotal` | ```number``` | Total API templates allowed. | [default to 0] | -| `templatesLeft` | ```number``` | API templates remaining. | [default to 0] | -| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | [default to 0] | -| `numFaxPagesLeft` | ```number``` | Number of fax pages left | [default to 0] | +| `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 | | [[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 e1efe123f..5bc605e4f 100644 --- a/sdks/node/model/accountResponseQuotas.ts +++ b/sdks/node/model/accountResponseQuotas.ts @@ -31,27 +31,27 @@ export class AccountResponseQuotas { /** * API signature requests remaining. */ - "apiSignatureRequestsLeft"?: number | null = 0; + "apiSignatureRequestsLeft"?: number | null; /** * Signature requests remaining. */ - "documentsLeft"?: number | null = 0; + "documentsLeft"?: number | null; /** * Total API templates allowed. */ - "templatesTotal"?: number | null = 0; + "templatesTotal"?: number | null; /** * API templates remaining. */ - "templatesLeft"?: number | null = 0; + "templatesLeft"?: number | null; /** * SMS verifications remaining. */ - "smsVerificationsLeft"?: number | null = 0; + "smsVerificationsLeft"?: number | null; /** * Number of fax pages left */ - "numFaxPagesLeft"?: number | null = 0; + "numFaxPagesLeft"?: number | null; static discriminator: string | undefined = undefined; diff --git a/sdks/php/docs/Model/AccountResponseQuotas.md b/sdks/php/docs/Model/AccountResponseQuotas.md index cd9d40a48..96399403d 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. | [default to 0] | -| `documents_left` | ```int``` | Signature requests remaining. | [default to 0] | -| `templates_total` | ```int``` | Total API templates allowed. | [default to 0] | -| `templates_left` | ```int``` | API templates remaining. | [default to 0] | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | [default to 0] | -| `num_fax_pages_left` | ```int``` | Number of fax pages left | [default to 0] | +| `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 | | [[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 98fb55ed0..85d004055 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 ?? [], 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); + $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); } /** diff --git a/sdks/python/docs/AccountResponseQuotas.md b/sdks/python/docs/AccountResponseQuotas.md index ab1b36dc0..189447310 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. | [default to 0] | -| `documents_left` | ```int``` | Signature requests remaining. | [default to 0] | -| `templates_total` | ```int``` | Total API templates allowed. | [default to 0] | -| `templates_left` | ```int``` | API templates remaining. | [default to 0] | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | [default to 0] | -| `num_fax_pages_left` | ```int``` | Number of fax pages left | [default to 0] | +| `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 | | [[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 c39cc3889..a58444549 100644 --- a/sdks/python/dropbox_sign/models/account_response_quotas.py +++ b/sdks/python/dropbox_sign/models/account_response_quotas.py @@ -33,22 +33,22 @@ class AccountResponseQuotas(BaseModel): """ # noqa: E501 api_signature_requests_left: Optional[StrictInt] = Field( - default=0, description="API signature requests remaining." + default=None, description="API signature requests remaining." ) documents_left: Optional[StrictInt] = Field( - default=0, description="Signature requests remaining." + default=None, description="Signature requests remaining." ) templates_total: Optional[StrictInt] = Field( - default=0, description="Total API templates allowed." + default=None, description="Total API templates allowed." ) templates_left: Optional[StrictInt] = Field( - default=0, description="API templates remaining." + default=None, description="API templates remaining." ) sms_verifications_left: Optional[StrictInt] = Field( - default=0, description="SMS verifications remaining." + default=None, description="SMS verifications remaining." ) num_fax_pages_left: Optional[StrictInt] = Field( - default=0, description="Number of fax pages left" + default=None, description="Number of fax pages left" ) __properties: ClassVar[List[str]] = [ "api_signature_requests_left", @@ -122,36 +122,12 @@ 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") - 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 - ), + "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"), } ) return _obj diff --git a/sdks/ruby/docs/AccountResponseQuotas.md b/sdks/ruby/docs/AccountResponseQuotas.md index d50615615..2b96ba96b 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. | [default to 0] | -| `documents_left` | ```Integer``` | Signature requests remaining. | [default to 0] | -| `templates_total` | ```Integer``` | Total API templates allowed. | [default to 0] | -| `templates_left` | ```Integer``` | API templates remaining. | [default to 0] | -| `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | [default to 0] | -| `num_fax_pages_left` | ```Integer``` | Number of fax pages left | [default to 0] | +| `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 | | 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 d202a1c1b..fd718d612 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb @@ -126,38 +126,26 @@ 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 From 55faeedfd3735641cb748f31a40b04deee8b10e7 Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Tue, 29 Oct 2024 14:12:45 -0500 Subject: [PATCH 15/16] AccountResponse AccountResponseUsage remove default values (#446) --- openapi-raw.yaml | 2 +- openapi-sdk.yaml | 2 +- openapi.yaml | 2 +- sdks/dotnet/docs/AccountResponseUsage.md | 2 +- .../Dropbox.Sign/Model/AccountResponseUsage.cs | 16 ++++++++++------ .../dropbox/sign/model/AccountResponseUsage.java | 2 +- .../dropbox/sign/model/AccountResponseUsage.java | 2 +- sdks/node/dist/api.js | 3 --- sdks/node/docs/model/AccountResponseUsage.md | 2 +- sdks/node/model/accountResponseUsage.ts | 2 +- sdks/node/types/model/accountResponseUsage.d.ts | 2 +- sdks/php/docs/Model/AccountResponseUsage.md | 2 +- sdks/php/src/Model/AccountResponseUsage.php | 14 ++++++++++---- sdks/python/docs/AccountResponseUsage.md | 2 +- .../models/account_response_usage.py | 12 ++---------- sdks/ruby/docs/AccountResponseUsage.md | 2 +- .../models/account_response_usage.rb | 5 ++--- 17 files changed, 36 insertions(+), 38 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index a99c6c809..4920f55a7 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -10417,7 +10417,7 @@ components: fax_pages_sent: description: '_t__AccountUsage::FAX_PAGES_SENT' type: integer - default: 0 + nullable: true type: object x-internal-class: true AccountVerifyResponseAccount: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 2dd05ea98..fe81aca41 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -11025,7 +11025,7 @@ components: fax_pages_sent: description: 'Number of fax pages sent' type: integer - default: 0 + nullable: true type: object x-internal-class: true AccountVerifyResponseAccount: diff --git a/openapi.yaml b/openapi.yaml index 4bc57f3d1..e49cd747a 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -11003,7 +11003,7 @@ components: fax_pages_sent: description: 'Number of fax pages sent' type: integer - default: 0 + nullable: true type: object x-internal-class: true AccountVerifyResponseAccount: diff --git a/sdks/dotnet/docs/AccountResponseUsage.md b/sdks/dotnet/docs/AccountResponseUsage.md index 27e541f8f..fa5536881 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] [default to 0] +**FaxPagesSent** | **int?** | Number of fax pages sent | [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/src/Dropbox.Sign/Model/AccountResponseUsage.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs index dd51fdcb5..bd9e2e5ac 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 (default to 0). - public AccountResponseUsage(int faxPagesSent = 0) + /// Number of fax pages sent. + public AccountResponseUsage(int? faxPagesSent = default(int?)) { this.FaxPagesSent = faxPagesSent; @@ -69,7 +69,7 @@ public static AccountResponseUsage Init(string jsonData) /// /// Number of fax pages sent [DataMember(Name = "fax_pages_sent", EmitDefaultValue = true)] - public int FaxPagesSent { get; set; } + public int? FaxPagesSent { get; set; } /// /// Returns the string presentation of the object @@ -117,7 +117,8 @@ public bool Equals(AccountResponseUsage input) return ( this.FaxPagesSent == input.FaxPagesSent || - this.FaxPagesSent.Equals(input.FaxPagesSent) + (this.FaxPagesSent != null && + this.FaxPagesSent.Equals(input.FaxPagesSent)) ); } @@ -130,7 +131,10 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; - hashCode = (hashCode * 59) + this.FaxPagesSent.GetHashCode(); + if (this.FaxPagesSent != null) + { + hashCode = (hashCode * 59) + this.FaxPagesSent.GetHashCode(); + } return hashCode; } } @@ -151,7 +155,7 @@ public List GetOpenApiTypes() { Name = "fax_pages_sent", Property = "FaxPagesSent", - Type = "int", + Type = "int?", Value = FaxPagesSent, }); 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 c45fe4ce2..daac05931 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 = 0; + private Integer faxPagesSent; public AccountResponseUsage() {} 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 34dc9f8c0..741d5e58c 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 = 0; + private Integer faxPagesSent; public AccountResponseUsage() { } diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index d06b3bae1..e92bff233 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -16568,9 +16568,6 @@ AccountResponseQuotas.attributeTypeMap = [ // model/accountResponseUsage.ts var _AccountResponseUsage = class { - constructor() { - this["faxPagesSent"] = 0; - } static getAttributeTypeMap() { return _AccountResponseUsage.attributeTypeMap; } diff --git a/sdks/node/docs/model/AccountResponseUsage.md b/sdks/node/docs/model/AccountResponseUsage.md index 0591e3c98..2f095fba9 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 | [default to 0] | +| `faxPagesSent` | ```number``` | Number of fax pages sent | | [[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/accountResponseUsage.ts b/sdks/node/model/accountResponseUsage.ts index ce2d969c0..95f6f9f88 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 | null; static discriminator: string | undefined = undefined; diff --git a/sdks/node/types/model/accountResponseUsage.d.ts b/sdks/node/types/model/accountResponseUsage.d.ts index 0b520ac76..7506ca0ee 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 | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/php/docs/Model/AccountResponseUsage.md b/sdks/php/docs/Model/AccountResponseUsage.md index c87b1422d..3d8c992c2 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 | [default to 0] | +| `fax_pages_sent` | ```int``` | Number of fax pages sent | | [[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/AccountResponseUsage.php b/sdks/php/src/Model/AccountResponseUsage.php index 6728300ac..94eb509e7 100644 --- a/sdks/php/src/Model/AccountResponseUsage.php +++ b/sdks/php/src/Model/AccountResponseUsage.php @@ -29,7 +29,6 @@ use ArrayAccess; use Dropbox\Sign\ObjectSerializer; -use InvalidArgumentException; use JsonSerializable; use ReturnTypeWillChange; @@ -78,7 +77,7 @@ class AccountResponseUsage implements ModelInterface, ArrayAccess, JsonSerializa * @var bool[] */ protected static array $openAPINullables = [ - 'fax_pages_sent' => false, + 'fax_pages_sent' => true, ]; /** @@ -236,7 +235,7 @@ public function getModelName() */ public function __construct(array $data = null) { - $this->setIfExists('fax_pages_sent', $data ?? [], 0); + $this->setIfExists('fax_pages_sent', $data ?? [], null); } /** @@ -316,7 +315,14 @@ public function getFaxPagesSent() public function setFaxPagesSent(?int $fax_pages_sent) { if (is_null($fax_pages_sent)) { - throw new InvalidArgumentException('non-nullable fax_pages_sent cannot be null'); + 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); + } } $this->container['fax_pages_sent'] = $fax_pages_sent; diff --git a/sdks/python/docs/AccountResponseUsage.md b/sdks/python/docs/AccountResponseUsage.md index a8ca8e606..dd99429af 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 | [default to 0] | +| `fax_pages_sent` | ```int``` | Number of fax pages sent | | [[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_usage.py b/sdks/python/dropbox_sign/models/account_response_usage.py index 84e6f9841..8efc7a64b 100644 --- a/sdks/python/dropbox_sign/models/account_response_usage.py +++ b/sdks/python/dropbox_sign/models/account_response_usage.py @@ -33,7 +33,7 @@ class AccountResponseUsage(BaseModel): """ # noqa: E501 fax_pages_sent: Optional[StrictInt] = Field( - default=0, description="Number of fax pages sent" + default=None, description="Number of fax pages sent" ) __properties: ClassVar[List[str]] = ["fax_pages_sent"] @@ -98,15 +98,7 @@ 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") - if obj.get("fax_pages_sent") is not None - else 0 - ) - } - ) + _obj = cls.model_validate({"fax_pages_sent": obj.get("fax_pages_sent")}) return _obj @classmethod diff --git a/sdks/ruby/docs/AccountResponseUsage.md b/sdks/ruby/docs/AccountResponseUsage.md index 85145219a..6dc2ddc21 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 | [default to 0] | +| `fax_pages_sent` | ```Integer``` | Number of fax pages sent | | 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 fe57fc441..3eb518794 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] + # @return [Integer, nil] attr_accessor :fax_pages_sent # Attribute mapping from ruby-style variable name to JSON key. @@ -45,6 +45,7 @@ def self.openapi_types # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'fax_pages_sent' ]) end @@ -90,8 +91,6 @@ 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 From 1da132eda7d470973aee37b6e9009ed23eb57fcf Mon Sep 17 00:00:00 2001 From: Juan Treminio <50673996+jtreminio-dropbox@users.noreply.github.com> Date: Tue, 29 Oct 2024 14:37:18 -0500 Subject: [PATCH 16/16] Cleanup generated files before new generation (#447) --- sdks/dotnet/run-build | 4 + sdks/dotnet/src/Dropbox.Sign/Model/FaxLine.cs | 245 ------ .../src/Dropbox.Sign/Model/FaxResponseFax.cs | 397 --------- .../Model/FaxResponseFaxTransmission.cs | 240 ----- .../SignatureRequestEditEmbeddedRequest.cs | 773 ----------------- ...eRequestEditEmbeddedWithTemplateRequest.cs | 558 ------------ .../Model/SignatureRequestEditRequest.cs | 817 ------------------ ...SignatureRequestEditWithTemplateRequest.cs | 602 ------------- sdks/dotnet/src/Dropbox.Sign/Model/SubFile.cs | 167 ---- .../Model/TemplateResponseCustomField.cs | 475 ---------- .../TemplateResponseDocumentCustomField.cs | 554 ------------ .../TemplateResponseDocumentFormField.cs | 549 ------------ .../TemplateResponseDocumentStaticField.cs | 381 -------- .../Model/TemplateResponseNamedFormField.cs | 484 ----------- sdks/java-v1/run-build | 4 + sdks/java-v2/run-build | 4 + sdks/node/run-build | 6 + sdks/php/run-build | 4 + .../dropbox_sign/models/fax_response_fax.py | 187 ---- .../models/fax_response_fax_transmission.py | 146 ---- sdks/python/dropbox_sign/models/sub_file.py | 125 --- sdks/python/run-build | 4 + sdks/ruby/run-build | 4 + 23 files changed, 30 insertions(+), 6700 deletions(-) delete mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/FaxLine.cs delete mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFax.cs delete mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFaxTransmission.cs delete mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs delete mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs delete mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs delete mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs delete mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/SubFile.cs delete mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCustomField.cs delete mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomField.cs delete mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormField.cs delete mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticField.cs delete mode 100644 sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseNamedFormField.cs delete mode 100644 sdks/python/dropbox_sign/models/fax_response_fax.py delete mode 100644 sdks/python/dropbox_sign/models/fax_response_fax_transmission.py delete mode 100644 sdks/python/dropbox_sign/models/sub_file.py diff --git a/sdks/dotnet/run-build b/sdks/dotnet/run-build index 06d6bb4c7..8a2332ad6 100755 --- a/sdks/dotnet/run-build +++ b/sdks/dotnet/run-build @@ -12,6 +12,10 @@ if [[ -n "$GITHUB_ACTIONS" ]]; then echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin fi +# cleanup +rm -f "${DIR}/src/Dropbox.Sign/Api/"*.cs +rm -f "${DIR}/src/Dropbox.Sign/Model/"*.cs + docker run --rm \ -v "${DIR}/:/local" \ openapitools/openapi-generator-cli:v7.8.0 generate \ diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLine.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLine.cs deleted file mode 100644 index bea924860..000000000 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLine.cs +++ /dev/null @@ -1,245 +0,0 @@ -/* - * Dropbox Sign API - * - * Dropbox Sign v3 API - * - * The version of the OpenAPI document: 3.0.0 - * Contact: apisupport@hellosign.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ - - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.ObjectModel; -using System.Linq; -using System.IO; -using System.Runtime.Serialization; -using System.Text; -using System.Text.RegularExpressions; -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using System.ComponentModel.DataAnnotations; -using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; - -namespace Dropbox.Sign.Model -{ - /// - /// FaxLine - /// - [DataContract(Name = "FaxLine")] - [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] - public partial class FaxLine : IOpenApiTyped, IEquatable, IValidatableObject - { - /// - /// Initializes a new instance of the class. - /// - [JsonConstructorAttribute] - protected FaxLine() { } - /// - /// Initializes a new instance of the class. - /// - /// Number. - /// Created at. - /// Updated at. - /// accounts. - public FaxLine(string number = default(string), string createdAt = default(string), string updatedAt = default(string), List accounts = default(List)) - { - - this.Number = number; - this.CreatedAt = createdAt; - this.UpdatedAt = updatedAt; - this.Accounts = accounts; - } - - /// - /// Attempt to instantiate and hydrate a new instance of this class - /// - /// String of JSON data representing target object - public static FaxLine Init(string jsonData) - { - var obj = JsonConvert.DeserializeObject(jsonData); - - if (obj == null) - { - throw new Exception("Unable to deserialize JSON to instance of FaxLine"); - } - - return obj; - } - - /// - /// Number - /// - /// Number - [DataMember(Name = "number", EmitDefaultValue = true)] - public string Number { get; set; } - - /// - /// Created at - /// - /// Created at - [DataMember(Name = "created_at", EmitDefaultValue = true)] - public string CreatedAt { get; set; } - - /// - /// Updated at - /// - /// Updated at - [DataMember(Name = "updated_at", EmitDefaultValue = true)] - public string UpdatedAt { get; set; } - - /// - /// Gets or Sets Accounts - /// - [DataMember(Name = "accounts", EmitDefaultValue = true)] - public List Accounts { get; set; } - - /// - /// Returns the string presentation of the object - /// - /// String presentation of the object - public override string ToString() - { - StringBuilder sb = new StringBuilder(); - sb.Append("class FaxLine {\n"); - sb.Append(" Number: ").Append(Number).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" UpdatedAt: ").Append(UpdatedAt).Append("\n"); - sb.Append(" Accounts: ").Append(Accounts).Append("\n"); - sb.Append("}\n"); - return sb.ToString(); - } - - /// - /// Returns the JSON string presentation of the object - /// - /// JSON string presentation of the object - public virtual string ToJson() - { - return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); - } - - /// - /// Returns true if objects are equal - /// - /// Object to be compared - /// Boolean - public override bool Equals(object input) - { - return this.Equals(input as FaxLine); - } - - /// - /// Returns true if FaxLine instances are equal - /// - /// Instance of FaxLine to be compared - /// Boolean - public bool Equals(FaxLine input) - { - if (input == null) - { - return false; - } - return - ( - this.Number == input.Number || - (this.Number != null && - this.Number.Equals(input.Number)) - ) && - ( - this.CreatedAt == input.CreatedAt || - (this.CreatedAt != null && - this.CreatedAt.Equals(input.CreatedAt)) - ) && - ( - this.UpdatedAt == input.UpdatedAt || - (this.UpdatedAt != null && - this.UpdatedAt.Equals(input.UpdatedAt)) - ) && - ( - this.Accounts == input.Accounts || - this.Accounts != null && - input.Accounts != null && - this.Accounts.SequenceEqual(input.Accounts) - ); - } - - /// - /// Gets the hash code - /// - /// Hash code - public override int GetHashCode() - { - unchecked // Overflow is fine, just wrap - { - int hashCode = 41; - if (this.Number != null) - { - hashCode = (hashCode * 59) + this.Number.GetHashCode(); - } - if (this.CreatedAt != null) - { - hashCode = (hashCode * 59) + this.CreatedAt.GetHashCode(); - } - if (this.UpdatedAt != null) - { - hashCode = (hashCode * 59) + this.UpdatedAt.GetHashCode(); - } - if (this.Accounts != null) - { - hashCode = (hashCode * 59) + this.Accounts.GetHashCode(); - } - return hashCode; - } - } - - public List GetOpenApiTypes() - { - var types = new List(); - types.Add(new OpenApiType() - { - Name = "number", - Property = "Number", - Type = "string", - Value = Number, - }); - types.Add(new OpenApiType() - { - Name = "created_at", - Property = "CreatedAt", - Type = "string", - Value = CreatedAt, - }); - types.Add(new OpenApiType() - { - Name = "updated_at", - Property = "UpdatedAt", - Type = "string", - Value = UpdatedAt, - }); - types.Add(new OpenApiType() - { - Name = "accounts", - Property = "Accounts", - Type = "List", - Value = Accounts, - }); - - return types; - } - - /// - /// To validate all properties of the instance - /// - /// Validation context - /// Validation Result - public IEnumerable Validate(ValidationContext validationContext) - { - yield break; - } - } - -} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFax.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFax.cs deleted file mode 100644 index abb8cab5f..000000000 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFax.cs +++ /dev/null @@ -1,397 +0,0 @@ -/* - * Dropbox Sign API - * - * Dropbox Sign v3 API - * - * The version of the OpenAPI document: 3.0.0 - * Contact: apisupport@hellosign.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ - - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.ObjectModel; -using System.Linq; -using System.IO; -using System.Runtime.Serialization; -using System.Text; -using System.Text.RegularExpressions; -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using System.ComponentModel.DataAnnotations; -using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; - -namespace Dropbox.Sign.Model -{ - /// - /// FaxResponseFax - /// - [DataContract(Name = "FaxResponseFax")] - [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] - public partial class FaxResponseFax : IEquatable, IValidatableObject - { - /// - /// Initializes a new instance of the class. - /// - [JsonConstructorAttribute] - protected FaxResponseFax() { } - /// - /// Initializes a new instance of the class. - /// - /// Fax ID. - /// Fax Title. - /// Fax Original Title. - /// Fax Subject. - /// Fax Message. - /// Fax Metadata. - /// Fax Created At Timestamp. - /// Fax Sender Email. - /// Fax Transmissions List. - /// Fax Files URL. - public FaxResponseFax(string faxId = default(string), string title = default(string), string originalTitle = default(string), string subject = default(string), string message = default(string), Object metadata = default(Object), int createdAt = default(int), string from = default(string), List transmissions = default(List), string filesUrl = default(string)) - { - - this.FaxId = faxId; - this.Title = title; - this.OriginalTitle = originalTitle; - this.Subject = subject; - this.Message = message; - this.Metadata = metadata; - this.CreatedAt = createdAt; - this.From = from; - this.Transmissions = transmissions; - this.FilesUrl = filesUrl; - } - - /// - /// Attempt to instantiate and hydrate a new instance of this class - /// - /// String of JSON data representing target object - public static FaxResponseFax Init(string jsonData) - { - var obj = JsonConvert.DeserializeObject(jsonData); - - if (obj == null) - { - throw new Exception("Unable to deserialize JSON to instance of FaxResponseFax"); - } - - return obj; - } - - /// - /// Fax ID - /// - /// Fax ID - [DataMember(Name = "fax_id", EmitDefaultValue = true)] - public string FaxId { get; set; } - - /// - /// Fax Title - /// - /// Fax Title - [DataMember(Name = "title", EmitDefaultValue = true)] - public string Title { get; set; } - - /// - /// Fax Original Title - /// - /// Fax Original Title - [DataMember(Name = "original_title", EmitDefaultValue = true)] - public string OriginalTitle { get; set; } - - /// - /// Fax Subject - /// - /// Fax Subject - [DataMember(Name = "subject", EmitDefaultValue = true)] - public string Subject { get; set; } - - /// - /// Fax Message - /// - /// Fax Message - [DataMember(Name = "message", EmitDefaultValue = true)] - public string Message { get; set; } - - /// - /// Fax Metadata - /// - /// Fax Metadata - [DataMember(Name = "metadata", EmitDefaultValue = true)] - public Object Metadata { get; set; } - - /// - /// Fax Created At Timestamp - /// - /// Fax Created At Timestamp - [DataMember(Name = "created_at", EmitDefaultValue = true)] - public int CreatedAt { get; set; } - - /// - /// Fax Sender Email - /// - /// Fax Sender Email - [DataMember(Name = "from", EmitDefaultValue = true)] - public string From { get; set; } - - /// - /// Fax Transmissions List - /// - /// Fax Transmissions List - [DataMember(Name = "transmissions", EmitDefaultValue = true)] - public List Transmissions { get; set; } - - /// - /// Fax Files URL - /// - /// Fax Files URL - [DataMember(Name = "files_url", EmitDefaultValue = true)] - public string FilesUrl { get; set; } - - /// - /// Returns the string presentation of the object - /// - /// String presentation of the object - public override string ToString() - { - StringBuilder sb = new StringBuilder(); - sb.Append("class FaxResponseFax {\n"); - sb.Append(" FaxId: ").Append(FaxId).Append("\n"); - sb.Append(" Title: ").Append(Title).Append("\n"); - sb.Append(" OriginalTitle: ").Append(OriginalTitle).Append("\n"); - sb.Append(" Subject: ").Append(Subject).Append("\n"); - sb.Append(" Message: ").Append(Message).Append("\n"); - sb.Append(" Metadata: ").Append(Metadata).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); - sb.Append(" From: ").Append(From).Append("\n"); - sb.Append(" Transmissions: ").Append(Transmissions).Append("\n"); - sb.Append(" FilesUrl: ").Append(FilesUrl).Append("\n"); - sb.Append("}\n"); - return sb.ToString(); - } - - /// - /// Returns the JSON string presentation of the object - /// - /// JSON string presentation of the object - public virtual string ToJson() - { - return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); - } - - /// - /// Returns true if objects are equal - /// - /// Object to be compared - /// Boolean - public override bool Equals(object input) - { - return this.Equals(input as FaxResponseFax); - } - - /// - /// Returns true if FaxResponseFax instances are equal - /// - /// Instance of FaxResponseFax to be compared - /// Boolean - public bool Equals(FaxResponseFax input) - { - if (input == null) - { - return false; - } - return - ( - this.FaxId == input.FaxId || - (this.FaxId != null && - this.FaxId.Equals(input.FaxId)) - ) && - ( - this.Title == input.Title || - (this.Title != null && - this.Title.Equals(input.Title)) - ) && - ( - this.OriginalTitle == input.OriginalTitle || - (this.OriginalTitle != null && - this.OriginalTitle.Equals(input.OriginalTitle)) - ) && - ( - this.Subject == input.Subject || - (this.Subject != null && - this.Subject.Equals(input.Subject)) - ) && - ( - this.Message == input.Message || - (this.Message != null && - this.Message.Equals(input.Message)) - ) && - ( - this.Metadata == input.Metadata || - (this.Metadata != null && - this.Metadata.Equals(input.Metadata)) - ) && - ( - this.CreatedAt == input.CreatedAt || - this.CreatedAt.Equals(input.CreatedAt) - ) && - ( - this.From == input.From || - (this.From != null && - this.From.Equals(input.From)) - ) && - ( - this.Transmissions == input.Transmissions || - this.Transmissions != null && - input.Transmissions != null && - this.Transmissions.SequenceEqual(input.Transmissions) - ) && - ( - this.FilesUrl == input.FilesUrl || - (this.FilesUrl != null && - this.FilesUrl.Equals(input.FilesUrl)) - ); - } - - /// - /// Gets the hash code - /// - /// Hash code - public override int GetHashCode() - { - unchecked // Overflow is fine, just wrap - { - int hashCode = 41; - if (this.FaxId != null) - { - hashCode = (hashCode * 59) + this.FaxId.GetHashCode(); - } - if (this.Title != null) - { - hashCode = (hashCode * 59) + this.Title.GetHashCode(); - } - if (this.OriginalTitle != null) - { - hashCode = (hashCode * 59) + this.OriginalTitle.GetHashCode(); - } - if (this.Subject != null) - { - hashCode = (hashCode * 59) + this.Subject.GetHashCode(); - } - if (this.Message != null) - { - hashCode = (hashCode * 59) + this.Message.GetHashCode(); - } - if (this.Metadata != null) - { - hashCode = (hashCode * 59) + this.Metadata.GetHashCode(); - } - hashCode = (hashCode * 59) + this.CreatedAt.GetHashCode(); - if (this.From != null) - { - hashCode = (hashCode * 59) + this.From.GetHashCode(); - } - if (this.Transmissions != null) - { - hashCode = (hashCode * 59) + this.Transmissions.GetHashCode(); - } - if (this.FilesUrl != null) - { - hashCode = (hashCode * 59) + this.FilesUrl.GetHashCode(); - } - return hashCode; - } - } - - /// - /// To validate all properties of the instance - /// - /// Validation context - /// Validation Result - IEnumerable IValidatableObject.Validate(ValidationContext validationContext) - { - yield break; - } - public List GetOpenApiTypes() - { - var types = new List(); - types.Add(new OpenApiType() - { - Name = "fax_id", - Property = "FaxId", - Type = "string", - Value = FaxId, - }); - types.Add(new OpenApiType() - { - Name = "title", - Property = "Title", - Type = "string", - Value = Title, - }); - types.Add(new OpenApiType() - { - Name = "original_title", - Property = "OriginalTitle", - Type = "string", - Value = OriginalTitle, - }); - types.Add(new OpenApiType() - { - Name = "subject", - Property = "Subject", - Type = "string", - Value = Subject, - }); - types.Add(new OpenApiType() - { - Name = "message", - Property = "Message", - Type = "string", - Value = Message, - }); - types.Add(new OpenApiType() - { - Name = "metadata", - Property = "Metadata", - Type = "Object", - Value = Metadata, - }); - types.Add(new OpenApiType() - { - Name = "created_at", - Property = "CreatedAt", - Type = "int", - Value = CreatedAt, - }); - types.Add(new OpenApiType() - { - Name = "from", - Property = "From", - Type = "string", - Value = From, - }); - types.Add(new OpenApiType() - { - Name = "transmissions", - Property = "Transmissions", - Type = "List", - Value = Transmissions, - }); - types.Add(new OpenApiType() - { - Name = "files_url", - Property = "FilesUrl", - Type = "string", - Value = FilesUrl, - }); - - return types; - } - } - -} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFaxTransmission.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFaxTransmission.cs deleted file mode 100644 index 51e666148..000000000 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxResponseFaxTransmission.cs +++ /dev/null @@ -1,240 +0,0 @@ -/* - * Dropbox Sign API - * - * Dropbox Sign v3 API - * - * The version of the OpenAPI document: 3.0.0 - * Contact: apisupport@hellosign.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ - - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.ObjectModel; -using System.Linq; -using System.IO; -using System.Runtime.Serialization; -using System.Text; -using System.Text.RegularExpressions; -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using System.ComponentModel.DataAnnotations; -using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; - -namespace Dropbox.Sign.Model -{ - /// - /// FaxResponseFaxTransmission - /// - [DataContract(Name = "FaxResponseFaxTransmission")] - [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] - public partial class FaxResponseFaxTransmission : IEquatable, IValidatableObject - { - /// - /// Initializes a new instance of the class. - /// - [JsonConstructorAttribute] - protected FaxResponseFaxTransmission() { } - /// - /// Initializes a new instance of the class. - /// - /// Fax Transmission Recipient. - /// Fax Transmission Sender. - /// Fax Transmission Status Code. - /// Fax Transmission Sent Timestamp. - public FaxResponseFaxTransmission(string recipient = default(string), string sender = default(string), string statusCode = default(string), int sentAt = default(int)) - { - - this.Recipient = recipient; - this.Sender = sender; - this.StatusCode = statusCode; - this.SentAt = sentAt; - } - - /// - /// Attempt to instantiate and hydrate a new instance of this class - /// - /// String of JSON data representing target object - public static FaxResponseFaxTransmission Init(string jsonData) - { - var obj = JsonConvert.DeserializeObject(jsonData); - - if (obj == null) - { - throw new Exception("Unable to deserialize JSON to instance of FaxResponseFaxTransmission"); - } - - return obj; - } - - /// - /// Fax Transmission Recipient - /// - /// Fax Transmission Recipient - [DataMember(Name = "recipient", EmitDefaultValue = true)] - public string Recipient { get; set; } - - /// - /// Fax Transmission Sender - /// - /// Fax Transmission Sender - [DataMember(Name = "sender", EmitDefaultValue = true)] - public string Sender { get; set; } - - /// - /// Fax Transmission Status Code - /// - /// Fax Transmission Status Code - [DataMember(Name = "status_code", EmitDefaultValue = true)] - public string StatusCode { get; set; } - - /// - /// Fax Transmission Sent Timestamp - /// - /// Fax Transmission Sent Timestamp - [DataMember(Name = "sent_at", EmitDefaultValue = true)] - public int SentAt { get; set; } - - /// - /// Returns the string presentation of the object - /// - /// String presentation of the object - public override string ToString() - { - StringBuilder sb = new StringBuilder(); - sb.Append("class FaxResponseFaxTransmission {\n"); - sb.Append(" Recipient: ").Append(Recipient).Append("\n"); - sb.Append(" Sender: ").Append(Sender).Append("\n"); - sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); - sb.Append(" SentAt: ").Append(SentAt).Append("\n"); - sb.Append("}\n"); - return sb.ToString(); - } - - /// - /// Returns the JSON string presentation of the object - /// - /// JSON string presentation of the object - public virtual string ToJson() - { - return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); - } - - /// - /// Returns true if objects are equal - /// - /// Object to be compared - /// Boolean - public override bool Equals(object input) - { - return this.Equals(input as FaxResponseFaxTransmission); - } - - /// - /// Returns true if FaxResponseFaxTransmission instances are equal - /// - /// Instance of FaxResponseFaxTransmission to be compared - /// Boolean - public bool Equals(FaxResponseFaxTransmission input) - { - if (input == null) - { - return false; - } - return - ( - this.Recipient == input.Recipient || - (this.Recipient != null && - this.Recipient.Equals(input.Recipient)) - ) && - ( - this.Sender == input.Sender || - (this.Sender != null && - this.Sender.Equals(input.Sender)) - ) && - ( - this.StatusCode == input.StatusCode || - (this.StatusCode != null && - this.StatusCode.Equals(input.StatusCode)) - ) && - ( - this.SentAt == input.SentAt || - this.SentAt.Equals(input.SentAt) - ); - } - - /// - /// Gets the hash code - /// - /// Hash code - public override int GetHashCode() - { - unchecked // Overflow is fine, just wrap - { - int hashCode = 41; - if (this.Recipient != null) - { - hashCode = (hashCode * 59) + this.Recipient.GetHashCode(); - } - if (this.Sender != null) - { - hashCode = (hashCode * 59) + this.Sender.GetHashCode(); - } - if (this.StatusCode != null) - { - hashCode = (hashCode * 59) + this.StatusCode.GetHashCode(); - } - hashCode = (hashCode * 59) + this.SentAt.GetHashCode(); - return hashCode; - } - } - - /// - /// To validate all properties of the instance - /// - /// Validation context - /// Validation Result - IEnumerable IValidatableObject.Validate(ValidationContext validationContext) - { - yield break; - } - public List GetOpenApiTypes() - { - var types = new List(); - types.Add(new OpenApiType() - { - Name = "recipient", - Property = "Recipient", - Type = "string", - Value = Recipient, - }); - types.Add(new OpenApiType() - { - Name = "sender", - Property = "Sender", - Type = "string", - Value = Sender, - }); - types.Add(new OpenApiType() - { - Name = "status_code", - Property = "StatusCode", - Type = "string", - Value = StatusCode, - }); - types.Add(new OpenApiType() - { - Name = "sent_at", - Property = "SentAt", - Type = "int", - Value = SentAt, - }); - - return types; - } - } - -} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs deleted file mode 100644 index ce078442e..000000000 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs +++ /dev/null @@ -1,773 +0,0 @@ -/* - * Dropbox Sign API - * - * Dropbox Sign v3 API - * - * The version of the OpenAPI document: 3.0.0 - * Contact: apisupport@hellosign.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ - - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.ObjectModel; -using System.Linq; -using System.IO; -using System.Runtime.Serialization; -using System.Text; -using System.Text.RegularExpressions; -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using System.ComponentModel.DataAnnotations; -using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; - -namespace Dropbox.Sign.Model -{ - /// - /// SignatureRequestEditEmbeddedRequest - /// - [DataContract(Name = "SignatureRequestEditEmbeddedRequest")] - [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] - public partial class SignatureRequestEditEmbeddedRequest : IOpenApiTyped, IEquatable, IValidatableObject - { - /// - /// Initializes a new instance of the class. - /// - [JsonConstructorAttribute] - protected SignatureRequestEditEmbeddedRequest() { } - /// - /// Initializes a new instance of the class. - /// - /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. - /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. - /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). - /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. (default to false). - /// A list describing the attachments. - /// The email addresses that should be CCed.. - /// Client id of the app you're using to create this embedded signature request. Used for security purposes. (required). - /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.. - /// fieldOptions. - /// Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.. - /// Conditional Logic rules for fields defined in `form_fields_per_document`.. - /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`. - /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. (default to false). - /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. - /// signingOptions. - /// The subject in the email that will be sent to the signers.. - /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). - /// The title you want to assign to the SignatureRequest.. - /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). - /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). - /// 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.. - public SignatureRequestEditEmbeddedRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) - { - - // to ensure "clientId" is required (not null) - if (clientId == null) - { - throw new ArgumentNullException("clientId is a required property for SignatureRequestEditEmbeddedRequest and cannot be null"); - } - this.ClientId = clientId; - this.Files = files; - this.FileUrls = fileUrls; - this.Signers = signers; - this.GroupedSigners = groupedSigners; - this.AllowDecline = allowDecline; - this.AllowReassign = allowReassign; - this.Attachments = attachments; - this.CcEmailAddresses = ccEmailAddresses; - this.CustomFields = customFields; - this.FieldOptions = fieldOptions; - this.FormFieldGroups = formFieldGroups; - this.FormFieldRules = formFieldRules; - this.FormFieldsPerDocument = formFieldsPerDocument; - this.HideTextTags = hideTextTags; - this.Message = message; - this.Metadata = metadata; - this.SigningOptions = signingOptions; - this.Subject = subject; - this.TestMode = testMode; - this.Title = title; - this.UseTextTags = useTextTags; - this.PopulateAutoFillFields = populateAutoFillFields; - this.ExpiresAt = expiresAt; - } - - /// - /// Attempt to instantiate and hydrate a new instance of this class - /// - /// String of JSON data representing target object - public static SignatureRequestEditEmbeddedRequest Init(string jsonData) - { - var obj = JsonConvert.DeserializeObject(jsonData); - - if (obj == null) - { - throw new Exception("Unable to deserialize JSON to instance of SignatureRequestEditEmbeddedRequest"); - } - - return obj; - } - - /// - /// Client id of the app you're using to create this embedded signature request. Used for security purposes. - /// - /// Client id of the app you're using to create this embedded signature request. Used for security purposes. - [DataMember(Name = "client_id", IsRequired = true, EmitDefaultValue = true)] - public string ClientId { get; set; } - - /// - /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - /// - /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - [DataMember(Name = "files", EmitDefaultValue = true)] - public List Files { get; set; } - - /// - /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - /// - /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - [DataMember(Name = "file_urls", EmitDefaultValue = true)] - public List FileUrls { get; set; } - - /// - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. - /// - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. - [DataMember(Name = "signers", EmitDefaultValue = true)] - public List Signers { get; set; } - - /// - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. - /// - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. - [DataMember(Name = "grouped_signers", EmitDefaultValue = true)] - public List GroupedSigners { get; set; } - - /// - /// Allows signers to decline to sign a document if `true`. Defaults to `false`. - /// - /// Allows signers to decline to sign a document if `true`. Defaults to `false`. - [DataMember(Name = "allow_decline", EmitDefaultValue = true)] - public bool AllowDecline { get; set; } - - /// - /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. - /// - /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. - [DataMember(Name = "allow_reassign", EmitDefaultValue = true)] - public bool AllowReassign { get; set; } - - /// - /// A list describing the attachments - /// - /// A list describing the attachments - [DataMember(Name = "attachments", EmitDefaultValue = true)] - public List Attachments { get; set; } - - /// - /// The email addresses that should be CCed. - /// - /// The email addresses that should be CCed. - [DataMember(Name = "cc_email_addresses", EmitDefaultValue = true)] - public List CcEmailAddresses { get; set; } - - /// - /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. - /// - /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. - [DataMember(Name = "custom_fields", EmitDefaultValue = true)] - public List CustomFields { get; set; } - - /// - /// Gets or Sets FieldOptions - /// - [DataMember(Name = "field_options", EmitDefaultValue = true)] - public SubFieldOptions FieldOptions { get; set; } - - /// - /// Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. - /// - /// Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. - [DataMember(Name = "form_field_groups", EmitDefaultValue = true)] - public List FormFieldGroups { get; set; } - - /// - /// Conditional Logic rules for fields defined in `form_fields_per_document`. - /// - /// Conditional Logic rules for fields defined in `form_fields_per_document`. - [DataMember(Name = "form_field_rules", EmitDefaultValue = true)] - public List FormFieldRules { get; set; } - - /// - /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` - /// - /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` - [DataMember(Name = "form_fields_per_document", EmitDefaultValue = true)] - public List FormFieldsPerDocument { get; set; } - - /// - /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. - /// - /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. - [DataMember(Name = "hide_text_tags", EmitDefaultValue = true)] - public bool HideTextTags { get; set; } - - /// - /// The custom message in the email that will be sent to the signers. - /// - /// The custom message in the email that will be sent to the signers. - [DataMember(Name = "message", EmitDefaultValue = true)] - public string Message { get; set; } - - /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. - /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. - [DataMember(Name = "metadata", EmitDefaultValue = true)] - public Dictionary Metadata { get; set; } - - /// - /// Gets or Sets SigningOptions - /// - [DataMember(Name = "signing_options", EmitDefaultValue = true)] - public SubSigningOptions SigningOptions { get; set; } - - /// - /// The subject in the email that will be sent to the signers. - /// - /// The subject in the email that will be sent to the signers. - [DataMember(Name = "subject", EmitDefaultValue = true)] - public string Subject { get; set; } - - /// - /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. - /// - /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. - [DataMember(Name = "test_mode", EmitDefaultValue = true)] - public bool TestMode { get; set; } - - /// - /// The title you want to assign to the SignatureRequest. - /// - /// The title you want to assign to the SignatureRequest. - [DataMember(Name = "title", EmitDefaultValue = true)] - public string Title { get; set; } - - /// - /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. - /// - /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. - [DataMember(Name = "use_text_tags", EmitDefaultValue = true)] - public bool UseTextTags { get; set; } - - /// - /// 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. - /// - /// 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. - [DataMember(Name = "populate_auto_fill_fields", EmitDefaultValue = true)] - public bool PopulateAutoFillFields { get; set; } - - /// - /// 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. - /// - /// 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. - [DataMember(Name = "expires_at", EmitDefaultValue = true)] - public int? ExpiresAt { get; set; } - - /// - /// Returns the string presentation of the object - /// - /// String presentation of the object - public override string ToString() - { - StringBuilder sb = new StringBuilder(); - sb.Append("class SignatureRequestEditEmbeddedRequest {\n"); - sb.Append(" ClientId: ").Append(ClientId).Append("\n"); - sb.Append(" Files: ").Append(Files).Append("\n"); - sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); - sb.Append(" Signers: ").Append(Signers).Append("\n"); - sb.Append(" GroupedSigners: ").Append(GroupedSigners).Append("\n"); - sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); - sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); - sb.Append(" Attachments: ").Append(Attachments).Append("\n"); - sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); - sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); - sb.Append(" FieldOptions: ").Append(FieldOptions).Append("\n"); - sb.Append(" FormFieldGroups: ").Append(FormFieldGroups).Append("\n"); - sb.Append(" FormFieldRules: ").Append(FormFieldRules).Append("\n"); - sb.Append(" FormFieldsPerDocument: ").Append(FormFieldsPerDocument).Append("\n"); - sb.Append(" HideTextTags: ").Append(HideTextTags).Append("\n"); - sb.Append(" Message: ").Append(Message).Append("\n"); - sb.Append(" Metadata: ").Append(Metadata).Append("\n"); - sb.Append(" SigningOptions: ").Append(SigningOptions).Append("\n"); - sb.Append(" Subject: ").Append(Subject).Append("\n"); - sb.Append(" TestMode: ").Append(TestMode).Append("\n"); - sb.Append(" Title: ").Append(Title).Append("\n"); - sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); - sb.Append(" PopulateAutoFillFields: ").Append(PopulateAutoFillFields).Append("\n"); - sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); - sb.Append("}\n"); - return sb.ToString(); - } - - /// - /// Returns the JSON string presentation of the object - /// - /// JSON string presentation of the object - public virtual string ToJson() - { - return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); - } - - /// - /// Returns true if objects are equal - /// - /// Object to be compared - /// Boolean - public override bool Equals(object input) - { - return this.Equals(input as SignatureRequestEditEmbeddedRequest); - } - - /// - /// Returns true if SignatureRequestEditEmbeddedRequest instances are equal - /// - /// Instance of SignatureRequestEditEmbeddedRequest to be compared - /// Boolean - public bool Equals(SignatureRequestEditEmbeddedRequest input) - { - if (input == null) - { - return false; - } - return - ( - this.ClientId == input.ClientId || - (this.ClientId != null && - this.ClientId.Equals(input.ClientId)) - ) && - ( - this.Files == input.Files || - this.Files != null && - input.Files != null && - this.Files.SequenceEqual(input.Files) - ) && - ( - this.FileUrls == input.FileUrls || - this.FileUrls != null && - input.FileUrls != null && - this.FileUrls.SequenceEqual(input.FileUrls) - ) && - ( - this.Signers == input.Signers || - this.Signers != null && - input.Signers != null && - this.Signers.SequenceEqual(input.Signers) - ) && - ( - this.GroupedSigners == input.GroupedSigners || - this.GroupedSigners != null && - input.GroupedSigners != null && - this.GroupedSigners.SequenceEqual(input.GroupedSigners) - ) && - ( - this.AllowDecline == input.AllowDecline || - this.AllowDecline.Equals(input.AllowDecline) - ) && - ( - this.AllowReassign == input.AllowReassign || - this.AllowReassign.Equals(input.AllowReassign) - ) && - ( - this.Attachments == input.Attachments || - this.Attachments != null && - input.Attachments != null && - this.Attachments.SequenceEqual(input.Attachments) - ) && - ( - this.CcEmailAddresses == input.CcEmailAddresses || - this.CcEmailAddresses != null && - input.CcEmailAddresses != null && - this.CcEmailAddresses.SequenceEqual(input.CcEmailAddresses) - ) && - ( - this.CustomFields == input.CustomFields || - this.CustomFields != null && - input.CustomFields != null && - this.CustomFields.SequenceEqual(input.CustomFields) - ) && - ( - this.FieldOptions == input.FieldOptions || - (this.FieldOptions != null && - this.FieldOptions.Equals(input.FieldOptions)) - ) && - ( - this.FormFieldGroups == input.FormFieldGroups || - this.FormFieldGroups != null && - input.FormFieldGroups != null && - this.FormFieldGroups.SequenceEqual(input.FormFieldGroups) - ) && - ( - this.FormFieldRules == input.FormFieldRules || - this.FormFieldRules != null && - input.FormFieldRules != null && - this.FormFieldRules.SequenceEqual(input.FormFieldRules) - ) && - ( - this.FormFieldsPerDocument == input.FormFieldsPerDocument || - this.FormFieldsPerDocument != null && - input.FormFieldsPerDocument != null && - this.FormFieldsPerDocument.SequenceEqual(input.FormFieldsPerDocument) - ) && - ( - this.HideTextTags == input.HideTextTags || - this.HideTextTags.Equals(input.HideTextTags) - ) && - ( - this.Message == input.Message || - (this.Message != null && - this.Message.Equals(input.Message)) - ) && - ( - this.Metadata == input.Metadata || - this.Metadata != null && - input.Metadata != null && - this.Metadata.SequenceEqual(input.Metadata) - ) && - ( - this.SigningOptions == input.SigningOptions || - (this.SigningOptions != null && - this.SigningOptions.Equals(input.SigningOptions)) - ) && - ( - this.Subject == input.Subject || - (this.Subject != null && - this.Subject.Equals(input.Subject)) - ) && - ( - this.TestMode == input.TestMode || - this.TestMode.Equals(input.TestMode) - ) && - ( - this.Title == input.Title || - (this.Title != null && - this.Title.Equals(input.Title)) - ) && - ( - this.UseTextTags == input.UseTextTags || - this.UseTextTags.Equals(input.UseTextTags) - ) && - ( - this.PopulateAutoFillFields == input.PopulateAutoFillFields || - this.PopulateAutoFillFields.Equals(input.PopulateAutoFillFields) - ) && - ( - this.ExpiresAt == input.ExpiresAt || - (this.ExpiresAt != null && - this.ExpiresAt.Equals(input.ExpiresAt)) - ); - } - - /// - /// Gets the hash code - /// - /// Hash code - public override int GetHashCode() - { - unchecked // Overflow is fine, just wrap - { - int hashCode = 41; - if (this.ClientId != null) - { - hashCode = (hashCode * 59) + this.ClientId.GetHashCode(); - } - if (this.Files != null) - { - hashCode = (hashCode * 59) + this.Files.GetHashCode(); - } - if (this.FileUrls != null) - { - hashCode = (hashCode * 59) + this.FileUrls.GetHashCode(); - } - if (this.Signers != null) - { - hashCode = (hashCode * 59) + this.Signers.GetHashCode(); - } - if (this.GroupedSigners != null) - { - hashCode = (hashCode * 59) + this.GroupedSigners.GetHashCode(); - } - hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); - hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); - if (this.Attachments != null) - { - hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); - } - if (this.CcEmailAddresses != null) - { - hashCode = (hashCode * 59) + this.CcEmailAddresses.GetHashCode(); - } - if (this.CustomFields != null) - { - hashCode = (hashCode * 59) + this.CustomFields.GetHashCode(); - } - if (this.FieldOptions != null) - { - hashCode = (hashCode * 59) + this.FieldOptions.GetHashCode(); - } - if (this.FormFieldGroups != null) - { - hashCode = (hashCode * 59) + this.FormFieldGroups.GetHashCode(); - } - if (this.FormFieldRules != null) - { - hashCode = (hashCode * 59) + this.FormFieldRules.GetHashCode(); - } - if (this.FormFieldsPerDocument != null) - { - hashCode = (hashCode * 59) + this.FormFieldsPerDocument.GetHashCode(); - } - hashCode = (hashCode * 59) + this.HideTextTags.GetHashCode(); - if (this.Message != null) - { - hashCode = (hashCode * 59) + this.Message.GetHashCode(); - } - if (this.Metadata != null) - { - hashCode = (hashCode * 59) + this.Metadata.GetHashCode(); - } - if (this.SigningOptions != null) - { - hashCode = (hashCode * 59) + this.SigningOptions.GetHashCode(); - } - if (this.Subject != null) - { - hashCode = (hashCode * 59) + this.Subject.GetHashCode(); - } - hashCode = (hashCode * 59) + this.TestMode.GetHashCode(); - if (this.Title != null) - { - hashCode = (hashCode * 59) + this.Title.GetHashCode(); - } - hashCode = (hashCode * 59) + this.UseTextTags.GetHashCode(); - hashCode = (hashCode * 59) + this.PopulateAutoFillFields.GetHashCode(); - if (this.ExpiresAt != null) - { - hashCode = (hashCode * 59) + this.ExpiresAt.GetHashCode(); - } - return hashCode; - } - } - - public List GetOpenApiTypes() - { - var types = new List(); - types.Add(new OpenApiType() - { - Name = "client_id", - Property = "ClientId", - Type = "string", - Value = ClientId, - }); - types.Add(new OpenApiType() - { - Name = "files", - Property = "Files", - Type = "List", - Value = Files, - }); - types.Add(new OpenApiType() - { - Name = "file_urls", - Property = "FileUrls", - Type = "List", - Value = FileUrls, - }); - types.Add(new OpenApiType() - { - Name = "signers", - Property = "Signers", - Type = "List", - Value = Signers, - }); - types.Add(new OpenApiType() - { - Name = "grouped_signers", - Property = "GroupedSigners", - Type = "List", - Value = GroupedSigners, - }); - types.Add(new OpenApiType() - { - Name = "allow_decline", - Property = "AllowDecline", - Type = "bool", - Value = AllowDecline, - }); - types.Add(new OpenApiType() - { - Name = "allow_reassign", - Property = "AllowReassign", - Type = "bool", - Value = AllowReassign, - }); - types.Add(new OpenApiType() - { - Name = "attachments", - Property = "Attachments", - Type = "List", - Value = Attachments, - }); - types.Add(new OpenApiType() - { - Name = "cc_email_addresses", - Property = "CcEmailAddresses", - Type = "List", - Value = CcEmailAddresses, - }); - types.Add(new OpenApiType() - { - Name = "custom_fields", - Property = "CustomFields", - Type = "List", - Value = CustomFields, - }); - types.Add(new OpenApiType() - { - Name = "field_options", - Property = "FieldOptions", - Type = "SubFieldOptions", - Value = FieldOptions, - }); - types.Add(new OpenApiType() - { - Name = "form_field_groups", - Property = "FormFieldGroups", - Type = "List", - Value = FormFieldGroups, - }); - types.Add(new OpenApiType() - { - Name = "form_field_rules", - Property = "FormFieldRules", - Type = "List", - Value = FormFieldRules, - }); - types.Add(new OpenApiType() - { - Name = "form_fields_per_document", - Property = "FormFieldsPerDocument", - Type = "List", - Value = FormFieldsPerDocument, - }); - types.Add(new OpenApiType() - { - Name = "hide_text_tags", - Property = "HideTextTags", - Type = "bool", - Value = HideTextTags, - }); - types.Add(new OpenApiType() - { - Name = "message", - Property = "Message", - Type = "string", - Value = Message, - }); - types.Add(new OpenApiType() - { - Name = "metadata", - Property = "Metadata", - Type = "Dictionary", - Value = Metadata, - }); - types.Add(new OpenApiType() - { - Name = "signing_options", - Property = "SigningOptions", - Type = "SubSigningOptions", - Value = SigningOptions, - }); - types.Add(new OpenApiType() - { - Name = "subject", - Property = "Subject", - Type = "string", - Value = Subject, - }); - types.Add(new OpenApiType() - { - Name = "test_mode", - Property = "TestMode", - Type = "bool", - Value = TestMode, - }); - types.Add(new OpenApiType() - { - Name = "title", - Property = "Title", - Type = "string", - Value = Title, - }); - types.Add(new OpenApiType() - { - Name = "use_text_tags", - Property = "UseTextTags", - Type = "bool", - Value = UseTextTags, - }); - types.Add(new OpenApiType() - { - Name = "populate_auto_fill_fields", - Property = "PopulateAutoFillFields", - Type = "bool", - Value = PopulateAutoFillFields, - }); - types.Add(new OpenApiType() - { - Name = "expires_at", - Property = "ExpiresAt", - Type = "int?", - Value = ExpiresAt, - }); - - return types; - } - - /// - /// To validate all properties of the instance - /// - /// Validation context - /// Validation Result - public IEnumerable Validate(ValidationContext validationContext) - { - // Message (string) maxLength - if (this.Message != null && this.Message.Length > 5000) - { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Message, length must be less than 5000.", new[] { "Message" }); - } - - // Subject (string) maxLength - if (this.Subject != null && this.Subject.Length > 255) - { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Subject, length must be less than 255.", new[] { "Subject" }); - } - - // Title (string) maxLength - if (this.Title != null && this.Title.Length > 255) - { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Title, length must be less than 255.", new[] { "Title" }); - } - - yield break; - } - } - -} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs deleted file mode 100644 index 6d91c684d..000000000 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs +++ /dev/null @@ -1,558 +0,0 @@ -/* - * Dropbox Sign API - * - * Dropbox Sign v3 API - * - * The version of the OpenAPI document: 3.0.0 - * Contact: apisupport@hellosign.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ - - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.ObjectModel; -using System.Linq; -using System.IO; -using System.Runtime.Serialization; -using System.Text; -using System.Text.RegularExpressions; -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using System.ComponentModel.DataAnnotations; -using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; - -namespace Dropbox.Sign.Model -{ - /// - /// SignatureRequestEditEmbeddedWithTemplateRequest - /// - [DataContract(Name = "SignatureRequestEditEmbeddedWithTemplateRequest")] - [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] - public partial class SignatureRequestEditEmbeddedWithTemplateRequest : IOpenApiTyped, IEquatable, IValidatableObject - { - /// - /// Initializes a new instance of the class. - /// - [JsonConstructorAttribute] - protected SignatureRequestEditEmbeddedWithTemplateRequest() { } - /// - /// Initializes a new instance of the class. - /// - /// Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. (required). - /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). - /// Add CC email recipients. Required when a CC role exists for the Template.. - /// Client id of the app you're using to create this embedded signature request. Used for security purposes. (required). - /// An array defining values and options for custom fields. Required when a custom field exists in the Template.. - /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. - /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. - /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. - /// Add Signers to your Templated-based Signature Request. (required). - /// signingOptions. - /// The subject in the email that will be sent to the signers.. - /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). - /// The title you want to assign to the SignatureRequest.. - /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). - public SignatureRequestEditEmbeddedWithTemplateRequest(List templateIds = default(List), bool allowDecline = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), List files = default(List), List fileUrls = default(List), string message = default(string), Dictionary metadata = default(Dictionary), List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool populateAutoFillFields = false) - { - - // to ensure "templateIds" is required (not null) - if (templateIds == null) - { - throw new ArgumentNullException("templateIds is a required property for SignatureRequestEditEmbeddedWithTemplateRequest and cannot be null"); - } - this.TemplateIds = templateIds; - // to ensure "clientId" is required (not null) - if (clientId == null) - { - throw new ArgumentNullException("clientId is a required property for SignatureRequestEditEmbeddedWithTemplateRequest and cannot be null"); - } - this.ClientId = clientId; - // to ensure "signers" is required (not null) - if (signers == null) - { - throw new ArgumentNullException("signers is a required property for SignatureRequestEditEmbeddedWithTemplateRequest and cannot be null"); - } - this.Signers = signers; - this.AllowDecline = allowDecline; - this.Ccs = ccs; - this.CustomFields = customFields; - this.Files = files; - this.FileUrls = fileUrls; - this.Message = message; - this.Metadata = metadata; - this.SigningOptions = signingOptions; - this.Subject = subject; - this.TestMode = testMode; - this.Title = title; - this.PopulateAutoFillFields = populateAutoFillFields; - } - - /// - /// Attempt to instantiate and hydrate a new instance of this class - /// - /// String of JSON data representing target object - public static SignatureRequestEditEmbeddedWithTemplateRequest Init(string jsonData) - { - var obj = JsonConvert.DeserializeObject(jsonData); - - if (obj == null) - { - throw new Exception("Unable to deserialize JSON to instance of SignatureRequestEditEmbeddedWithTemplateRequest"); - } - - return obj; - } - - /// - /// Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. - /// - /// Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. - [DataMember(Name = "template_ids", IsRequired = true, EmitDefaultValue = true)] - public List TemplateIds { get; set; } - - /// - /// Client id of the app you're using to create this embedded signature request. Used for security purposes. - /// - /// Client id of the app you're using to create this embedded signature request. Used for security purposes. - [DataMember(Name = "client_id", IsRequired = true, EmitDefaultValue = true)] - public string ClientId { get; set; } - - /// - /// Add Signers to your Templated-based Signature Request. - /// - /// Add Signers to your Templated-based Signature Request. - [DataMember(Name = "signers", IsRequired = true, EmitDefaultValue = true)] - public List Signers { get; set; } - - /// - /// Allows signers to decline to sign a document if `true`. Defaults to `false`. - /// - /// Allows signers to decline to sign a document if `true`. Defaults to `false`. - [DataMember(Name = "allow_decline", EmitDefaultValue = true)] - public bool AllowDecline { get; set; } - - /// - /// Add CC email recipients. Required when a CC role exists for the Template. - /// - /// Add CC email recipients. Required when a CC role exists for the Template. - [DataMember(Name = "ccs", EmitDefaultValue = true)] - public List Ccs { get; set; } - - /// - /// An array defining values and options for custom fields. Required when a custom field exists in the Template. - /// - /// An array defining values and options for custom fields. Required when a custom field exists in the Template. - [DataMember(Name = "custom_fields", EmitDefaultValue = true)] - public List CustomFields { get; set; } - - /// - /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - /// - /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - [DataMember(Name = "files", EmitDefaultValue = true)] - public List Files { get; set; } - - /// - /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - /// - /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - [DataMember(Name = "file_urls", EmitDefaultValue = true)] - public List FileUrls { get; set; } - - /// - /// The custom message in the email that will be sent to the signers. - /// - /// The custom message in the email that will be sent to the signers. - [DataMember(Name = "message", EmitDefaultValue = true)] - public string Message { get; set; } - - /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. - /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. - [DataMember(Name = "metadata", EmitDefaultValue = true)] - public Dictionary Metadata { get; set; } - - /// - /// Gets or Sets SigningOptions - /// - [DataMember(Name = "signing_options", EmitDefaultValue = true)] - public SubSigningOptions SigningOptions { get; set; } - - /// - /// The subject in the email that will be sent to the signers. - /// - /// The subject in the email that will be sent to the signers. - [DataMember(Name = "subject", EmitDefaultValue = true)] - public string Subject { get; set; } - - /// - /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. - /// - /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. - [DataMember(Name = "test_mode", EmitDefaultValue = true)] - public bool TestMode { get; set; } - - /// - /// The title you want to assign to the SignatureRequest. - /// - /// The title you want to assign to the SignatureRequest. - [DataMember(Name = "title", EmitDefaultValue = true)] - public string Title { get; set; } - - /// - /// 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. - /// - /// 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. - [DataMember(Name = "populate_auto_fill_fields", EmitDefaultValue = true)] - public bool PopulateAutoFillFields { get; set; } - - /// - /// Returns the string presentation of the object - /// - /// String presentation of the object - public override string ToString() - { - StringBuilder sb = new StringBuilder(); - sb.Append("class SignatureRequestEditEmbeddedWithTemplateRequest {\n"); - sb.Append(" TemplateIds: ").Append(TemplateIds).Append("\n"); - sb.Append(" ClientId: ").Append(ClientId).Append("\n"); - sb.Append(" Signers: ").Append(Signers).Append("\n"); - sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); - sb.Append(" Ccs: ").Append(Ccs).Append("\n"); - sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); - sb.Append(" Files: ").Append(Files).Append("\n"); - sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); - sb.Append(" Message: ").Append(Message).Append("\n"); - sb.Append(" Metadata: ").Append(Metadata).Append("\n"); - sb.Append(" SigningOptions: ").Append(SigningOptions).Append("\n"); - sb.Append(" Subject: ").Append(Subject).Append("\n"); - sb.Append(" TestMode: ").Append(TestMode).Append("\n"); - sb.Append(" Title: ").Append(Title).Append("\n"); - sb.Append(" PopulateAutoFillFields: ").Append(PopulateAutoFillFields).Append("\n"); - sb.Append("}\n"); - return sb.ToString(); - } - - /// - /// Returns the JSON string presentation of the object - /// - /// JSON string presentation of the object - public virtual string ToJson() - { - return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); - } - - /// - /// Returns true if objects are equal - /// - /// Object to be compared - /// Boolean - public override bool Equals(object input) - { - return this.Equals(input as SignatureRequestEditEmbeddedWithTemplateRequest); - } - - /// - /// Returns true if SignatureRequestEditEmbeddedWithTemplateRequest instances are equal - /// - /// Instance of SignatureRequestEditEmbeddedWithTemplateRequest to be compared - /// Boolean - public bool Equals(SignatureRequestEditEmbeddedWithTemplateRequest input) - { - if (input == null) - { - return false; - } - return - ( - this.TemplateIds == input.TemplateIds || - this.TemplateIds != null && - input.TemplateIds != null && - this.TemplateIds.SequenceEqual(input.TemplateIds) - ) && - ( - this.ClientId == input.ClientId || - (this.ClientId != null && - this.ClientId.Equals(input.ClientId)) - ) && - ( - this.Signers == input.Signers || - this.Signers != null && - input.Signers != null && - this.Signers.SequenceEqual(input.Signers) - ) && - ( - this.AllowDecline == input.AllowDecline || - this.AllowDecline.Equals(input.AllowDecline) - ) && - ( - this.Ccs == input.Ccs || - this.Ccs != null && - input.Ccs != null && - this.Ccs.SequenceEqual(input.Ccs) - ) && - ( - this.CustomFields == input.CustomFields || - this.CustomFields != null && - input.CustomFields != null && - this.CustomFields.SequenceEqual(input.CustomFields) - ) && - ( - this.Files == input.Files || - this.Files != null && - input.Files != null && - this.Files.SequenceEqual(input.Files) - ) && - ( - this.FileUrls == input.FileUrls || - this.FileUrls != null && - input.FileUrls != null && - this.FileUrls.SequenceEqual(input.FileUrls) - ) && - ( - this.Message == input.Message || - (this.Message != null && - this.Message.Equals(input.Message)) - ) && - ( - this.Metadata == input.Metadata || - this.Metadata != null && - input.Metadata != null && - this.Metadata.SequenceEqual(input.Metadata) - ) && - ( - this.SigningOptions == input.SigningOptions || - (this.SigningOptions != null && - this.SigningOptions.Equals(input.SigningOptions)) - ) && - ( - this.Subject == input.Subject || - (this.Subject != null && - this.Subject.Equals(input.Subject)) - ) && - ( - this.TestMode == input.TestMode || - this.TestMode.Equals(input.TestMode) - ) && - ( - this.Title == input.Title || - (this.Title != null && - this.Title.Equals(input.Title)) - ) && - ( - this.PopulateAutoFillFields == input.PopulateAutoFillFields || - this.PopulateAutoFillFields.Equals(input.PopulateAutoFillFields) - ); - } - - /// - /// Gets the hash code - /// - /// Hash code - public override int GetHashCode() - { - unchecked // Overflow is fine, just wrap - { - int hashCode = 41; - if (this.TemplateIds != null) - { - hashCode = (hashCode * 59) + this.TemplateIds.GetHashCode(); - } - if (this.ClientId != null) - { - hashCode = (hashCode * 59) + this.ClientId.GetHashCode(); - } - if (this.Signers != null) - { - hashCode = (hashCode * 59) + this.Signers.GetHashCode(); - } - hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); - if (this.Ccs != null) - { - hashCode = (hashCode * 59) + this.Ccs.GetHashCode(); - } - if (this.CustomFields != null) - { - hashCode = (hashCode * 59) + this.CustomFields.GetHashCode(); - } - if (this.Files != null) - { - hashCode = (hashCode * 59) + this.Files.GetHashCode(); - } - if (this.FileUrls != null) - { - hashCode = (hashCode * 59) + this.FileUrls.GetHashCode(); - } - if (this.Message != null) - { - hashCode = (hashCode * 59) + this.Message.GetHashCode(); - } - if (this.Metadata != null) - { - hashCode = (hashCode * 59) + this.Metadata.GetHashCode(); - } - if (this.SigningOptions != null) - { - hashCode = (hashCode * 59) + this.SigningOptions.GetHashCode(); - } - if (this.Subject != null) - { - hashCode = (hashCode * 59) + this.Subject.GetHashCode(); - } - hashCode = (hashCode * 59) + this.TestMode.GetHashCode(); - if (this.Title != null) - { - hashCode = (hashCode * 59) + this.Title.GetHashCode(); - } - hashCode = (hashCode * 59) + this.PopulateAutoFillFields.GetHashCode(); - return hashCode; - } - } - - public List GetOpenApiTypes() - { - var types = new List(); - types.Add(new OpenApiType() - { - Name = "template_ids", - Property = "TemplateIds", - Type = "List", - Value = TemplateIds, - }); - types.Add(new OpenApiType() - { - Name = "client_id", - Property = "ClientId", - Type = "string", - Value = ClientId, - }); - types.Add(new OpenApiType() - { - Name = "signers", - Property = "Signers", - Type = "List", - Value = Signers, - }); - types.Add(new OpenApiType() - { - Name = "allow_decline", - Property = "AllowDecline", - Type = "bool", - Value = AllowDecline, - }); - types.Add(new OpenApiType() - { - Name = "ccs", - Property = "Ccs", - Type = "List", - Value = Ccs, - }); - types.Add(new OpenApiType() - { - Name = "custom_fields", - Property = "CustomFields", - Type = "List", - Value = CustomFields, - }); - types.Add(new OpenApiType() - { - Name = "files", - Property = "Files", - Type = "List", - Value = Files, - }); - types.Add(new OpenApiType() - { - Name = "file_urls", - Property = "FileUrls", - Type = "List", - Value = FileUrls, - }); - types.Add(new OpenApiType() - { - Name = "message", - Property = "Message", - Type = "string", - Value = Message, - }); - types.Add(new OpenApiType() - { - Name = "metadata", - Property = "Metadata", - Type = "Dictionary", - Value = Metadata, - }); - types.Add(new OpenApiType() - { - Name = "signing_options", - Property = "SigningOptions", - Type = "SubSigningOptions", - Value = SigningOptions, - }); - types.Add(new OpenApiType() - { - Name = "subject", - Property = "Subject", - Type = "string", - Value = Subject, - }); - types.Add(new OpenApiType() - { - Name = "test_mode", - Property = "TestMode", - Type = "bool", - Value = TestMode, - }); - types.Add(new OpenApiType() - { - Name = "title", - Property = "Title", - Type = "string", - Value = Title, - }); - types.Add(new OpenApiType() - { - Name = "populate_auto_fill_fields", - Property = "PopulateAutoFillFields", - Type = "bool", - Value = PopulateAutoFillFields, - }); - - return types; - } - - /// - /// To validate all properties of the instance - /// - /// Validation context - /// Validation Result - public IEnumerable Validate(ValidationContext validationContext) - { - // Message (string) maxLength - if (this.Message != null && this.Message.Length > 5000) - { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Message, length must be less than 5000.", new[] { "Message" }); - } - - // Subject (string) maxLength - if (this.Subject != null && this.Subject.Length > 255) - { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Subject, length must be less than 255.", new[] { "Subject" }); - } - - // Title (string) maxLength - if (this.Title != null && this.Title.Length > 255) - { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Title, length must be less than 255.", new[] { "Title" }); - } - - yield break; - } - } - -} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs deleted file mode 100644 index 02b19c235..000000000 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs +++ /dev/null @@ -1,817 +0,0 @@ -/* - * Dropbox Sign API - * - * Dropbox Sign v3 API - * - * The version of the OpenAPI document: 3.0.0 - * Contact: apisupport@hellosign.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ - - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.ObjectModel; -using System.Linq; -using System.IO; -using System.Runtime.Serialization; -using System.Text; -using System.Text.RegularExpressions; -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using System.ComponentModel.DataAnnotations; -using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; - -namespace Dropbox.Sign.Model -{ - /// - /// SignatureRequestEditRequest - /// - [DataContract(Name = "SignatureRequestEditRequest")] - [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] - public partial class SignatureRequestEditRequest : IOpenApiTyped, IEquatable, IValidatableObject - { - /// - /// Initializes a new instance of the class. - /// - [JsonConstructorAttribute] - protected SignatureRequestEditRequest() { } - /// - /// Initializes a new instance of the class. - /// - /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. - /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. - /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). - /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. (default to false). - /// A list describing the attachments. - /// The email addresses that should be CCed.. - /// The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.. - /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.. - /// fieldOptions. - /// Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.. - /// Conditional Logic rules for fields defined in `form_fields_per_document`.. - /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`. - /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. (default to false). - /// Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. (default to false). - /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. (default to false). - /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. - /// signingOptions. - /// The URL you want signers redirected to after they successfully sign.. - /// The subject in the email that will be sent to the signers.. - /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). - /// The title you want to assign to the SignatureRequest.. - /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). - /// 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.. - public SignatureRequestEditRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, int? expiresAt = default(int?)) - { - - this.Files = files; - this.FileUrls = fileUrls; - this.Signers = signers; - this.GroupedSigners = groupedSigners; - this.AllowDecline = allowDecline; - this.AllowReassign = allowReassign; - this.Attachments = attachments; - this.CcEmailAddresses = ccEmailAddresses; - this.ClientId = clientId; - this.CustomFields = customFields; - this.FieldOptions = fieldOptions; - this.FormFieldGroups = formFieldGroups; - this.FormFieldRules = formFieldRules; - this.FormFieldsPerDocument = formFieldsPerDocument; - this.HideTextTags = hideTextTags; - this.IsQualifiedSignature = isQualifiedSignature; - this.IsEid = isEid; - this.Message = message; - this.Metadata = metadata; - this.SigningOptions = signingOptions; - this.SigningRedirectUrl = signingRedirectUrl; - this.Subject = subject; - this.TestMode = testMode; - this.Title = title; - this.UseTextTags = useTextTags; - this.ExpiresAt = expiresAt; - } - - /// - /// Attempt to instantiate and hydrate a new instance of this class - /// - /// String of JSON data representing target object - public static SignatureRequestEditRequest Init(string jsonData) - { - var obj = JsonConvert.DeserializeObject(jsonData); - - if (obj == null) - { - throw new Exception("Unable to deserialize JSON to instance of SignatureRequestEditRequest"); - } - - return obj; - } - - /// - /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - /// - /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - [DataMember(Name = "files", EmitDefaultValue = true)] - public List Files { get; set; } - - /// - /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - /// - /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - [DataMember(Name = "file_urls", EmitDefaultValue = true)] - public List FileUrls { get; set; } - - /// - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. - /// - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. - [DataMember(Name = "signers", EmitDefaultValue = true)] - public List Signers { get; set; } - - /// - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. - /// - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. - [DataMember(Name = "grouped_signers", EmitDefaultValue = true)] - public List GroupedSigners { get; set; } - - /// - /// Allows signers to decline to sign a document if `true`. Defaults to `false`. - /// - /// Allows signers to decline to sign a document if `true`. Defaults to `false`. - [DataMember(Name = "allow_decline", EmitDefaultValue = true)] - public bool AllowDecline { get; set; } - - /// - /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. - /// - /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. - [DataMember(Name = "allow_reassign", EmitDefaultValue = true)] - public bool AllowReassign { get; set; } - - /// - /// A list describing the attachments - /// - /// A list describing the attachments - [DataMember(Name = "attachments", EmitDefaultValue = true)] - public List Attachments { get; set; } - - /// - /// The email addresses that should be CCed. - /// - /// The email addresses that should be CCed. - [DataMember(Name = "cc_email_addresses", EmitDefaultValue = true)] - public List CcEmailAddresses { get; set; } - - /// - /// The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. - /// - /// The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. - [DataMember(Name = "client_id", EmitDefaultValue = true)] - public string ClientId { get; set; } - - /// - /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. - /// - /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. - [DataMember(Name = "custom_fields", EmitDefaultValue = true)] - public List CustomFields { get; set; } - - /// - /// Gets or Sets FieldOptions - /// - [DataMember(Name = "field_options", EmitDefaultValue = true)] - public SubFieldOptions FieldOptions { get; set; } - - /// - /// Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. - /// - /// Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. - [DataMember(Name = "form_field_groups", EmitDefaultValue = true)] - public List FormFieldGroups { get; set; } - - /// - /// Conditional Logic rules for fields defined in `form_fields_per_document`. - /// - /// Conditional Logic rules for fields defined in `form_fields_per_document`. - [DataMember(Name = "form_field_rules", EmitDefaultValue = true)] - public List FormFieldRules { get; set; } - - /// - /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` - /// - /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` - [DataMember(Name = "form_fields_per_document", EmitDefaultValue = true)] - public List FormFieldsPerDocument { get; set; } - - /// - /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. - /// - /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. - [DataMember(Name = "hide_text_tags", EmitDefaultValue = true)] - public bool HideTextTags { get; set; } - - /// - /// Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. - /// - /// Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. - [DataMember(Name = "is_qualified_signature", EmitDefaultValue = true)] - [Obsolete] - public bool IsQualifiedSignature { get; set; } - - /// - /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. - /// - /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. - [DataMember(Name = "is_eid", EmitDefaultValue = true)] - public bool IsEid { get; set; } - - /// - /// The custom message in the email that will be sent to the signers. - /// - /// The custom message in the email that will be sent to the signers. - [DataMember(Name = "message", EmitDefaultValue = true)] - public string Message { get; set; } - - /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. - /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. - [DataMember(Name = "metadata", EmitDefaultValue = true)] - public Dictionary Metadata { get; set; } - - /// - /// Gets or Sets SigningOptions - /// - [DataMember(Name = "signing_options", EmitDefaultValue = true)] - public SubSigningOptions SigningOptions { get; set; } - - /// - /// The URL you want signers redirected to after they successfully sign. - /// - /// The URL you want signers redirected to after they successfully sign. - [DataMember(Name = "signing_redirect_url", EmitDefaultValue = true)] - public string SigningRedirectUrl { get; set; } - - /// - /// The subject in the email that will be sent to the signers. - /// - /// The subject in the email that will be sent to the signers. - [DataMember(Name = "subject", EmitDefaultValue = true)] - public string Subject { get; set; } - - /// - /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. - /// - /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. - [DataMember(Name = "test_mode", EmitDefaultValue = true)] - public bool TestMode { get; set; } - - /// - /// The title you want to assign to the SignatureRequest. - /// - /// The title you want to assign to the SignatureRequest. - [DataMember(Name = "title", EmitDefaultValue = true)] - public string Title { get; set; } - - /// - /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. - /// - /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. - [DataMember(Name = "use_text_tags", EmitDefaultValue = true)] - public bool UseTextTags { get; set; } - - /// - /// 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. - /// - /// 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. - [DataMember(Name = "expires_at", EmitDefaultValue = true)] - public int? ExpiresAt { get; set; } - - /// - /// Returns the string presentation of the object - /// - /// String presentation of the object - public override string ToString() - { - StringBuilder sb = new StringBuilder(); - sb.Append("class SignatureRequestEditRequest {\n"); - sb.Append(" Files: ").Append(Files).Append("\n"); - sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); - sb.Append(" Signers: ").Append(Signers).Append("\n"); - sb.Append(" GroupedSigners: ").Append(GroupedSigners).Append("\n"); - sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); - sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); - sb.Append(" Attachments: ").Append(Attachments).Append("\n"); - sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); - sb.Append(" ClientId: ").Append(ClientId).Append("\n"); - sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); - sb.Append(" FieldOptions: ").Append(FieldOptions).Append("\n"); - sb.Append(" FormFieldGroups: ").Append(FormFieldGroups).Append("\n"); - sb.Append(" FormFieldRules: ").Append(FormFieldRules).Append("\n"); - sb.Append(" FormFieldsPerDocument: ").Append(FormFieldsPerDocument).Append("\n"); - sb.Append(" HideTextTags: ").Append(HideTextTags).Append("\n"); - sb.Append(" IsQualifiedSignature: ").Append(IsQualifiedSignature).Append("\n"); - sb.Append(" IsEid: ").Append(IsEid).Append("\n"); - sb.Append(" Message: ").Append(Message).Append("\n"); - sb.Append(" Metadata: ").Append(Metadata).Append("\n"); - sb.Append(" SigningOptions: ").Append(SigningOptions).Append("\n"); - sb.Append(" SigningRedirectUrl: ").Append(SigningRedirectUrl).Append("\n"); - sb.Append(" Subject: ").Append(Subject).Append("\n"); - sb.Append(" TestMode: ").Append(TestMode).Append("\n"); - sb.Append(" Title: ").Append(Title).Append("\n"); - sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); - sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); - sb.Append("}\n"); - return sb.ToString(); - } - - /// - /// Returns the JSON string presentation of the object - /// - /// JSON string presentation of the object - public virtual string ToJson() - { - return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); - } - - /// - /// Returns true if objects are equal - /// - /// Object to be compared - /// Boolean - public override bool Equals(object input) - { - return this.Equals(input as SignatureRequestEditRequest); - } - - /// - /// Returns true if SignatureRequestEditRequest instances are equal - /// - /// Instance of SignatureRequestEditRequest to be compared - /// Boolean - public bool Equals(SignatureRequestEditRequest input) - { - if (input == null) - { - return false; - } - return - ( - this.Files == input.Files || - this.Files != null && - input.Files != null && - this.Files.SequenceEqual(input.Files) - ) && - ( - this.FileUrls == input.FileUrls || - this.FileUrls != null && - input.FileUrls != null && - this.FileUrls.SequenceEqual(input.FileUrls) - ) && - ( - this.Signers == input.Signers || - this.Signers != null && - input.Signers != null && - this.Signers.SequenceEqual(input.Signers) - ) && - ( - this.GroupedSigners == input.GroupedSigners || - this.GroupedSigners != null && - input.GroupedSigners != null && - this.GroupedSigners.SequenceEqual(input.GroupedSigners) - ) && - ( - this.AllowDecline == input.AllowDecline || - this.AllowDecline.Equals(input.AllowDecline) - ) && - ( - this.AllowReassign == input.AllowReassign || - this.AllowReassign.Equals(input.AllowReassign) - ) && - ( - this.Attachments == input.Attachments || - this.Attachments != null && - input.Attachments != null && - this.Attachments.SequenceEqual(input.Attachments) - ) && - ( - this.CcEmailAddresses == input.CcEmailAddresses || - this.CcEmailAddresses != null && - input.CcEmailAddresses != null && - this.CcEmailAddresses.SequenceEqual(input.CcEmailAddresses) - ) && - ( - this.ClientId == input.ClientId || - (this.ClientId != null && - this.ClientId.Equals(input.ClientId)) - ) && - ( - this.CustomFields == input.CustomFields || - this.CustomFields != null && - input.CustomFields != null && - this.CustomFields.SequenceEqual(input.CustomFields) - ) && - ( - this.FieldOptions == input.FieldOptions || - (this.FieldOptions != null && - this.FieldOptions.Equals(input.FieldOptions)) - ) && - ( - this.FormFieldGroups == input.FormFieldGroups || - this.FormFieldGroups != null && - input.FormFieldGroups != null && - this.FormFieldGroups.SequenceEqual(input.FormFieldGroups) - ) && - ( - this.FormFieldRules == input.FormFieldRules || - this.FormFieldRules != null && - input.FormFieldRules != null && - this.FormFieldRules.SequenceEqual(input.FormFieldRules) - ) && - ( - this.FormFieldsPerDocument == input.FormFieldsPerDocument || - this.FormFieldsPerDocument != null && - input.FormFieldsPerDocument != null && - this.FormFieldsPerDocument.SequenceEqual(input.FormFieldsPerDocument) - ) && - ( - this.HideTextTags == input.HideTextTags || - this.HideTextTags.Equals(input.HideTextTags) - ) && - ( - this.IsQualifiedSignature == input.IsQualifiedSignature || - this.IsQualifiedSignature.Equals(input.IsQualifiedSignature) - ) && - ( - this.IsEid == input.IsEid || - this.IsEid.Equals(input.IsEid) - ) && - ( - this.Message == input.Message || - (this.Message != null && - this.Message.Equals(input.Message)) - ) && - ( - this.Metadata == input.Metadata || - this.Metadata != null && - input.Metadata != null && - this.Metadata.SequenceEqual(input.Metadata) - ) && - ( - this.SigningOptions == input.SigningOptions || - (this.SigningOptions != null && - this.SigningOptions.Equals(input.SigningOptions)) - ) && - ( - this.SigningRedirectUrl == input.SigningRedirectUrl || - (this.SigningRedirectUrl != null && - this.SigningRedirectUrl.Equals(input.SigningRedirectUrl)) - ) && - ( - this.Subject == input.Subject || - (this.Subject != null && - this.Subject.Equals(input.Subject)) - ) && - ( - this.TestMode == input.TestMode || - this.TestMode.Equals(input.TestMode) - ) && - ( - this.Title == input.Title || - (this.Title != null && - this.Title.Equals(input.Title)) - ) && - ( - this.UseTextTags == input.UseTextTags || - this.UseTextTags.Equals(input.UseTextTags) - ) && - ( - this.ExpiresAt == input.ExpiresAt || - (this.ExpiresAt != null && - this.ExpiresAt.Equals(input.ExpiresAt)) - ); - } - - /// - /// Gets the hash code - /// - /// Hash code - public override int GetHashCode() - { - unchecked // Overflow is fine, just wrap - { - int hashCode = 41; - if (this.Files != null) - { - hashCode = (hashCode * 59) + this.Files.GetHashCode(); - } - if (this.FileUrls != null) - { - hashCode = (hashCode * 59) + this.FileUrls.GetHashCode(); - } - if (this.Signers != null) - { - hashCode = (hashCode * 59) + this.Signers.GetHashCode(); - } - if (this.GroupedSigners != null) - { - hashCode = (hashCode * 59) + this.GroupedSigners.GetHashCode(); - } - hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); - hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); - if (this.Attachments != null) - { - hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); - } - if (this.CcEmailAddresses != null) - { - hashCode = (hashCode * 59) + this.CcEmailAddresses.GetHashCode(); - } - if (this.ClientId != null) - { - hashCode = (hashCode * 59) + this.ClientId.GetHashCode(); - } - if (this.CustomFields != null) - { - hashCode = (hashCode * 59) + this.CustomFields.GetHashCode(); - } - if (this.FieldOptions != null) - { - hashCode = (hashCode * 59) + this.FieldOptions.GetHashCode(); - } - if (this.FormFieldGroups != null) - { - hashCode = (hashCode * 59) + this.FormFieldGroups.GetHashCode(); - } - if (this.FormFieldRules != null) - { - hashCode = (hashCode * 59) + this.FormFieldRules.GetHashCode(); - } - if (this.FormFieldsPerDocument != null) - { - hashCode = (hashCode * 59) + this.FormFieldsPerDocument.GetHashCode(); - } - hashCode = (hashCode * 59) + this.HideTextTags.GetHashCode(); - hashCode = (hashCode * 59) + this.IsQualifiedSignature.GetHashCode(); - hashCode = (hashCode * 59) + this.IsEid.GetHashCode(); - if (this.Message != null) - { - hashCode = (hashCode * 59) + this.Message.GetHashCode(); - } - if (this.Metadata != null) - { - hashCode = (hashCode * 59) + this.Metadata.GetHashCode(); - } - if (this.SigningOptions != null) - { - hashCode = (hashCode * 59) + this.SigningOptions.GetHashCode(); - } - if (this.SigningRedirectUrl != null) - { - hashCode = (hashCode * 59) + this.SigningRedirectUrl.GetHashCode(); - } - if (this.Subject != null) - { - hashCode = (hashCode * 59) + this.Subject.GetHashCode(); - } - hashCode = (hashCode * 59) + this.TestMode.GetHashCode(); - if (this.Title != null) - { - hashCode = (hashCode * 59) + this.Title.GetHashCode(); - } - hashCode = (hashCode * 59) + this.UseTextTags.GetHashCode(); - if (this.ExpiresAt != null) - { - hashCode = (hashCode * 59) + this.ExpiresAt.GetHashCode(); - } - return hashCode; - } - } - - public List GetOpenApiTypes() - { - var types = new List(); - types.Add(new OpenApiType() - { - Name = "files", - Property = "Files", - Type = "List", - Value = Files, - }); - types.Add(new OpenApiType() - { - Name = "file_urls", - Property = "FileUrls", - Type = "List", - Value = FileUrls, - }); - types.Add(new OpenApiType() - { - Name = "signers", - Property = "Signers", - Type = "List", - Value = Signers, - }); - types.Add(new OpenApiType() - { - Name = "grouped_signers", - Property = "GroupedSigners", - Type = "List", - Value = GroupedSigners, - }); - types.Add(new OpenApiType() - { - Name = "allow_decline", - Property = "AllowDecline", - Type = "bool", - Value = AllowDecline, - }); - types.Add(new OpenApiType() - { - Name = "allow_reassign", - Property = "AllowReassign", - Type = "bool", - Value = AllowReassign, - }); - types.Add(new OpenApiType() - { - Name = "attachments", - Property = "Attachments", - Type = "List", - Value = Attachments, - }); - types.Add(new OpenApiType() - { - Name = "cc_email_addresses", - Property = "CcEmailAddresses", - Type = "List", - Value = CcEmailAddresses, - }); - types.Add(new OpenApiType() - { - Name = "client_id", - Property = "ClientId", - Type = "string", - Value = ClientId, - }); - types.Add(new OpenApiType() - { - Name = "custom_fields", - Property = "CustomFields", - Type = "List", - Value = CustomFields, - }); - types.Add(new OpenApiType() - { - Name = "field_options", - Property = "FieldOptions", - Type = "SubFieldOptions", - Value = FieldOptions, - }); - types.Add(new OpenApiType() - { - Name = "form_field_groups", - Property = "FormFieldGroups", - Type = "List", - Value = FormFieldGroups, - }); - types.Add(new OpenApiType() - { - Name = "form_field_rules", - Property = "FormFieldRules", - Type = "List", - Value = FormFieldRules, - }); - types.Add(new OpenApiType() - { - Name = "form_fields_per_document", - Property = "FormFieldsPerDocument", - Type = "List", - Value = FormFieldsPerDocument, - }); - types.Add(new OpenApiType() - { - Name = "hide_text_tags", - Property = "HideTextTags", - Type = "bool", - Value = HideTextTags, - }); - types.Add(new OpenApiType() - { - Name = "is_qualified_signature", - Property = "IsQualifiedSignature", - Type = "bool", - Value = IsQualifiedSignature, - }); - types.Add(new OpenApiType() - { - Name = "is_eid", - Property = "IsEid", - Type = "bool", - Value = IsEid, - }); - types.Add(new OpenApiType() - { - Name = "message", - Property = "Message", - Type = "string", - Value = Message, - }); - types.Add(new OpenApiType() - { - Name = "metadata", - Property = "Metadata", - Type = "Dictionary", - Value = Metadata, - }); - types.Add(new OpenApiType() - { - Name = "signing_options", - Property = "SigningOptions", - Type = "SubSigningOptions", - Value = SigningOptions, - }); - types.Add(new OpenApiType() - { - Name = "signing_redirect_url", - Property = "SigningRedirectUrl", - Type = "string", - Value = SigningRedirectUrl, - }); - types.Add(new OpenApiType() - { - Name = "subject", - Property = "Subject", - Type = "string", - Value = Subject, - }); - types.Add(new OpenApiType() - { - Name = "test_mode", - Property = "TestMode", - Type = "bool", - Value = TestMode, - }); - types.Add(new OpenApiType() - { - Name = "title", - Property = "Title", - Type = "string", - Value = Title, - }); - types.Add(new OpenApiType() - { - Name = "use_text_tags", - Property = "UseTextTags", - Type = "bool", - Value = UseTextTags, - }); - types.Add(new OpenApiType() - { - Name = "expires_at", - Property = "ExpiresAt", - Type = "int?", - Value = ExpiresAt, - }); - - return types; - } - - /// - /// To validate all properties of the instance - /// - /// Validation context - /// Validation Result - public IEnumerable Validate(ValidationContext validationContext) - { - // Message (string) maxLength - if (this.Message != null && this.Message.Length > 5000) - { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Message, length must be less than 5000.", new[] { "Message" }); - } - - // Subject (string) maxLength - if (this.Subject != null && this.Subject.Length > 255) - { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Subject, length must be less than 255.", new[] { "Subject" }); - } - - // Title (string) maxLength - if (this.Title != null && this.Title.Length > 255) - { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Title, length must be less than 255.", new[] { "Title" }); - } - - yield break; - } - } - -} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs deleted file mode 100644 index 437003358..000000000 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs +++ /dev/null @@ -1,602 +0,0 @@ -/* - * Dropbox Sign API - * - * Dropbox Sign v3 API - * - * The version of the OpenAPI document: 3.0.0 - * Contact: apisupport@hellosign.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ - - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.ObjectModel; -using System.Linq; -using System.IO; -using System.Runtime.Serialization; -using System.Text; -using System.Text.RegularExpressions; -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using System.ComponentModel.DataAnnotations; -using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; - -namespace Dropbox.Sign.Model -{ - /// - /// SignatureRequestEditWithTemplateRequest - /// - [DataContract(Name = "SignatureRequestEditWithTemplateRequest")] - [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] - public partial class SignatureRequestEditWithTemplateRequest : IOpenApiTyped, IEquatable, IValidatableObject - { - /// - /// Initializes a new instance of the class. - /// - [JsonConstructorAttribute] - protected SignatureRequestEditWithTemplateRequest() { } - /// - /// Initializes a new instance of the class. - /// - /// Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. (required). - /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). - /// Add CC email recipients. Required when a CC role exists for the Template.. - /// Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.. - /// An array defining values and options for custom fields. Required when a custom field exists in the Template.. - /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. - /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. - /// Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. (default to false). - /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. (default to false). - /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. - /// Add Signers to your Templated-based Signature Request. (required). - /// signingOptions. - /// The URL you want signers redirected to after they successfully sign.. - /// The subject in the email that will be sent to the signers.. - /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). - /// The title you want to assign to the SignatureRequest.. - public SignatureRequestEditWithTemplateRequest(List templateIds = default(List), bool allowDecline = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), List files = default(List), List fileUrls = default(List), bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string)) - { - - // to ensure "templateIds" is required (not null) - if (templateIds == null) - { - throw new ArgumentNullException("templateIds is a required property for SignatureRequestEditWithTemplateRequest and cannot be null"); - } - this.TemplateIds = templateIds; - // to ensure "signers" is required (not null) - if (signers == null) - { - throw new ArgumentNullException("signers is a required property for SignatureRequestEditWithTemplateRequest and cannot be null"); - } - this.Signers = signers; - this.AllowDecline = allowDecline; - this.Ccs = ccs; - this.ClientId = clientId; - this.CustomFields = customFields; - this.Files = files; - this.FileUrls = fileUrls; - this.IsQualifiedSignature = isQualifiedSignature; - this.IsEid = isEid; - this.Message = message; - this.Metadata = metadata; - this.SigningOptions = signingOptions; - this.SigningRedirectUrl = signingRedirectUrl; - this.Subject = subject; - this.TestMode = testMode; - this.Title = title; - } - - /// - /// Attempt to instantiate and hydrate a new instance of this class - /// - /// String of JSON data representing target object - public static SignatureRequestEditWithTemplateRequest Init(string jsonData) - { - var obj = JsonConvert.DeserializeObject(jsonData); - - if (obj == null) - { - throw new Exception("Unable to deserialize JSON to instance of SignatureRequestEditWithTemplateRequest"); - } - - return obj; - } - - /// - /// Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. - /// - /// Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. - [DataMember(Name = "template_ids", IsRequired = true, EmitDefaultValue = true)] - public List TemplateIds { get; set; } - - /// - /// Add Signers to your Templated-based Signature Request. - /// - /// Add Signers to your Templated-based Signature Request. - [DataMember(Name = "signers", IsRequired = true, EmitDefaultValue = true)] - public List Signers { get; set; } - - /// - /// Allows signers to decline to sign a document if `true`. Defaults to `false`. - /// - /// Allows signers to decline to sign a document if `true`. Defaults to `false`. - [DataMember(Name = "allow_decline", EmitDefaultValue = true)] - public bool AllowDecline { get; set; } - - /// - /// Add CC email recipients. Required when a CC role exists for the Template. - /// - /// Add CC email recipients. Required when a CC role exists for the Template. - [DataMember(Name = "ccs", EmitDefaultValue = true)] - public List Ccs { get; set; } - - /// - /// Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. - /// - /// Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. - [DataMember(Name = "client_id", EmitDefaultValue = true)] - public string ClientId { get; set; } - - /// - /// An array defining values and options for custom fields. Required when a custom field exists in the Template. - /// - /// An array defining values and options for custom fields. Required when a custom field exists in the Template. - [DataMember(Name = "custom_fields", EmitDefaultValue = true)] - public List CustomFields { get; set; } - - /// - /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - /// - /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - [DataMember(Name = "files", EmitDefaultValue = true)] - public List Files { get; set; } - - /// - /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - /// - /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. - [DataMember(Name = "file_urls", EmitDefaultValue = true)] - public List FileUrls { get; set; } - - /// - /// Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. - /// - /// Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. - [DataMember(Name = "is_qualified_signature", EmitDefaultValue = true)] - [Obsolete] - public bool IsQualifiedSignature { get; set; } - - /// - /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. - /// - /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. - [DataMember(Name = "is_eid", EmitDefaultValue = true)] - public bool IsEid { get; set; } - - /// - /// The custom message in the email that will be sent to the signers. - /// - /// The custom message in the email that will be sent to the signers. - [DataMember(Name = "message", EmitDefaultValue = true)] - public string Message { get; set; } - - /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. - /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. - [DataMember(Name = "metadata", EmitDefaultValue = true)] - public Dictionary Metadata { get; set; } - - /// - /// Gets or Sets SigningOptions - /// - [DataMember(Name = "signing_options", EmitDefaultValue = true)] - public SubSigningOptions SigningOptions { get; set; } - - /// - /// The URL you want signers redirected to after they successfully sign. - /// - /// The URL you want signers redirected to after they successfully sign. - [DataMember(Name = "signing_redirect_url", EmitDefaultValue = true)] - public string SigningRedirectUrl { get; set; } - - /// - /// The subject in the email that will be sent to the signers. - /// - /// The subject in the email that will be sent to the signers. - [DataMember(Name = "subject", EmitDefaultValue = true)] - public string Subject { get; set; } - - /// - /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. - /// - /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. - [DataMember(Name = "test_mode", EmitDefaultValue = true)] - public bool TestMode { get; set; } - - /// - /// The title you want to assign to the SignatureRequest. - /// - /// The title you want to assign to the SignatureRequest. - [DataMember(Name = "title", EmitDefaultValue = true)] - public string Title { get; set; } - - /// - /// Returns the string presentation of the object - /// - /// String presentation of the object - public override string ToString() - { - StringBuilder sb = new StringBuilder(); - sb.Append("class SignatureRequestEditWithTemplateRequest {\n"); - sb.Append(" TemplateIds: ").Append(TemplateIds).Append("\n"); - sb.Append(" Signers: ").Append(Signers).Append("\n"); - sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); - sb.Append(" Ccs: ").Append(Ccs).Append("\n"); - sb.Append(" ClientId: ").Append(ClientId).Append("\n"); - sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); - sb.Append(" Files: ").Append(Files).Append("\n"); - sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); - sb.Append(" IsQualifiedSignature: ").Append(IsQualifiedSignature).Append("\n"); - sb.Append(" IsEid: ").Append(IsEid).Append("\n"); - sb.Append(" Message: ").Append(Message).Append("\n"); - sb.Append(" Metadata: ").Append(Metadata).Append("\n"); - sb.Append(" SigningOptions: ").Append(SigningOptions).Append("\n"); - sb.Append(" SigningRedirectUrl: ").Append(SigningRedirectUrl).Append("\n"); - sb.Append(" Subject: ").Append(Subject).Append("\n"); - sb.Append(" TestMode: ").Append(TestMode).Append("\n"); - sb.Append(" Title: ").Append(Title).Append("\n"); - sb.Append("}\n"); - return sb.ToString(); - } - - /// - /// Returns the JSON string presentation of the object - /// - /// JSON string presentation of the object - public virtual string ToJson() - { - return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); - } - - /// - /// Returns true if objects are equal - /// - /// Object to be compared - /// Boolean - public override bool Equals(object input) - { - return this.Equals(input as SignatureRequestEditWithTemplateRequest); - } - - /// - /// Returns true if SignatureRequestEditWithTemplateRequest instances are equal - /// - /// Instance of SignatureRequestEditWithTemplateRequest to be compared - /// Boolean - public bool Equals(SignatureRequestEditWithTemplateRequest input) - { - if (input == null) - { - return false; - } - return - ( - this.TemplateIds == input.TemplateIds || - this.TemplateIds != null && - input.TemplateIds != null && - this.TemplateIds.SequenceEqual(input.TemplateIds) - ) && - ( - this.Signers == input.Signers || - this.Signers != null && - input.Signers != null && - this.Signers.SequenceEqual(input.Signers) - ) && - ( - this.AllowDecline == input.AllowDecline || - this.AllowDecline.Equals(input.AllowDecline) - ) && - ( - this.Ccs == input.Ccs || - this.Ccs != null && - input.Ccs != null && - this.Ccs.SequenceEqual(input.Ccs) - ) && - ( - this.ClientId == input.ClientId || - (this.ClientId != null && - this.ClientId.Equals(input.ClientId)) - ) && - ( - this.CustomFields == input.CustomFields || - this.CustomFields != null && - input.CustomFields != null && - this.CustomFields.SequenceEqual(input.CustomFields) - ) && - ( - this.Files == input.Files || - this.Files != null && - input.Files != null && - this.Files.SequenceEqual(input.Files) - ) && - ( - this.FileUrls == input.FileUrls || - this.FileUrls != null && - input.FileUrls != null && - this.FileUrls.SequenceEqual(input.FileUrls) - ) && - ( - this.IsQualifiedSignature == input.IsQualifiedSignature || - this.IsQualifiedSignature.Equals(input.IsQualifiedSignature) - ) && - ( - this.IsEid == input.IsEid || - this.IsEid.Equals(input.IsEid) - ) && - ( - this.Message == input.Message || - (this.Message != null && - this.Message.Equals(input.Message)) - ) && - ( - this.Metadata == input.Metadata || - this.Metadata != null && - input.Metadata != null && - this.Metadata.SequenceEqual(input.Metadata) - ) && - ( - this.SigningOptions == input.SigningOptions || - (this.SigningOptions != null && - this.SigningOptions.Equals(input.SigningOptions)) - ) && - ( - this.SigningRedirectUrl == input.SigningRedirectUrl || - (this.SigningRedirectUrl != null && - this.SigningRedirectUrl.Equals(input.SigningRedirectUrl)) - ) && - ( - this.Subject == input.Subject || - (this.Subject != null && - this.Subject.Equals(input.Subject)) - ) && - ( - this.TestMode == input.TestMode || - this.TestMode.Equals(input.TestMode) - ) && - ( - this.Title == input.Title || - (this.Title != null && - this.Title.Equals(input.Title)) - ); - } - - /// - /// Gets the hash code - /// - /// Hash code - public override int GetHashCode() - { - unchecked // Overflow is fine, just wrap - { - int hashCode = 41; - if (this.TemplateIds != null) - { - hashCode = (hashCode * 59) + this.TemplateIds.GetHashCode(); - } - if (this.Signers != null) - { - hashCode = (hashCode * 59) + this.Signers.GetHashCode(); - } - hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); - if (this.Ccs != null) - { - hashCode = (hashCode * 59) + this.Ccs.GetHashCode(); - } - if (this.ClientId != null) - { - hashCode = (hashCode * 59) + this.ClientId.GetHashCode(); - } - if (this.CustomFields != null) - { - hashCode = (hashCode * 59) + this.CustomFields.GetHashCode(); - } - if (this.Files != null) - { - hashCode = (hashCode * 59) + this.Files.GetHashCode(); - } - if (this.FileUrls != null) - { - hashCode = (hashCode * 59) + this.FileUrls.GetHashCode(); - } - hashCode = (hashCode * 59) + this.IsQualifiedSignature.GetHashCode(); - hashCode = (hashCode * 59) + this.IsEid.GetHashCode(); - if (this.Message != null) - { - hashCode = (hashCode * 59) + this.Message.GetHashCode(); - } - if (this.Metadata != null) - { - hashCode = (hashCode * 59) + this.Metadata.GetHashCode(); - } - if (this.SigningOptions != null) - { - hashCode = (hashCode * 59) + this.SigningOptions.GetHashCode(); - } - if (this.SigningRedirectUrl != null) - { - hashCode = (hashCode * 59) + this.SigningRedirectUrl.GetHashCode(); - } - if (this.Subject != null) - { - hashCode = (hashCode * 59) + this.Subject.GetHashCode(); - } - hashCode = (hashCode * 59) + this.TestMode.GetHashCode(); - if (this.Title != null) - { - hashCode = (hashCode * 59) + this.Title.GetHashCode(); - } - return hashCode; - } - } - - public List GetOpenApiTypes() - { - var types = new List(); - types.Add(new OpenApiType() - { - Name = "template_ids", - Property = "TemplateIds", - Type = "List", - Value = TemplateIds, - }); - types.Add(new OpenApiType() - { - Name = "signers", - Property = "Signers", - Type = "List", - Value = Signers, - }); - types.Add(new OpenApiType() - { - Name = "allow_decline", - Property = "AllowDecline", - Type = "bool", - Value = AllowDecline, - }); - types.Add(new OpenApiType() - { - Name = "ccs", - Property = "Ccs", - Type = "List", - Value = Ccs, - }); - types.Add(new OpenApiType() - { - Name = "client_id", - Property = "ClientId", - Type = "string", - Value = ClientId, - }); - types.Add(new OpenApiType() - { - Name = "custom_fields", - Property = "CustomFields", - Type = "List", - Value = CustomFields, - }); - types.Add(new OpenApiType() - { - Name = "files", - Property = "Files", - Type = "List", - Value = Files, - }); - types.Add(new OpenApiType() - { - Name = "file_urls", - Property = "FileUrls", - Type = "List", - Value = FileUrls, - }); - types.Add(new OpenApiType() - { - Name = "is_qualified_signature", - Property = "IsQualifiedSignature", - Type = "bool", - Value = IsQualifiedSignature, - }); - types.Add(new OpenApiType() - { - Name = "is_eid", - Property = "IsEid", - Type = "bool", - Value = IsEid, - }); - types.Add(new OpenApiType() - { - Name = "message", - Property = "Message", - Type = "string", - Value = Message, - }); - types.Add(new OpenApiType() - { - Name = "metadata", - Property = "Metadata", - Type = "Dictionary", - Value = Metadata, - }); - types.Add(new OpenApiType() - { - Name = "signing_options", - Property = "SigningOptions", - Type = "SubSigningOptions", - Value = SigningOptions, - }); - types.Add(new OpenApiType() - { - Name = "signing_redirect_url", - Property = "SigningRedirectUrl", - Type = "string", - Value = SigningRedirectUrl, - }); - types.Add(new OpenApiType() - { - Name = "subject", - Property = "Subject", - Type = "string", - Value = Subject, - }); - types.Add(new OpenApiType() - { - Name = "test_mode", - Property = "TestMode", - Type = "bool", - Value = TestMode, - }); - types.Add(new OpenApiType() - { - Name = "title", - Property = "Title", - Type = "string", - Value = Title, - }); - - return types; - } - - /// - /// To validate all properties of the instance - /// - /// Validation context - /// Validation Result - public IEnumerable Validate(ValidationContext validationContext) - { - // Message (string) maxLength - if (this.Message != null && this.Message.Length > 5000) - { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Message, length must be less than 5000.", new[] { "Message" }); - } - - // Subject (string) maxLength - if (this.Subject != null && this.Subject.Length > 255) - { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Subject, length must be less than 255.", new[] { "Subject" }); - } - - // Title (string) maxLength - if (this.Title != null && this.Title.Length > 255) - { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Title, length must be less than 255.", new[] { "Title" }); - } - - yield break; - } - } - -} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubFile.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubFile.cs deleted file mode 100644 index d17056299..000000000 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubFile.cs +++ /dev/null @@ -1,167 +0,0 @@ -/* - * Dropbox Sign API - * - * Dropbox Sign v3 API - * - * The version of the OpenAPI document: 3.0.0 - * Contact: apisupport@hellosign.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ - - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.ObjectModel; -using System.Linq; -using System.IO; -using System.Runtime.Serialization; -using System.Text; -using System.Text.RegularExpressions; -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using System.ComponentModel.DataAnnotations; -using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; - -namespace Dropbox.Sign.Model -{ - /// - /// Actual uploaded physical file - /// - [DataContract(Name = "SubFile")] - [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] - public partial class SubFile : IEquatable, IValidatableObject - { - /// - /// Initializes a new instance of the class. - /// - [JsonConstructorAttribute] - protected SubFile() { } - /// - /// Initializes a new instance of the class. - /// - /// Actual physical uploaded file name that is derived during upload. Not settable parameter. (default to ""). - public SubFile(string name = @"") - { - - // use default value if no "name" provided - this.Name = name ?? ""; - } - - /// - /// Attempt to instantiate and hydrate a new instance of this class - /// - /// String of JSON data representing target object - public static SubFile Init(string jsonData) - { - var obj = JsonConvert.DeserializeObject(jsonData); - - if (obj == null) - { - throw new Exception("Unable to deserialize JSON to instance of SubFile"); - } - - return obj; - } - - /// - /// Actual physical uploaded file name that is derived during upload. Not settable parameter. - /// - /// Actual physical uploaded file name that is derived during upload. Not settable parameter. - [DataMember(Name = "name", EmitDefaultValue = true)] - public string Name { get; set; } - - /// - /// Returns the string presentation of the object - /// - /// String presentation of the object - public override string ToString() - { - StringBuilder sb = new StringBuilder(); - sb.Append("class SubFile {\n"); - sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append("}\n"); - return sb.ToString(); - } - - /// - /// Returns the JSON string presentation of the object - /// - /// JSON string presentation of the object - public virtual string ToJson() - { - return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); - } - - /// - /// Returns true if objects are equal - /// - /// Object to be compared - /// Boolean - public override bool Equals(object input) - { - return this.Equals(input as SubFile); - } - - /// - /// Returns true if SubFile instances are equal - /// - /// Instance of SubFile to be compared - /// Boolean - public bool Equals(SubFile input) - { - if (input == null) - { - return false; - } - return - ( - this.Name == input.Name || - (this.Name != null && - this.Name.Equals(input.Name)) - ); - } - - /// - /// Gets the hash code - /// - /// Hash code - public override int GetHashCode() - { - unchecked // Overflow is fine, just wrap - { - int hashCode = 41; - if (this.Name != null) - { - hashCode = (hashCode * 59) + this.Name.GetHashCode(); - } - return hashCode; - } - } - - /// - /// To validate all properties of the instance - /// - /// Validation context - /// Validation Result - IEnumerable IValidatableObject.Validate(ValidationContext validationContext) - { - yield break; - } - public List GetOpenApiTypes() - { - var types = new List(); - types.Add(new OpenApiType() - { - Name = "name", - Property = "Name", - Type = "string", - Value = Name, - }); - - return types; - } - } - -} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCustomField.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCustomField.cs deleted file mode 100644 index 39e50fb91..000000000 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCustomField.cs +++ /dev/null @@ -1,475 +0,0 @@ -/* - * Dropbox Sign API - * - * Dropbox Sign v3 API - * - * The version of the OpenAPI document: 3.0.0 - * Contact: apisupport@hellosign.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ - - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.ObjectModel; -using System.Linq; -using System.IO; -using System.Runtime.Serialization; -using System.Text; -using System.Text.RegularExpressions; -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using System.ComponentModel.DataAnnotations; -using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; - -namespace Dropbox.Sign.Model -{ - /// - /// TemplateResponseCustomField - /// - [DataContract(Name = "TemplateResponseCustomField")] - [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] - public partial class TemplateResponseCustomField : IOpenApiTyped, IEquatable, IValidatableObject - { - /// - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. - /// - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. - [JsonConverter(typeof(StringEnumConverter))] - public enum TypeEnum - { - /// - /// Enum Text for value: text - /// - [EnumMember(Value = "text")] - Text = 1, - - /// - /// Enum Checkbox for value: checkbox - /// - [EnumMember(Value = "checkbox")] - Checkbox = 2 - - } - - - /// - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. - /// - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. - [DataMember(Name = "type", EmitDefaultValue = true)] - public TypeEnum? Type { get; set; } - /// - /// Initializes a new instance of the class. - /// - [JsonConstructorAttribute] - protected TemplateResponseCustomField() { } - /// - /// Initializes a new instance of the class. - /// - /// The name of the Custom Field.. - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. - /// The unique ID for this field.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. - /// avgTextLength. - /// Whether this form field is multiline text.. - /// Original font size used in this form field's text.. - /// Font family used in this form field's text.. - public TemplateResponseCustomField(string name = default(string), TypeEnum? type = default(TypeEnum?), int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string apiId = default(string), string group = default(string), TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool? isMultiline = default(bool?), int? originalFontSize = default(int?), string fontFamily = default(string)) - { - - this.Name = name; - this.Type = type; - this.X = x; - this.Y = y; - this.Width = width; - this.Height = height; - this.Required = required; - this.ApiId = apiId; - this.Group = group; - this.AvgTextLength = avgTextLength; - this.IsMultiline = isMultiline; - this.OriginalFontSize = originalFontSize; - this.FontFamily = fontFamily; - } - - /// - /// Attempt to instantiate and hydrate a new instance of this class - /// - /// String of JSON data representing target object - public static TemplateResponseCustomField Init(string jsonData) - { - var obj = JsonConvert.DeserializeObject(jsonData); - - if (obj == null) - { - throw new Exception("Unable to deserialize JSON to instance of TemplateResponseCustomField"); - } - - return obj; - } - - /// - /// The name of the Custom Field. - /// - /// The name of the Custom Field. - [DataMember(Name = "name", EmitDefaultValue = true)] - public string Name { get; set; } - - /// - /// The horizontal offset in pixels for this form field. - /// - /// The horizontal offset in pixels for this form field. - [DataMember(Name = "x", EmitDefaultValue = true)] - public int X { get; set; } - - /// - /// The vertical offset in pixels for this form field. - /// - /// The vertical offset in pixels for this form field. - [DataMember(Name = "y", EmitDefaultValue = true)] - public int Y { get; set; } - - /// - /// The width in pixels of this form field. - /// - /// The width in pixels of this form field. - [DataMember(Name = "width", EmitDefaultValue = true)] - public int Width { get; set; } - - /// - /// The height in pixels of this form field. - /// - /// The height in pixels of this form field. - [DataMember(Name = "height", EmitDefaultValue = true)] - public int Height { get; set; } - - /// - /// Boolean showing whether or not this field is required. - /// - /// Boolean showing whether or not this field is required. - [DataMember(Name = "required", EmitDefaultValue = true)] - public bool Required { get; set; } - - /// - /// The unique ID for this field. - /// - /// The unique ID for this field. - [DataMember(Name = "api_id", EmitDefaultValue = true)] - public string ApiId { get; set; } - - /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null`. - /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null`. - [DataMember(Name = "group", EmitDefaultValue = true)] - public string Group { get; set; } - - /// - /// Gets or Sets AvgTextLength - /// - [DataMember(Name = "avg_text_length", EmitDefaultValue = true)] - public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } - - /// - /// Whether this form field is multiline text. - /// - /// Whether this form field is multiline text. - [DataMember(Name = "isMultiline", EmitDefaultValue = true)] - public bool? IsMultiline { get; set; } - - /// - /// Original font size used in this form field's text. - /// - /// Original font size used in this form field's text. - [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] - public int? OriginalFontSize { get; set; } - - /// - /// Font family used in this form field's text. - /// - /// Font family used in this form field's text. - [DataMember(Name = "fontFamily", EmitDefaultValue = true)] - public string FontFamily { get; set; } - - /// - /// Returns the string presentation of the object - /// - /// String presentation of the object - public override string ToString() - { - StringBuilder sb = new StringBuilder(); - sb.Append("class TemplateResponseCustomField {\n"); - sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Type: ").Append(Type).Append("\n"); - sb.Append(" X: ").Append(X).Append("\n"); - sb.Append(" Y: ").Append(Y).Append("\n"); - sb.Append(" Width: ").Append(Width).Append("\n"); - sb.Append(" Height: ").Append(Height).Append("\n"); - sb.Append(" Required: ").Append(Required).Append("\n"); - sb.Append(" ApiId: ").Append(ApiId).Append("\n"); - sb.Append(" Group: ").Append(Group).Append("\n"); - sb.Append(" AvgTextLength: ").Append(AvgTextLength).Append("\n"); - sb.Append(" IsMultiline: ").Append(IsMultiline).Append("\n"); - sb.Append(" OriginalFontSize: ").Append(OriginalFontSize).Append("\n"); - sb.Append(" FontFamily: ").Append(FontFamily).Append("\n"); - sb.Append("}\n"); - return sb.ToString(); - } - - /// - /// Returns the JSON string presentation of the object - /// - /// JSON string presentation of the object - public virtual string ToJson() - { - return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); - } - - /// - /// Returns true if objects are equal - /// - /// Object to be compared - /// Boolean - public override bool Equals(object input) - { - return this.Equals(input as TemplateResponseCustomField); - } - - /// - /// Returns true if TemplateResponseCustomField instances are equal - /// - /// Instance of TemplateResponseCustomField to be compared - /// Boolean - public bool Equals(TemplateResponseCustomField input) - { - if (input == null) - { - return false; - } - return - ( - this.Name == input.Name || - (this.Name != null && - this.Name.Equals(input.Name)) - ) && - ( - this.Type == input.Type || - this.Type.Equals(input.Type) - ) && - ( - this.X == input.X || - this.X.Equals(input.X) - ) && - ( - this.Y == input.Y || - this.Y.Equals(input.Y) - ) && - ( - this.Width == input.Width || - this.Width.Equals(input.Width) - ) && - ( - this.Height == input.Height || - this.Height.Equals(input.Height) - ) && - ( - this.Required == input.Required || - this.Required.Equals(input.Required) - ) && - ( - this.ApiId == input.ApiId || - (this.ApiId != null && - this.ApiId.Equals(input.ApiId)) - ) && - ( - this.Group == input.Group || - (this.Group != null && - this.Group.Equals(input.Group)) - ) && - ( - this.AvgTextLength == input.AvgTextLength || - (this.AvgTextLength != null && - this.AvgTextLength.Equals(input.AvgTextLength)) - ) && - ( - this.IsMultiline == input.IsMultiline || - (this.IsMultiline != null && - this.IsMultiline.Equals(input.IsMultiline)) - ) && - ( - this.OriginalFontSize == input.OriginalFontSize || - (this.OriginalFontSize != null && - this.OriginalFontSize.Equals(input.OriginalFontSize)) - ) && - ( - this.FontFamily == input.FontFamily || - (this.FontFamily != null && - this.FontFamily.Equals(input.FontFamily)) - ); - } - - /// - /// Gets the hash code - /// - /// Hash code - public override int GetHashCode() - { - unchecked // Overflow is fine, just wrap - { - int hashCode = 41; - if (this.Name != null) - { - hashCode = (hashCode * 59) + this.Name.GetHashCode(); - } - hashCode = (hashCode * 59) + this.Type.GetHashCode(); - hashCode = (hashCode * 59) + this.X.GetHashCode(); - hashCode = (hashCode * 59) + this.Y.GetHashCode(); - hashCode = (hashCode * 59) + this.Width.GetHashCode(); - hashCode = (hashCode * 59) + this.Height.GetHashCode(); - hashCode = (hashCode * 59) + this.Required.GetHashCode(); - if (this.ApiId != null) - { - hashCode = (hashCode * 59) + this.ApiId.GetHashCode(); - } - if (this.Group != null) - { - hashCode = (hashCode * 59) + this.Group.GetHashCode(); - } - if (this.AvgTextLength != null) - { - hashCode = (hashCode * 59) + this.AvgTextLength.GetHashCode(); - } - if (this.IsMultiline != null) - { - hashCode = (hashCode * 59) + this.IsMultiline.GetHashCode(); - } - if (this.OriginalFontSize != null) - { - hashCode = (hashCode * 59) + this.OriginalFontSize.GetHashCode(); - } - if (this.FontFamily != null) - { - hashCode = (hashCode * 59) + this.FontFamily.GetHashCode(); - } - return hashCode; - } - } - - public List GetOpenApiTypes() - { - var types = new List(); - types.Add(new OpenApiType() - { - Name = "name", - Property = "Name", - Type = "string", - Value = Name, - }); - types.Add(new OpenApiType() - { - Name = "type", - Property = "Type", - Type = "string", - Value = Type, - }); - types.Add(new OpenApiType() - { - Name = "x", - Property = "X", - Type = "int", - Value = X, - }); - types.Add(new OpenApiType() - { - Name = "y", - Property = "Y", - Type = "int", - Value = Y, - }); - types.Add(new OpenApiType() - { - Name = "width", - Property = "Width", - Type = "int", - Value = Width, - }); - types.Add(new OpenApiType() - { - Name = "height", - Property = "Height", - Type = "int", - Value = Height, - }); - types.Add(new OpenApiType() - { - Name = "required", - Property = "Required", - Type = "bool", - Value = Required, - }); - types.Add(new OpenApiType() - { - Name = "api_id", - Property = "ApiId", - Type = "string", - Value = ApiId, - }); - types.Add(new OpenApiType() - { - Name = "group", - Property = "Group", - Type = "string", - Value = Group, - }); - types.Add(new OpenApiType() - { - Name = "avg_text_length", - Property = "AvgTextLength", - Type = "TemplateResponseFieldAvgTextLength", - Value = AvgTextLength, - }); - types.Add(new OpenApiType() - { - Name = "isMultiline", - Property = "IsMultiline", - Type = "bool?", - Value = IsMultiline, - }); - types.Add(new OpenApiType() - { - Name = "originalFontSize", - Property = "OriginalFontSize", - Type = "int?", - Value = OriginalFontSize, - }); - types.Add(new OpenApiType() - { - Name = "fontFamily", - Property = "FontFamily", - Type = "string", - Value = FontFamily, - }); - - return types; - } - - /// - /// To validate all properties of the instance - /// - /// Validation context - /// Validation Result - public IEnumerable Validate(ValidationContext validationContext) - { - yield break; - } - } - -} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomField.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomField.cs deleted file mode 100644 index 958f7595b..000000000 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomField.cs +++ /dev/null @@ -1,554 +0,0 @@ -/* - * Dropbox Sign API - * - * Dropbox Sign v3 API - * - * The version of the OpenAPI document: 3.0.0 - * Contact: apisupport@hellosign.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ - - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.ObjectModel; -using System.Linq; -using System.IO; -using System.Runtime.Serialization; -using System.Text; -using System.Text.RegularExpressions; -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using System.ComponentModel.DataAnnotations; -using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; - -namespace Dropbox.Sign.Model -{ - /// - /// TemplateResponseDocumentCustomField - /// - [DataContract(Name = "TemplateResponseDocumentCustomField")] - [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] - public partial class TemplateResponseDocumentCustomField : IOpenApiTyped, IEquatable, IValidatableObject - { - /// - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. - /// - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. - [JsonConverter(typeof(StringEnumConverter))] - public enum TypeEnum - { - /// - /// Enum Text for value: text - /// - [EnumMember(Value = "text")] - Text = 1, - - /// - /// Enum Checkbox for value: checkbox - /// - [EnumMember(Value = "checkbox")] - Checkbox = 2 - - } - - - /// - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. - /// - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. - [DataMember(Name = "type", EmitDefaultValue = true)] - public TypeEnum? Type { get; set; } - /// - /// Initializes a new instance of the class. - /// - [JsonConstructorAttribute] - protected TemplateResponseDocumentCustomField() { } - /// - /// Initializes a new instance of the class. - /// - /// The name of the Custom Field.. - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported.. - /// The signer of the Custom Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. - /// The unique ID for this field.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. - /// avgTextLength. - /// Whether this form field is multiline text.. - /// Original font size used in this form field's text.. - /// Font family used in this form field's text.. - /// Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.. - /// reusableFormId. - public TemplateResponseDocumentCustomField(string name = default(string), TypeEnum? type = default(TypeEnum?), string signer = default(string), int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string apiId = default(string), string group = default(string), TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool? isMultiline = default(bool?), int? originalFontSize = default(int?), string fontFamily = default(string), Object namedFormFields = default(Object), string reusableFormId = default(string)) - { - - this.Name = name; - this.Type = type; - this.Signer = signer; - this.X = x; - this.Y = y; - this.Width = width; - this.Height = height; - this.Required = required; - this.ApiId = apiId; - this.Group = group; - this.AvgTextLength = avgTextLength; - this.IsMultiline = isMultiline; - this.OriginalFontSize = originalFontSize; - this.FontFamily = fontFamily; - this.NamedFormFields = namedFormFields; - this.ReusableFormId = reusableFormId; - } - - /// - /// Attempt to instantiate and hydrate a new instance of this class - /// - /// String of JSON data representing target object - public static TemplateResponseDocumentCustomField Init(string jsonData) - { - var obj = JsonConvert.DeserializeObject(jsonData); - - if (obj == null) - { - throw new Exception("Unable to deserialize JSON to instance of TemplateResponseDocumentCustomField"); - } - - return obj; - } - - /// - /// The name of the Custom Field. - /// - /// The name of the Custom Field. - [DataMember(Name = "name", EmitDefaultValue = true)] - public string Name { get; set; } - - /// - /// The signer of the Custom Field. - /// - /// The signer of the Custom Field. - [DataMember(Name = "signer", EmitDefaultValue = true)] - public string Signer { get; set; } - - /// - /// The horizontal offset in pixels for this form field. - /// - /// The horizontal offset in pixels for this form field. - [DataMember(Name = "x", EmitDefaultValue = true)] - public int X { get; set; } - - /// - /// The vertical offset in pixels for this form field. - /// - /// The vertical offset in pixels for this form field. - [DataMember(Name = "y", EmitDefaultValue = true)] - public int Y { get; set; } - - /// - /// The width in pixels of this form field. - /// - /// The width in pixels of this form field. - [DataMember(Name = "width", EmitDefaultValue = true)] - public int Width { get; set; } - - /// - /// The height in pixels of this form field. - /// - /// The height in pixels of this form field. - [DataMember(Name = "height", EmitDefaultValue = true)] - public int Height { get; set; } - - /// - /// Boolean showing whether or not this field is required. - /// - /// Boolean showing whether or not this field is required. - [DataMember(Name = "required", EmitDefaultValue = true)] - public bool Required { get; set; } - - /// - /// The unique ID for this field. - /// - /// The unique ID for this field. - [DataMember(Name = "api_id", EmitDefaultValue = true)] - public string ApiId { get; set; } - - /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null`. - /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null`. - [DataMember(Name = "group", EmitDefaultValue = true)] - public string Group { get; set; } - - /// - /// Gets or Sets AvgTextLength - /// - [DataMember(Name = "avg_text_length", EmitDefaultValue = true)] - public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } - - /// - /// Whether this form field is multiline text. - /// - /// Whether this form field is multiline text. - [DataMember(Name = "isMultiline", EmitDefaultValue = true)] - public bool? IsMultiline { get; set; } - - /// - /// Original font size used in this form field's text. - /// - /// Original font size used in this form field's text. - [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] - public int? OriginalFontSize { get; set; } - - /// - /// Font family used in this form field's text. - /// - /// Font family used in this form field's text. - [DataMember(Name = "fontFamily", EmitDefaultValue = true)] - public string FontFamily { get; set; } - - /// - /// Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. - /// - /// Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. - [DataMember(Name = "named_form_fields", EmitDefaultValue = true)] - [Obsolete] - public Object NamedFormFields { get; set; } - - /// - /// Gets or Sets ReusableFormId - /// - [DataMember(Name = "reusable_form_id", EmitDefaultValue = true)] - [Obsolete] - public string ReusableFormId { get; set; } - - /// - /// Returns the string presentation of the object - /// - /// String presentation of the object - public override string ToString() - { - StringBuilder sb = new StringBuilder(); - sb.Append("class TemplateResponseDocumentCustomField {\n"); - sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Type: ").Append(Type).Append("\n"); - sb.Append(" Signer: ").Append(Signer).Append("\n"); - sb.Append(" X: ").Append(X).Append("\n"); - sb.Append(" Y: ").Append(Y).Append("\n"); - sb.Append(" Width: ").Append(Width).Append("\n"); - sb.Append(" Height: ").Append(Height).Append("\n"); - sb.Append(" Required: ").Append(Required).Append("\n"); - sb.Append(" ApiId: ").Append(ApiId).Append("\n"); - sb.Append(" Group: ").Append(Group).Append("\n"); - sb.Append(" AvgTextLength: ").Append(AvgTextLength).Append("\n"); - sb.Append(" IsMultiline: ").Append(IsMultiline).Append("\n"); - sb.Append(" OriginalFontSize: ").Append(OriginalFontSize).Append("\n"); - sb.Append(" FontFamily: ").Append(FontFamily).Append("\n"); - sb.Append(" NamedFormFields: ").Append(NamedFormFields).Append("\n"); - sb.Append(" ReusableFormId: ").Append(ReusableFormId).Append("\n"); - sb.Append("}\n"); - return sb.ToString(); - } - - /// - /// Returns the JSON string presentation of the object - /// - /// JSON string presentation of the object - public virtual string ToJson() - { - return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); - } - - /// - /// Returns true if objects are equal - /// - /// Object to be compared - /// Boolean - public override bool Equals(object input) - { - return this.Equals(input as TemplateResponseDocumentCustomField); - } - - /// - /// Returns true if TemplateResponseDocumentCustomField instances are equal - /// - /// Instance of TemplateResponseDocumentCustomField to be compared - /// Boolean - public bool Equals(TemplateResponseDocumentCustomField input) - { - if (input == null) - { - return false; - } - return - ( - this.Name == input.Name || - (this.Name != null && - this.Name.Equals(input.Name)) - ) && - ( - this.Type == input.Type || - this.Type.Equals(input.Type) - ) && - ( - this.Signer == input.Signer || - (this.Signer != null && - this.Signer.Equals(input.Signer)) - ) && - ( - this.X == input.X || - this.X.Equals(input.X) - ) && - ( - this.Y == input.Y || - this.Y.Equals(input.Y) - ) && - ( - this.Width == input.Width || - this.Width.Equals(input.Width) - ) && - ( - this.Height == input.Height || - this.Height.Equals(input.Height) - ) && - ( - this.Required == input.Required || - this.Required.Equals(input.Required) - ) && - ( - this.ApiId == input.ApiId || - (this.ApiId != null && - this.ApiId.Equals(input.ApiId)) - ) && - ( - this.Group == input.Group || - (this.Group != null && - this.Group.Equals(input.Group)) - ) && - ( - this.AvgTextLength == input.AvgTextLength || - (this.AvgTextLength != null && - this.AvgTextLength.Equals(input.AvgTextLength)) - ) && - ( - this.IsMultiline == input.IsMultiline || - (this.IsMultiline != null && - this.IsMultiline.Equals(input.IsMultiline)) - ) && - ( - this.OriginalFontSize == input.OriginalFontSize || - (this.OriginalFontSize != null && - this.OriginalFontSize.Equals(input.OriginalFontSize)) - ) && - ( - this.FontFamily == input.FontFamily || - (this.FontFamily != null && - this.FontFamily.Equals(input.FontFamily)) - ) && - ( - this.NamedFormFields == input.NamedFormFields || - (this.NamedFormFields != null && - this.NamedFormFields.Equals(input.NamedFormFields)) - ) && - ( - this.ReusableFormId == input.ReusableFormId || - (this.ReusableFormId != null && - this.ReusableFormId.Equals(input.ReusableFormId)) - ); - } - - /// - /// Gets the hash code - /// - /// Hash code - public override int GetHashCode() - { - unchecked // Overflow is fine, just wrap - { - int hashCode = 41; - if (this.Name != null) - { - hashCode = (hashCode * 59) + this.Name.GetHashCode(); - } - hashCode = (hashCode * 59) + this.Type.GetHashCode(); - if (this.Signer != null) - { - hashCode = (hashCode * 59) + this.Signer.GetHashCode(); - } - hashCode = (hashCode * 59) + this.X.GetHashCode(); - hashCode = (hashCode * 59) + this.Y.GetHashCode(); - hashCode = (hashCode * 59) + this.Width.GetHashCode(); - hashCode = (hashCode * 59) + this.Height.GetHashCode(); - hashCode = (hashCode * 59) + this.Required.GetHashCode(); - if (this.ApiId != null) - { - hashCode = (hashCode * 59) + this.ApiId.GetHashCode(); - } - if (this.Group != null) - { - hashCode = (hashCode * 59) + this.Group.GetHashCode(); - } - if (this.AvgTextLength != null) - { - hashCode = (hashCode * 59) + this.AvgTextLength.GetHashCode(); - } - if (this.IsMultiline != null) - { - hashCode = (hashCode * 59) + this.IsMultiline.GetHashCode(); - } - if (this.OriginalFontSize != null) - { - hashCode = (hashCode * 59) + this.OriginalFontSize.GetHashCode(); - } - if (this.FontFamily != null) - { - hashCode = (hashCode * 59) + this.FontFamily.GetHashCode(); - } - if (this.NamedFormFields != null) - { - hashCode = (hashCode * 59) + this.NamedFormFields.GetHashCode(); - } - if (this.ReusableFormId != null) - { - hashCode = (hashCode * 59) + this.ReusableFormId.GetHashCode(); - } - return hashCode; - } - } - - public List GetOpenApiTypes() - { - var types = new List(); - types.Add(new OpenApiType() - { - Name = "name", - Property = "Name", - Type = "string", - Value = Name, - }); - types.Add(new OpenApiType() - { - Name = "type", - Property = "Type", - Type = "string", - Value = Type, - }); - types.Add(new OpenApiType() - { - Name = "signer", - Property = "Signer", - Type = "string", - Value = Signer, - }); - types.Add(new OpenApiType() - { - Name = "x", - Property = "X", - Type = "int", - Value = X, - }); - types.Add(new OpenApiType() - { - Name = "y", - Property = "Y", - Type = "int", - Value = Y, - }); - types.Add(new OpenApiType() - { - Name = "width", - Property = "Width", - Type = "int", - Value = Width, - }); - types.Add(new OpenApiType() - { - Name = "height", - Property = "Height", - Type = "int", - Value = Height, - }); - types.Add(new OpenApiType() - { - Name = "required", - Property = "Required", - Type = "bool", - Value = Required, - }); - types.Add(new OpenApiType() - { - Name = "api_id", - Property = "ApiId", - Type = "string", - Value = ApiId, - }); - types.Add(new OpenApiType() - { - Name = "group", - Property = "Group", - Type = "string", - Value = Group, - }); - types.Add(new OpenApiType() - { - Name = "avg_text_length", - Property = "AvgTextLength", - Type = "TemplateResponseFieldAvgTextLength", - Value = AvgTextLength, - }); - types.Add(new OpenApiType() - { - Name = "isMultiline", - Property = "IsMultiline", - Type = "bool?", - Value = IsMultiline, - }); - types.Add(new OpenApiType() - { - Name = "originalFontSize", - Property = "OriginalFontSize", - Type = "int?", - Value = OriginalFontSize, - }); - types.Add(new OpenApiType() - { - Name = "fontFamily", - Property = "FontFamily", - Type = "string", - Value = FontFamily, - }); - types.Add(new OpenApiType() - { - Name = "named_form_fields", - Property = "NamedFormFields", - Type = "Object", - Value = NamedFormFields, - }); - types.Add(new OpenApiType() - { - Name = "reusable_form_id", - Property = "ReusableFormId", - Type = "string", - Value = ReusableFormId, - }); - - return types; - } - - /// - /// To validate all properties of the instance - /// - /// Validation context - /// Validation Result - public IEnumerable Validate(ValidationContext validationContext) - { - yield break; - } - } - -} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormField.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormField.cs deleted file mode 100644 index 9a84275b0..000000000 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormField.cs +++ /dev/null @@ -1,549 +0,0 @@ -/* - * Dropbox Sign API - * - * Dropbox Sign v3 API - * - * The version of the OpenAPI document: 3.0.0 - * Contact: apisupport@hellosign.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ - - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.ObjectModel; -using System.Linq; -using System.IO; -using System.Runtime.Serialization; -using System.Text; -using System.Text.RegularExpressions; -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using System.ComponentModel.DataAnnotations; -using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; - -namespace Dropbox.Sign.Model -{ - /// - /// TemplateResponseDocumentFormField - /// - [DataContract(Name = "TemplateResponseDocumentFormField")] - [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] - public partial class TemplateResponseDocumentFormField : IOpenApiTyped, IEquatable, IValidatableObject - { - /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). - /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). - [JsonConverter(typeof(StringEnumConverter))] - public enum TypeEnum - { - /// - /// Enum Checkbox for value: checkbox - /// - [EnumMember(Value = "checkbox")] - Checkbox = 1, - - /// - /// Enum CheckboxMerge for value: checkbox-merge - /// - [EnumMember(Value = "checkbox-merge")] - CheckboxMerge = 2, - - /// - /// Enum DateSigned for value: date_signed - /// - [EnumMember(Value = "date_signed")] - DateSigned = 3, - - /// - /// Enum Dropdown for value: dropdown - /// - [EnumMember(Value = "dropdown")] - Dropdown = 4, - - /// - /// Enum Hyperlink for value: hyperlink - /// - [EnumMember(Value = "hyperlink")] - Hyperlink = 5, - - /// - /// Enum Initials for value: initials - /// - [EnumMember(Value = "initials")] - Initials = 6, - - /// - /// Enum Signature for value: signature - /// - [EnumMember(Value = "signature")] - Signature = 7, - - /// - /// Enum Radio for value: radio - /// - [EnumMember(Value = "radio")] - Radio = 8, - - /// - /// Enum Text for value: text - /// - [EnumMember(Value = "text")] - Text = 9, - - /// - /// Enum TextMerge for value: text-merge - /// - [EnumMember(Value = "text-merge")] - TextMerge = 10 - - } - - - /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). - /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). - [DataMember(Name = "type", EmitDefaultValue = true)] - public TypeEnum? Type { get; set; } - /// - /// Initializes a new instance of the class. - /// - [JsonConstructorAttribute] - protected TemplateResponseDocumentFormField() { } - /// - /// Initializes a new instance of the class. - /// - /// A unique id for the form field.. - /// The name of the form field.. - /// The type of this form field. See [field types](/api/reference/constants/#field-types).. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. - /// avgTextLength. - /// Whether this form field is multiline text.. - /// Original font size used in this form field's text.. - /// Font family used in this form field's text.. - public TemplateResponseDocumentFormField(string apiId = default(string), string name = default(string), TypeEnum? type = default(TypeEnum?), string signer = default(string), int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string), TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool? isMultiline = default(bool?), int? originalFontSize = default(int?), string fontFamily = default(string)) - { - - this.ApiId = apiId; - this.Name = name; - this.Type = type; - this.Signer = signer; - this.X = x; - this.Y = y; - this.Width = width; - this.Height = height; - this.Required = required; - this.Group = group; - this.AvgTextLength = avgTextLength; - this.IsMultiline = isMultiline; - this.OriginalFontSize = originalFontSize; - this.FontFamily = fontFamily; - } - - /// - /// Attempt to instantiate and hydrate a new instance of this class - /// - /// String of JSON data representing target object - public static TemplateResponseDocumentFormField Init(string jsonData) - { - var obj = JsonConvert.DeserializeObject(jsonData); - - if (obj == null) - { - throw new Exception("Unable to deserialize JSON to instance of TemplateResponseDocumentFormField"); - } - - return obj; - } - - /// - /// A unique id for the form field. - /// - /// A unique id for the form field. - [DataMember(Name = "api_id", EmitDefaultValue = true)] - public string ApiId { get; set; } - - /// - /// The name of the form field. - /// - /// The name of the form field. - [DataMember(Name = "name", EmitDefaultValue = true)] - public string Name { get; set; } - - /// - /// The signer of the Form Field. - /// - /// The signer of the Form Field. - [DataMember(Name = "signer", EmitDefaultValue = true)] - public string Signer { get; set; } - - /// - /// The horizontal offset in pixels for this form field. - /// - /// The horizontal offset in pixels for this form field. - [DataMember(Name = "x", EmitDefaultValue = true)] - public int X { get; set; } - - /// - /// The vertical offset in pixels for this form field. - /// - /// The vertical offset in pixels for this form field. - [DataMember(Name = "y", EmitDefaultValue = true)] - public int Y { get; set; } - - /// - /// The width in pixels of this form field. - /// - /// The width in pixels of this form field. - [DataMember(Name = "width", EmitDefaultValue = true)] - public int Width { get; set; } - - /// - /// The height in pixels of this form field. - /// - /// The height in pixels of this form field. - [DataMember(Name = "height", EmitDefaultValue = true)] - public int Height { get; set; } - - /// - /// Boolean showing whether or not this field is required. - /// - /// Boolean showing whether or not this field is required. - [DataMember(Name = "required", EmitDefaultValue = true)] - public bool Required { get; set; } - - /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null`. - /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null`. - [DataMember(Name = "group", EmitDefaultValue = true)] - public string Group { get; set; } - - /// - /// Gets or Sets AvgTextLength - /// - [DataMember(Name = "avg_text_length", EmitDefaultValue = true)] - public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } - - /// - /// Whether this form field is multiline text. - /// - /// Whether this form field is multiline text. - [DataMember(Name = "isMultiline", EmitDefaultValue = true)] - public bool? IsMultiline { get; set; } - - /// - /// Original font size used in this form field's text. - /// - /// Original font size used in this form field's text. - [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] - public int? OriginalFontSize { get; set; } - - /// - /// Font family used in this form field's text. - /// - /// Font family used in this form field's text. - [DataMember(Name = "fontFamily", EmitDefaultValue = true)] - public string FontFamily { get; set; } - - /// - /// Returns the string presentation of the object - /// - /// String presentation of the object - public override string ToString() - { - StringBuilder sb = new StringBuilder(); - sb.Append("class TemplateResponseDocumentFormField {\n"); - sb.Append(" ApiId: ").Append(ApiId).Append("\n"); - sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Type: ").Append(Type).Append("\n"); - sb.Append(" Signer: ").Append(Signer).Append("\n"); - sb.Append(" X: ").Append(X).Append("\n"); - sb.Append(" Y: ").Append(Y).Append("\n"); - sb.Append(" Width: ").Append(Width).Append("\n"); - sb.Append(" Height: ").Append(Height).Append("\n"); - sb.Append(" Required: ").Append(Required).Append("\n"); - sb.Append(" Group: ").Append(Group).Append("\n"); - sb.Append(" AvgTextLength: ").Append(AvgTextLength).Append("\n"); - sb.Append(" IsMultiline: ").Append(IsMultiline).Append("\n"); - sb.Append(" OriginalFontSize: ").Append(OriginalFontSize).Append("\n"); - sb.Append(" FontFamily: ").Append(FontFamily).Append("\n"); - sb.Append("}\n"); - return sb.ToString(); - } - - /// - /// Returns the JSON string presentation of the object - /// - /// JSON string presentation of the object - public virtual string ToJson() - { - return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); - } - - /// - /// Returns true if objects are equal - /// - /// Object to be compared - /// Boolean - public override bool Equals(object input) - { - return this.Equals(input as TemplateResponseDocumentFormField); - } - - /// - /// Returns true if TemplateResponseDocumentFormField instances are equal - /// - /// Instance of TemplateResponseDocumentFormField to be compared - /// Boolean - public bool Equals(TemplateResponseDocumentFormField input) - { - if (input == null) - { - return false; - } - return - ( - this.ApiId == input.ApiId || - (this.ApiId != null && - this.ApiId.Equals(input.ApiId)) - ) && - ( - this.Name == input.Name || - (this.Name != null && - this.Name.Equals(input.Name)) - ) && - ( - this.Type == input.Type || - this.Type.Equals(input.Type) - ) && - ( - this.Signer == input.Signer || - (this.Signer != null && - this.Signer.Equals(input.Signer)) - ) && - ( - this.X == input.X || - this.X.Equals(input.X) - ) && - ( - this.Y == input.Y || - this.Y.Equals(input.Y) - ) && - ( - this.Width == input.Width || - this.Width.Equals(input.Width) - ) && - ( - this.Height == input.Height || - this.Height.Equals(input.Height) - ) && - ( - this.Required == input.Required || - this.Required.Equals(input.Required) - ) && - ( - this.Group == input.Group || - (this.Group != null && - this.Group.Equals(input.Group)) - ) && - ( - this.AvgTextLength == input.AvgTextLength || - (this.AvgTextLength != null && - this.AvgTextLength.Equals(input.AvgTextLength)) - ) && - ( - this.IsMultiline == input.IsMultiline || - (this.IsMultiline != null && - this.IsMultiline.Equals(input.IsMultiline)) - ) && - ( - this.OriginalFontSize == input.OriginalFontSize || - (this.OriginalFontSize != null && - this.OriginalFontSize.Equals(input.OriginalFontSize)) - ) && - ( - this.FontFamily == input.FontFamily || - (this.FontFamily != null && - this.FontFamily.Equals(input.FontFamily)) - ); - } - - /// - /// Gets the hash code - /// - /// Hash code - public override int GetHashCode() - { - unchecked // Overflow is fine, just wrap - { - int hashCode = 41; - if (this.ApiId != null) - { - hashCode = (hashCode * 59) + this.ApiId.GetHashCode(); - } - if (this.Name != null) - { - hashCode = (hashCode * 59) + this.Name.GetHashCode(); - } - hashCode = (hashCode * 59) + this.Type.GetHashCode(); - if (this.Signer != null) - { - hashCode = (hashCode * 59) + this.Signer.GetHashCode(); - } - hashCode = (hashCode * 59) + this.X.GetHashCode(); - hashCode = (hashCode * 59) + this.Y.GetHashCode(); - hashCode = (hashCode * 59) + this.Width.GetHashCode(); - hashCode = (hashCode * 59) + this.Height.GetHashCode(); - hashCode = (hashCode * 59) + this.Required.GetHashCode(); - if (this.Group != null) - { - hashCode = (hashCode * 59) + this.Group.GetHashCode(); - } - if (this.AvgTextLength != null) - { - hashCode = (hashCode * 59) + this.AvgTextLength.GetHashCode(); - } - if (this.IsMultiline != null) - { - hashCode = (hashCode * 59) + this.IsMultiline.GetHashCode(); - } - if (this.OriginalFontSize != null) - { - hashCode = (hashCode * 59) + this.OriginalFontSize.GetHashCode(); - } - if (this.FontFamily != null) - { - hashCode = (hashCode * 59) + this.FontFamily.GetHashCode(); - } - return hashCode; - } - } - - public List GetOpenApiTypes() - { - var types = new List(); - types.Add(new OpenApiType() - { - Name = "api_id", - Property = "ApiId", - Type = "string", - Value = ApiId, - }); - types.Add(new OpenApiType() - { - Name = "name", - Property = "Name", - Type = "string", - Value = Name, - }); - types.Add(new OpenApiType() - { - Name = "type", - Property = "Type", - Type = "string", - Value = Type, - }); - types.Add(new OpenApiType() - { - Name = "signer", - Property = "Signer", - Type = "string", - Value = Signer, - }); - types.Add(new OpenApiType() - { - Name = "x", - Property = "X", - Type = "int", - Value = X, - }); - types.Add(new OpenApiType() - { - Name = "y", - Property = "Y", - Type = "int", - Value = Y, - }); - types.Add(new OpenApiType() - { - Name = "width", - Property = "Width", - Type = "int", - Value = Width, - }); - types.Add(new OpenApiType() - { - Name = "height", - Property = "Height", - Type = "int", - Value = Height, - }); - types.Add(new OpenApiType() - { - Name = "required", - Property = "Required", - Type = "bool", - Value = Required, - }); - types.Add(new OpenApiType() - { - Name = "group", - Property = "Group", - Type = "string", - Value = Group, - }); - types.Add(new OpenApiType() - { - Name = "avg_text_length", - Property = "AvgTextLength", - Type = "TemplateResponseFieldAvgTextLength", - Value = AvgTextLength, - }); - types.Add(new OpenApiType() - { - Name = "isMultiline", - Property = "IsMultiline", - Type = "bool?", - Value = IsMultiline, - }); - types.Add(new OpenApiType() - { - Name = "originalFontSize", - Property = "OriginalFontSize", - Type = "int?", - Value = OriginalFontSize, - }); - types.Add(new OpenApiType() - { - Name = "fontFamily", - Property = "FontFamily", - Type = "string", - Value = FontFamily, - }); - - return types; - } - - /// - /// To validate all properties of the instance - /// - /// Validation context - /// Validation Result - public IEnumerable Validate(ValidationContext validationContext) - { - yield break; - } - } - -} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticField.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticField.cs deleted file mode 100644 index 85f472c5b..000000000 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticField.cs +++ /dev/null @@ -1,381 +0,0 @@ -/* - * Dropbox Sign API - * - * Dropbox Sign v3 API - * - * The version of the OpenAPI document: 3.0.0 - * Contact: apisupport@hellosign.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ - - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.ObjectModel; -using System.Linq; -using System.IO; -using System.Runtime.Serialization; -using System.Text; -using System.Text.RegularExpressions; -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using System.ComponentModel.DataAnnotations; -using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; - -namespace Dropbox.Sign.Model -{ - /// - /// TemplateResponseDocumentStaticField - /// - [DataContract(Name = "TemplateResponseDocumentStaticField")] - [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] - public partial class TemplateResponseDocumentStaticField : IOpenApiTyped, IEquatable, IValidatableObject - { - /// - /// Initializes a new instance of the class. - /// - [JsonConstructorAttribute] - protected TemplateResponseDocumentStaticField() { } - /// - /// Initializes a new instance of the class. - /// - /// The name of the static field.. - /// The type of this static field. See [field types](/api/reference/constants/#field-types).. - /// The signer of the Static Field.. - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. - /// A unique id for the static field.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. - public TemplateResponseDocumentStaticField(string name = default(string), string type = default(string), string signer = default(string), int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string apiId = default(string), string group = default(string)) - { - - this.Name = name; - this.Type = type; - this.Signer = signer; - this.X = x; - this.Y = y; - this.Width = width; - this.Height = height; - this.Required = required; - this.ApiId = apiId; - this.Group = group; - } - - /// - /// Attempt to instantiate and hydrate a new instance of this class - /// - /// String of JSON data representing target object - public static TemplateResponseDocumentStaticField Init(string jsonData) - { - var obj = JsonConvert.DeserializeObject(jsonData); - - if (obj == null) - { - throw new Exception("Unable to deserialize JSON to instance of TemplateResponseDocumentStaticField"); - } - - return obj; - } - - /// - /// The name of the static field. - /// - /// The name of the static field. - [DataMember(Name = "name", EmitDefaultValue = true)] - public string Name { get; set; } - - /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). - /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). - [DataMember(Name = "type", EmitDefaultValue = true)] - public string Type { get; set; } - - /// - /// The signer of the Static Field. - /// - /// The signer of the Static Field. - [DataMember(Name = "signer", EmitDefaultValue = true)] - public string Signer { get; set; } - - /// - /// The horizontal offset in pixels for this static field. - /// - /// The horizontal offset in pixels for this static field. - [DataMember(Name = "x", EmitDefaultValue = true)] - public int X { get; set; } - - /// - /// The vertical offset in pixels for this static field. - /// - /// The vertical offset in pixels for this static field. - [DataMember(Name = "y", EmitDefaultValue = true)] - public int Y { get; set; } - - /// - /// The width in pixels of this static field. - /// - /// The width in pixels of this static field. - [DataMember(Name = "width", EmitDefaultValue = true)] - public int Width { get; set; } - - /// - /// The height in pixels of this static field. - /// - /// The height in pixels of this static field. - [DataMember(Name = "height", EmitDefaultValue = true)] - public int Height { get; set; } - - /// - /// Boolean showing whether or not this field is required. - /// - /// Boolean showing whether or not this field is required. - [DataMember(Name = "required", EmitDefaultValue = true)] - public bool Required { get; set; } - - /// - /// A unique id for the static field. - /// - /// A unique id for the static field. - [DataMember(Name = "api_id", EmitDefaultValue = true)] - public string ApiId { get; set; } - - /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null`. - /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null`. - [DataMember(Name = "group", EmitDefaultValue = true)] - public string Group { get; set; } - - /// - /// Returns the string presentation of the object - /// - /// String presentation of the object - public override string ToString() - { - StringBuilder sb = new StringBuilder(); - sb.Append("class TemplateResponseDocumentStaticField {\n"); - sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Type: ").Append(Type).Append("\n"); - sb.Append(" Signer: ").Append(Signer).Append("\n"); - sb.Append(" X: ").Append(X).Append("\n"); - sb.Append(" Y: ").Append(Y).Append("\n"); - sb.Append(" Width: ").Append(Width).Append("\n"); - sb.Append(" Height: ").Append(Height).Append("\n"); - sb.Append(" Required: ").Append(Required).Append("\n"); - sb.Append(" ApiId: ").Append(ApiId).Append("\n"); - sb.Append(" Group: ").Append(Group).Append("\n"); - sb.Append("}\n"); - return sb.ToString(); - } - - /// - /// Returns the JSON string presentation of the object - /// - /// JSON string presentation of the object - public virtual string ToJson() - { - return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); - } - - /// - /// Returns true if objects are equal - /// - /// Object to be compared - /// Boolean - public override bool Equals(object input) - { - return this.Equals(input as TemplateResponseDocumentStaticField); - } - - /// - /// Returns true if TemplateResponseDocumentStaticField instances are equal - /// - /// Instance of TemplateResponseDocumentStaticField to be compared - /// Boolean - public bool Equals(TemplateResponseDocumentStaticField input) - { - if (input == null) - { - return false; - } - return - ( - this.Name == input.Name || - (this.Name != null && - this.Name.Equals(input.Name)) - ) && - ( - this.Type == input.Type || - (this.Type != null && - this.Type.Equals(input.Type)) - ) && - ( - this.Signer == input.Signer || - (this.Signer != null && - this.Signer.Equals(input.Signer)) - ) && - ( - this.X == input.X || - this.X.Equals(input.X) - ) && - ( - this.Y == input.Y || - this.Y.Equals(input.Y) - ) && - ( - this.Width == input.Width || - this.Width.Equals(input.Width) - ) && - ( - this.Height == input.Height || - this.Height.Equals(input.Height) - ) && - ( - this.Required == input.Required || - this.Required.Equals(input.Required) - ) && - ( - this.ApiId == input.ApiId || - (this.ApiId != null && - this.ApiId.Equals(input.ApiId)) - ) && - ( - this.Group == input.Group || - (this.Group != null && - this.Group.Equals(input.Group)) - ); - } - - /// - /// Gets the hash code - /// - /// Hash code - public override int GetHashCode() - { - unchecked // Overflow is fine, just wrap - { - int hashCode = 41; - if (this.Name != null) - { - hashCode = (hashCode * 59) + this.Name.GetHashCode(); - } - if (this.Type != null) - { - hashCode = (hashCode * 59) + this.Type.GetHashCode(); - } - if (this.Signer != null) - { - hashCode = (hashCode * 59) + this.Signer.GetHashCode(); - } - hashCode = (hashCode * 59) + this.X.GetHashCode(); - hashCode = (hashCode * 59) + this.Y.GetHashCode(); - hashCode = (hashCode * 59) + this.Width.GetHashCode(); - hashCode = (hashCode * 59) + this.Height.GetHashCode(); - hashCode = (hashCode * 59) + this.Required.GetHashCode(); - if (this.ApiId != null) - { - hashCode = (hashCode * 59) + this.ApiId.GetHashCode(); - } - if (this.Group != null) - { - hashCode = (hashCode * 59) + this.Group.GetHashCode(); - } - return hashCode; - } - } - - public List GetOpenApiTypes() - { - var types = new List(); - types.Add(new OpenApiType() - { - Name = "name", - Property = "Name", - Type = "string", - Value = Name, - }); - types.Add(new OpenApiType() - { - Name = "type", - Property = "Type", - Type = "string", - Value = Type, - }); - types.Add(new OpenApiType() - { - Name = "signer", - Property = "Signer", - Type = "string", - Value = Signer, - }); - types.Add(new OpenApiType() - { - Name = "x", - Property = "X", - Type = "int", - Value = X, - }); - types.Add(new OpenApiType() - { - Name = "y", - Property = "Y", - Type = "int", - Value = Y, - }); - types.Add(new OpenApiType() - { - Name = "width", - Property = "Width", - Type = "int", - Value = Width, - }); - types.Add(new OpenApiType() - { - Name = "height", - Property = "Height", - Type = "int", - Value = Height, - }); - types.Add(new OpenApiType() - { - Name = "required", - Property = "Required", - Type = "bool", - Value = Required, - }); - types.Add(new OpenApiType() - { - Name = "api_id", - Property = "ApiId", - Type = "string", - Value = ApiId, - }); - types.Add(new OpenApiType() - { - Name = "group", - Property = "Group", - Type = "string", - Value = Group, - }); - - return types; - } - - /// - /// To validate all properties of the instance - /// - /// Validation context - /// Validation Result - public IEnumerable Validate(ValidationContext validationContext) - { - yield break; - } - } - -} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseNamedFormField.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseNamedFormField.cs deleted file mode 100644 index d6dfd5f5b..000000000 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseNamedFormField.cs +++ /dev/null @@ -1,484 +0,0 @@ -/* - * Dropbox Sign API - * - * Dropbox Sign v3 API - * - * The version of the OpenAPI document: 3.0.0 - * Contact: apisupport@hellosign.com - * Generated by: https://github.com/openapitools/openapi-generator.git - */ - - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.ObjectModel; -using System.Linq; -using System.IO; -using System.Runtime.Serialization; -using System.Text; -using System.Text.RegularExpressions; -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using System.ComponentModel.DataAnnotations; -using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; - -namespace Dropbox.Sign.Model -{ - /// - /// TemplateResponseNamedFormField - /// - [DataContract(Name = "TemplateResponseNamedFormField")] - [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] - public partial class TemplateResponseNamedFormField : IOpenApiTyped, IEquatable, IValidatableObject - { - /// - /// Initializes a new instance of the class. - /// - [JsonConstructorAttribute] - protected TemplateResponseNamedFormField() { } - /// - /// Initializes a new instance of the class. - /// - /// The name of the Named Form Field.. - /// The type of this Named Form Field. Only `text` and `checkbox` are currently supported.. - /// The signer of the Named Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. - /// The unique ID for this field.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. - /// avgTextLength. - /// Whether this form field is multiline text.. - /// Original font size used in this form field's text.. - /// Font family used in this form field's text.. - public TemplateResponseNamedFormField(string name = default(string), string type = default(string), string signer = default(string), int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string apiId = default(string), string group = default(string), TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool? isMultiline = default(bool?), int? originalFontSize = default(int?), string fontFamily = default(string)) - { - - this.Name = name; - this.Type = type; - this.Signer = signer; - this.X = x; - this.Y = y; - this.Width = width; - this.Height = height; - this.Required = required; - this.ApiId = apiId; - this.Group = group; - this.AvgTextLength = avgTextLength; - this.IsMultiline = isMultiline; - this.OriginalFontSize = originalFontSize; - this.FontFamily = fontFamily; - } - - /// - /// Attempt to instantiate and hydrate a new instance of this class - /// - /// String of JSON data representing target object - public static TemplateResponseNamedFormField Init(string jsonData) - { - var obj = JsonConvert.DeserializeObject(jsonData); - - if (obj == null) - { - throw new Exception("Unable to deserialize JSON to instance of TemplateResponseNamedFormField"); - } - - return obj; - } - - /// - /// The name of the Named Form Field. - /// - /// The name of the Named Form Field. - [DataMember(Name = "name", EmitDefaultValue = true)] - public string Name { get; set; } - - /// - /// The type of this Named Form Field. Only `text` and `checkbox` are currently supported. - /// - /// The type of this Named Form Field. Only `text` and `checkbox` are currently supported. - [DataMember(Name = "type", EmitDefaultValue = true)] - public string Type { get; set; } - - /// - /// The signer of the Named Form Field. - /// - /// The signer of the Named Form Field. - [DataMember(Name = "signer", EmitDefaultValue = true)] - public string Signer { get; set; } - - /// - /// The horizontal offset in pixels for this form field. - /// - /// The horizontal offset in pixels for this form field. - [DataMember(Name = "x", EmitDefaultValue = true)] - public int X { get; set; } - - /// - /// The vertical offset in pixels for this form field. - /// - /// The vertical offset in pixels for this form field. - [DataMember(Name = "y", EmitDefaultValue = true)] - public int Y { get; set; } - - /// - /// The width in pixels of this form field. - /// - /// The width in pixels of this form field. - [DataMember(Name = "width", EmitDefaultValue = true)] - public int Width { get; set; } - - /// - /// The height in pixels of this form field. - /// - /// The height in pixels of this form field. - [DataMember(Name = "height", EmitDefaultValue = true)] - public int Height { get; set; } - - /// - /// Boolean showing whether or not this field is required. - /// - /// Boolean showing whether or not this field is required. - [DataMember(Name = "required", EmitDefaultValue = true)] - public bool Required { get; set; } - - /// - /// The unique ID for this field. - /// - /// The unique ID for this field. - [DataMember(Name = "api_id", EmitDefaultValue = true)] - public string ApiId { get; set; } - - /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null`. - /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null`. - [DataMember(Name = "group", EmitDefaultValue = true)] - public string Group { get; set; } - - /// - /// Gets or Sets AvgTextLength - /// - [DataMember(Name = "avg_text_length", EmitDefaultValue = true)] - public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } - - /// - /// Whether this form field is multiline text. - /// - /// Whether this form field is multiline text. - [DataMember(Name = "isMultiline", EmitDefaultValue = true)] - public bool? IsMultiline { get; set; } - - /// - /// Original font size used in this form field's text. - /// - /// Original font size used in this form field's text. - [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] - public int? OriginalFontSize { get; set; } - - /// - /// Font family used in this form field's text. - /// - /// Font family used in this form field's text. - [DataMember(Name = "fontFamily", EmitDefaultValue = true)] - public string FontFamily { get; set; } - - /// - /// Returns the string presentation of the object - /// - /// String presentation of the object - public override string ToString() - { - StringBuilder sb = new StringBuilder(); - sb.Append("class TemplateResponseNamedFormField {\n"); - sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Type: ").Append(Type).Append("\n"); - sb.Append(" Signer: ").Append(Signer).Append("\n"); - sb.Append(" X: ").Append(X).Append("\n"); - sb.Append(" Y: ").Append(Y).Append("\n"); - sb.Append(" Width: ").Append(Width).Append("\n"); - sb.Append(" Height: ").Append(Height).Append("\n"); - sb.Append(" Required: ").Append(Required).Append("\n"); - sb.Append(" ApiId: ").Append(ApiId).Append("\n"); - sb.Append(" Group: ").Append(Group).Append("\n"); - sb.Append(" AvgTextLength: ").Append(AvgTextLength).Append("\n"); - sb.Append(" IsMultiline: ").Append(IsMultiline).Append("\n"); - sb.Append(" OriginalFontSize: ").Append(OriginalFontSize).Append("\n"); - sb.Append(" FontFamily: ").Append(FontFamily).Append("\n"); - sb.Append("}\n"); - return sb.ToString(); - } - - /// - /// Returns the JSON string presentation of the object - /// - /// JSON string presentation of the object - public virtual string ToJson() - { - return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); - } - - /// - /// Returns true if objects are equal - /// - /// Object to be compared - /// Boolean - public override bool Equals(object input) - { - return this.Equals(input as TemplateResponseNamedFormField); - } - - /// - /// Returns true if TemplateResponseNamedFormField instances are equal - /// - /// Instance of TemplateResponseNamedFormField to be compared - /// Boolean - public bool Equals(TemplateResponseNamedFormField input) - { - if (input == null) - { - return false; - } - return - ( - this.Name == input.Name || - (this.Name != null && - this.Name.Equals(input.Name)) - ) && - ( - this.Type == input.Type || - (this.Type != null && - this.Type.Equals(input.Type)) - ) && - ( - this.Signer == input.Signer || - (this.Signer != null && - this.Signer.Equals(input.Signer)) - ) && - ( - this.X == input.X || - this.X.Equals(input.X) - ) && - ( - this.Y == input.Y || - this.Y.Equals(input.Y) - ) && - ( - this.Width == input.Width || - this.Width.Equals(input.Width) - ) && - ( - this.Height == input.Height || - this.Height.Equals(input.Height) - ) && - ( - this.Required == input.Required || - this.Required.Equals(input.Required) - ) && - ( - this.ApiId == input.ApiId || - (this.ApiId != null && - this.ApiId.Equals(input.ApiId)) - ) && - ( - this.Group == input.Group || - (this.Group != null && - this.Group.Equals(input.Group)) - ) && - ( - this.AvgTextLength == input.AvgTextLength || - (this.AvgTextLength != null && - this.AvgTextLength.Equals(input.AvgTextLength)) - ) && - ( - this.IsMultiline == input.IsMultiline || - (this.IsMultiline != null && - this.IsMultiline.Equals(input.IsMultiline)) - ) && - ( - this.OriginalFontSize == input.OriginalFontSize || - (this.OriginalFontSize != null && - this.OriginalFontSize.Equals(input.OriginalFontSize)) - ) && - ( - this.FontFamily == input.FontFamily || - (this.FontFamily != null && - this.FontFamily.Equals(input.FontFamily)) - ); - } - - /// - /// Gets the hash code - /// - /// Hash code - public override int GetHashCode() - { - unchecked // Overflow is fine, just wrap - { - int hashCode = 41; - if (this.Name != null) - { - hashCode = (hashCode * 59) + this.Name.GetHashCode(); - } - if (this.Type != null) - { - hashCode = (hashCode * 59) + this.Type.GetHashCode(); - } - if (this.Signer != null) - { - hashCode = (hashCode * 59) + this.Signer.GetHashCode(); - } - hashCode = (hashCode * 59) + this.X.GetHashCode(); - hashCode = (hashCode * 59) + this.Y.GetHashCode(); - hashCode = (hashCode * 59) + this.Width.GetHashCode(); - hashCode = (hashCode * 59) + this.Height.GetHashCode(); - hashCode = (hashCode * 59) + this.Required.GetHashCode(); - if (this.ApiId != null) - { - hashCode = (hashCode * 59) + this.ApiId.GetHashCode(); - } - if (this.Group != null) - { - hashCode = (hashCode * 59) + this.Group.GetHashCode(); - } - if (this.AvgTextLength != null) - { - hashCode = (hashCode * 59) + this.AvgTextLength.GetHashCode(); - } - if (this.IsMultiline != null) - { - hashCode = (hashCode * 59) + this.IsMultiline.GetHashCode(); - } - if (this.OriginalFontSize != null) - { - hashCode = (hashCode * 59) + this.OriginalFontSize.GetHashCode(); - } - if (this.FontFamily != null) - { - hashCode = (hashCode * 59) + this.FontFamily.GetHashCode(); - } - return hashCode; - } - } - - public List GetOpenApiTypes() - { - var types = new List(); - types.Add(new OpenApiType() - { - Name = "name", - Property = "Name", - Type = "string", - Value = Name, - }); - types.Add(new OpenApiType() - { - Name = "type", - Property = "Type", - Type = "string", - Value = Type, - }); - types.Add(new OpenApiType() - { - Name = "signer", - Property = "Signer", - Type = "string", - Value = Signer, - }); - types.Add(new OpenApiType() - { - Name = "x", - Property = "X", - Type = "int", - Value = X, - }); - types.Add(new OpenApiType() - { - Name = "y", - Property = "Y", - Type = "int", - Value = Y, - }); - types.Add(new OpenApiType() - { - Name = "width", - Property = "Width", - Type = "int", - Value = Width, - }); - types.Add(new OpenApiType() - { - Name = "height", - Property = "Height", - Type = "int", - Value = Height, - }); - types.Add(new OpenApiType() - { - Name = "required", - Property = "Required", - Type = "bool", - Value = Required, - }); - types.Add(new OpenApiType() - { - Name = "api_id", - Property = "ApiId", - Type = "string", - Value = ApiId, - }); - types.Add(new OpenApiType() - { - Name = "group", - Property = "Group", - Type = "string", - Value = Group, - }); - types.Add(new OpenApiType() - { - Name = "avg_text_length", - Property = "AvgTextLength", - Type = "TemplateResponseFieldAvgTextLength", - Value = AvgTextLength, - }); - types.Add(new OpenApiType() - { - Name = "isMultiline", - Property = "IsMultiline", - Type = "bool?", - Value = IsMultiline, - }); - types.Add(new OpenApiType() - { - Name = "originalFontSize", - Property = "OriginalFontSize", - Type = "int?", - Value = OriginalFontSize, - }); - types.Add(new OpenApiType() - { - Name = "fontFamily", - Property = "FontFamily", - Type = "string", - Value = FontFamily, - }); - - return types; - } - - /// - /// To validate all properties of the instance - /// - /// Validation context - /// Validation Result - public IEnumerable Validate(ValidationContext validationContext) - { - yield break; - } - } - -} diff --git a/sdks/java-v1/run-build b/sdks/java-v1/run-build index 63fcb5cbe..ce4f11eff 100755 --- a/sdks/java-v1/run-build +++ b/sdks/java-v1/run-build @@ -12,6 +12,10 @@ if [[ -n "$GITHUB_ACTIONS" ]]; then echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin fi +# cleanup +rm -f "${DIR}/src/main/java/com/dropbox/sign/api/"*.java +rm -f "${DIR}/src/main/java/com/dropbox/sign/model/"*.java + docker run --rm \ -v "${DIR}/:/local" \ openapitools/openapi-generator-cli:v7.8.0 generate \ diff --git a/sdks/java-v2/run-build b/sdks/java-v2/run-build index ad13373ef..778da00da 100755 --- a/sdks/java-v2/run-build +++ b/sdks/java-v2/run-build @@ -12,6 +12,10 @@ if [[ -n "$GITHUB_ACTIONS" ]]; then echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin fi +# cleanup +rm -f "${DIR}/src/main/java/com/dropbox/sign/api/"*.java +rm -f "${DIR}/src/main/java/com/dropbox/sign/model/"*.java + docker run --rm \ -v "${DIR}/:/local" \ openapitools/openapi-generator-cli:v7.8.0 generate \ diff --git a/sdks/node/run-build b/sdks/node/run-build index 500687ba5..09afd7e37 100755 --- a/sdks/node/run-build +++ b/sdks/node/run-build @@ -12,6 +12,12 @@ if [[ -n "$GITHUB_ACTIONS" ]]; then echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin fi +# cleanup +rm -f "${DIR}/api/"*.ts +rm -f "${DIR}/model/"*.ts +rm -f "${DIR}/types/api/"*.ts +rm -f "${DIR}/types/model/"*.ts + # Generate code docker run --rm \ -v "${DIR}/:/local" \ diff --git a/sdks/php/run-build b/sdks/php/run-build index de3579e42..8723998b1 100755 --- a/sdks/php/run-build +++ b/sdks/php/run-build @@ -12,6 +12,10 @@ if [[ -n "$GITHUB_ACTIONS" ]]; then echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin fi +# cleanup +rm -f "${DIR}/src/Api/"*.php +rm -f "${DIR}/src/Model/"*.php + docker run --rm \ -v "${DIR}/:/local" \ -v "${DIR}/openapi-sdk.yaml:/local/openapi-sdk.yaml" \ diff --git a/sdks/python/dropbox_sign/models/fax_response_fax.py b/sdks/python/dropbox_sign/models/fax_response_fax.py deleted file mode 100644 index e66df9880..000000000 --- a/sdks/python/dropbox_sign/models/fax_response_fax.py +++ /dev/null @@ -1,187 +0,0 @@ -# coding: utf-8 - -""" - Dropbox Sign API - - Dropbox Sign v3 API - - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - - -from __future__ import annotations -import pprint -import re # noqa: F401 -import json - -from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Optional -from dropbox_sign.models.fax_response_fax_transmission import FaxResponseFaxTransmission -from typing import Optional, Set, Tuple -from typing_extensions import Self -import io -from pydantic import StrictBool -from typing import Union - - -class FaxResponseFax(BaseModel): - """ - FaxResponseFax - """ # noqa: E501 - - fax_id: Optional[StrictStr] = Field(default=None, description="Fax ID") - title: Optional[StrictStr] = Field(default=None, description="Fax Title") - original_title: Optional[StrictStr] = Field( - default=None, description="Fax Original Title" - ) - subject: Optional[StrictStr] = Field(default=None, description="Fax Subject") - message: Optional[StrictStr] = Field(default=None, description="Fax Message") - metadata: Optional[Dict[str, Any]] = Field(default=None, description="Fax Metadata") - created_at: Optional[StrictInt] = Field( - default=None, description="Fax Created At Timestamp" - ) - var_from: Optional[StrictStr] = Field( - default=None, description="Fax Sender Email", alias="from" - ) - transmissions: Optional[List[FaxResponseFaxTransmission]] = Field( - default=None, description="Fax Transmissions List" - ) - files_url: Optional[StrictStr] = Field(default=None, description="Fax Files URL") - __properties: ClassVar[List[str]] = [ - "fax_id", - "title", - "original_title", - "subject", - "message", - "metadata", - "created_at", - "from", - "transmissions", - "files_url", - ] - - model_config = ConfigDict( - populate_by_name=True, - validate_assignment=True, - protected_namespaces=(), - arbitrary_types_allowed=True, - ) - - def to_str(self) -> str: - """Returns the string representation of the model using alias""" - return pprint.pformat(self.model_dump(by_alias=True)) - - def to_json(self) -> str: - """Returns the JSON representation of the model using alias""" - # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead - return json.dumps(self.to_dict()) - - def to_json_form_params( - self, excluded_fields: Set[str] = None - ) -> List[Tuple[str, str]]: - data: List[Tuple[str, str]] = [] - - for key, value in self.to_dict(excluded_fields).items(): - if isinstance(value, (int, str, bool)): - data.append((key, value)) - else: - data.append((key, json.dumps(value, ensure_ascii=False))) - - return data - - @classmethod - def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of FaxResponseFax from a JSON string""" - return cls.from_dict(json.loads(json_str)) - - def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: - """Return the dictionary representation of the model using alias. - - This has the following differences from calling pydantic's - `self.model_dump(by_alias=True)`: - - * `None` is only added to the output dict for nullable fields that - were set at model initialization. Other fields with value `None` - are ignored. - """ - - _dict = self.model_dump( - by_alias=True, - exclude=excluded_fields, - exclude_none=True, - ) - # override the default output from pydantic by calling `to_dict()` of each item in transmissions (list) - _items = [] - if self.transmissions: - for _item_transmissions in self.transmissions: - if _item_transmissions: - _items.append(_item_transmissions.to_dict()) - _dict["transmissions"] = _items - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of FaxResponseFax from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _obj = cls.model_validate( - { - "fax_id": obj.get("fax_id"), - "title": obj.get("title"), - "original_title": obj.get("original_title"), - "subject": obj.get("subject"), - "message": obj.get("message"), - "metadata": obj.get("metadata"), - "created_at": obj.get("created_at"), - "from": obj.get("from"), - "transmissions": ( - [ - FaxResponseFaxTransmission.from_dict(_item) - for _item in obj["transmissions"] - ] - if obj.get("transmissions") is not None - else None - ), - "files_url": obj.get("files_url"), - } - ) - return _obj - - @classmethod - def init(cls, data: Any) -> Self: - """ - Attempt to instantiate and hydrate a new instance of this class - """ - if isinstance(data, str): - data = json.loads(data) - - return cls.from_dict(data) - - @classmethod - def openapi_types(cls) -> Dict[str, str]: - return { - "fax_id": "(str,)", - "title": "(str,)", - "original_title": "(str,)", - "subject": "(str,)", - "message": "(str,)", - "metadata": "(object,)", - "created_at": "(int,)", - "var_from": "(str,)", - "transmissions": "(List[FaxResponseFaxTransmission],)", - "files_url": "(str,)", - } - - @classmethod - def openapi_type_is_array(cls, property_name: str) -> bool: - return property_name in [ - "transmissions", - ] diff --git a/sdks/python/dropbox_sign/models/fax_response_fax_transmission.py b/sdks/python/dropbox_sign/models/fax_response_fax_transmission.py deleted file mode 100644 index 0c47a93f0..000000000 --- a/sdks/python/dropbox_sign/models/fax_response_fax_transmission.py +++ /dev/null @@ -1,146 +0,0 @@ -# coding: utf-8 - -""" - Dropbox Sign API - - Dropbox Sign v3 API - - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - - -from __future__ import annotations -import pprint -import re # noqa: F401 -import json - -from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple -from typing_extensions import Self -import io -from pydantic import StrictBool -from typing import Union - - -class FaxResponseFaxTransmission(BaseModel): - """ - FaxResponseFaxTransmission - """ # noqa: E501 - - recipient: Optional[StrictStr] = Field( - default=None, description="Fax Transmission Recipient" - ) - sender: Optional[StrictStr] = Field( - default=None, description="Fax Transmission Sender" - ) - status_code: Optional[StrictStr] = Field( - default=None, description="Fax Transmission Status Code" - ) - sent_at: Optional[StrictInt] = Field( - default=None, description="Fax Transmission Sent Timestamp" - ) - __properties: ClassVar[List[str]] = [ - "recipient", - "sender", - "status_code", - "sent_at", - ] - - model_config = ConfigDict( - populate_by_name=True, - validate_assignment=True, - protected_namespaces=(), - arbitrary_types_allowed=True, - ) - - def to_str(self) -> str: - """Returns the string representation of the model using alias""" - return pprint.pformat(self.model_dump(by_alias=True)) - - def to_json(self) -> str: - """Returns the JSON representation of the model using alias""" - # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead - return json.dumps(self.to_dict()) - - def to_json_form_params( - self, excluded_fields: Set[str] = None - ) -> List[Tuple[str, str]]: - data: List[Tuple[str, str]] = [] - - for key, value in self.to_dict(excluded_fields).items(): - if isinstance(value, (int, str, bool)): - data.append((key, value)) - else: - data.append((key, json.dumps(value, ensure_ascii=False))) - - return data - - @classmethod - def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of FaxResponseFaxTransmission from a JSON string""" - return cls.from_dict(json.loads(json_str)) - - def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: - """Return the dictionary representation of the model using alias. - - This has the following differences from calling pydantic's - `self.model_dump(by_alias=True)`: - - * `None` is only added to the output dict for nullable fields that - were set at model initialization. Other fields with value `None` - are ignored. - """ - - _dict = self.model_dump( - by_alias=True, - exclude=excluded_fields, - exclude_none=True, - ) - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of FaxResponseFaxTransmission from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _obj = cls.model_validate( - { - "recipient": obj.get("recipient"), - "sender": obj.get("sender"), - "status_code": obj.get("status_code"), - "sent_at": obj.get("sent_at"), - } - ) - return _obj - - @classmethod - def init(cls, data: Any) -> Self: - """ - Attempt to instantiate and hydrate a new instance of this class - """ - if isinstance(data, str): - data = json.loads(data) - - return cls.from_dict(data) - - @classmethod - def openapi_types(cls) -> Dict[str, str]: - return { - "recipient": "(str,)", - "sender": "(str,)", - "status_code": "(str,)", - "sent_at": "(int,)", - } - - @classmethod - def openapi_type_is_array(cls, property_name: str) -> bool: - return property_name in [] diff --git a/sdks/python/dropbox_sign/models/sub_file.py b/sdks/python/dropbox_sign/models/sub_file.py deleted file mode 100644 index a3c21e4f7..000000000 --- a/sdks/python/dropbox_sign/models/sub_file.py +++ /dev/null @@ -1,125 +0,0 @@ -# coding: utf-8 - -""" - Dropbox Sign API - - Dropbox Sign v3 API - - The version of the OpenAPI document: 3.0.0 - Contact: apisupport@hellosign.com - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - - -from __future__ import annotations -import pprint -import re # noqa: F401 -import json - -from pydantic import BaseModel, ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List, Optional -from typing import Optional, Set, Tuple -from typing_extensions import Self -import io -from pydantic import StrictBool -from typing import Union - - -class SubFile(BaseModel): - """ - Actual uploaded physical file - """ # noqa: E501 - - name: Optional[StrictStr] = Field( - default="", - description="Actual physical uploaded file name that is derived during upload. Not settable parameter.", - ) - __properties: ClassVar[List[str]] = ["name"] - - model_config = ConfigDict( - populate_by_name=True, - validate_assignment=True, - protected_namespaces=(), - arbitrary_types_allowed=True, - ) - - def to_str(self) -> str: - """Returns the string representation of the model using alias""" - return pprint.pformat(self.model_dump(by_alias=True)) - - def to_json(self) -> str: - """Returns the JSON representation of the model using alias""" - # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead - return json.dumps(self.to_dict()) - - def to_json_form_params( - self, excluded_fields: Set[str] = None - ) -> List[Tuple[str, str]]: - data: List[Tuple[str, str]] = [] - - for key, value in self.to_dict(excluded_fields).items(): - if isinstance(value, (int, str, bool)): - data.append((key, value)) - else: - data.append((key, json.dumps(value, ensure_ascii=False))) - - return data - - @classmethod - def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of SubFile from a JSON string""" - return cls.from_dict(json.loads(json_str)) - - def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: - """Return the dictionary representation of the model using alias. - - This has the following differences from calling pydantic's - `self.model_dump(by_alias=True)`: - - * `None` is only added to the output dict for nullable fields that - were set at model initialization. Other fields with value `None` - are ignored. - """ - - _dict = self.model_dump( - by_alias=True, - exclude=excluded_fields, - exclude_none=True, - ) - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of SubFile from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _obj = cls.model_validate( - {"name": obj.get("name") if obj.get("name") is not None else ""} - ) - return _obj - - @classmethod - def init(cls, data: Any) -> Self: - """ - Attempt to instantiate and hydrate a new instance of this class - """ - if isinstance(data, str): - data = json.loads(data) - - return cls.from_dict(data) - - @classmethod - def openapi_types(cls) -> Dict[str, str]: - return { - "name": "(str,)", - } - - @classmethod - def openapi_type_is_array(cls, property_name: str) -> bool: - return property_name in [] diff --git a/sdks/python/run-build b/sdks/python/run-build index 94829a43a..bfa300872 100755 --- a/sdks/python/run-build +++ b/sdks/python/run-build @@ -12,6 +12,10 @@ if [[ -n "$GITHUB_ACTIONS" ]]; then echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin fi +# cleanup +rm -f "${DIR}/dropbox_sign/api/"*.py +rm -f "${DIR}/dropbox_sign/models/"*.py + docker run --rm \ -v "${DIR}/:/local" \ openapitools/openapi-generator-cli:v7.8.0 generate \ diff --git a/sdks/ruby/run-build b/sdks/ruby/run-build index 5df7ba9d4..7127d6455 100755 --- a/sdks/ruby/run-build +++ b/sdks/ruby/run-build @@ -12,6 +12,10 @@ if [[ -n "$GITHUB_ACTIONS" ]]; then echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin fi +# cleanup +rm -f "${DIR}/lib/dropbox-sign/api/"*.rb +rm -f "${DIR}/lib/dropbox-sign/models/"*.rb + docker run --rm \ -v "${DIR}/:/local" \ openapitools/openapi-generator-cli:v7.8.0 generate \