Class: TrophyApiClient::AchievementResponse

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, name:, trigger:, key:, description: OMIT, badge_url: OMIT, streak_length: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, additional_properties: nil) ⇒ TrophyApiClient::AchievementResponse 



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
 
# File 'lib/trophy_api_client/types/achievement_response.rb', line 59

def initialize(id:, name:, trigger:, key:, description: OMIT, badge_url: OMIT, streak_length: OMIT,
               metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, additional_properties: nil)
  @id = id
  @name = name
  @trigger = trigger
  @description = description if description != OMIT
  @badge_url = badge_url if badge_url != OMIT
  @key = key
  @streak_length = streak_length if streak_length != OMIT
  @metric_id = metric_id if metric_id != OMIT
  @metric_value = metric_value if metric_value != OMIT
  @metric_name = metric_name if metric_name != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "name": name,
    "trigger": trigger,
    "description": description,
    "badgeUrl": badge_url,
    "key": key,
    "streakLength": streak_length,
    "metricId": metric_id,
    "metricValue": metric_value,
    "metricName": metric_name
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly) 



35
36
37
 
# File 'lib/trophy_api_client/types/achievement_response.rb', line 35

def additional_properties
  @additional_properties
end

#badge_url ⇒ String (readonly) 



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

def badge_url
  @badge_url
end

#description ⇒ String (readonly) 



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

def description
  @description
end

#id ⇒ String (readonly) 



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

def id
  @id
end

#key ⇒ String (readonly) 



21
22
23
 
# File 'lib/trophy_api_client/types/achievement_response.rb', line 21

def key
  @key
end

#metric_id ⇒ String (readonly) 



27
28
29
 
# File 'lib/trophy_api_client/types/achievement_response.rb', line 27

def metric_id
  @metric_id
end

#metric_name ⇒ String (readonly) 



33
34
35
 
# File 'lib/trophy_api_client/types/achievement_response.rb', line 33

def metric_name
  @metric_name
end

#metric_value ⇒ Float (readonly) 



30
31
32
 
# File 'lib/trophy_api_client/types/achievement_response.rb', line 30

def metric_value
  @metric_value
end

#name ⇒ String (readonly) 



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

def name
  @name
end

#streak_length ⇒ Integer (readonly) 



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

def streak_length
  @streak_length
end

#trigger ⇒ TrophyApiClient::AchievementResponseTrigger (readonly) 



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

def trigger
  @trigger
end

Class Method Details

.from_json(json_object:) ⇒ TrophyApiClient::AchievementResponse

Deserialize a JSON object to an instance of AchievementResponse



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/trophy_api_client/types/achievement_response.rb', line 92

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  name = parsed_json["name"]
  trigger = parsed_json["trigger"]
  description = parsed_json["description"]
  badge_url = parsed_json["badgeUrl"]
  key = parsed_json["key"]
  streak_length = parsed_json["streakLength"]
  metric_id = parsed_json["metricId"]
  metric_value = parsed_json["metricValue"]
  metric_name = parsed_json["metricName"]
  new(
    id: id,
    name: name,
    trigger: trigger,
    description: description,
    badge_url: badge_url,
    key: key,
    streak_length: streak_length,
    metric_id: metric_id,
    metric_value: metric_value,
    metric_name: metric_name,
    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.



133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/trophy_api_client/types/achievement_response.rb', line 133

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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.trigger.is_a?(TrophyApiClient::AchievementResponseTrigger) != false || raise("Passed value for field obj.trigger 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.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
  obj.streak_length&.is_a?(Integer) != false || raise("Passed value for field obj.streak_length is not the expected type, validation failed.")
  obj.metric_id&.is_a?(String) != false || raise("Passed value for field obj.metric_id is not the expected type, validation failed.")
  obj.metric_value&.is_a?(Float) != false || raise("Passed value for field obj.metric_value is not the expected type, validation failed.")
  obj.metric_name&.is_a?(String) != false || raise("Passed value for field obj.metric_name is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of AchievementResponse to a JSON object



123
124
125
 
# File 'lib/trophy_api_client/types/achievement_response.rb', line 123

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