dropbox-sign 1.0.1 → 1.1.0

data/lib/dropbox-sign/models/{template_response_document_form_field.rb → template_response_document_form_field_text.rb}

@@ -17,62 +17,31 @@ module Dropbox
 end
 
 module Dropbox::Sign
-  class TemplateResponseDocumentFormField
-    # A unique id for the form field.
-    # @return [String]
-    attr_accessor :api_id
-
-    # The name of the form field.
-    # @return [String]
-    attr_accessor :name
-
-    # The type of this form field. See [field types](/api/reference/constants/#field-types).
+  # This class extends `TemplateResponseDocumentFormFieldBase`
+  class TemplateResponseDocumentFormFieldText < TemplateResponseDocumentFormFieldBase
+    # The type of this form field. See [field types](/api/reference/constants/#field-types).  * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
     # @return [String]
     attr_accessor :type
 
-    # The signer of the Form Field.
-    # @return [String]
-    attr_accessor :signer
-
-    # The horizontal offset in pixels for this form field.
-    # @return [Integer]
-    attr_accessor :x
-
-    # The vertical offset in pixels for this form field.
-    # @return [Integer]
-    attr_accessor :y
-
-    # The width in pixels of this form field.
-    # @return [Integer]
-    attr_accessor :width
-
-    # The height in pixels of this form field.
-    # @return [Integer]
-    attr_accessor :height
-
-    # Boolean showing whether or not this field is required.
-    # @return [Boolean]
-    attr_accessor :required
-
-    # The name of the group this field is in. If this field is not a group, this defaults to `null`.
-    # @return [String, nil]
-    attr_accessor :group
-
     # @return [TemplateResponseFieldAvgTextLength]
     attr_accessor :avg_text_length
 
     # Whether this form field is multiline text.
-    # @return [Boolean, nil]
+    # @return [Boolean]
     attr_accessor :is_multiline
 
     # Original font size used in this form field's text.
-    # @return [Integer, nil]
+    # @return [Integer]
     attr_accessor :original_font_size
 
     # Font family used in this form field's text.
-    # @return [String, nil]
+    # @return [String]
     attr_accessor :font_family
 
+    # 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.
+    # @return [String, nil]
+    attr_accessor :validation_type
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -98,136 +67,86 @@ module Dropbox::Sign
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'api_id' => :'api_id',
-        :'name' => :'name',
         :'type' => :'type',
-        :'signer' => :'signer',
-        :'x' => :'x',
-        :'y' => :'y',
-        :'width' => :'width',
-        :'height' => :'height',
-        :'required' => :'required',
-        :'group' => :'group',
         :'avg_text_length' => :'avg_text_length',
         :'is_multiline' => :'isMultiline',
         :'original_font_size' => :'originalFontSize',
-        :'font_family' => :'fontFamily'
+        :'font_family' => :'fontFamily',
+        :'validation_type' => :'validation_type'
       }
     end
 
-    # Returns all the JSON keys this model knows about
+    # Returns all the JSON keys this model knows about, including the ones defined in its parent(s)
     def self.acceptable_attributes
-      attribute_map.values
+      attribute_map.values.concat(superclass.acceptable_attributes)
     end
 
     # Returns attribute map of this model + parent
     def self.merged_attributes
-      self.attribute_map
+      self.superclass.attribute_map.merge(self.attribute_map)
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'api_id' => :'String',
-        :'name' => :'String',
         :'type' => :'String',
-        :'signer' => :'String',
-        :'x' => :'Integer',
-        :'y' => :'Integer',
-        :'width' => :'Integer',
-        :'height' => :'Integer',
-        :'required' => :'Boolean',
-        :'group' => :'String',
         :'avg_text_length' => :'TemplateResponseFieldAvgTextLength',
         :'is_multiline' => :'Boolean',
         :'original_font_size' => :'Integer',
-        :'font_family' => :'String'
+        :'font_family' => :'String',
+        :'validation_type' => :'String'
       }
     end
 
     # Attribute type mapping of this model + parent
     def self.merged_types
-      self.openapi_types
+      self.superclass.openapi_types.merge(self.openapi_types)
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'group',
-        :'is_multiline',
-        :'original_font_size',
-        :'font_family'
+        :'validation_type'
       ])
     end
 
     # Returns list of attributes with nullable: true of this model + parent
     def self.merged_nullable
-      self.openapi_nullable
+      self.superclass.openapi_nullable.merge(self.openapi_nullable)
     end
 
     # Attempt to instantiate and hydrate a new instance of this class
     # @param [Object] data Data to be converted
-    # @return [TemplateResponseDocumentFormField]
+    # @return [TemplateResponseDocumentFormFieldText]
     def self.init(data)
       return ApiClient.default.convert_to_type(
         data,
-        "TemplateResponseDocumentFormField"
-      ) || TemplateResponseDocumentFormField.new
+        "TemplateResponseDocumentFormFieldText"
+      ) || TemplateResponseDocumentFormFieldText.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::TemplateResponseDocumentFormField` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::TemplateResponseDocumentFormFieldText` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.merged_attributes.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormField`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentFormFieldText`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'api_id')
-        self.api_id = attributes[:'api_id']
-      end
-
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      end
+      # call parent's initialize
+      super(attributes)
 
       if attributes.key?(:'type')
         self.type = attributes[:'type']
-      end
-
-      if attributes.key?(:'signer')
-        self.signer = attributes[:'signer']
-      end
-
-      if attributes.key?(:'x')
-        self.x = attributes[:'x']
-      end
-
-      if attributes.key?(:'y')
-        self.y = attributes[:'y']
-      end
-
-      if attributes.key?(:'width')
-        self.width = attributes[:'width']
-      end
-
-      if attributes.key?(:'height')
-        self.height = attributes[:'height']
-      end
-
-      if attributes.key?(:'required')
-        self.required = attributes[:'required']
-      end
-
-      if attributes.key?(:'group')
-        self.group = attributes[:'group']
+      else
+        self.type = 'text'
       end
 
       if attributes.key?(:'avg_text_length')
@@ -245,31 +164,40 @@ module Dropbox::Sign
       if attributes.key?(:'font_family')
         self.font_family = attributes[:'font_family']
       end
+
+      if attributes.key?(:'validation_type')
+        self.validation_type = attributes[:'validation_type']
+      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 = super
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      type_validator = EnumAttributeValidator.new('String', ["checkbox", "checkbox-merge", "date_signed", "dropdown", "hyperlink", "initials", "signature", "radio", "text", "text-merge"])
-      return false unless type_validator.valid?(@type)
-      true
+      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)
+      true && super
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] type Object to be assigned
-    def type=(type)
-      validator = EnumAttributeValidator.new('String', ["checkbox", "checkbox-merge", "date_signed", "dropdown", "hyperlink", "initials", "signature", "radio", "text", "text-merge"])
-      unless validator.valid?(type)
-        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+    # @param [Object] validation_type Object to be assigned
+    def validation_type=(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"])
+      unless validator.valid?(validation_type)
+        fail ArgumentError, "invalid value for \"validation_type\", must be one of #{validator.allowable_values}."
       end
-      @type = type
+      @validation_type = validation_type
     end
 
     # Checks equality by comparing each attribute.
@@ -277,20 +205,12 @@ module Dropbox::Sign
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          api_id == o.api_id &&
-          name == o.name &&
           type == o.type &&
-          signer == o.signer &&
-          x == o.x &&
-          y == o.y &&
-          width == o.width &&
-          height == o.height &&
-          required == o.required &&
-          group == o.group &&
           avg_text_length == o.avg_text_length &&
           is_multiline == o.is_multiline &&
           original_font_size == o.original_font_size &&
-          font_family == o.font_family
+          font_family == o.font_family &&
+          validation_type == o.validation_type && super(o)
     end
 
     # @see the `==` method
@@ -302,7 +222,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [api_id, name, type, signer, x, y, width, height, required, group, avg_text_length, is_multiline, original_font_size, font_family].hash
+      [type, avg_text_length, is_multiline, original_font_size, font_family, validation_type].hash
     end
 
     # Builds the object from hash
@@ -317,6 +237,7 @@ module Dropbox::Sign
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
+      super(attributes)
       attribute_map = self.class.merged_attributes
 
       self.class.merged_types.each_pair do |key, type|
@@ -394,7 +315,7 @@ module Dropbox::Sign
     # 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 = {}
+      hash = super
       self.class.merged_attributes.each_pair do |attr, param|
         value = self.send(attr)
         if value.nil?

data/lib/dropbox-sign/models/{template_response_custom_field.rb → template_response_document_static_field_base.rb}

@@ -17,28 +17,36 @@ module Dropbox
 end
 
 module Dropbox::Sign
-  class TemplateResponseCustomField
-    # The name of the Custom Field.
+  # An array describing static overlay fields. **Note** only available for certain subscriptions.
+  class TemplateResponseDocumentStaticFieldBase
+    # @return [String]
+    attr_accessor :type
+
+    # A unique id for the static field.
+    # @return [String]
+    attr_accessor :api_id
+
+    # The name of the static field.
     # @return [String]
     attr_accessor :name
 
-    # The type of this Custom Field. Only `text` and `checkbox` are currently supported.
+    # The signer of the Static Field.
     # @return [String]
-    attr_accessor :type
+    attr_accessor :signer
 
-    # The horizontal offset in pixels for this form field.
+    # The horizontal offset in pixels for this static field.
     # @return [Integer]
     attr_accessor :x
 
-    # The vertical offset in pixels for this form field.
+    # The vertical offset in pixels for this static field.
     # @return [Integer]
     attr_accessor :y
 
-    # The width in pixels of this form field.
+    # The width in pixels of this static field.
     # @return [Integer]
     attr_accessor :width
 
-    # The height in pixels of this form field.
+    # The height in pixels of this static field.
     # @return [Integer]
     attr_accessor :height
 
@@ -46,67 +54,28 @@ module Dropbox::Sign
     # @return [Boolean]
     attr_accessor :required
 
-    # The unique ID for this field.
-    # @return [String]
-    attr_accessor :api_id
-
     # The name of the group this field is in. If this field is not a group, this defaults to `null`.
     # @return [String, nil]
     attr_accessor :group
 
-    # @return [TemplateResponseFieldAvgTextLength]
-    attr_accessor :avg_text_length
-
-    # Whether this form field is multiline text.
-    # @return [Boolean, nil]
-    attr_accessor :is_multiline
-
-    # Original font size used in this form field's text.
-    # @return [Integer, nil]
-    attr_accessor :original_font_size
-
-    # Font family used in this form field's text.
-    # @return [String, nil]
-    attr_accessor :font_family
-
-    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
+    # Final font size used by this form field.
+    # @return [Integer]
+    attr_accessor :font_size
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'name' => :'name',
         :'type' => :'type',
+        :'api_id' => :'api_id',
+        :'name' => :'name',
+        :'signer' => :'signer',
         :'x' => :'x',
         :'y' => :'y',
         :'width' => :'width',
         :'height' => :'height',
         :'required' => :'required',
-        :'api_id' => :'api_id',
         :'group' => :'group',
-        :'avg_text_length' => :'avg_text_length',
-        :'is_multiline' => :'isMultiline',
-        :'original_font_size' => :'originalFontSize',
-        :'font_family' => :'fontFamily'
+        :'font_size' => :'fontSize'
       }
     end
 
@@ -123,19 +92,17 @@ module Dropbox::Sign
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'name' => :'String',
         :'type' => :'String',
+        :'api_id' => :'String',
+        :'name' => :'String',
+        :'signer' => :'String',
         :'x' => :'Integer',
         :'y' => :'Integer',
         :'width' => :'Integer',
         :'height' => :'Integer',
         :'required' => :'Boolean',
-        :'api_id' => :'String',
         :'group' => :'String',
-        :'avg_text_length' => :'TemplateResponseFieldAvgTextLength',
-        :'is_multiline' => :'Boolean',
-        :'original_font_size' => :'Integer',
-        :'font_family' => :'String'
+        :'font_size' => :'Integer'
       }
     end
 
@@ -148,9 +115,6 @@ module Dropbox::Sign
     def self.openapi_nullable
       Set.new([
         :'group',
-        :'is_multiline',
-        :'original_font_size',
-        :'font_family'
       ])
     end
 
@@ -159,37 +123,73 @@ module Dropbox::Sign
       self.openapi_nullable
     end
 
-    # Attempt to instantiate and hydrate a new instance of this class
-    # @param [Object] data Data to be converted
-    # @return [TemplateResponseCustomField]
-    def self.init(data)
-      return ApiClient.default.convert_to_type(
-        data,
-        "TemplateResponseCustomField"
-      ) || TemplateResponseCustomField.new
+    # discriminator's property name in OpenAPI v3
+    def self.openapi_discriminator_name
+      :'type'
+    end
+
+    def self.discriminator_class_name(value)
+      return nil unless value.is_a?(String)
+
+      if value == 'checkbox'
+        return "Dropbox::Sign::TemplateResponseDocumentStaticFieldCheckbox"
+      end
+      if value == 'date_signed'
+        return "Dropbox::Sign::TemplateResponseDocumentStaticFieldDateSigned"
+      end
+      if value == 'dropdown'
+        return "Dropbox::Sign::TemplateResponseDocumentStaticFieldDropdown"
+      end
+      if value == 'hyperlink'
+        return "Dropbox::Sign::TemplateResponseDocumentStaticFieldHyperlink"
+      end
+      if value == 'initials'
+        return "Dropbox::Sign::TemplateResponseDocumentStaticFieldInitials"
+      end
+      if value == 'radio'
+        return "Dropbox::Sign::TemplateResponseDocumentStaticFieldRadio"
+      end
+      if value == 'signature'
+        return "Dropbox::Sign::TemplateResponseDocumentStaticFieldSignature"
+      end
+      if value == 'text'
+        return "Dropbox::Sign::TemplateResponseDocumentStaticFieldText"
+      end
+
+      return nil
     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::TemplateResponseCustomField` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::TemplateResponseDocumentStaticFieldBase` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.merged_attributes.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseCustomField`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticFieldBase`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'api_id')
+        self.api_id = attributes[:'api_id']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
 
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
+      if attributes.key?(:'signer')
+        self.signer = attributes[:'signer']
+      else
+        self.signer = 'me_now'
       end
 
       if attributes.key?(:'x')
@@ -212,28 +212,12 @@ module Dropbox::Sign
         self.required = attributes[:'required']
       end
 
-      if attributes.key?(:'api_id')
-        self.api_id = attributes[:'api_id']
-      end
-
       if attributes.key?(:'group')
         self.group = attributes[:'group']
       end
 
-      if attributes.key?(:'avg_text_length')
-        self.avg_text_length = attributes[:'avg_text_length']
-      end
-
-      if attributes.key?(:'is_multiline')
-        self.is_multiline = attributes[:'is_multiline']
-      end
-
-      if attributes.key?(:'original_font_size')
-        self.original_font_size = attributes[:'original_font_size']
-      end
-
-      if attributes.key?(:'font_family')
-        self.font_family = attributes[:'font_family']
+      if attributes.key?(:'font_size')
+        self.font_size = attributes[:'font_size']
       end
     end
 
@@ -241,45 +225,36 @@ module Dropbox::Sign
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      type_validator = EnumAttributeValidator.new('String', ["text", "checkbox"])
-      return false unless type_validator.valid?(@type)
+      return false if @type.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] type Object to be assigned
-    def type=(type)
-      validator = EnumAttributeValidator.new('String', ["text", "checkbox"])
-      unless validator.valid?(type)
-        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
-      end
-      @type = type
-    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 &&
-          name == o.name &&
           type == o.type &&
+          api_id == o.api_id &&
+          name == o.name &&
+          signer == o.signer &&
           x == o.x &&
           y == o.y &&
           width == o.width &&
           height == o.height &&
           required == o.required &&
-          api_id == o.api_id &&
           group == o.group &&
-          avg_text_length == o.avg_text_length &&
-          is_multiline == o.is_multiline &&
-          original_font_size == o.original_font_size &&
-          font_family == o.font_family
+          font_size == o.font_size
     end
 
     # @see the `==` method
@@ -291,13 +266,20 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, type, x, y, width, height, required, api_id, group, avg_text_length, is_multiline, original_font_size, font_family].hash
+      [type, api_id, name, signer, x, y, width, height, required, group, font_size].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)
+      if !attributes[self.openapi_discriminator_name].nil?
+        klass = self.discriminator_class_name(attributes[self.openapi_discriminator_name])
+        if klass != new.class.to_s
+          obj = Object.const_get(klass).new.build_from_hash(attributes)
+          return obj
+        end
+      end
       new.build_from_hash(attributes)
     end