Class: Dropbox::Sign::EventCallbackRequestEvent
- Inherits:
-
Object
- Object
- Dropbox::Sign::EventCallbackRequestEvent
- Defined in:
- lib/dropbox-sign/models/event_callback_request_event.rb
Overview
Basic information about the event that occurred.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#event_hash ⇒ String
Generated hash used to verify source of event data.
- #event_metadata ⇒ EventCallbackRequestEventMetadata
-
#event_time ⇒ String
Time the event was created (using Unix time).
-
#event_type ⇒ String
Type of callback event that was triggered.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.init(data) ⇒ EventCallbackRequestEvent
Attempt to instantiate and hydrate a new instance of this class.
-
.merged_attributes ⇒ Object
Returns attribute map of this model + parent.
-
.merged_nullable ⇒ Object
Returns list of attributes with nullable: true of this model + parent.
-
.merged_types ⇒ Object
Attribute type mapping of this model + parent.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value, include_nil = true) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ EventCallbackRequestEvent
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash(include_nil = true) ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ EventCallbackRequestEvent
Initializes the object
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 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 117 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::EventCallbackRequestEvent` 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::EventCallbackRequestEvent`. 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?(:'event_time') self.event_time = attributes[:'event_time'] end if attributes.key?(:'event_type') self.event_type = attributes[:'event_type'] end if attributes.key?(:'event_hash') self.event_hash = attributes[:'event_hash'] end if attributes.key?(:'event_metadata') self. = attributes[:'event_metadata'] end end |
Instance Attribute Details
#event_hash ⇒ String
Generated hash used to verify source of event data.
32 33 34 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 32 def event_hash @event_hash end |
#event_metadata ⇒ EventCallbackRequestEventMetadata
35 36 37 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 35 def @event_metadata end |
#event_time ⇒ String
Time the event was created (using Unix time).
24 25 26 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 24 def event_time @event_time end |
#event_type ⇒ String
Type of callback event that was triggered.
28 29 30 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 28 def event_type @event_type end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
70 71 72 |
# File 'lib/dropbox-sign/models/event_callback_request_event.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/event_callback_request_event.rb', line 60 def self.attribute_map { :'event_time' => :'event_time', :'event_type' => :'event_type', :'event_hash' => :'event_hash', :'event_metadata' => :'event_metadata' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
218 219 220 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 218 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.init(data) ⇒ EventCallbackRequestEvent
Attempt to instantiate and hydrate a new instance of this class
108 109 110 111 112 113 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 108 def self.init(data) return ApiClient.default.convert_to_type( data, "EventCallbackRequestEvent" ) || EventCallbackRequestEvent.new end |
.merged_attributes ⇒ Object
Returns attribute map of this model + parent
75 76 77 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 75 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/event_callback_request_event.rb', line 101 def self.merged_nullable self.openapi_nullable end |
.merged_types ⇒ Object
Attribute type mapping of this model + parent
90 91 92 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 90 def self.merged_types self.openapi_types end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
95 96 97 98 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 95 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
80 81 82 83 84 85 86 87 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 80 def self.openapi_types { :'event_time' => :'String', :'event_type' => :'String', :'event_hash' => :'String', :'event_metadata' => :'EventCallbackRequestEventMetadata' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
194 195 196 197 198 199 200 201 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 194 def ==(o) return true if self.equal?(o) self.class == o.class && event_time == o.event_time && event_type == o.event_type && event_hash == o.event_hash && == o. end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 248 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 :File value 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 # models (e.g. Pet) klass = Dropbox::Sign.const_get(type) 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
322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 322 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
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 225 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
205 206 207 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 205 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
211 212 213 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 211 def hash [event_time, event_type, event_hash, ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 149 def list_invalid_properties invalid_properties = Array.new if @event_time.nil? invalid_properties.push('invalid value for "event_time", event_time cannot be nil.') end if @event_type.nil? invalid_properties.push('invalid value for "event_type", event_type cannot be nil.') end if @event_hash.nil? invalid_properties.push('invalid value for "event_hash", event_hash cannot be nil.') end if @event_metadata.nil? invalid_properties.push('invalid value for "event_metadata", event_metadata cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
297 298 299 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 297 def to_body to_hash end |
#to_hash(include_nil = true) ⇒ Hash
Returns the object in the form of hash
303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 303 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
291 292 293 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 291 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
172 173 174 175 176 177 178 179 180 |
# File 'lib/dropbox-sign/models/event_callback_request_event.rb', line 172 def valid? return false if @event_time.nil? return false if @event_type.nil? event_type_validator = EnumAttributeValidator.new('String', ["account_confirmed", "unknown_error", "file_error", "sign_url_invalid", "signature_request_viewed", "signature_request_signed", "signature_request_sent", "signature_request_all_signed", "signature_request_email_bounce", "signature_request_remind", "signature_request_incomplete_qes", "signature_request_destroyed", "signature_request_canceled", "signature_request_downloadable", "signature_request_declined", "signature_request_reassigned", "signature_request_invalid", "signature_request_prepared", "signature_request_expired", "template_created", "template_error", "callback_test"]) return false unless event_type_validator.valid?(@event_type) return false if @event_hash.nil? return false if @event_metadata.nil? true end |