Class: TrophyApiClient::PointsAward

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, awarded: OMIT, date: OMIT, total: OMIT, trigger: OMIT, additional_properties: nil) ⇒ TrophyApiClient::PointsAward

Parameters:

  • id (String) (defaults to: OMIT) —

    The ID of the trigger award

  • awarded (Float) (defaults to: OMIT) —

    The points awarded by this trigger

  • date (String) (defaults to: OMIT) —

    The date these points were awarded, in ISO 8601 format.

  • total (Float) (defaults to: OMIT) —

    The user’s total points after this award occurred.

  • trigger (TrophyApiClient::PointsTrigger) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

def initialize(id: OMIT, awarded: OMIT, date: OMIT, total: OMIT, trigger: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @awarded = awarded if awarded != OMIT
  @date = date if date != OMIT
  @total = total if total != OMIT
  @trigger = trigger if trigger != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "awarded": awarded,
    "date": date,
    "total": total,
    "trigger": trigger
  }.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



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

def additional_properties
  @additional_properties
end

#awarded ⇒ Float (readonly)

Returns The points awarded by this trigger.

Returns:

  • (Float) —

    The points awarded by this trigger



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

def awarded
  @awarded
end

#date ⇒ String (readonly)

Returns The date these points were awarded, in ISO 8601 format.

Returns:

  • (String) —

    The date these points were awarded, in ISO 8601 format.



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

def date
  @date
end

#id ⇒ String (readonly)

Returns The ID of the trigger award.

Returns:

  • (String) —

    The ID of the trigger award



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

def id
  @id
end

#total ⇒ Float (readonly)

Returns The user’s total points after this award occurred.

Returns:

  • (Float) —

    The user’s total points after this award occurred.



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

def total
  @total
end

#trigger ⇒ TrophyApiClient::PointsTrigger (readonly)

Returns:



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

def trigger
  @trigger
end

Class Method Details

.from_json(json_object:) ⇒ TrophyApiClient::PointsAward

Deserialize a JSON object to an instance of PointsAward

Parameters:

  • json_object (String)

Returns:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/trophy_api_client/types/points_award.rb', line 56

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  awarded = parsed_json["awarded"]
  date = parsed_json["date"]
  total = parsed_json["total"]
  if parsed_json["trigger"].nil?
    trigger = nil
  else
    trigger = parsed_json["trigger"].to_json
    trigger = TrophyApiClient::PointsTrigger.from_json(json_object: trigger)
  end
  new(
    id: id,
    awarded: awarded,
    date: date,
    total: total,
    trigger: trigger,
    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) 


92
93
94
95
96
97
98
 
# File 'lib/trophy_api_client/types/points_award.rb', line 92

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.awarded&.is_a?(Float) != false || raise("Passed value for field obj.awarded is not the expected type, validation failed.")
  obj.date&.is_a?(String) != false || raise("Passed value for field obj.date is not the expected type, validation failed.")
  obj.total&.is_a?(Float) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
  obj.trigger.nil? || TrophyApiClient::PointsTrigger.validate_raw(obj: obj.trigger)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of PointsAward to a JSON object

Returns:

  • (String) 


82
83
84
 
# File 'lib/trophy_api_client/types/points_award.rb', line 82

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