Class: Paid::Signal

Inherits:
Object
  • Object
show all
Defined in:
lib/paid_ruby/types/signal.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(event_name: OMIT, agent_id: OMIT, external_agent_id: OMIT, customer_id: OMIT, data: OMIT, additional_properties: nil) ⇒ Paid::Signal

Parameters:

  • event_name (String) (defaults to: OMIT)
  • agent_id (String) (defaults to: OMIT)
  • external_agent_id (String) (defaults to: OMIT)
  • customer_id (String) (defaults to: OMIT)
  • data (Hash{String => Object}) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/paid_ruby/types/signal.rb', line 32

def initialize(event_name: OMIT, agent_id: OMIT, external_agent_id: OMIT, customer_id: OMIT, data: OMIT, additional_properties: nil)
  @event_name = event_name if event_name != OMIT
  @agent_id = agent_id if agent_id != OMIT
  @external_agent_id = external_agent_id if external_agent_id != OMIT
  @customer_id = customer_id if customer_id != OMIT
  @data = data if data != OMIT
  @additional_properties = additional_properties
  @_field_set = { "event_name": event_name, "agent_id": agent_id, "external_agent_id": external_agent_id, "customer_id": customer_id, "data": data }.reject do | _k, v |
  v == OMIT
end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



18
19
20
 
# File 'lib/paid_ruby/types/signal.rb', line 18

def additional_properties
  @additional_properties
end

#agent_id ⇒ String (readonly)

Returns:

  • (String) 


10
11
12
 
# File 'lib/paid_ruby/types/signal.rb', line 10

def agent_id
  @agent_id
end

#customer_id ⇒ String (readonly)

Returns:

  • (String) 


14
15
16
 
# File 'lib/paid_ruby/types/signal.rb', line 14

def customer_id
  @customer_id
end

#data ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


16
17
18
 
# File 'lib/paid_ruby/types/signal.rb', line 16

def data
  @data
end

#event_name ⇒ String (readonly)

Returns:

  • (String) 


8
9
10
 
# File 'lib/paid_ruby/types/signal.rb', line 8

def event_name
  @event_name
end

#external_agent_id ⇒ String (readonly)

Returns:

  • (String) 


12
13
14
 
# File 'lib/paid_ruby/types/signal.rb', line 12

def external_agent_id
  @external_agent_id
end

Class Method Details

.from_json(json_object:) ⇒ Paid::Signal

Parameters:

  • json_object (String)

Returns:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/paid_ruby/types/signal.rb', line 47

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  event_name = parsed_json["event_name"]
  agent_id = parsed_json["agent_id"]
  external_agent_id = parsed_json["external_agent_id"]
  customer_id = parsed_json["customer_id"]
  data = parsed_json["data"]
  new(
    event_name: event_name,
    agent_id: agent_id,
    external_agent_id: external_agent_id,
    customer_id: customer_id,
    data: data,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


76
77
78
79
80
81
82
 
# File 'lib/paid_ruby/types/signal.rb', line 76

def self.validate_raw(obj:)
  obj.event_name&.is_a?(String) != false || raise("Passed value for field obj.event_name is not the expected type, validation failed.")
  obj.agent_id&.is_a?(String) != false || raise("Passed value for field obj.agent_id is not the expected type, validation failed.")
  obj.external_agent_id&.is_a?(String) != false || raise("Passed value for field obj.external_agent_id is not the expected type, validation failed.")
  obj.customer_id&.is_a?(String) != false || raise("Passed value for field obj.customer_id is not the expected type, validation failed.")
  obj.data&.is_a?(Hash) != false || raise("Passed value for field obj.data is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


67
68
69
 
# File 'lib/paid_ruby/types/signal.rb', line 67

def to_json
  @_field_set&.to_json
end