Class: TrophyApiClient::CreateMetricsResponse

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

Overview

Response containing created metrics and any per-item issues.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(created:, issues:, additional_properties: nil) ⇒ TrophyApiClient::CreateMetricsResponse

Parameters:

  • created (Array<TrophyApiClient::CreatedMetric>) —

    Array of successfully created metrics.

  • issues (Array<TrophyApiClient::AdminIssue>) —

    Array of issues encountered during metric creation.

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

    Additional properties unmapped to the current class definition



27
28
29
30
31
32
 
# File 'lib/trophy_api_client/types/create_metrics_response.rb', line 27

def initialize(created:, issues:, additional_properties: nil)
  @created = created
  @issues = issues
  @additional_properties = additional_properties
  @_field_set = { "created": created, "issues": issues }
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



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

def additional_properties
  @additional_properties
end

#created ⇒ Array<TrophyApiClient::CreatedMetric> (readonly)

Returns Array of successfully created metrics.

Returns:



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

def created
  @created
end

#issues ⇒ Array<TrophyApiClient::AdminIssue> (readonly)

Returns Array of issues encountered during metric creation.

Returns:



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

def issues
  @issues
end

Class Method Details

.from_json(json_object:) ⇒ TrophyApiClient::CreateMetricsResponse

Deserialize a JSON object to an instance of CreateMetricsResponse

Parameters:

  • json_object (String)

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/trophy_api_client/types/create_metrics_response.rb', line 38

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  created = parsed_json["created"]&.map do |item|
    item = item.to_json
    TrophyApiClient::CreatedMetric.from_json(json_object: item)
  end
  issues = parsed_json["issues"]&.map do |item|
    item = item.to_json
    TrophyApiClient::AdminIssue.from_json(json_object: item)
  end
  new(
    created: created,
    issues: issues,
    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) 


69
70
71
72
 
# File 'lib/trophy_api_client/types/create_metrics_response.rb', line 69

def self.validate_raw(obj:)
  obj.created.is_a?(Array) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
  obj.issues.is_a?(Array) != false || raise("Passed value for field obj.issues is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of CreateMetricsResponse to a JSON object

Returns:

  • (String) 


59
60
61
 
# File 'lib/trophy_api_client/types/create_metrics_response.rb', line 59

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