Class: Dropbox::Sign::SubFormFieldRuleAction

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubFormFieldRuleAction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



116
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
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 116

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

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

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

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

Instance Attribute Details

#field_id ⇒ String

field_id or group_id is required, but not both. Must reference the ‘api_id` of an existing field defined within `form_fields_per_document`. Cannot use with `group_id`. Trigger and action fields must belong to the same signer.

Returns:

  • (String) 


30
31
32
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 30

def field_id
  @field_id
end

#group_id ⇒ String

group_id or field_id is required, but not both. Must reference the ID of an existing group defined within ‘form_field_groups`. Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer.

Returns:

  • (String) 


34
35
36
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 34

def group_id
  @group_id
end

#hidden ⇒ Boolean

‘true` to hide the target field when rule is satisfied, otherwise `false`.

Returns:

  • (Boolean) 


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

def hidden
  @hidden
end

#type ⇒ String

Returns:

  • (String) 


26
27
28
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 26

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'hidden' => :'hidden',
    :'type' => :'type',
    :'field_id' => :'field_id',
    :'group_id' => :'group_id'
  }
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



207
208
209
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 207

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

.init(data) ⇒ SubFormFieldRuleAction

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



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

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



90
91
92
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 90

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



100
101
102
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 100

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



95
96
97
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 95

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'hidden' => :'Boolean',
    :'type' => :'String',
    :'field_id' => :'String',
    :'group_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
190
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      hidden == o.hidden &&
      type == o.type &&
      field_id == o.field_id &&
      group_id == o.group_id
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



237
238
239
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
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 237

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



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 308

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 214

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


194
195
196
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



200
201
202
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 200

def hash
  [hidden, type, field_id, group_id].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



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 148

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

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



283
284
285
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 283

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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 289

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



277
278
279
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 277

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



163
164
165
166
167
168
169
 
# File 'lib/dropbox-sign/models/sub_form_field_rule_action.rb', line 163

def valid?
  return false if @hidden.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["change-field-visibility", "change-group-visibility"])
  return false unless type_validator.valid?(@type)
  true
end