Class: Courier::AuditEvents::Actor

Inherits:
Object
  • Object
show all
Defined in:
lib/trycourier/audit_events/types/actor.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: nil, email: nil, additional_properties: nil) ⇒ AuditEvents::Actor

Parameters:

  • id (String) (defaults to: nil)
  • email (String) (defaults to: nil)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



14
15
16
17
18
19
20
21
 
# File 'lib/trycourier/audit_events/types/actor.rb', line 14

def initialize(id: nil, email: nil, additional_properties: nil)
  # @type [String]
  @id = id
  # @type [String]
  @email = email
  # @type [OpenStruct] Additional properties unmapped to the current class definition
  @additional_properties = additional_properties
end

Instance Attribute Details

#additional_properties ⇒ Object (readonly)

Returns the value of attribute additional_properties.



8
9
10
 
# File 'lib/trycourier/audit_events/types/actor.rb', line 8

def additional_properties
  @additional_properties
end

#email ⇒ Object (readonly)

Returns the value of attribute email.



8
9
10
 
# File 'lib/trycourier/audit_events/types/actor.rb', line 8

def email
  @email
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



8
9
10
 
# File 'lib/trycourier/audit_events/types/actor.rb', line 8

def id
  @id
end

Class Method Details

.from_json(json_object:) ⇒ AuditEvents::Actor

Deserialize a JSON object to an instance of Actor

Parameters:

  • json_object (JSON)

Returns:



27
28
29
30
31
32
33
 
# File 'lib/trycourier/audit_events/types/actor.rb', line 27

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  id = struct.id
  email = struct.email
  new(id: id, email: email, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object’s property definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


46
47
48
49
 
# File 'lib/trycourier/audit_events/types/actor.rb', line 46

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of Actor to a JSON object

Returns:

  • (JSON) 


38
39
40
 
# File 'lib/trycourier/audit_events/types/actor.rb', line 38

def to_json(*_args)
  { "id": @id, "email": @email }.to_json
end