Class: TrophyApiClient::WebhooksStreakFreezeEarnedPayload

Inherits:
Object
  • Object
show all
Defined in:
lib/trophy_api_client/types/webhooks_streak_freeze_earned_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:, earned:, freezes:, additional_properties: nil) ⇒ TrophyApiClient::WebhooksStreakFreezeEarnedPayload

Parameters:

  • The webhook event type.

  • The user who earned streak freezes.

  • The number of freezes earned.

  • The total number of freezes the user has after the event.

  • (defaults to: nil)

    Additional properties unmapped to the current class definition



31
32
33
34
35
36
37
38
 
# File 'lib/trophy_api_client/types/webhooks_streak_freeze_earned_payload.rb', line 31

def initialize(type:, user:, earned:, freezes:, additional_properties: nil)
  @type = type
  @user = user
  @earned = earned
  @freezes = freezes
  @additional_properties = additional_properties
  @_field_set = { "type": type, "user": user, "earned": earned, "freezes": freezes }
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • Additional properties unmapped to the current class definition



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

def additional_properties
  @additional_properties
end

#earned ⇒ Integer (readonly)

Returns The number of freezes earned.

Returns:

  • The number of freezes earned.



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

def earned
  @earned
end

#freezes ⇒ Integer (readonly)

Returns The total number of freezes the user has after the event.

Returns:

  • The total number of freezes the user has after the event.



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

def freezes
  @freezes
end

#type ⇒ String (readonly)

Returns The webhook event type.

Returns:

  • The webhook event type.



10
11
12
 
# File 'lib/trophy_api_client/types/webhooks_streak_freeze_earned_payload.rb', line 10

def type
  @type
end

#user ⇒ TrophyApiClient::User (readonly)

Returns The user who earned streak freezes.

Returns:

  • The user who earned streak freezes.



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

def user
  @user
end

Class Method Details

.from_json(json_object:) ⇒ TrophyApiClient::WebhooksStreakFreezeEarnedPayload

Deserialize a JSON object to an instance of WebhooksStreakFreezeEarnedPayload

Parameters:

Returns:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/trophy_api_client/types/webhooks_streak_freeze_earned_payload.rb', line 44

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
  earned = parsed_json["earned"]
  freezes = parsed_json["freezes"]
  new(
    type: type,
    user: user,
    earned: earned,
    freezes: freezes,
    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:

Returns:



78
79
80
81
82
83
 
# File 'lib/trophy_api_client/types/webhooks_streak_freeze_earned_payload.rb', line 78

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)
  obj.earned.is_a?(Integer) != false || raise("Passed value for field obj.earned is not the expected type, validation failed.")
  obj.freezes.is_a?(Integer) != false || raise("Passed value for field obj.freezes is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of WebhooksStreakFreezeEarnedPayload to a JSON object

Returns:



68
69
70
 
# File 'lib/trophy_api_client/types/webhooks_streak_freeze_earned_payload.rb', line 68

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