Class: TrophyApiClient::WebhooksPointsLevelChangedPayload

Inherits:
Object
  • Object
show all
Defined in:
lib/trophy_api_client/types/webhooks_points_level_changed_payload.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, user:, points:, previous_level: OMIT, new_level: OMIT, additional_properties: nil) ⇒ TrophyApiClient::WebhooksPointsLevelChangedPayload

Parameters:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/trophy_api_client/types/webhooks_points_level_changed_payload.rb', line 36

def initialize(type:, user:, points:, previous_level: OMIT, new_level: OMIT, additional_properties: nil)
  @type = type
  @user = user
  @points = points
  @previous_level = previous_level if previous_level != OMIT
  @new_level = new_level if new_level != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "type": type,
    "user": user,
    "points": points,
    "previousLevel": previous_level,
    "newLevel": new_level
  }.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



22
23
24
 
# File 'lib/trophy_api_client/types/webhooks_points_level_changed_payload.rb', line 22

def additional_properties
  @additional_properties
end

#new_level ⇒ TrophyApiClient::PointsLevel (readonly)

Returns The user’s new level, or null if the user no longer has a level.

Returns:



20
21
22
 
# File 'lib/trophy_api_client/types/webhooks_points_level_changed_payload.rb', line 20

def new_level
  @new_level
end

#points ⇒ TrophyApiClient::WebhooksPointsLevelChangedPayloadPoints (readonly)

Returns The points system in which the level changed.

Returns:



16
17
18
 
# File 'lib/trophy_api_client/types/webhooks_points_level_changed_payload.rb', line 16

def points
  @points
end

#previous_level ⇒ TrophyApiClient::PointsLevel (readonly)

Returns The user’s previous level, or null if the user had no level.

Returns:



18
19
20
 
# File 'lib/trophy_api_client/types/webhooks_points_level_changed_payload.rb', line 18

def previous_level
  @previous_level
end

#type ⇒ String (readonly)

Returns The webhook event type.

Returns:

  • (String) —

    The webhook event type.



12
13
14
 
# File 'lib/trophy_api_client/types/webhooks_points_level_changed_payload.rb', line 12

def type
  @type
end

#user ⇒ TrophyApiClient::User (readonly)

Returns The user whose level changed.

Returns:



14
15
16
 
# File 'lib/trophy_api_client/types/webhooks_points_level_changed_payload.rb', line 14

def user
  @user
end

Class Method Details

.from_json(json_object:) ⇒ TrophyApiClient::WebhooksPointsLevelChangedPayload

Deserialize a JSON object to an instance of WebhooksPointsLevelChangedPayload

Parameters:

  • json_object (String)

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/trophy_api_client/types/webhooks_points_level_changed_payload.rb', line 58

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  type = parsed_json["type"]
  if parsed_json["user"].nil?
    user = nil
  else
    user = parsed_json["user"].to_json
    user = TrophyApiClient::User.from_json(json_object: user)
  end
  if parsed_json["points"].nil?
    points = nil
  else
    points = parsed_json["points"].to_json
    points = TrophyApiClient::WebhooksPointsLevelChangedPayloadPoints.from_json(json_object: points)
  end
  if parsed_json["previousLevel"].nil?
    previous_level = nil
  else
    previous_level = parsed_json["previousLevel"].to_json
    previous_level = TrophyApiClient::PointsLevel.from_json(json_object: previous_level)
  end
  if parsed_json["newLevel"].nil?
    new_level = nil
  else
    new_level = parsed_json["newLevel"].to_json
    new_level = TrophyApiClient::PointsLevel.from_json(json_object: new_level)
  end
  new(
    type: type,
    user: user,
    points: points,
    previous_level: previous_level,
    new_level: new_level,
    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) 


109
110
111
112
113
114
115
 
# File 'lib/trophy_api_client/types/webhooks_points_level_changed_payload.rb', line 109

def self.validate_raw(obj:)
  obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
  TrophyApiClient::User.validate_raw(obj: obj.user)
  TrophyApiClient::WebhooksPointsLevelChangedPayloadPoints.validate_raw(obj: obj.points)
  obj.previous_level.nil? || TrophyApiClient::PointsLevel.validate_raw(obj: obj.previous_level)
  obj.new_level.nil? || TrophyApiClient::PointsLevel.validate_raw(obj: obj.new_level)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of WebhooksPointsLevelChangedPayload to a JSON object

Returns:

  • (String) 


99
100
101
 
# File 'lib/trophy_api_client/types/webhooks_points_level_changed_payload.rb', line 99

def to_json(*_args)
  @_field_set&.to_json
end