Class: Gusto::ReportTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/fern_gusto/types/report_template.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(columns: OMIT, groupings: OMIT, company_uuid: OMIT, report_type: OMIT, additional_properties: nil) ⇒ Gusto::ReportTemplate

Parameters:

  • columns (Array<String>) (defaults to: OMIT) —

    List of columns recommended

  • groupings (Array<String>) (defaults to: OMIT) —

    List of groupings recommended

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

    Company UUID

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

    Type of report template

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

    Additional properties unmapped to the current class definition



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/fern_gusto/types/report_template.rb', line 29

def initialize(columns: OMIT, groupings: OMIT, company_uuid: OMIT, report_type: OMIT, additional_properties: nil)
  @columns = columns if columns != OMIT
  @groupings = groupings if groupings != OMIT
  @company_uuid = company_uuid if company_uuid != OMIT
  @report_type = report_type if report_type != OMIT
  @additional_properties = additional_properties
  @_field_set = { "columns": columns, "groupings": groupings, "company_uuid": company_uuid, "report_type": report_type }.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



16
17
18
 
# File 'lib/fern_gusto/types/report_template.rb', line 16

def additional_properties
  @additional_properties
end

#columns ⇒ Array<String> (readonly)

Returns List of columns recommended.

Returns:

  • (Array<String>) —

    List of columns recommended



8
9
10
 
# File 'lib/fern_gusto/types/report_template.rb', line 8

def columns
  @columns
end

#company_uuid ⇒ String (readonly)

Returns Company UUID.

Returns:

  • (String) —

    Company UUID



12
13
14
 
# File 'lib/fern_gusto/types/report_template.rb', line 12

def company_uuid
  @company_uuid
end

#groupings ⇒ Array<String> (readonly)

Returns List of groupings recommended.

Returns:

  • (Array<String>) —

    List of groupings recommended



10
11
12
 
# File 'lib/fern_gusto/types/report_template.rb', line 10

def groupings
  @groupings
end

#report_type ⇒ String (readonly)

Returns Type of report template.

Returns:

  • (String) —

    Type of report template



14
15
16
 
# File 'lib/fern_gusto/types/report_template.rb', line 14

def report_type
  @report_type
end

Class Method Details

.from_json(json_object:) ⇒ Gusto::ReportTemplate

Parameters:

  • json_object (String)

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/fern_gusto/types/report_template.rb', line 43

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  columns = parsed_json["columns"]
  groupings = parsed_json["groupings"]
  company_uuid = parsed_json["company_uuid"]
  report_type = parsed_json["report_type"]
  new(
    columns: columns,
    groupings: groupings,
    company_uuid: company_uuid,
    report_type: report_type,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


70
71
72
73
74
75
 
# File 'lib/fern_gusto/types/report_template.rb', line 70

def self.validate_raw(obj:)
  obj.columns&.is_a?(Array) != false || raise("Passed value for field obj.columns is not the expected type, validation failed.")
  obj.groupings&.is_a?(Array) != false || raise("Passed value for field obj.groupings is not the expected type, validation failed.")
  obj.company_uuid&.is_a?(String) != false || raise("Passed value for field obj.company_uuid is not the expected type, validation failed.")
  obj.report_type&.is_a?(String) != false || raise("Passed value for field obj.report_type is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


61
62
63
 
# File 'lib/fern_gusto/types/report_template.rb', line 61

def to_json
  @_field_set&.to_json
end