Class: TrophyApiClient::AchievementCompletionResponse

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

Constant Summary collapse

OMIT =
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(completion_id:, achievement:, additional_properties: nil) ⇒ TrophyApiClient::AchievementCompletionResponse

Parameters:

  • completion_id (String)

    The unique ID of the completion.

  • achievement (TrophyApiClient::CompletedAchievementResponse)
  • additional_properties (OpenStruct) (defaults to: nil)

    Additional properties unmapped to the current class definition



25
26
27
28
29
30
# File 'lib/trophy_api_client/types/achievement_completion_response.rb', line 25

def initialize(completion_id:, achievement:, additional_properties: nil)
  @completion_id = completion_id
  @achievement = achievement
  @additional_properties = additional_properties
  @_field_set = { "completionId": completion_id, "achievement": achievement }
end

Instance Attribute Details

#achievementTrophyApiClient::CompletedAchievementResponse (readonly)



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

def achievement
  @achievement
end

#additional_propertiesOpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct)

    Additional properties unmapped to the current class definition



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

def additional_properties
  @additional_properties
end

#completion_idString (readonly)

Returns The unique ID of the completion.

Returns:

  • (String)

    The unique ID of the completion.



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

def completion_id
  @completion_id
end

Class Method Details

.from_json(json_object:) ⇒ TrophyApiClient::AchievementCompletionResponse

Deserialize a JSON object to an instance of AchievementCompletionResponse

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  completion_id = parsed_json["completionId"]
  if parsed_json["achievement"].nil?
    achievement = nil
  else
    achievement = parsed_json["achievement"].to_json
    achievement = TrophyApiClient::CompletedAchievementResponse.from_json(json_object: achievement)
  end
  new(
    completion_id: completion_id,
    achievement: achievement,
    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)


66
67
68
69
# File 'lib/trophy_api_client/types/achievement_completion_response.rb', line 66

def self.validate_raw(obj:)
  obj.completion_id.is_a?(String) != false || raise("Passed value for field obj.completion_id is not the expected type, validation failed.")
  TrophyApiClient::CompletedAchievementResponse.validate_raw(obj: obj.achievement)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of AchievementCompletionResponse to a JSON object

Returns:

  • (String)


56
57
58
# File 'lib/trophy_api_client/types/achievement_completion_response.rb', line 56

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