dropbox-sign 1.1.2 → 1.4.1

data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb

@@ -31,12 +31,44 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :content_url
 
+    # Font family for the field.
+    # @return [String]
+    attr_accessor :font_family
+
+    # The initial px font size for the field contents. Can be any integer value between `7` and `49`.  **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
+    # @return [Integer]
+    attr_accessor :font_size
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'type' => :'type',
         :'content' => :'content',
-        :'content_url' => :'content_url'
+        :'content_url' => :'content_url',
+        :'font_family' => :'font_family',
+        :'font_size' => :'font_size'
       }
     end
 
@@ -55,7 +87,9 @@ module Dropbox::Sign
       {
         :'type' => :'String',
         :'content' => :'String',
-        :'content_url' => :'String'
+        :'content_url' => :'String',
+        :'font_family' => :'String',
+        :'font_size' => :'Integer'
       }
     end
 
@@ -116,6 +150,16 @@ module Dropbox::Sign
       if attributes.key?(:'content_url')
         self.content_url = attributes[:'content_url']
       end
+
+      if attributes.key?(:'font_family')
+        self.font_family = attributes[:'font_family']
+      end
+
+      if attributes.key?(:'font_size')
+        self.font_size = attributes[:'font_size']
+      else
+        self.font_size = 12
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -143,9 +187,21 @@ module Dropbox::Sign
       return false if @type.nil?
       return false if @content.nil?
       return false if @content_url.nil?
+      font_family_validator = EnumAttributeValidator.new('String', ["helvetica", "arial", "courier", "calibri", "cambria", "georgia", "times", "trebuchet", "verdana", "roboto", "robotoMono", "notoSans", "notoSerif", "notoCJK-JP-Regular", "notoHebrew-Regular", "notoSanThaiMerged"])
+      return false unless font_family_validator.valid?(@font_family)
       true && super
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] font_family Object to be assigned
+    def font_family=(font_family)
+      validator = EnumAttributeValidator.new('String', ["helvetica", "arial", "courier", "calibri", "cambria", "georgia", "times", "trebuchet", "verdana", "roboto", "robotoMono", "notoSans", "notoSerif", "notoCJK-JP-Regular", "notoHebrew-Regular", "notoSanThaiMerged"])
+      unless validator.valid?(font_family)
+        fail ArgumentError, "invalid value for \"font_family\", must be one of #{validator.allowable_values}."
+      end
+      @font_family = font_family
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -153,7 +209,9 @@ module Dropbox::Sign
       self.class == o.class &&
           type == o.type &&
           content == o.content &&
-          content_url == o.content_url && super(o)
+          content_url == o.content_url &&
+          font_family == o.font_family &&
+          font_size == o.font_size && super(o)
     end
 
     # @see the `==` method
@@ -165,7 +223,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, content, content_url].hash
+      [type, content, content_url, font_family, font_size].hash
     end
 
     # Builds the object from hash

data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb

@@ -39,7 +39,7 @@ module Dropbox::Sign
     # @return [Boolean]
     attr_accessor :masked
 
-    # Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.  **NOTE**: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.
+    # Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.  **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.
     # @return [String]
     attr_accessor :validation_type
 
@@ -49,6 +49,18 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :validation_custom_regex_format_label
 
+    # Content of a `me_now` text field
+    # @return [String]
+    attr_accessor :content
+
+    # Font family for the field.
+    # @return [String]
+    attr_accessor :font_family
+
+    # The initial px font size for the field contents. Can be any integer value between `7` and `49`.  **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
+    # @return [Integer]
+    attr_accessor :font_size
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -81,7 +93,10 @@ module Dropbox::Sign
         :'masked' => :'masked',
         :'validation_type' => :'validation_type',
         :'validation_custom_regex' => :'validation_custom_regex',
-        :'validation_custom_regex_format_label' => :'validation_custom_regex_format_label'
+        :'validation_custom_regex_format_label' => :'validation_custom_regex_format_label',
+        :'content' => :'content',
+        :'font_family' => :'font_family',
+        :'font_size' => :'font_size'
       }
     end
 
@@ -105,7 +120,10 @@ module Dropbox::Sign
         :'masked' => :'Boolean',
         :'validation_type' => :'String',
         :'validation_custom_regex' => :'String',
-        :'validation_custom_regex_format_label' => :'String'
+        :'validation_custom_regex_format_label' => :'String',
+        :'content' => :'String',
+        :'font_family' => :'String',
+        :'font_size' => :'Integer'
       }
     end
 
@@ -186,6 +204,20 @@ module Dropbox::Sign
       if attributes.key?(:'validation_custom_regex_format_label')
         self.validation_custom_regex_format_label = attributes[:'validation_custom_regex_format_label']
       end
+
+      if attributes.key?(:'content')
+        self.content = attributes[:'content']
+      end
+
+      if attributes.key?(:'font_family')
+        self.font_family = attributes[:'font_family']
+      end
+
+      if attributes.key?(:'font_size')
+        self.font_size = attributes[:'font_size']
+      else
+        self.font_size = 12
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -205,6 +237,8 @@ module Dropbox::Sign
       return false if @type.nil?
       validation_type_validator = EnumAttributeValidator.new('String', ["numbers_only", "letters_only", "phone_number", "bank_routing_number", "bank_account_number", "email_address", "zip_code", "social_security_number", "employer_identification_number", "custom_regex"])
       return false unless validation_type_validator.valid?(@validation_type)
+      font_family_validator = EnumAttributeValidator.new('String', ["helvetica", "arial", "courier", "calibri", "cambria", "georgia", "times", "trebuchet", "verdana", "roboto", "robotoMono", "notoSans", "notoSerif", "notoCJK-JP-Regular", "notoHebrew-Regular", "notoSanThaiMerged"])
+      return false unless font_family_validator.valid?(@font_family)
       true && super
     end
 
@@ -218,6 +252,16 @@ module Dropbox::Sign
       @validation_type = validation_type
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] font_family Object to be assigned
+    def font_family=(font_family)
+      validator = EnumAttributeValidator.new('String', ["helvetica", "arial", "courier", "calibri", "cambria", "georgia", "times", "trebuchet", "verdana", "roboto", "robotoMono", "notoSans", "notoSerif", "notoCJK-JP-Regular", "notoHebrew-Regular", "notoSanThaiMerged"])
+      unless validator.valid?(font_family)
+        fail ArgumentError, "invalid value for \"font_family\", must be one of #{validator.allowable_values}."
+      end
+      @font_family = font_family
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -230,7 +274,10 @@ module Dropbox::Sign
           masked == o.masked &&
           validation_type == o.validation_type &&
           validation_custom_regex == o.validation_custom_regex &&
-          validation_custom_regex_format_label == o.validation_custom_regex_format_label && super(o)
+          validation_custom_regex_format_label == o.validation_custom_regex_format_label &&
+          content == o.content &&
+          font_family == o.font_family &&
+          font_size == o.font_size && super(o)
     end
 
     # @see the `==` method
@@ -242,7 +289,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, placeholder, auto_fill_type, link_id, masked, validation_type, validation_custom_regex, validation_custom_regex_format_label].hash
+      [type, placeholder, auto_fill_type, link_id, masked, validation_type, validation_custom_regex, validation_custom_regex_format_label, content, font_family, font_size].hash
     end
 
     # Builds the object from hash

data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb

@@ -23,10 +23,42 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :type
 
+    # Font family for the field.
+    # @return [String]
+    attr_accessor :font_family
+
+    # The initial px font size for the field contents. Can be any integer value between `7` and `49`.  **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
+    # @return [Integer]
+    attr_accessor :font_size
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'type' => :'type'
+        :'type' => :'type',
+        :'font_family' => :'font_family',
+        :'font_size' => :'font_size'
       }
     end
 
@@ -43,7 +75,9 @@ module Dropbox::Sign
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'type' => :'String'
+        :'type' => :'String',
+        :'font_family' => :'String',
+        :'font_size' => :'Integer'
       }
     end
 
@@ -96,6 +130,16 @@ module Dropbox::Sign
       else
         self.type = 'text-merge'
       end
+
+      if attributes.key?(:'font_family')
+        self.font_family = attributes[:'font_family']
+      end
+
+      if attributes.key?(:'font_size')
+        self.font_size = attributes[:'font_size']
+      else
+        self.font_size = 12
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -113,15 +157,29 @@ module Dropbox::Sign
     # @return true if the model is valid
     def valid?
       return false if @type.nil?
+      font_family_validator = EnumAttributeValidator.new('String', ["helvetica", "arial", "courier", "calibri", "cambria", "georgia", "times", "trebuchet", "verdana", "roboto", "robotoMono", "notoSans", "notoSerif", "notoCJK-JP-Regular", "notoHebrew-Regular", "notoSanThaiMerged"])
+      return false unless font_family_validator.valid?(@font_family)
       true && super
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] font_family Object to be assigned
+    def font_family=(font_family)
+      validator = EnumAttributeValidator.new('String', ["helvetica", "arial", "courier", "calibri", "cambria", "georgia", "times", "trebuchet", "verdana", "roboto", "robotoMono", "notoSans", "notoSerif", "notoCJK-JP-Regular", "notoHebrew-Regular", "notoSanThaiMerged"])
+      unless validator.valid?(font_family)
+        fail ArgumentError, "invalid value for \"font_family\", must be one of #{validator.allowable_values}."
+      end
+      @font_family = font_family
+    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 &&
-          type == o.type && super(o)
+          type == o.type &&
+          font_family == o.font_family &&
+          font_size == o.font_size && super(o)
     end
 
     # @see the `==` method
@@ -133,7 +191,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type].hash
+      [type, font_family, font_size].hash
     end
 
     # Builds the object from hash

data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb

@@ -22,7 +22,7 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :group
 
-    # Signers belonging to this Group.  **NOTE**: Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below.
+    # Signers belonging to this Group.  **NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below.
     # @return [Array<SubSignatureRequestSigner>]
     attr_accessor :signers
 

data/lib/dropbox-sign/models/sub_signature_request_signer.rb

@@ -34,7 +34,7 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :pin
 
-    # An E.164 formatted phone number.  **Note**: Not available in test mode and requires a Standard plan or higher.
+    # An E.164 formatted phone number.  By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).  **NOTE:** Not available in test mode and requires a Standard plan or higher.
     # @return [String]
     attr_accessor :sms_phone_number
 

data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb

@@ -34,7 +34,7 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :pin
 
-    # An E.164 formatted phone number.  **Note**: Not available in test mode and requires a Standard plan or higher.
+    # An E.164 formatted phone number.  By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).  **NOTE:** Not available in test mode and requires a Standard plan or higher.
     # @return [String]
     attr_accessor :sms_phone_number
 

data/lib/dropbox-sign/models/sub_signing_options.rb

@@ -17,7 +17,7 @@ module Dropbox
 end
 
 module Dropbox::Sign
-  # This allows the requester to specify the types allowed for creating a signature.  **Note**: If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
+  # This allows the requester to specify the types allowed for creating a signature.  **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
   class SubSigningOptions
     # The default type shown (limited to the listed types)
     # @return [String]

data/lib/dropbox-sign/models/sub_white_labeling_options.rb

@@ -17,7 +17,7 @@ module Dropbox
 end
 
 module Dropbox::Sign
-  # An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans)  Take a look at our [white labeling guide](/api/reference/white-labeling/) to learn more.
+  # An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans)  Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more.
   class SubWhiteLabelingOptions
     # @return [String]
     attr_accessor :header_background_color

data/lib/dropbox-sign/models/team_add_member_request.rb

@@ -26,7 +26,7 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :email_address
 
-    # A role member will take in a new Team.  **Note**: This parameter is used only if `team_id` is provided.
+    # A role member will take in a new Team.  **NOTE:** This parameter is used only if `team_id` is provided.
     # @return [String]
     attr_accessor :role
 

data/lib/dropbox-sign/models/team_remove_member_request.rb

@@ -26,7 +26,7 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :email_address
 
-    # The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.  **Note**: Only available for Enterprise plans.
+    # The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.  **NOTE:** Only available for Enterprise plans.
     # @return [String]
     attr_accessor :new_owner_email_address
 
@@ -34,7 +34,7 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :new_team_id
 
-    # A new role member will take in a new Team.  **Note**: This parameter is used only if `new_team_id` is provided.
+    # A new role member will take in a new Team.  **NOTE:** This parameter is used only if `new_team_id` is provided.
     # @return [String]
     attr_accessor :new_role
 

data/lib/dropbox-sign/models/template_add_user_request.rb

@@ -18,11 +18,11 @@ end
 
 module Dropbox::Sign
   class TemplateAddUserRequest
-    # The id of the Account to give access to the Template. <b>Note</b> The account id prevails if email address is also provided.
+    # The id of the Account to give access to the Template. **NOTE:** The account id prevails if email address is also provided.
     # @return [String]
     attr_accessor :account_id
 
-    # The email address of the Account to give access to the Template. <b>Note</b> The account id prevails if it is also provided.
+    # The email address of the Account to give access to the Template. **NOTE:** The account id prevails if it is also provided.
     # @return [String]
     attr_accessor :email_address
 

data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb

@@ -34,7 +34,7 @@ module Dropbox::Sign
     # @return [Boolean]
     attr_accessor :allow_ccs
 
-    # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.  **Note**: Only available for Premium plan and higher.
+    # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.  **NOTE:** Only available for Premium plan and higher.
     # @return [Boolean]
     attr_accessor :allow_reassign
 
@@ -68,7 +68,7 @@ module Dropbox::Sign
     # @return [Array<SubFormFieldRule>]
     attr_accessor :form_field_rules
 
-    # The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)  **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.  * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
+    # The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)  **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.  * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
     # @return [Array<SubFormFieldsPerDocumentBase>]
     attr_accessor :form_fields_per_document