dropbox-sign 1.0.1 → 1.1.0

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

@@ -67,12 +67,12 @@ module Dropbox::Sign
     # @return [Array<TemplateResponseDocument>]
     attr_accessor :documents
 
-    # An array of Custom Field objects.
-    # @return [Array<TemplateResponseCustomField>, nil]
+    # Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
+    # @return [Array<TemplateResponseDocumentCustomFieldBase>, nil]
     attr_accessor :custom_fields
 
     # Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
-    # @return [Array<TemplateResponseNamedFormField>, nil]
+    # @return [Array<TemplateResponseDocumentFormFieldBase>, nil]
     attr_accessor :named_form_fields
 
     # An array of the Accounts that can use this Template.
@@ -125,8 +125,8 @@ module Dropbox::Sign
         :'signer_roles' => :'Array<TemplateResponseSignerRole>',
         :'cc_roles' => :'Array<TemplateResponseCCRole>',
         :'documents' => :'Array<TemplateResponseDocument>',
-        :'custom_fields' => :'Array<TemplateResponseCustomField>',
-        :'named_form_fields' => :'Array<TemplateResponseNamedFormField>',
+        :'custom_fields' => :'Array<TemplateResponseDocumentCustomFieldBase>',
+        :'named_form_fields' => :'Array<TemplateResponseDocumentFormFieldBase>',
         :'accounts' => :'Array<TemplateResponseAccount>'
       }
     end

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

@@ -30,16 +30,16 @@ module Dropbox::Sign
     # @return [Array<TemplateResponseDocumentFieldGroup>]
     attr_accessor :field_groups
 
-    # An array of Form Field objects containing the name and type of each named textbox and checkmark field.
-    # @return [Array<TemplateResponseDocumentFormField>]
+    # An array of Form Field objects containing the name and type of each named field.
+    # @return [Array<TemplateResponseDocumentFormFieldBase>]
     attr_accessor :form_fields
 
-    # An array of Document Custom Field objects.
-    # @return [Array<TemplateResponseDocumentCustomField>]
+    # An array of Form Field objects containing the name and type of each named field.
+    # @return [Array<TemplateResponseDocumentCustomFieldBase>]
     attr_accessor :custom_fields
 
-    # An array describing static overlay fields. <b>Note</b> only available for certain subscriptions.
-    # @return [Array<TemplateResponseDocumentStaticField>, nil]
+    # An array describing static overlay fields. **Note** only available for certain subscriptions.
+    # @return [Array<TemplateResponseDocumentStaticFieldBase>, nil]
     attr_accessor :static_fields
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -70,9 +70,9 @@ module Dropbox::Sign
         :'name' => :'String',
         :'index' => :'Integer',
         :'field_groups' => :'Array<TemplateResponseDocumentFieldGroup>',
-        :'form_fields' => :'Array<TemplateResponseDocumentFormField>',
-        :'custom_fields' => :'Array<TemplateResponseDocumentCustomField>',
-        :'static_fields' => :'Array<TemplateResponseDocumentStaticField>'
+        :'form_fields' => :'Array<TemplateResponseDocumentFormFieldBase>',
+        :'custom_fields' => :'Array<TemplateResponseDocumentCustomFieldBase>',
+        :'static_fields' => :'Array<TemplateResponseDocumentStaticFieldBase>'
       }
     end
 

data/lib/dropbox-sign/models/{template_response_document_static_field.rb → template_response_document_custom_field_base.rb}

@@ -17,32 +17,36 @@ module Dropbox
 end
 
 module Dropbox::Sign
-  class TemplateResponseDocumentStaticField
-    # The name of the static field.
+  # An array of Form Field objects containing the name and type of each named field.
+  class TemplateResponseDocumentCustomFieldBase
     # @return [String]
-    attr_accessor :name
+    attr_accessor :type
 
-    # The type of this static field. See [field types](/api/reference/constants/#field-types).
+    # The unique ID for this field.
     # @return [String]
-    attr_accessor :type
+    attr_accessor :api_id
 
-    # The signer of the Static Field.
+    # The name of the Custom Field.
     # @return [String]
+    attr_accessor :name
+
+    # The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).
+    # @return [String, nil]
     attr_accessor :signer
 
-    # The horizontal offset in pixels for this static field.
+    # The horizontal offset in pixels for this form field.
     # @return [Integer]
     attr_accessor :x
 
-    # The vertical offset in pixels for this static field.
+    # The vertical offset in pixels for this form field.
     # @return [Integer]
     attr_accessor :y
 
-    # The width in pixels of this static field.
+    # The width in pixels of this form field.
     # @return [Integer]
     attr_accessor :width
 
-    # The height in pixels of this static field.
+    # The height in pixels of this form field.
     # @return [Integer]
     attr_accessor :height
 
@@ -50,27 +54,28 @@ module Dropbox::Sign
     # @return [Boolean]
     attr_accessor :required
 
-    # A unique id for the static 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
 
+    # 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'
+        :'group' => :'group',
+        :'font_size' => :'fontSize'
       }
     end
 
@@ -87,16 +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'
+        :'group' => :'String',
+        :'font_size' => :'Integer'
       }
     end
 
@@ -108,7 +114,8 @@ module Dropbox::Sign
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'group'
+        :'signer',
+        :'group',
       ])
     end
 
@@ -117,39 +124,51 @@ 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 [TemplateResponseDocumentStaticField]
-    def self.init(data)
-      return ApiClient.default.convert_to_type(
-        data,
-        "TemplateResponseDocumentStaticField"
-      ) || TemplateResponseDocumentStaticField.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::TemplateResponseDocumentCustomFieldCheckbox"
+      end
+      if value == 'text'
+        return "Dropbox::Sign::TemplateResponseDocumentCustomFieldText"
+      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::TemplateResponseDocumentStaticField` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::TemplateResponseDocumentCustomFieldBase` 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::TemplateResponseDocumentStaticField`. 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::TemplateResponseDocumentCustomFieldBase`. 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?(:'name')
-        self.name = attributes[:'name']
-      end
-
       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?(:'signer')
         self.signer = attributes[:'signer']
       end
@@ -174,25 +193,30 @@ 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?(:'font_size')
+        self.font_size = attributes[:'font_size']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @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?
+      return false if @type.nil?
       true
     end
 
@@ -201,16 +225,17 @@ module Dropbox::Sign
     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
+          group == o.group &&
+          font_size == o.font_size
     end
 
     # @see the `==` method
@@ -222,13 +247,20 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, type, signer, x, y, width, height, required, api_id, group].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
 

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

@@ -0,0 +1,263 @@
+=begin
+#Dropbox Sign API
+
+#Dropbox Sign v3 API
+
+The version of the OpenAPI document: 3.0.0
+Contact: apisupport@hellosign.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.3.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Dropbox
+end
+
+module Dropbox::Sign
+  # This class extends `TemplateResponseDocumentCustomFieldBase`
+  class TemplateResponseDocumentCustomFieldCheckbox < TemplateResponseDocumentCustomFieldBase
+    # The type of this Custom Field. Only `text` and `checkbox` are currently supported.  * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`
+    # @return [String]
+    attr_accessor :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about, including the ones defined in its parent(s)
+    def self.acceptable_attributes
+      attribute_map.values.concat(superclass.acceptable_attributes)
+    end
+
+    # Returns attribute map of this model + parent
+    def self.merged_attributes
+      self.superclass.attribute_map.merge(self.attribute_map)
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String'
+      }
+    end
+
+    # Attribute type mapping of this model + parent
+    def self.merged_types
+      self.superclass.openapi_types.merge(self.openapi_types)
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Returns list of attributes with nullable: true of this model + parent
+    def self.merged_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 [TemplateResponseDocumentCustomFieldCheckbox]
+    def self.init(data)
+      return ApiClient.default.convert_to_type(
+        data,
+        "TemplateResponseDocumentCustomFieldCheckbox"
+      ) || TemplateResponseDocumentCustomFieldCheckbox.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::TemplateResponseDocumentCustomFieldCheckbox` 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::TemplateResponseDocumentCustomFieldCheckbox`. 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
+      }
+
+      # call parent's initialize
+      super(attributes)
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = 'checkbox'
+      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 = 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?
+      return false if @type.nil?
+      true && super
+    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)
+    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
+      [type].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)
+      super(attributes)
+      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 :File
+        value
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\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
+        # models (e.g. Pet)
+        klass = Dropbox::Sign.const_get(type)
+        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 = super
+      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