diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 936e581fa..4f4f1d57e 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -11125,6 +11125,8 @@ components: nullable: true usage: $ref: '#/components/schemas/AccountResponseUsage' + settings: + $ref: '#/components/schemas/AccountResponseSettings' type: object x-internal-class: true OAuthTokenResponse: @@ -11172,6 +11174,20 @@ components: nullable: true type: object x-internal-class: true + AccountResponseSettings: + description: '_t__Account::SETTINGS' + properties: + signer_access_codes: + description: '_t__AccountSettings::SIGNER_ACCESS_CODES' + type: boolean + sms_delivery: + description: '_t__AccountSettings::SMS_DELIVERY' + type: boolean + sms_authentication: + description: '_t__AccountSettings::SMS_AUTHENTICATION' + type: boolean + type: object + x-internal-class: true AccountResponseUsage: description: '_t__Account::USAGE' properties: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 96e8f4c6c..dfd272f52 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -11865,6 +11865,8 @@ components: nullable: true usage: $ref: '#/components/schemas/AccountResponseUsage' + settings: + $ref: '#/components/schemas/AccountResponseSettings' type: object x-internal-class: true OAuthTokenResponse: @@ -11912,6 +11914,20 @@ components: nullable: true type: object x-internal-class: true + AccountResponseSettings: + description: 'Subset of configured settings' + properties: + signer_access_codes: + description: 'Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).' + type: boolean + sms_delivery: + description: 'Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).' + type: boolean + sms_authentication: + description: 'Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).' + type: boolean + type: object + x-internal-class: true AccountResponseUsage: description: 'Details concerning monthly usage' properties: diff --git a/openapi.yaml b/openapi.yaml index 397c8330e..c3f5354b8 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -11728,6 +11728,8 @@ components: nullable: true usage: $ref: '#/components/schemas/AccountResponseUsage' + settings: + $ref: '#/components/schemas/AccountResponseSettings' type: object x-internal-class: true OAuthTokenResponse: @@ -11775,6 +11777,20 @@ components: nullable: true type: object x-internal-class: true + AccountResponseSettings: + description: 'Subset of configured settings' + properties: + signer_access_codes: + description: 'Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).' + type: boolean + sms_delivery: + description: 'Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).' + type: boolean + sms_authentication: + description: 'Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).' + type: boolean + type: object + x-internal-class: true AccountResponseUsage: description: 'Details concerning monthly usage' properties: diff --git a/sdks/dotnet/README.md b/sdks/dotnet/README.md index 12e2a2d19..c287fe1c8 100644 --- a/sdks/dotnet/README.md +++ b/sdks/dotnet/README.md @@ -215,6 +215,7 @@ Class | Method | HTTP request | Description - [Model.AccountGetResponse](docs/AccountGetResponse.md) - [Model.AccountResponse](docs/AccountResponse.md) - [Model.AccountResponseQuotas](docs/AccountResponseQuotas.md) + - [Model.AccountResponseSettings](docs/AccountResponseSettings.md) - [Model.AccountResponseUsage](docs/AccountResponseUsage.md) - [Model.AccountUpdateRequest](docs/AccountUpdateRequest.md) - [Model.AccountVerifyRequest](docs/AccountVerifyRequest.md) diff --git a/sdks/dotnet/docs/AccountResponse.md b/sdks/dotnet/docs/AccountResponse.md index 2f9672466..875aa407d 100644 --- a/sdks/dotnet/docs/AccountResponse.md +++ b/sdks/dotnet/docs/AccountResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AccountId** | **string** | The ID of the Account | [optional] **EmailAddress** | **string** | The email address associated with the Account. | [optional] **IsLocked** | **bool** | Returns `true` if the user has been locked out of their account by a team admin. | [optional] **IsPaidHs** | **bool** | Returns `true` if the user has a paid Dropbox Sign account. | [optional] **IsPaidHf** | **bool** | Returns `true` if the user has a paid HelloFax account. | [optional] **Quotas** | [**AccountResponseQuotas**](AccountResponseQuotas.md) | | [optional] **CallbackUrl** | **string** | The URL that Dropbox Sign events will `POST` to. | [optional] **RoleCode** | **string** | The membership role for the team. | [optional] **TeamId** | **string** | The id of the team account belongs to. | [optional] **Locale** | **string** | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | [optional] **Usage** | [**AccountResponseUsage**](AccountResponseUsage.md) | | [optional] +**AccountId** | **string** | The ID of the Account | [optional] **EmailAddress** | **string** | The email address associated with the Account. | [optional] **IsLocked** | **bool** | Returns `true` if the user has been locked out of their account by a team admin. | [optional] **IsPaidHs** | **bool** | Returns `true` if the user has a paid Dropbox Sign account. | [optional] **IsPaidHf** | **bool** | Returns `true` if the user has a paid HelloFax account. | [optional] **Quotas** | [**AccountResponseQuotas**](AccountResponseQuotas.md) | | [optional] **CallbackUrl** | **string** | The URL that Dropbox Sign events will `POST` to. | [optional] **RoleCode** | **string** | The membership role for the team. | [optional] **TeamId** | **string** | The id of the team account belongs to. | [optional] **Locale** | **string** | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | [optional] **Usage** | [**AccountResponseUsage**](AccountResponseUsage.md) | | [optional] **Settings** | [**AccountResponseSettings**](AccountResponseSettings.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/AccountResponseSettings.md b/sdks/dotnet/docs/AccountResponseSettings.md new file mode 100644 index 000000000..69cc3c20e --- /dev/null +++ b/sdks/dotnet/docs/AccountResponseSettings.md @@ -0,0 +1,11 @@ +# Dropbox.Sign.Model.AccountResponseSettings +Subset of configured settings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SignerAccessCodes** | **bool** | Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | [optional] **SmsDelivery** | **bool** | Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | [optional] **SmsAuthentication** | **bool** | Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | [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/AccountResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponse.cs index 6d65726d7..e4af82916 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponse.cs @@ -52,7 +52,8 @@ protected AccountResponse() { } /// The id of the team account belongs to.. /// The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.. /// usage. - public AccountResponse(string accountId = default(string), string emailAddress = default(string), bool isLocked = default(bool), bool isPaidHs = default(bool), bool isPaidHf = default(bool), AccountResponseQuotas quotas = default(AccountResponseQuotas), string callbackUrl = default(string), string roleCode = default(string), string teamId = default(string), string locale = default(string), AccountResponseUsage usage = default(AccountResponseUsage)) + /// settings. + public AccountResponse(string accountId = default(string), string emailAddress = default(string), bool isLocked = default(bool), bool isPaidHs = default(bool), bool isPaidHf = default(bool), AccountResponseQuotas quotas = default(AccountResponseQuotas), string callbackUrl = default(string), string roleCode = default(string), string teamId = default(string), string locale = default(string), AccountResponseUsage usage = default(AccountResponseUsage), AccountResponseSettings settings = default(AccountResponseSettings)) { this.AccountId = accountId; @@ -66,6 +67,7 @@ protected AccountResponse() { } this.TeamId = teamId; this.Locale = locale; this.Usage = usage; + this.Settings = settings; } /// @@ -159,6 +161,12 @@ public static AccountResponse Init(string jsonData) [DataMember(Name = "usage", EmitDefaultValue = true)] public AccountResponseUsage Usage { get; set; } + /// + /// Gets or Sets Settings + /// + [DataMember(Name = "settings", EmitDefaultValue = true)] + public AccountResponseSettings Settings { get; set; } + /// /// Returns the string presentation of the object /// @@ -178,6 +186,7 @@ public override string ToString() sb.Append(" TeamId: ").Append(TeamId).Append("\n"); sb.Append(" Locale: ").Append(Locale).Append("\n"); sb.Append(" Usage: ").Append(Usage).Append("\n"); + sb.Append(" Settings: ").Append(Settings).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -264,6 +273,11 @@ public bool Equals(AccountResponse input) this.Usage == input.Usage || (this.Usage != null && this.Usage.Equals(input.Usage)) + ) && + ( + this.Settings == input.Settings || + (this.Settings != null && + this.Settings.Equals(input.Settings)) ); } @@ -311,6 +325,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Usage.GetHashCode(); } + if (this.Settings != null) + { + hashCode = (hashCode * 59) + this.Settings.GetHashCode(); + } return hashCode; } } @@ -404,6 +422,13 @@ public List GetOpenApiTypes() Type = "AccountResponseUsage", Value = Usage, }); + types.Add(new OpenApiType() + { + Name = "settings", + Property = "Settings", + Type = "AccountResponseSettings", + Value = Settings, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseSettings.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseSettings.cs new file mode 100644 index 000000000..0359d7317 --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseSettings.cs @@ -0,0 +1,206 @@ +/* + * 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 +{ + /// + /// Subset of configured settings + /// + [DataContract(Name = "AccountResponseSettings")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class AccountResponseSettings : IEquatable, IValidatableObject + { + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected AccountResponseSettings() { } + /// + /// Initializes a new instance of the class. + /// + /// Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).. + /// Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).. + /// Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).. + public AccountResponseSettings(bool signerAccessCodes = default(bool), bool smsDelivery = default(bool), bool smsAuthentication = default(bool)) + { + + this.SignerAccessCodes = signerAccessCodes; + this.SmsDelivery = smsDelivery; + this.SmsAuthentication = smsAuthentication; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static AccountResponseSettings Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of AccountResponseSettings"); + } + + return obj; + } + + /// + /// Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + /// + /// Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + [DataMember(Name = "signer_access_codes", EmitDefaultValue = true)] + public bool SignerAccessCodes { get; set; } + + /// + /// Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + /// + /// Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + [DataMember(Name = "sms_delivery", EmitDefaultValue = true)] + public bool SmsDelivery { get; set; } + + /// + /// Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + /// + /// Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + [DataMember(Name = "sms_authentication", EmitDefaultValue = true)] + public bool SmsAuthentication { 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 AccountResponseSettings {\n"); + sb.Append(" SignerAccessCodes: ").Append(SignerAccessCodes).Append("\n"); + sb.Append(" SmsDelivery: ").Append(SmsDelivery).Append("\n"); + sb.Append(" SmsAuthentication: ").Append(SmsAuthentication).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 AccountResponseSettings); + } + + /// + /// Returns true if AccountResponseSettings instances are equal + /// + /// Instance of AccountResponseSettings to be compared + /// Boolean + public bool Equals(AccountResponseSettings input) + { + if (input == null) + { + return false; + } + return + ( + this.SignerAccessCodes == input.SignerAccessCodes || + this.SignerAccessCodes.Equals(input.SignerAccessCodes) + ) && + ( + this.SmsDelivery == input.SmsDelivery || + this.SmsDelivery.Equals(input.SmsDelivery) + ) && + ( + this.SmsAuthentication == input.SmsAuthentication || + this.SmsAuthentication.Equals(input.SmsAuthentication) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + hashCode = (hashCode * 59) + this.SignerAccessCodes.GetHashCode(); + hashCode = (hashCode * 59) + this.SmsDelivery.GetHashCode(); + hashCode = (hashCode * 59) + this.SmsAuthentication.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 = "signer_access_codes", + Property = "SignerAccessCodes", + Type = "bool", + Value = SignerAccessCodes, + }); + types.Add(new OpenApiType() + { + Name = "sms_delivery", + Property = "SmsDelivery", + Type = "bool", + Value = SmsDelivery, + }); + types.Add(new OpenApiType() + { + Name = "sms_authentication", + Property = "SmsAuthentication", + Type = "bool", + Value = SmsAuthentication, + }); + + return types; + } + } + +} diff --git a/sdks/java-v1/README.md b/sdks/java-v1/README.md index a6ba86f6c..a0e36fb0f 100644 --- a/sdks/java-v1/README.md +++ b/sdks/java-v1/README.md @@ -257,6 +257,7 @@ Class | Method | HTTP request | Description - [AccountGetResponse](docs/AccountGetResponse.md) - [AccountResponse](docs/AccountResponse.md) - [AccountResponseQuotas](docs/AccountResponseQuotas.md) + - [AccountResponseSettings](docs/AccountResponseSettings.md) - [AccountResponseUsage](docs/AccountResponseUsage.md) - [AccountUpdateRequest](docs/AccountUpdateRequest.md) - [AccountVerifyRequest](docs/AccountVerifyRequest.md) diff --git a/sdks/java-v1/docs/AccountResponse.md b/sdks/java-v1/docs/AccountResponse.md index 5b73aa02d..18ab59fc1 100644 --- a/sdks/java-v1/docs/AccountResponse.md +++ b/sdks/java-v1/docs/AccountResponse.md @@ -19,6 +19,7 @@ | `teamId` | ```String``` | The id of the team account belongs to. | | | `locale` | ```String``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | | | `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | | +| `settings` | [```AccountResponseSettings```](AccountResponseSettings.md) | | | diff --git a/sdks/java-v1/docs/AccountResponseSettings.md b/sdks/java-v1/docs/AccountResponseSettings.md new file mode 100644 index 000000000..cd139079d --- /dev/null +++ b/sdks/java-v1/docs/AccountResponseSettings.md @@ -0,0 +1,16 @@ + + +# AccountResponseSettings + +Subset of configured settings + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `signerAccessCodes` | ```Boolean``` | Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | +| `smsDelivery` | ```Boolean``` | Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | +| `smsAuthentication` | ```Boolean``` | Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | + + + diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java index 02ee9cf83..7d694847b 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java @@ -35,7 +35,8 @@ AccountResponse.JSON_PROPERTY_ROLE_CODE, AccountResponse.JSON_PROPERTY_TEAM_ID, AccountResponse.JSON_PROPERTY_LOCALE, - AccountResponse.JSON_PROPERTY_USAGE + AccountResponse.JSON_PROPERTY_USAGE, + AccountResponse.JSON_PROPERTY_SETTINGS }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -75,6 +76,9 @@ public class AccountResponse { public static final String JSON_PROPERTY_USAGE = "usage"; @javax.annotation.Nullable private AccountResponseUsage usage; + public static final String JSON_PROPERTY_SETTINGS = "settings"; + @javax.annotation.Nullable private AccountResponseSettings settings; + public AccountResponse() {} /** @@ -335,6 +339,28 @@ public void setUsage(@javax.annotation.Nullable AccountResponseUsage usage) { this.usage = usage; } + public AccountResponse settings(@javax.annotation.Nullable AccountResponseSettings settings) { + this.settings = settings; + return this; + } + + /** + * Get settings + * + * @return settings + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SETTINGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public AccountResponseSettings getSettings() { + return settings; + } + + @JsonProperty(JSON_PROPERTY_SETTINGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSettings(@javax.annotation.Nullable AccountResponseSettings settings) { + this.settings = settings; + } + /** Return true if this AccountResponse object is equal to o. */ @Override public boolean equals(Object o) { @@ -355,7 +381,8 @@ public boolean equals(Object o) { && Objects.equals(this.roleCode, accountResponse.roleCode) && Objects.equals(this.teamId, accountResponse.teamId) && Objects.equals(this.locale, accountResponse.locale) - && Objects.equals(this.usage, accountResponse.usage); + && Objects.equals(this.usage, accountResponse.usage) + && Objects.equals(this.settings, accountResponse.settings); } @Override @@ -371,7 +398,8 @@ public int hashCode() { roleCode, teamId, locale, - usage); + usage, + settings); } @Override @@ -389,6 +417,7 @@ public String toString() { sb.append(" teamId: ").append(toIndentedString(teamId)).append("\n"); sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); sb.append(" usage: ").append(toIndentedString(usage)).append("\n"); + sb.append(" settings: ").append(toIndentedString(settings)).append("\n"); sb.append("}"); return sb.toString(); } @@ -609,6 +638,24 @@ public Map createFormData() throws ApiException { map.put("usage", JSON.getDefault().getMapper().writeValueAsString(usage)); } } + if (settings != null) { + if (isFileTypeOrListOfFiles(settings)) { + fileTypeFound = true; + } + + if (settings.getClass().equals(java.io.File.class) + || settings.getClass().equals(Integer.class) + || settings.getClass().equals(String.class) + || settings.getClass().isEnum()) { + map.put("settings", settings); + } else if (isListOfFile(settings)) { + for (int i = 0; i < getListSize(settings); i++) { + map.put("settings[" + i + "]", getFromList(settings, i)); + } + } else { + map.put("settings", JSON.getDefault().getMapper().writeValueAsString(settings)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseSettings.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseSettings.java new file mode 100644 index 000000000..1f43c1d3a --- /dev/null +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseSettings.java @@ -0,0 +1,278 @@ +/* + * 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.HashMap; +import java.util.Map; +import java.util.Objects; + +/** Subset of configured settings */ +@JsonPropertyOrder({ + AccountResponseSettings.JSON_PROPERTY_SIGNER_ACCESS_CODES, + AccountResponseSettings.JSON_PROPERTY_SMS_DELIVERY, + AccountResponseSettings.JSON_PROPERTY_SMS_AUTHENTICATION +}) +@javax.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.12.0") +@JsonIgnoreProperties(ignoreUnknown = true) +public class AccountResponseSettings { + public static final String JSON_PROPERTY_SIGNER_ACCESS_CODES = "signer_access_codes"; + @javax.annotation.Nullable private Boolean signerAccessCodes; + + public static final String JSON_PROPERTY_SMS_DELIVERY = "sms_delivery"; + @javax.annotation.Nullable private Boolean smsDelivery; + + public static final String JSON_PROPERTY_SMS_AUTHENTICATION = "sms_authentication"; + @javax.annotation.Nullable private Boolean smsAuthentication; + + public AccountResponseSettings() {} + + /** + * Attempt to instantiate and hydrate a new instance of this class + * + * @param jsonData String of JSON data representing target object + */ + public static AccountResponseSettings init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, AccountResponseSettings.class); + } + + public static AccountResponseSettings init(HashMap data) throws Exception { + return new ObjectMapper() + .readValue( + new ObjectMapper().writeValueAsString(data), AccountResponseSettings.class); + } + + public AccountResponseSettings signerAccessCodes( + @javax.annotation.Nullable Boolean signerAccessCodes) { + this.signerAccessCodes = signerAccessCodes; + return this; + } + + /** + * Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read + * more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + * + * @return signerAccessCodes + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_ACCESS_CODES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getSignerAccessCodes() { + return signerAccessCodes; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_ACCESS_CODES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerAccessCodes(@javax.annotation.Nullable Boolean signerAccessCodes) { + this.signerAccessCodes = signerAccessCodes; + } + + public AccountResponseSettings smsDelivery(@javax.annotation.Nullable Boolean smsDelivery) { + this.smsDelivery = smsDelivery; + return this; + } + + /** + * Returns `true` if _Text message_ is enabled in Admin Console. [Read + * more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + * + * @return smsDelivery + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SMS_DELIVERY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getSmsDelivery() { + return smsDelivery; + } + + @JsonProperty(JSON_PROPERTY_SMS_DELIVERY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSmsDelivery(@javax.annotation.Nullable Boolean smsDelivery) { + this.smsDelivery = smsDelivery; + } + + public AccountResponseSettings smsAuthentication( + @javax.annotation.Nullable Boolean smsAuthentication) { + this.smsAuthentication = smsAuthentication; + return this; + } + + /** + * Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read + * more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + * + * @return smsAuthentication + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SMS_AUTHENTICATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getSmsAuthentication() { + return smsAuthentication; + } + + @JsonProperty(JSON_PROPERTY_SMS_AUTHENTICATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSmsAuthentication(@javax.annotation.Nullable Boolean smsAuthentication) { + this.smsAuthentication = smsAuthentication; + } + + /** Return true if this AccountResponseSettings object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + AccountResponseSettings accountResponseSettings = (AccountResponseSettings) o; + return Objects.equals(this.signerAccessCodes, accountResponseSettings.signerAccessCodes) + && Objects.equals(this.smsDelivery, accountResponseSettings.smsDelivery) + && Objects.equals( + this.smsAuthentication, accountResponseSettings.smsAuthentication); + } + + @Override + public int hashCode() { + return Objects.hash(signerAccessCodes, smsDelivery, smsAuthentication); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class AccountResponseSettings {\n"); + sb.append(" signerAccessCodes: ") + .append(toIndentedString(signerAccessCodes)) + .append("\n"); + sb.append(" smsDelivery: ").append(toIndentedString(smsDelivery)).append("\n"); + sb.append(" smsAuthentication: ") + .append(toIndentedString(smsAuthentication)) + .append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (signerAccessCodes != null) { + if (isFileTypeOrListOfFiles(signerAccessCodes)) { + fileTypeFound = true; + } + + if (signerAccessCodes.getClass().equals(java.io.File.class) + || signerAccessCodes.getClass().equals(Integer.class) + || signerAccessCodes.getClass().equals(String.class) + || signerAccessCodes.getClass().isEnum()) { + map.put("signer_access_codes", signerAccessCodes); + } else if (isListOfFile(signerAccessCodes)) { + for (int i = 0; i < getListSize(signerAccessCodes); i++) { + map.put( + "signer_access_codes[" + i + "]", + getFromList(signerAccessCodes, i)); + } + } else { + map.put( + "signer_access_codes", + JSON.getDefault().getMapper().writeValueAsString(signerAccessCodes)); + } + } + if (smsDelivery != null) { + if (isFileTypeOrListOfFiles(smsDelivery)) { + fileTypeFound = true; + } + + if (smsDelivery.getClass().equals(java.io.File.class) + || smsDelivery.getClass().equals(Integer.class) + || smsDelivery.getClass().equals(String.class) + || smsDelivery.getClass().isEnum()) { + map.put("sms_delivery", smsDelivery); + } else if (isListOfFile(smsDelivery)) { + for (int i = 0; i < getListSize(smsDelivery); i++) { + map.put("sms_delivery[" + i + "]", getFromList(smsDelivery, i)); + } + } else { + map.put( + "sms_delivery", + JSON.getDefault().getMapper().writeValueAsString(smsDelivery)); + } + } + if (smsAuthentication != null) { + if (isFileTypeOrListOfFiles(smsAuthentication)) { + fileTypeFound = true; + } + + if (smsAuthentication.getClass().equals(java.io.File.class) + || smsAuthentication.getClass().equals(Integer.class) + || smsAuthentication.getClass().equals(String.class) + || smsAuthentication.getClass().isEnum()) { + map.put("sms_authentication", smsAuthentication); + } else if (isListOfFile(smsAuthentication)) { + for (int i = 0; i < getListSize(smsAuthentication); i++) { + map.put("sms_authentication[" + i + "]", getFromList(smsAuthentication, i)); + } + } else { + map.put( + "sms_authentication", + JSON.getDefault().getMapper().writeValueAsString(smsAuthentication)); + } + } + } 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 13bb5fc7d..50f768ee5 100644 --- a/sdks/java-v2/README.md +++ b/sdks/java-v2/README.md @@ -233,6 +233,7 @@ Class | Method | HTTP request | Description - [AccountGetResponse](docs/AccountGetResponse.md) - [AccountResponse](docs/AccountResponse.md) - [AccountResponseQuotas](docs/AccountResponseQuotas.md) + - [AccountResponseSettings](docs/AccountResponseSettings.md) - [AccountResponseUsage](docs/AccountResponseUsage.md) - [AccountUpdateRequest](docs/AccountUpdateRequest.md) - [AccountVerifyRequest](docs/AccountVerifyRequest.md) diff --git a/sdks/java-v2/docs/AccountResponse.md b/sdks/java-v2/docs/AccountResponse.md index 5b73aa02d..18ab59fc1 100644 --- a/sdks/java-v2/docs/AccountResponse.md +++ b/sdks/java-v2/docs/AccountResponse.md @@ -19,6 +19,7 @@ | `teamId` | ```String``` | The id of the team account belongs to. | | | `locale` | ```String``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | | | `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | | +| `settings` | [```AccountResponseSettings```](AccountResponseSettings.md) | | | diff --git a/sdks/java-v2/docs/AccountResponseSettings.md b/sdks/java-v2/docs/AccountResponseSettings.md new file mode 100644 index 000000000..cd139079d --- /dev/null +++ b/sdks/java-v2/docs/AccountResponseSettings.md @@ -0,0 +1,16 @@ + + +# AccountResponseSettings + +Subset of configured settings + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `signerAccessCodes` | ```Boolean``` | Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | +| `smsDelivery` | ```Boolean``` | Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | +| `smsAuthentication` | ```Boolean``` | Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | + + + diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java index e7140787d..d851bed80 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java @@ -17,6 +17,7 @@ import java.util.Map; import java.util.HashMap; import com.dropbox.sign.model.AccountResponseQuotas; +import com.dropbox.sign.model.AccountResponseSettings; import com.dropbox.sign.model.AccountResponseUsage; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; @@ -45,7 +46,8 @@ AccountResponse.JSON_PROPERTY_ROLE_CODE, AccountResponse.JSON_PROPERTY_TEAM_ID, AccountResponse.JSON_PROPERTY_LOCALE, - AccountResponse.JSON_PROPERTY_USAGE + AccountResponse.JSON_PROPERTY_USAGE, + AccountResponse.JSON_PROPERTY_SETTINGS }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -94,6 +96,10 @@ public class AccountResponse { @jakarta.annotation.Nullable private AccountResponseUsage usage; + public static final String JSON_PROPERTY_SETTINGS = "settings"; + @jakarta.annotation.Nullable + private AccountResponseSettings settings; + public AccountResponse() { } @@ -387,6 +393,31 @@ public void setUsage(@jakarta.annotation.Nullable AccountResponseUsage usage) { } + public AccountResponse settings(@jakarta.annotation.Nullable AccountResponseSettings settings) { + this.settings = settings; + return this; + } + + /** + * Get settings + * @return settings + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SETTINGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public AccountResponseSettings getSettings() { + return settings; + } + + + @JsonProperty(JSON_PROPERTY_SETTINGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSettings(@jakarta.annotation.Nullable AccountResponseSettings settings) { + this.settings = settings; + } + + /** * Return true if this AccountResponse object is equal to o. */ @@ -409,12 +440,13 @@ public boolean equals(Object o) { Objects.equals(this.roleCode, accountResponse.roleCode) && Objects.equals(this.teamId, accountResponse.teamId) && Objects.equals(this.locale, accountResponse.locale) && - Objects.equals(this.usage, accountResponse.usage); + Objects.equals(this.usage, accountResponse.usage) && + Objects.equals(this.settings, accountResponse.settings); } @Override public int hashCode() { - return Objects.hash(accountId, emailAddress, isLocked, isPaidHs, isPaidHf, quotas, callbackUrl, roleCode, teamId, locale, usage); + return Objects.hash(accountId, emailAddress, isLocked, isPaidHs, isPaidHf, quotas, callbackUrl, roleCode, teamId, locale, usage, settings); } @Override @@ -432,6 +464,7 @@ public String toString() { sb.append(" teamId: ").append(toIndentedString(teamId)).append("\n"); sb.append(" locale: ").append(toIndentedString(locale)).append("\n"); sb.append(" usage: ").append(toIndentedString(usage)).append("\n"); + sb.append(" settings: ").append(toIndentedString(settings)).append("\n"); sb.append("}"); return sb.toString(); } @@ -649,6 +682,25 @@ public Map createFormData() throws ApiException { map.put("usage", JSON.getDefault().getMapper().writeValueAsString(usage)); } } + if (settings != null) { + if (isFileTypeOrListOfFiles(settings)) { + fileTypeFound = true; + } + + if (settings.getClass().equals(java.io.File.class) || + settings.getClass().equals(Integer.class) || + settings.getClass().equals(String.class) || + settings.getClass().isEnum()) { + map.put("settings", settings); + } else if (isListOfFile(settings)) { + for(int i = 0; i< getListSize(settings); i++) { + map.put("settings[" + i + "]", getFromList(settings, i)); + } + } + else { + map.put("settings", JSON.getDefault().getMapper().writeValueAsString(settings)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseSettings.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseSettings.java new file mode 100644 index 000000000..fa92563d0 --- /dev/null +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseSettings.java @@ -0,0 +1,281 @@ +/* + * 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; +/** + * Subset of configured settings + */ +@JsonPropertyOrder({ + AccountResponseSettings.JSON_PROPERTY_SIGNER_ACCESS_CODES, + AccountResponseSettings.JSON_PROPERTY_SMS_DELIVERY, + AccountResponseSettings.JSON_PROPERTY_SMS_AUTHENTICATION +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class AccountResponseSettings { + public static final String JSON_PROPERTY_SIGNER_ACCESS_CODES = "signer_access_codes"; + @jakarta.annotation.Nullable + private Boolean signerAccessCodes; + + public static final String JSON_PROPERTY_SMS_DELIVERY = "sms_delivery"; + @jakarta.annotation.Nullable + private Boolean smsDelivery; + + public static final String JSON_PROPERTY_SMS_AUTHENTICATION = "sms_authentication"; + @jakarta.annotation.Nullable + private Boolean smsAuthentication; + + public AccountResponseSettings() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public AccountResponseSettings init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, AccountResponseSettings.class); + } + + static public AccountResponseSettings init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + AccountResponseSettings.class + ); + } + + public AccountResponseSettings signerAccessCodes(@jakarta.annotation.Nullable Boolean signerAccessCodes) { + this.signerAccessCodes = signerAccessCodes; + return this; + } + + /** + * Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + * @return signerAccessCodes + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_ACCESS_CODES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getSignerAccessCodes() { + return signerAccessCodes; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_ACCESS_CODES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerAccessCodes(@jakarta.annotation.Nullable Boolean signerAccessCodes) { + this.signerAccessCodes = signerAccessCodes; + } + + + public AccountResponseSettings smsDelivery(@jakarta.annotation.Nullable Boolean smsDelivery) { + this.smsDelivery = smsDelivery; + return this; + } + + /** + * Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + * @return smsDelivery + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SMS_DELIVERY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getSmsDelivery() { + return smsDelivery; + } + + + @JsonProperty(JSON_PROPERTY_SMS_DELIVERY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSmsDelivery(@jakarta.annotation.Nullable Boolean smsDelivery) { + this.smsDelivery = smsDelivery; + } + + + public AccountResponseSettings smsAuthentication(@jakarta.annotation.Nullable Boolean smsAuthentication) { + this.smsAuthentication = smsAuthentication; + return this; + } + + /** + * Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + * @return smsAuthentication + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SMS_AUTHENTICATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getSmsAuthentication() { + return smsAuthentication; + } + + + @JsonProperty(JSON_PROPERTY_SMS_AUTHENTICATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSmsAuthentication(@jakarta.annotation.Nullable Boolean smsAuthentication) { + this.smsAuthentication = smsAuthentication; + } + + + /** + * Return true if this AccountResponseSettings object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + AccountResponseSettings accountResponseSettings = (AccountResponseSettings) o; + return Objects.equals(this.signerAccessCodes, accountResponseSettings.signerAccessCodes) && + Objects.equals(this.smsDelivery, accountResponseSettings.smsDelivery) && + Objects.equals(this.smsAuthentication, accountResponseSettings.smsAuthentication); + } + + @Override + public int hashCode() { + return Objects.hash(signerAccessCodes, smsDelivery, smsAuthentication); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class AccountResponseSettings {\n"); + sb.append(" signerAccessCodes: ").append(toIndentedString(signerAccessCodes)).append("\n"); + sb.append(" smsDelivery: ").append(toIndentedString(smsDelivery)).append("\n"); + sb.append(" smsAuthentication: ").append(toIndentedString(smsAuthentication)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (signerAccessCodes != null) { + if (isFileTypeOrListOfFiles(signerAccessCodes)) { + fileTypeFound = true; + } + + if (signerAccessCodes.getClass().equals(java.io.File.class) || + signerAccessCodes.getClass().equals(Integer.class) || + signerAccessCodes.getClass().equals(String.class) || + signerAccessCodes.getClass().isEnum()) { + map.put("signer_access_codes", signerAccessCodes); + } else if (isListOfFile(signerAccessCodes)) { + for(int i = 0; i< getListSize(signerAccessCodes); i++) { + map.put("signer_access_codes[" + i + "]", getFromList(signerAccessCodes, i)); + } + } + else { + map.put("signer_access_codes", JSON.getDefault().getMapper().writeValueAsString(signerAccessCodes)); + } + } + if (smsDelivery != null) { + if (isFileTypeOrListOfFiles(smsDelivery)) { + fileTypeFound = true; + } + + if (smsDelivery.getClass().equals(java.io.File.class) || + smsDelivery.getClass().equals(Integer.class) || + smsDelivery.getClass().equals(String.class) || + smsDelivery.getClass().isEnum()) { + map.put("sms_delivery", smsDelivery); + } else if (isListOfFile(smsDelivery)) { + for(int i = 0; i< getListSize(smsDelivery); i++) { + map.put("sms_delivery[" + i + "]", getFromList(smsDelivery, i)); + } + } + else { + map.put("sms_delivery", JSON.getDefault().getMapper().writeValueAsString(smsDelivery)); + } + } + if (smsAuthentication != null) { + if (isFileTypeOrListOfFiles(smsAuthentication)) { + fileTypeFound = true; + } + + if (smsAuthentication.getClass().equals(java.io.File.class) || + smsAuthentication.getClass().equals(Integer.class) || + smsAuthentication.getClass().equals(String.class) || + smsAuthentication.getClass().isEnum()) { + map.put("sms_authentication", smsAuthentication); + } else if (isListOfFile(smsAuthentication)) { + for(int i = 0; i< getListSize(smsAuthentication); i++) { + map.put("sms_authentication[" + i + "]", getFromList(smsAuthentication, i)); + } + } + else { + map.put("sms_authentication", JSON.getDefault().getMapper().writeValueAsString(smsAuthentication)); + } + } + } 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 eb324de36..19d311d6c 100644 --- a/sdks/node/README.md +++ b/sdks/node/README.md @@ -161,6 +161,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [AccountGetResponse](./docs/model/AccountGetResponse.md) - [AccountResponse](./docs/model/AccountResponse.md) - [AccountResponseQuotas](./docs/model/AccountResponseQuotas.md) +- [AccountResponseSettings](./docs/model/AccountResponseSettings.md) - [AccountResponseUsage](./docs/model/AccountResponseUsage.md) - [AccountUpdateRequest](./docs/model/AccountUpdateRequest.md) - [AccountVerifyRequest](./docs/model/AccountVerifyRequest.md) diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 4c5a18ded..989d4e230 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -13150,6 +13150,7 @@ __export(api_exports, { AccountGetResponse: () => AccountGetResponse, AccountResponse: () => AccountResponse, AccountResponseQuotas: () => AccountResponseQuotas, + AccountResponseSettings: () => AccountResponseSettings, AccountResponseUsage: () => AccountResponseUsage, AccountUpdateRequest: () => AccountUpdateRequest, AccountVerifyRequest: () => AccountVerifyRequest, @@ -16824,6 +16825,11 @@ var AccountResponse = class _AccountResponse { name: "usage", baseName: "usage", type: "AccountResponseUsage" + }, + { + name: "settings", + baseName: "settings", + type: "AccountResponseSettings" } ]; } @@ -16884,6 +16890,39 @@ var AccountResponseQuotas = class _AccountResponseQuotas { } }; +// model/accountResponseSettings.ts +var AccountResponseSettings = class _AccountResponseSettings { + static { + this.discriminator = void 0; + } + static { + this.attributeTypeMap = [ + { + name: "signerAccessCodes", + baseName: "signer_access_codes", + type: "boolean" + }, + { + name: "smsDelivery", + baseName: "sms_delivery", + type: "boolean" + }, + { + name: "smsAuthentication", + baseName: "sms_authentication", + type: "boolean" + } + ]; + } + static getAttributeTypeMap() { + return _AccountResponseSettings.attributeTypeMap; + } + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data) { + return ObjectSerializer.deserialize(data, "AccountResponseSettings"); + } +}; + // model/accountResponseUsage.ts var AccountResponseUsage = class _AccountResponseUsage { static { @@ -26943,6 +26982,7 @@ var typeMap = { AccountGetResponse, AccountResponse, AccountResponseQuotas, + AccountResponseSettings, AccountResponseUsage, AccountUpdateRequest, AccountVerifyRequest, @@ -36588,6 +36628,7 @@ var APIS = [ AccountGetResponse, AccountResponse, AccountResponseQuotas, + AccountResponseSettings, AccountResponseUsage, AccountUpdateRequest, AccountVerifyRequest, diff --git a/sdks/node/docs/model/AccountResponse.md b/sdks/node/docs/model/AccountResponse.md index b24e1638f..87f26057e 100644 --- a/sdks/node/docs/model/AccountResponse.md +++ b/sdks/node/docs/model/AccountResponse.md @@ -17,5 +17,6 @@ Name | Type | Description | Notes | `teamId` | ```string``` | The id of the team account belongs to. | | | `locale` | ```string``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | | | `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | | +| `settings` | [```AccountResponseSettings```](AccountResponseSettings.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/AccountResponseSettings.md b/sdks/node/docs/model/AccountResponseSettings.md new file mode 100644 index 000000000..f9071a590 --- /dev/null +++ b/sdks/node/docs/model/AccountResponseSettings.md @@ -0,0 +1,13 @@ +# # AccountResponseSettings + +Subset of configured settings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `signerAccessCodes` | ```boolean``` | Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | +| `smsDelivery` | ```boolean``` | Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | +| `smsAuthentication` | ```boolean``` | Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/model/accountResponse.ts b/sdks/node/model/accountResponse.ts index 73394d615..131dedc2a 100644 --- a/sdks/node/model/accountResponse.ts +++ b/sdks/node/model/accountResponse.ts @@ -24,6 +24,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { AccountResponseQuotas } from "./accountResponseQuotas"; +import { AccountResponseSettings } from "./accountResponseSettings"; import { AccountResponseUsage } from "./accountResponseUsage"; export class AccountResponse { @@ -65,6 +66,7 @@ export class AccountResponse { */ "locale"?: string | null; "usage"?: AccountResponseUsage; + "settings"?: AccountResponseSettings; static discriminator: string | undefined = undefined; @@ -124,6 +126,11 @@ export class AccountResponse { baseName: "usage", type: "AccountResponseUsage", }, + { + name: "settings", + baseName: "settings", + type: "AccountResponseSettings", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/accountResponseSettings.ts b/sdks/node/model/accountResponseSettings.ts new file mode 100644 index 000000000..600e041de --- /dev/null +++ b/sdks/node/model/accountResponseSettings.ts @@ -0,0 +1,72 @@ +/** + * 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 "./"; + +/** + * Subset of configured settings + */ +export class AccountResponseSettings { + /** + * Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + */ + "signerAccessCodes"?: boolean; + /** + * Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + */ + "smsDelivery"?: boolean; + /** + * Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + */ + "smsAuthentication"?: boolean; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "signerAccessCodes", + baseName: "signer_access_codes", + type: "boolean", + }, + { + name: "smsDelivery", + baseName: "sms_delivery", + type: "boolean", + }, + { + name: "smsAuthentication", + baseName: "sms_authentication", + type: "boolean", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return AccountResponseSettings.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): AccountResponseSettings { + return ObjectSerializer.deserialize(data, "AccountResponseSettings"); + } +} diff --git a/sdks/node/model/index.ts b/sdks/node/model/index.ts index cd4da181f..7b5badacb 100644 --- a/sdks/node/model/index.ts +++ b/sdks/node/model/index.ts @@ -3,6 +3,7 @@ import { AccountCreateResponse } from "./accountCreateResponse"; import { AccountGetResponse } from "./accountGetResponse"; import { AccountResponse } from "./accountResponse"; import { AccountResponseQuotas } from "./accountResponseQuotas"; +import { AccountResponseSettings } from "./accountResponseSettings"; import { AccountResponseUsage } from "./accountResponseUsage"; import { AccountUpdateRequest } from "./accountUpdateRequest"; import { AccountVerifyRequest } from "./accountVerifyRequest"; @@ -261,6 +262,7 @@ export let typeMap: { [index: string]: any } = { AccountGetResponse: AccountGetResponse, AccountResponse: AccountResponse, AccountResponseQuotas: AccountResponseQuotas, + AccountResponseSettings: AccountResponseSettings, AccountResponseUsage: AccountResponseUsage, AccountUpdateRequest: AccountUpdateRequest, AccountVerifyRequest: AccountVerifyRequest, @@ -490,6 +492,7 @@ export { AccountGetResponse, AccountResponse, AccountResponseQuotas, + AccountResponseSettings, AccountResponseUsage, AccountUpdateRequest, AccountVerifyRequest, diff --git a/sdks/node/types/model/accountResponse.d.ts b/sdks/node/types/model/accountResponse.d.ts index c38fde985..767441b96 100644 --- a/sdks/node/types/model/accountResponse.d.ts +++ b/sdks/node/types/model/accountResponse.d.ts @@ -1,5 +1,6 @@ import { AttributeTypeMap } from "./"; import { AccountResponseQuotas } from "./accountResponseQuotas"; +import { AccountResponseSettings } from "./accountResponseSettings"; import { AccountResponseUsage } from "./accountResponseUsage"; export declare class AccountResponse { "accountId"?: string; @@ -13,6 +14,7 @@ export declare class AccountResponse { "teamId"?: string | null; "locale"?: string | null; "usage"?: AccountResponseUsage; + "settings"?: AccountResponseSettings; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/accountResponseSettings.d.ts b/sdks/node/types/model/accountResponseSettings.d.ts new file mode 100644 index 000000000..4d816d64c --- /dev/null +++ b/sdks/node/types/model/accountResponseSettings.d.ts @@ -0,0 +1,10 @@ +import { AttributeTypeMap } from "./"; +export declare class AccountResponseSettings { + "signerAccessCodes"?: boolean; + "smsDelivery"?: boolean; + "smsAuthentication"?: boolean; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): AccountResponseSettings; +} diff --git a/sdks/node/types/model/index.d.ts b/sdks/node/types/model/index.d.ts index 097631a55..e34120091 100644 --- a/sdks/node/types/model/index.d.ts +++ b/sdks/node/types/model/index.d.ts @@ -3,6 +3,7 @@ import { AccountCreateResponse } from "./accountCreateResponse"; import { AccountGetResponse } from "./accountGetResponse"; import { AccountResponse } from "./accountResponse"; import { AccountResponseQuotas } from "./accountResponseQuotas"; +import { AccountResponseSettings } from "./accountResponseSettings"; import { AccountResponseUsage } from "./accountResponseUsage"; import { AccountUpdateRequest } from "./accountUpdateRequest"; import { AccountVerifyRequest } from "./accountVerifyRequest"; @@ -199,4 +200,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, 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, SignatureRequestEditEmbeddedRequest, SignatureRequestEditEmbeddedWithTemplateRequest, SignatureRequestEditRequest, SignatureRequestEditWithTemplateRequest, 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, SubUpdateFormField, SubWhiteLabelingOptions, TeamAddMemberRequest, TeamCreateRequest, TeamGetInfoResponse, TeamGetResponse, TeamInfoResponse, TeamInviteResponse, TeamInvitesResponse, TeamMemberResponse, TeamMembersResponse, TeamParentResponse, TeamRemoveMemberRequest, TeamResponse, TeamSubTeamsResponse, TeamUpdateRequest, TemplateAddUserRequest, TemplateCreateEmbeddedDraftRequest, TemplateCreateEmbeddedDraftResponse, TemplateCreateEmbeddedDraftResponseTemplate, TemplateCreateRequest, TemplateCreateResponse, TemplateCreateResponseTemplate, 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, TemplateUpdateRequest, UnclaimedDraftCreateEmbeddedRequest, UnclaimedDraftCreateEmbeddedWithTemplateRequest, UnclaimedDraftCreateRequest, UnclaimedDraftCreateResponse, UnclaimedDraftEditAndResendRequest, UnclaimedDraftResponse, VoidAuth, WarningResponse, }; +export { AccountCreateRequest, AccountCreateResponse, AccountGetResponse, AccountResponse, AccountResponseQuotas, AccountResponseSettings, 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, SignatureRequestEditEmbeddedRequest, SignatureRequestEditEmbeddedWithTemplateRequest, SignatureRequestEditRequest, SignatureRequestEditWithTemplateRequest, 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, SubUpdateFormField, SubWhiteLabelingOptions, TeamAddMemberRequest, TeamCreateRequest, TeamGetInfoResponse, TeamGetResponse, TeamInfoResponse, TeamInviteResponse, TeamInvitesResponse, TeamMemberResponse, TeamMembersResponse, TeamParentResponse, TeamRemoveMemberRequest, TeamResponse, TeamSubTeamsResponse, TeamUpdateRequest, TemplateAddUserRequest, TemplateCreateEmbeddedDraftRequest, TemplateCreateEmbeddedDraftResponse, TemplateCreateEmbeddedDraftResponseTemplate, TemplateCreateRequest, TemplateCreateResponse, TemplateCreateResponseTemplate, 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, TemplateUpdateRequest, UnclaimedDraftCreateEmbeddedRequest, UnclaimedDraftCreateEmbeddedWithTemplateRequest, UnclaimedDraftCreateRequest, UnclaimedDraftCreateResponse, UnclaimedDraftEditAndResendRequest, UnclaimedDraftResponse, VoidAuth, WarningResponse, }; diff --git a/sdks/php/README.md b/sdks/php/README.md index 8d1fa2d17..30c3cc8f7 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -230,6 +230,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [AccountGetResponse](docs/Model/AccountGetResponse.md) - [AccountResponse](docs/Model/AccountResponse.md) - [AccountResponseQuotas](docs/Model/AccountResponseQuotas.md) +- [AccountResponseSettings](docs/Model/AccountResponseSettings.md) - [AccountResponseUsage](docs/Model/AccountResponseUsage.md) - [AccountUpdateRequest](docs/Model/AccountUpdateRequest.md) - [AccountVerifyRequest](docs/Model/AccountVerifyRequest.md) diff --git a/sdks/php/docs/Model/AccountResponse.md b/sdks/php/docs/Model/AccountResponse.md index 3121826ba..8cabded2a 100644 --- a/sdks/php/docs/Model/AccountResponse.md +++ b/sdks/php/docs/Model/AccountResponse.md @@ -17,5 +17,6 @@ Name | Type | Description | Notes | `team_id` | ```string``` | The id of the team account belongs to. | | | `locale` | ```string``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | | | `usage` | [```\Dropbox\Sign\Model\AccountResponseUsage```](AccountResponseUsage.md) | | | +| `settings` | [```\Dropbox\Sign\Model\AccountResponseSettings```](AccountResponseSettings.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/AccountResponseSettings.md b/sdks/php/docs/Model/AccountResponseSettings.md new file mode 100644 index 000000000..913c6584a --- /dev/null +++ b/sdks/php/docs/Model/AccountResponseSettings.md @@ -0,0 +1,13 @@ +# # AccountResponseSettings + +Subset of configured settings + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `signer_access_codes` | ```bool``` | Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | +| `sms_delivery` | ```bool``` | Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | +| `sms_authentication` | ```bool``` | Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/src/Model/AccountResponse.php b/sdks/php/src/Model/AccountResponse.php index 251546bab..25a88c24f 100644 --- a/sdks/php/src/Model/AccountResponse.php +++ b/sdks/php/src/Model/AccountResponse.php @@ -68,6 +68,7 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable 'team_id' => 'string', 'locale' => 'string', 'usage' => '\Dropbox\Sign\Model\AccountResponseUsage', + 'settings' => '\Dropbox\Sign\Model\AccountResponseSettings', ]; /** @@ -89,6 +90,7 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable 'team_id' => null, 'locale' => null, 'usage' => null, + 'settings' => null, ]; /** @@ -108,6 +110,7 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable 'team_id' => true, 'locale' => true, 'usage' => false, + 'settings' => false, ]; /** @@ -199,6 +202,7 @@ public function isNullableSetToNull(string $property): bool 'team_id' => 'team_id', 'locale' => 'locale', 'usage' => 'usage', + 'settings' => 'settings', ]; /** @@ -218,6 +222,7 @@ public function isNullableSetToNull(string $property): bool 'team_id' => 'setTeamId', 'locale' => 'setLocale', 'usage' => 'setUsage', + 'settings' => 'setSettings', ]; /** @@ -237,6 +242,7 @@ public function isNullableSetToNull(string $property): bool 'team_id' => 'getTeamId', 'locale' => 'getLocale', 'usage' => 'getUsage', + 'settings' => 'getSettings', ]; /** @@ -306,6 +312,7 @@ public function __construct(?array $data = null) $this->setIfExists('team_id', $data ?? [], null); $this->setIfExists('locale', $data ?? [], null); $this->setIfExists('usage', $data ?? [], null); + $this->setIfExists('settings', $data ?? [], null); } /** @@ -690,6 +697,33 @@ public function setUsage(?AccountResponseUsage $usage) return $this; } + /** + * Gets settings + * + * @return AccountResponseSettings|null + */ + public function getSettings() + { + return $this->container['settings']; + } + + /** + * Sets settings + * + * @param AccountResponseSettings|null $settings settings + * + * @return self + */ + public function setSettings(?AccountResponseSettings $settings) + { + if (is_null($settings)) { + throw new InvalidArgumentException('non-nullable settings cannot be null'); + } + $this->container['settings'] = $settings; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/AccountResponseSettings.php b/sdks/php/src/Model/AccountResponseSettings.php new file mode 100644 index 000000000..b150e8088 --- /dev/null +++ b/sdks/php/src/Model/AccountResponseSettings.php @@ -0,0 +1,480 @@ + + */ +class AccountResponseSettings implements ModelInterface, ArrayAccess, JsonSerializable +{ + public const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $openAPIModelName = 'AccountResponseSettings'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $openAPITypes = [ + 'signer_access_codes' => 'bool', + 'sms_delivery' => 'bool', + 'sms_authentication' => 'bool', + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ + protected static $openAPIFormats = [ + 'signer_access_codes' => null, + 'sms_delivery' => null, + 'sms_authentication' => null, + ]; + + /** + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ + protected static array $openAPINullables = [ + 'signer_access_codes' => false, + 'sms_delivery' => false, + 'sms_authentication' => 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 = [ + 'signer_access_codes' => 'signer_access_codes', + 'sms_delivery' => 'sms_delivery', + 'sms_authentication' => 'sms_authentication', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'signer_access_codes' => 'setSignerAccessCodes', + 'sms_delivery' => 'setSmsDelivery', + 'sms_authentication' => 'setSmsAuthentication', + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'signer_access_codes' => 'getSignerAccessCodes', + 'sms_delivery' => 'getSmsDelivery', + 'sms_authentication' => 'getSmsAuthentication', + ]; + + /** + * 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[]|null $data Associated array of property values + * initializing the model + */ + public function __construct(?array $data = null) + { + $this->setIfExists('signer_access_codes', $data ?? [], null); + $this->setIfExists('sms_delivery', $data ?? [], null); + $this->setIfExists('sms_authentication', $data ?? [], null); + } + + /** + * @deprecated use ::init() + */ + public static function fromArray(array $data): AccountResponseSettings + { + return self::init($data); + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + */ + public static function init(array $data): AccountResponseSettings + { + /** @var AccountResponseSettings */ + return ObjectSerializer::deserialize( + $data, + AccountResponseSettings::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() + { + return []; + } + + /** + * 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 signer_access_codes + * + * @return bool|null + */ + public function getSignerAccessCodes() + { + return $this->container['signer_access_codes']; + } + + /** + * Sets signer_access_codes + * + * @param bool|null $signer_access_codes Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + * + * @return self + */ + public function setSignerAccessCodes(?bool $signer_access_codes) + { + if (is_null($signer_access_codes)) { + throw new InvalidArgumentException('non-nullable signer_access_codes cannot be null'); + } + $this->container['signer_access_codes'] = $signer_access_codes; + + return $this; + } + + /** + * Gets sms_delivery + * + * @return bool|null + */ + public function getSmsDelivery() + { + return $this->container['sms_delivery']; + } + + /** + * Sets sms_delivery + * + * @param bool|null $sms_delivery Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + * + * @return self + */ + public function setSmsDelivery(?bool $sms_delivery) + { + if (is_null($sms_delivery)) { + throw new InvalidArgumentException('non-nullable sms_delivery cannot be null'); + } + $this->container['sms_delivery'] = $sms_delivery; + + return $this; + } + + /** + * Gets sms_authentication + * + * @return bool|null + */ + public function getSmsAuthentication() + { + return $this->container['sms_authentication']; + } + + /** + * Sets sms_authentication + * + * @param bool|null $sms_authentication Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + * + * @return self + */ + public function setSmsAuthentication(?bool $sms_authentication) + { + if (is_null($sms_authentication)) { + throw new InvalidArgumentException('non-nullable sms_authentication cannot be null'); + } + $this->container['sms_authentication'] = $sms_authentication; + + 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 ccc6d09d3..d9a3c0faf 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -186,6 +186,7 @@ Class | Method | HTTP request | Description - [AccountGetResponse](docs/AccountGetResponse.md) - [AccountResponse](docs/AccountResponse.md) - [AccountResponseQuotas](docs/AccountResponseQuotas.md) + - [AccountResponseSettings](docs/AccountResponseSettings.md) - [AccountResponseUsage](docs/AccountResponseUsage.md) - [AccountUpdateRequest](docs/AccountUpdateRequest.md) - [AccountVerifyRequest](docs/AccountVerifyRequest.md) diff --git a/sdks/python/docs/AccountResponse.md b/sdks/python/docs/AccountResponse.md index fe7f8da48..169026b85 100644 --- a/sdks/python/docs/AccountResponse.md +++ b/sdks/python/docs/AccountResponse.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes | `team_id` | ```str``` | The id of the team account belongs to. | | | `locale` | ```str``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | | | `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | | +| `settings` | [```AccountResponseSettings```](AccountResponseSettings.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/AccountResponseSettings.md b/sdks/python/docs/AccountResponseSettings.md new file mode 100644 index 000000000..2817e7268 --- /dev/null +++ b/sdks/python/docs/AccountResponseSettings.md @@ -0,0 +1,14 @@ +# AccountResponseSettings + +Subset of configured settings + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `signer_access_codes` | ```bool``` | Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | +| `sms_delivery` | ```bool``` | Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | +| `sms_authentication` | ```bool``` | Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | + +[[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 434f62d03..7333f4019 100644 --- a/sdks/python/dropbox_sign/__init__.py +++ b/sdks/python/dropbox_sign/__init__.py @@ -37,6 +37,7 @@ from dropbox_sign.models.account_get_response import AccountGetResponse from dropbox_sign.models.account_response import AccountResponse from dropbox_sign.models.account_response_quotas import AccountResponseQuotas +from dropbox_sign.models.account_response_settings import AccountResponseSettings from dropbox_sign.models.account_response_usage import AccountResponseUsage from dropbox_sign.models.account_update_request import AccountUpdateRequest from dropbox_sign.models.account_verify_request import AccountVerifyRequest diff --git a/sdks/python/dropbox_sign/models/__init__.py b/sdks/python/dropbox_sign/models/__init__.py index 9608ce6eb..5ce58f513 100644 --- a/sdks/python/dropbox_sign/models/__init__.py +++ b/sdks/python/dropbox_sign/models/__init__.py @@ -20,6 +20,7 @@ from dropbox_sign.models.account_get_response import AccountGetResponse from dropbox_sign.models.account_response import AccountResponse from dropbox_sign.models.account_response_quotas import AccountResponseQuotas +from dropbox_sign.models.account_response_settings import AccountResponseSettings from dropbox_sign.models.account_response_usage import AccountResponseUsage from dropbox_sign.models.account_update_request import AccountUpdateRequest from dropbox_sign.models.account_verify_request import AccountVerifyRequest diff --git a/sdks/python/dropbox_sign/models/account_response.py b/sdks/python/dropbox_sign/models/account_response.py index 527377330..9f8beb4d2 100644 --- a/sdks/python/dropbox_sign/models/account_response.py +++ b/sdks/python/dropbox_sign/models/account_response.py @@ -21,6 +21,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.account_response_quotas import AccountResponseQuotas +from dropbox_sign.models.account_response_settings import AccountResponseSettings from dropbox_sign.models.account_response_usage import AccountResponseUsage from typing import Optional, Set from typing_extensions import Self @@ -67,6 +68,7 @@ class AccountResponse(BaseModel): description="The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.", ) usage: Optional[AccountResponseUsage] = None + settings: Optional[AccountResponseSettings] = None __properties: ClassVar[List[str]] = [ "account_id", "email_address", @@ -79,6 +81,7 @@ class AccountResponse(BaseModel): "team_id", "locale", "usage", + "settings", ] model_config = ConfigDict( @@ -137,6 +140,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of usage if self.usage: _dict["usage"] = self.usage.to_dict() + # override the default output from pydantic by calling `to_dict()` of settings + if self.settings: + _dict["settings"] = self.settings.to_dict() return _dict @classmethod @@ -169,6 +175,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("usage") is not None else None ), + "settings": ( + AccountResponseSettings.from_dict(obj["settings"]) + if obj.get("settings") is not None + else None + ), } ) return _obj @@ -197,6 +208,7 @@ def openapi_types(cls) -> Dict[str, str]: "team_id": "(str,)", "locale": "(str,)", "usage": "(AccountResponseUsage,)", + "settings": "(AccountResponseSettings,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/account_response_settings.py b/sdks/python/dropbox_sign/models/account_response_settings.py new file mode 100644 index 000000000..18fbe9844 --- /dev/null +++ b/sdks/python/dropbox_sign/models/account_response_settings.py @@ -0,0 +1,143 @@ +# 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 +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self +from typing import Tuple, Union +import io +from pydantic import StrictBool + + +class AccountResponseSettings(BaseModel): + """ + Subset of configured settings + """ # noqa: E501 + + signer_access_codes: Optional[StrictBool] = Field( + default=None, + description="Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).", + ) + sms_delivery: Optional[StrictBool] = Field( + default=None, + description="Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).", + ) + sms_authentication: Optional[StrictBool] = Field( + default=None, + description="Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).", + ) + __properties: ClassVar[List[str]] = [ + "signer_access_codes", + "sms_delivery", + "sms_authentication", + ] + + 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 AccountResponseSettings 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 AccountResponseSettings from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "signer_access_codes": obj.get("signer_access_codes"), + "sms_delivery": obj.get("sms_delivery"), + "sms_authentication": obj.get("sms_authentication"), + } + ) + 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 { + "signer_access_codes": "(bool,)", + "sms_delivery": "(bool,)", + "sms_authentication": "(bool,)", + } + + @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 147a91868..e925ed63a 100644 --- a/sdks/ruby/README.md +++ b/sdks/ruby/README.md @@ -190,6 +190,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [Dropbox::Sign::AccountGetResponse](docs/AccountGetResponse.md) - [Dropbox::Sign::AccountResponse](docs/AccountResponse.md) - [Dropbox::Sign::AccountResponseQuotas](docs/AccountResponseQuotas.md) + - [Dropbox::Sign::AccountResponseSettings](docs/AccountResponseSettings.md) - [Dropbox::Sign::AccountResponseUsage](docs/AccountResponseUsage.md) - [Dropbox::Sign::AccountUpdateRequest](docs/AccountUpdateRequest.md) - [Dropbox::Sign::AccountVerifyRequest](docs/AccountVerifyRequest.md) diff --git a/sdks/ruby/docs/AccountResponse.md b/sdks/ruby/docs/AccountResponse.md index 294f29431..aeb1b38ae 100644 --- a/sdks/ruby/docs/AccountResponse.md +++ b/sdks/ruby/docs/AccountResponse.md @@ -17,4 +17,5 @@ | `team_id` | ```String``` | The id of the team account belongs to. | | | `locale` | ```String``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | | | `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | | +| `settings` | [```AccountResponseSettings```](AccountResponseSettings.md) | | | diff --git a/sdks/ruby/docs/AccountResponseSettings.md b/sdks/ruby/docs/AccountResponseSettings.md new file mode 100644 index 000000000..642280e83 --- /dev/null +++ b/sdks/ruby/docs/AccountResponseSettings.md @@ -0,0 +1,12 @@ +# Dropbox::Sign::AccountResponseSettings + +Subset of configured settings + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `signer_access_codes` | ```Boolean``` | Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | +| `sms_delivery` | ```Boolean``` | Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | +| `sms_authentication` | ```Boolean``` | Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | | + diff --git a/sdks/ruby/lib/dropbox-sign.rb b/sdks/ruby/lib/dropbox-sign.rb index 42b56d949..729ebf6c1 100644 --- a/sdks/ruby/lib/dropbox-sign.rb +++ b/sdks/ruby/lib/dropbox-sign.rb @@ -22,6 +22,7 @@ require 'dropbox-sign/models/account_get_response' require 'dropbox-sign/models/account_response' require 'dropbox-sign/models/account_response_quotas' +require 'dropbox-sign/models/account_response_settings' require 'dropbox-sign/models/account_response_usage' require 'dropbox-sign/models/account_update_request' require 'dropbox-sign/models/account_verify_request' diff --git a/sdks/ruby/lib/dropbox-sign/models/account_response.rb b/sdks/ruby/lib/dropbox-sign/models/account_response.rb index 4e96e470d..d9ccec82e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response.rb @@ -60,6 +60,9 @@ class AccountResponse # @return [AccountResponseUsage] attr_accessor :usage + # @return [AccountResponseSettings] + attr_accessor :settings + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -73,7 +76,8 @@ def self.attribute_map :'role_code' => :'role_code', :'team_id' => :'team_id', :'locale' => :'locale', - :'usage' => :'usage' + :'usage' => :'usage', + :'settings' => :'settings' } end @@ -100,7 +104,8 @@ def self.openapi_types :'role_code' => :'String', :'team_id' => :'String', :'locale' => :'String', - :'usage' => :'AccountResponseUsage' + :'usage' => :'AccountResponseUsage', + :'settings' => :'AccountResponseSettings' } end @@ -198,6 +203,10 @@ def initialize(attributes = {}) if attributes.key?(:'usage') self.usage = attributes[:'usage'] end + + if attributes.key?(:'settings') + self.settings = attributes[:'settings'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -228,7 +237,8 @@ def ==(o) role_code == o.role_code && team_id == o.team_id && locale == o.locale && - usage == o.usage + usage == o.usage && + settings == o.settings end # @see the `==` method @@ -240,7 +250,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [account_id, email_address, is_locked, is_paid_hs, is_paid_hf, quotas, callback_url, role_code, team_id, locale, usage].hash + [account_id, email_address, is_locked, is_paid_hs, is_paid_hf, quotas, callback_url, role_code, team_id, locale, usage, settings].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/account_response_settings.rb b/sdks/ruby/lib/dropbox-sign/models/account_response_settings.rb new file mode 100644 index 000000000..5710c3ac8 --- /dev/null +++ b/sdks/ruby/lib/dropbox-sign/models/account_response_settings.rb @@ -0,0 +1,275 @@ +=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.12.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + # Subset of configured settings + class AccountResponseSettings + # Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + # @return [Boolean] + attr_accessor :signer_access_codes + + # Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + # @return [Boolean] + attr_accessor :sms_delivery + + # Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). + # @return [Boolean] + attr_accessor :sms_authentication + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'signer_access_codes' => :'signer_access_codes', + :'sms_delivery' => :'sms_delivery', + :'sms_authentication' => :'sms_authentication' + } + end + + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + acceptable_attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'signer_access_codes' => :'Boolean', + :'sms_delivery' => :'Boolean', + :'sms_authentication' => :'Boolean' + } + 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 [AccountResponseSettings] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "AccountResponseSettings" + ) || AccountResponseSettings.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::AccountResponseSettings` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map + 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::AccountResponseSettings`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'signer_access_codes') + self.signer_access_codes = attributes[:'signer_access_codes'] + end + + if attributes.key?(:'sms_delivery') + self.sms_delivery = attributes[:'sms_delivery'] + end + + if attributes.key?(:'sms_authentication') + self.sms_authentication = attributes[:'sms_authentication'] + 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 + 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? + 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 && + signer_access_codes == o.signer_access_codes && + sms_delivery == o.sms_delivery && + sms_authentication == o.sms_authentication + 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 + [signer_access_codes, sms_delivery, sms_authentication].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/translations/en.yaml b/translations/en.yaml index 382dadd9a..54283f924 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -1273,6 +1273,7 @@ "Account::LOCALE": The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. "Account::QUOTA": Details concerning remaining monthly quotas. "Account::USAGE": Details concerning monthly usage +"Account::SETTINGS": Subset of configured settings "AccountQuota::TEMPLATES_LEFT": API templates remaining. "AccountQuota::TEMPLATES_TOTAL": Total API templates allowed. "AccountQuota::API_SIGNATURE_REQUESTS_LEFT": API signature requests remaining. @@ -1280,6 +1281,9 @@ "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 +"AccountSettings::SIGNER_ACCESS_CODES": Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). +"AccountSettings::SMS_DELIVERY": Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). +"AccountSettings::SMS_AUTHENTICATION": Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). "ApiAppCreateResponseExample::SUMMARY": API App "ApiAppGetResponseExample::SUMMARY": API App