Class: Dropbox::Sign::SubFieldOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/dropbox-sign/models/sub_field_options.rb

Overview

This allows the requester to specify field options for a signature request.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubFieldOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 100

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SubFieldOptions` 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::SubFieldOptions`. 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?(:'date_format')
    self.date_format = attributes[:'date_format']
  end
end

Instance Attribute Details

#date_format ⇒ String

Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) NOTE: Only available for Premium and higher.

Returns:

  • (String) 


24
25
26
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 24

def date_format
  @date_format
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



56
57
58
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 56

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



49
50
51
52
53
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 49

def self.attribute_map
  {
    :'date_format' => :'date_format'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



171
172
173
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 171

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.init(data) ⇒ SubFieldOptions

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



91
92
93
94
95
96
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 91

def self.init(data)
  return ApiClient.default.convert_to_type(
    data,
    "SubFieldOptions"
  ) || SubFieldOptions.new
end

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



74
75
76
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 74

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

Returns list of attributes with nullable: true of this model + parent



84
85
86
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 84

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



79
80
81
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 79

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



68
69
70
71
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 68

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 61

def self.openapi_types
  {
    :'date_format' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



150
151
152
153
154
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 150

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date_format == o.date_format
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 201

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<(?<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
    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

#_to_hash(value, include_nil = true) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 272

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 178

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


158
159
160
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 158

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



164
165
166
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 164

def hash
  [date_format].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



120
121
122
123
124
125
126
127
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 120

def list_invalid_properties
  invalid_properties = Array.new
  if @date_format.nil?
    invalid_properties.push('invalid value for "date_format", date_format cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



247
248
249
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 247

def to_body
  to_hash
end

#to_hash(include_nil = true) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 253

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



241
242
243
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 241

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



131
132
133
134
135
136
 
# File 'lib/dropbox-sign/models/sub_field_options.rb', line 131

def valid?
  return false if @date_format.nil?
  date_format_validator = EnumAttributeValidator.new('String', ["MM / DD / YYYY", "MM - DD - YYYY", "DD / MM / YYYY", "DD - MM - YYYY", "YYYY / MM / DD", "YYYY - MM - DD"])
  return false unless date_format_validator.valid?(@date_format)
  true
end