class SignRequestClient::Event
Attributes
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/signrequest_client/models/event.rb, line 60 def self.attribute_map { :'uuid' => :'uuid', :'status' => :'status', :'event_type' => :'event_type', :'delivered' => :'delivered', :'delivered_on' => :'delivered_on', :'callback_status_code' => :'callback_status_code', :'timestamp' => :'timestamp', :'team' => :'team', :'document' => :'document', :'signer' => :'signer' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/signrequest_client/models/event.rb, line 93 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'uuid') self.uuid = attributes[:'uuid'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'event_type') self.event_type = attributes[:'event_type'] end if attributes.has_key?(:'delivered') self.delivered = attributes[:'delivered'] end if attributes.has_key?(:'delivered_on') self.delivered_on = attributes[:'delivered_on'] end if attributes.has_key?(:'callback_status_code') self.callback_status_code = attributes[:'callback_status_code'] end if attributes.has_key?(:'timestamp') self.timestamp = attributes[:'timestamp'] end if attributes.has_key?(:'team') self.team = attributes[:'team'] end if attributes.has_key?(:'document') self.document = attributes[:'document'] end if attributes.has_key?(:'signer') self.signer = attributes[:'signer'] end end
Attribute type mapping.
# File lib/signrequest_client/models/event.rb, line 76 def self.swagger_types { :'uuid' => :'String', :'status' => :'String', :'event_type' => :'String', :'delivered' => :'BOOLEAN', :'delivered_on' => :'DateTime', :'callback_status_code' => :'Integer', :'timestamp' => :'DateTime', :'team' => :'DocumentTeam', :'document' => :'Document', :'signer' => :'Signer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/signrequest_client/models/event.rb, line 194 def ==(o) return true if self.equal?(o) self.class == o.class && uuid == o.uuid && status == o.status && event_type == o.event_type && delivered == o.delivered && delivered_on == o.delivered_on && callback_status_code == o.callback_status_code && timestamp == o.timestamp && team == o.team && document == o.document && signer == o.signer end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/signrequest_client/models/event.rb, line 245 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 temp_model = SignRequestClient.const_get(type).new temp_model.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/signrequest_client/models/event.rb, line 311 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/signrequest_client/models/event.rb, line 224 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/signrequest_client/models/event.rb, line 211 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] event_type
Object to be assigned
# File lib/signrequest_client/models/event.rb, line 184 def event_type=(event_type) validator = EnumAttributeValidator.new('String', ['convert_error', 'converted', 'sending_error', 'sent', 'declined', 'cancelled', 'expired', 'signed', 'viewed', 'downloaded', 'signer_signed', 'signer_email_bounced', 'signer_viewed_email', 'signer_viewed', 'signer_forwarded', 'signer_downloaded', 'signrequest_received']) unless validator.valid?(event_type) fail ArgumentError, 'invalid value for "event_type", must be one of #{validator.allowable_values}.' end @event_type = event_type end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/signrequest_client/models/event.rb, line 217 def hash [uuid, status, event_type, delivered, delivered_on, callback_status_code, timestamp, team, document, signer].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/signrequest_client/models/event.rb, line 142 def list_invalid_properties invalid_properties = Array.new if !@uuid.nil? && @uuid.to_s.length < 1 invalid_properties.push('invalid value for "uuid", the character length must be great than or equal to 1.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/signrequest_client/models/event.rb, line 174 def status=(status) validator = EnumAttributeValidator.new('String', ['ok', 'error']) unless validator.valid?(status) fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.' end @status = status end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/signrequest_client/models/event.rb, line 297 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/signrequest_client/models/event.rb, line 285 def to_s to_hash.to_s end
Custom attribute writer method with validation @param [Object] uuid Value to be assigned
# File lib/signrequest_client/models/event.rb, line 164 def uuid=(uuid) if !uuid.nil? && uuid.to_s.length < 1 fail ArgumentError, 'invalid value for "uuid", the character length must be great than or equal to 1.' end @uuid = uuid end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/signrequest_client/models/event.rb, line 153 def valid? return false if !@uuid.nil? && @uuid.to_s.length < 1 status_validator = EnumAttributeValidator.new('String', ['ok', 'error']) return false unless status_validator.valid?(@status) event_type_validator = EnumAttributeValidator.new('String', ['convert_error', 'converted', 'sending_error', 'sent', 'declined', 'cancelled', 'expired', 'signed', 'viewed', 'downloaded', 'signer_signed', 'signer_email_bounced', 'signer_viewed_email', 'signer_viewed', 'signer_forwarded', 'signer_downloaded', 'signrequest_received']) return false unless event_type_validator.valid?(@event_type) true end