Class: TrophyApiClient::GetUserPointsResponse

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, key:, name:, total:, awards:, description: OMIT, badge_url: OMIT, max_points: OMIT, additional_properties: nil) ⇒ TrophyApiClient::GetUserPointsResponse

Parameters:

  • id (String) —

    The ID of the points system

  • key (String) —

    The key of the points system

  • name (String) —

    The name of the points system

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

    The description of the points system

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

    The URL of the badge image for the points system

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

    The maximum number of points a user can be awarded in this points system

  • total (Integer) —

    The user’s total points

  • awards (Array<TrophyApiClient::PointsAward>) —

    Array of trigger awards that added points.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

def initialize(id:, key:, name:, total:, awards:, description: OMIT, badge_url: OMIT, max_points: OMIT,
               additional_properties: nil)
  @id = id
  @key = key
  @name = name
  @description = description if description != OMIT
  @badge_url = badge_url if badge_url != OMIT
  @max_points = max_points if max_points != OMIT
  @total = total
  @awards = awards
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "key": key,
    "name": name,
    "description": description,
    "badgeUrl": badge_url,
    "maxPoints": max_points,
    "total": total,
    "awards": awards
  }.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



26
27
28
 
# File 'lib/trophy_api_client/types/get_user_points_response.rb', line 26

def additional_properties
  @additional_properties
end

#awards ⇒ Array<TrophyApiClient::PointsAward> (readonly)

Returns Array of trigger awards that added points.

Returns:



24
25
26
 
# File 'lib/trophy_api_client/types/get_user_points_response.rb', line 24

def awards
  @awards
end

#badge_url ⇒ String (readonly)

Returns The URL of the badge image for the points system.

Returns:

  • (String) —

    The URL of the badge image for the points system



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

def badge_url
  @badge_url
end

#description ⇒ String (readonly)

Returns The description of the points system.

Returns:

  • (String) —

    The description of the points system



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

def description
  @description
end

#id ⇒ String (readonly)

Returns The ID of the points system.

Returns:

  • (String) —

    The ID of the points system



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

def id
  @id
end

#key ⇒ String (readonly)

Returns The key of the points system.

Returns:

  • (String) —

    The key of the points system



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

def key
  @key
end

#max_points ⇒ Float (readonly)

Returns The maximum number of points a user can be awarded in this points system.

Returns:

  • (Float) —

    The maximum number of points a user can be awarded in this points system



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

def max_points
  @max_points
end

#name ⇒ String (readonly)

Returns The name of the points system.

Returns:

  • (String) —

    The name of the points system



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

def name
  @name
end

#total ⇒ Integer (readonly)

Returns The user’s total points.

Returns:

  • (Integer) —

    The user’s total points



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

def total
  @total
end

Class Method Details

.from_json(json_object:) ⇒ TrophyApiClient::GetUserPointsResponse

Deserialize a JSON object to an instance of GetUserPointsResponse

Parameters:

  • json_object (String)

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/trophy_api_client/types/get_user_points_response.rb', line 72

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  key = parsed_json["key"]
  name = parsed_json["name"]
  description = parsed_json["description"]
  badge_url = parsed_json["badgeUrl"]
  max_points = parsed_json["maxPoints"]
  total = parsed_json["total"]
  awards = parsed_json["awards"]&.map do |item|
    item = item.to_json
    TrophyApiClient::PointsAward.from_json(json_object: item)
  end
  new(
    id: id,
    key: key,
    name: name,
    description: description,
    badge_url: badge_url,
    max_points: max_points,
    total: total,
    awards: awards,
    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) 


112
113
114
115
116
117
118
119
120
121
 
# File 'lib/trophy_api_client/types/get_user_points_response.rb', line 112

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.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
  obj.badge_url&.is_a?(String) != false || raise("Passed value for field obj.badge_url is not the expected type, validation failed.")
  obj.max_points&.is_a?(Float) != false || raise("Passed value for field obj.max_points is not the expected type, validation failed.")
  obj.total.is_a?(Integer) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
  obj.awards.is_a?(Array) != false || raise("Passed value for field obj.awards is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of GetUserPointsResponse to a JSON object

Returns:

  • (String) 


102
103
104
 
# File 'lib/trophy_api_client/types/get_user_points_response.rb', line 102

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