Class: Dropbox::Sign::EventCallbackRequestEventMetadata

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

Overview

Specific metadata about the event.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EventCallbackRequestEventMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
130
131
132
133
134
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 105

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::EventCallbackRequestEventMetadata` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  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::EventCallbackRequestEventMetadata`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

Instance Attribute Details

#event_message ⇒ String?

Message about a declined or failed (due to error) signature flow.

Returns:

  • (String, nil) 


36
37
38
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 36

def event_message
  @event_message
end

#related_signature_id ⇒ String?

Signature ID for a specific signer. Applicable to ‘signature_request_signed` and `signature_request_viewed` events.

Returns:

  • (String, nil) 


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

def related_signature_id
  @related_signature_id
end

#reported_for_account_id ⇒ String?

Account ID the event was reported for.

Returns:

  • (String, nil) 


28
29
30
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 28

def 
  @reported_for_account_id
end

#reported_for_app_id ⇒ String?

App ID the event was reported for.

Returns:

  • (String, nil) 


32
33
34
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 32

def reported_for_app_id
  @reported_for_app_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



54
55
56
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 54

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'related_signature_id' => :'related_signature_id',
    :'reported_for_account_id' => :'reported_for_account_id',
    :'reported_for_app_id' => :'reported_for_app_id',
    :'event_message' => :'event_message'
  }
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



175
176
177
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 175

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

.init(data) ⇒ EventCallbackRequestEventMetadata

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



96
97
98
99
100
101
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 96

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



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

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



89
90
91
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 89

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



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

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
72
73
74
75
76
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 69

def self.openapi_nullable
  Set.new([
    :'related_signature_id',
    :'reported_for_account_id',
    :'reported_for_app_id',
    :'event_message'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'related_signature_id' => :'String',
    :'reported_for_account_id' => :'String',
    :'reported_for_app_id' => :'String',
    :'event_message' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
158
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      related_signature_id == o.related_signature_id &&
       == o. &&
      reported_for_app_id == o.reported_for_app_id &&
      event_message == o.event_message
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



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
238
239
240
241
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 205

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 276

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 182

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


162
163
164
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



168
169
170
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 168

def hash
  [related_signature_id, , reported_for_app_id, event_message].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



138
139
140
141
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 138

def list_invalid_properties
  invalid_properties = Array.new
  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



251
252
253
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 251

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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 257

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



245
246
247
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 245

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



145
146
147
 
# File 'lib/dropbox-sign/models/event_callback_request_event_metadata.rb', line 145

def valid?
  true
end