Class: Dropbox::Sign::SubFormFieldRuleTrigger

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubFormFieldRuleTrigger

Initializes the object

Parameters:

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

    Model attributes in the form of hash



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 117

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

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

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

Instance Attribute Details

#id ⇒ String

Must reference the ‘api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer.

Returns:

  • (String) 


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

def id
  @id
end

#operator ⇒ String

Different field types allow different ‘operator` values: - Field type of text: - is: exact match - not: not exact match - match: regular expression, without /. Example: - OK `[a-zA-Z0-9]` - Not OK `/[a-zA-Z0-9]/` - Field type of dropdown: - is: exact match, single value - not: not exact match, single value - any: exact match, array of values. - none: not exact match, array of values. - Field type of checkbox: - is: exact match, single value - not: not exact match, single value - Field type of radio: - is: exact match, single value - not: not exact match, single value

Returns:

  • (String) 


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

def operator
  @operator
end

#value ⇒ String

value or values is required, but not both. The value to match against operator. - When operator is one of the following, value must be ‘String`: - `is` - `not` - `match` Otherwise, - checkbox: When type of trigger is checkbox, value must be `0` or `1` - radio: When type of trigger is radio, value must be `1`

Returns:

  • (String) 


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

def value
  @value
end

#values ⇒ Array<String>

values or value is required, but not both. The values to match against operator when it is one of the following: - ‘any` - `none`

Returns:

  • (Array<String>) 


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

def values
  @values
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 60

def self.attribute_map
  {
    :'id' => :'id',
    :'operator' => :'operator',
    :'value' => :'value',
    :'values' => :'values'
  }
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



210
211
212
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 210

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

.init(data) ⇒ SubFormFieldRuleTrigger

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



108
109
110
111
112
113
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 108

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



91
92
93
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 91

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



101
102
103
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 101

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



96
97
98
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 96

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



85
86
87
88
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 85

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

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 75

def self.openapi_types
  {
    :'id' => :'String',
    :'operator' => :'String',
    :'value' => :'String',
    :'values' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      operator == o.operator &&
      value == o.value &&
      values == o.values
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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 240

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 311

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 217

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


197
198
199
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



203
204
205
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 203

def hash
  [id, operator, value, values].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



151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 151

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

  if @operator.nil?
    invalid_properties.push('invalid value for "operator", operator 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



286
287
288
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 286

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 292

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



280
281
282
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 280

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



166
167
168
169
170
171
172
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_trigger.rb', line 166

def valid?
  return false if @id.nil?
  return false if @operator.nil?
  operator_validator = EnumAttributeValidator.new('String', ["any", "is", "match", "none", "not"])
  return false unless operator_validator.valid?(@operator)
  true
end