Class: Dropbox::Sign::SubFormFieldRule

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubFormFieldRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 95

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

  if attributes.key?(:'trigger_operator')
    self.trigger_operator = attributes[:'trigger_operator']
  else
    self.trigger_operator = 'AND'
  end

  if attributes.key?(:'triggers')
    if (value = attributes[:'triggers']).is_a?(Array)
      self.triggers = value
    end
  end

  if attributes.key?(:'actions')
    if (value = attributes[:'actions']).is_a?(Array)
      self.actions = value
    end
  end
end

Instance Attribute Details

#actions ⇒ Array<SubFormFieldRuleAction>

An array of action definitions, the "then that" part of "if this, **then that**". Any number of actions may be attached to a single rule.

Returns:



35
36
37
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 35

def actions
  @actions
end

#id ⇒ String

Must be unique across all defined rules.

Returns:

  • (String) 


23
24
25
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 23

def id
  @id
end

#trigger_operator ⇒ String

Currently only ‘AND` is supported. Support for `OR` is being worked on.

Returns:

  • (String) 


27
28
29
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 27

def trigger_operator
  @trigger_operator
end

#triggers ⇒ Array<SubFormFieldRuleTrigger>

An array of trigger definitions, the "if this" part of "**if this**, then that". Currently only a single trigger per rule is allowed.

Returns:



31
32
33
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 31

def triggers
  @triggers
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



48
49
50
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 48

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 38

def self.attribute_map
  {
    :'id' => :'id',
    :'trigger_operator' => :'trigger_operator',
    :'triggers' => :'triggers',
    :'actions' => :'actions'
  }
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



235
236
237
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 235

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

.init(data) ⇒ SubFormFieldRule

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



86
87
88
89
90
91
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 86

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



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

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



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

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



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

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



63
64
65
66
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 63

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

.openapi_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 53

def self.openapi_types
  {
    :'id' => :'String',
    :'trigger_operator' => :'String',
    :'triggers' => :'Array<SubFormFieldRuleTrigger>',
    :'actions' => :'Array<SubFormFieldRuleAction>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



211
212
213
214
215
216
217
218
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 211

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      trigger_operator == o.trigger_operator &&
      triggers == o.triggers &&
      actions == o.actions
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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 265

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 336

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 242

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


222
223
224
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 222

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



228
229
230
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 228

def hash
  [id, trigger_operator, triggers, actions].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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 133

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

  if @trigger_operator.nil?
    invalid_properties.push('invalid value for "trigger_operator", trigger_operator cannot be nil.')
  end

  if @triggers.nil?
    invalid_properties.push('invalid value for "triggers", triggers cannot be nil.')
  end

  if @triggers.length > 1
    invalid_properties.push('invalid value for "triggers", number of items must be less than or equal to 1.')
  end

  if @triggers.length < 1
    invalid_properties.push('invalid value for "triggers", number of items must be greater than or equal to 1.')
  end

  if @actions.nil?
    invalid_properties.push('invalid value for "actions", actions cannot be nil.')
  end

  if @actions.length < 1
    invalid_properties.push('invalid value for "actions", number of items must be greater than or equal to 1.')
  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



311
312
313
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 311

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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 317

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



305
306
307
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 305

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



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/dropbox-sign/models/sub_form_field_rule.rb', line 168

def valid?
  return false if @id.nil?
  return false if @trigger_operator.nil?
  return false if @triggers.nil?
  return false if @triggers.length > 1
  return false if @triggers.length < 1
  return false if @actions.nil?
  return false if @actions.length < 1
  true
end