Class: Intrinio::ESGComprehensiveRating

Inherits:
Object
  • Object
show all
Defined in:
lib/intrinio-sdk/models/esg_comprehensive_rating.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ESGComprehensiveRating

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 228

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'date')
    self.date = attributes[:'date']
  end

  if attributes.has_key?(:'country_average_rating')
    self.country_average_rating = attributes[:'country_average_rating']
  end

  if attributes.has_key?(:'industry_average_rating')
    self.industry_average_rating = attributes[:'industry_average_rating']
  end

  if attributes.has_key?(:'overall_rating')
    self.overall_rating = attributes[:'overall_rating']
  end

  if attributes.has_key?(:'community_rating')
    self.community_rating = attributes[:'community_rating']
  end

  if attributes.has_key?(:'employee_rating')
    self.employee_rating = attributes[:'employee_rating']
  end

  if attributes.has_key?(:'environment_rating')
    self.environment_rating = attributes[:'environment_rating']
  end

  if attributes.has_key?(:'governance_rating')
    self.governance_rating = attributes[:'governance_rating']
  end

  if attributes.has_key?(:'human_rights_and_supply_chain_rating')
    self.human_rights_and_supply_chain_rating = attributes[:'human_rights_and_supply_chain_rating']
  end

  if attributes.has_key?(:'community_dev_and_philanthropy_rating')
    self.community_dev_and_philanthropy_rating = attributes[:'community_dev_and_philanthropy_rating']
  end

  if attributes.has_key?(:'product_rating')
    self.product_rating = attributes[:'product_rating']
  end

  if attributes.has_key?(:'compensation_and_benefits_rating')
    self.compensation_and_benefits_rating = attributes[:'compensation_and_benefits_rating']
  end

  if attributes.has_key?(:'diversity_and_labor_rights_rating')
    self.diversity_and_labor_rights_rating = attributes[:'diversity_and_labor_rights_rating']
  end

  if attributes.has_key?(:'training_health_and_safety_rating')
    self.training_health_and_safety_rating = attributes[:'training_health_and_safety_rating']
  end

  if attributes.has_key?(:'energy_climate_change_rating')
    self.energy_climate_change_rating = attributes[:'energy_climate_change_rating']
  end

  if attributes.has_key?(:'environment_policy_and_reporting_rating')
    self.environment_policy_and_reporting_rating = attributes[:'environment_policy_and_reporting_rating']
  end

  if attributes.has_key?(:'resource_management_rating')
    self.resource_management_rating = attributes[:'resource_management_rating']
  end

  if attributes.has_key?(:'board_rating')
    self.board_rating = attributes[:'board_rating']
  end

  if attributes.has_key?(:'leadership_ethics_rating')
    self.leadership_ethics_rating = attributes[:'leadership_ethics_rating']
  end

  if attributes.has_key?(:'transparency_reporting_rating')
    self.transparency_reporting_rating = attributes[:'transparency_reporting_rating']
  end

  if attributes.has_key?(:'country_percentile_rank')
    self.country_percentile_rank = attributes[:'country_percentile_rank']
  end

  if attributes.has_key?(:'industry_percentile_rank')
    self.industry_percentile_rank = attributes[:'industry_percentile_rank']
  end

  if attributes.has_key?(:'overall_percentile_rank')
    self.overall_percentile_rank = attributes[:'overall_percentile_rank']
  end

  if attributes.has_key?(:'community_percentile_rank')
    self.community_percentile_rank = attributes[:'community_percentile_rank']
  end

  if attributes.has_key?(:'employee_percentile_rank')
    self.employee_percentile_rank = attributes[:'employee_percentile_rank']
  end

  if attributes.has_key?(:'environment_percentile_rank')
    self.environment_percentile_rank = attributes[:'environment_percentile_rank']
  end

  if attributes.has_key?(:'governance_percentile_rank')
    self.governance_percentile_rank = attributes[:'governance_percentile_rank']
  end

  if attributes.has_key?(:'human_rights_and_supply_chain_percentile_rank')
    self.human_rights_and_supply_chain_percentile_rank = attributes[:'human_rights_and_supply_chain_percentile_rank']
  end

  if attributes.has_key?(:'community_dev_and_philanthropy_percentile_rank')
    self.community_dev_and_philanthropy_percentile_rank = attributes[:'community_dev_and_philanthropy_percentile_rank']
  end

  if attributes.has_key?(:'product_percentile_rank')
    self.product_percentile_rank = attributes[:'product_percentile_rank']
  end

  if attributes.has_key?(:'compensation_and_benefits_percentile_rank')
    self.compensation_and_benefits_percentile_rank = attributes[:'compensation_and_benefits_percentile_rank']
  end

  if attributes.has_key?(:'diversity_and_labor_rights_percentile_rank')
    self.diversity_and_labor_rights_percentile_rank = attributes[:'diversity_and_labor_rights_percentile_rank']
  end

  if attributes.has_key?(:'training_health_and_safety_percentile_rank')
    self.training_health_and_safety_percentile_rank = attributes[:'training_health_and_safety_percentile_rank']
  end

  if attributes.has_key?(:'energy_climate_change_percentile_rank')
    self.energy_climate_change_percentile_rank = attributes[:'energy_climate_change_percentile_rank']
  end

  if attributes.has_key?(:'environment_policy_and_reporting_percentile_rank')
    self.environment_policy_and_reporting_percentile_rank = attributes[:'environment_policy_and_reporting_percentile_rank']
  end

  if attributes.has_key?(:'resource_management_percentile_rank')
    self.resource_management_percentile_rank = attributes[:'resource_management_percentile_rank']
  end

  if attributes.has_key?(:'board_percentile_rank')
    self.board_percentile_rank = attributes[:'board_percentile_rank']
  end

  if attributes.has_key?(:'leadership_ethics_percentile_rank')
    self.leadership_ethics_percentile_rank = attributes[:'leadership_ethics_percentile_rank']
  end

  if attributes.has_key?(:'transparency_reporting_percentile_rank')
    self.transparency_reporting_percentile_rank = attributes[:'transparency_reporting_percentile_rank']
  end

end

Instance Attribute Details

#board_percentile_rankObject

The percentile rank of the company’s Board rating in comparison to all companies within the CSRHub ESG universe.



127
128
129
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 127

def board_percentile_rank
  @board_percentile_rank
end

#board_ratingObject

The Board subcategory covers a company’s effectiveness in following best practices in corporate governance principles related to board membership. It includes how the company provides competitive and proportionate management compensation and its ability to incent executives and board members to achieve both financial and extra-financial targets.



70
71
72
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 70

def board_rating
  @board_rating
end

#community_dev_and_philanthropy_percentile_rankObject

The percentile rank of the company’s Community, Dev, and Philanthropy rating in comparison to all companies within the CSRHub ESG universe.



103
104
105
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 103

def community_dev_and_philanthropy_percentile_rank
  @community_dev_and_philanthropy_percentile_rank
end

#community_dev_and_philanthropy_ratingObject

The Community Development and Philanthropy subcategory covers the relationship between a company and the communities within which it is embedded. It reflects a company’s community citizenship through charitable giving, donations of goods, and volunteerism of staff time. It also includes protecting public health (e.g., avoidance of industrial accidents) and managing the social impacts of its operations.



46
47
48
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 46

def community_dev_and_philanthropy_rating
  @community_dev_and_philanthropy_rating
end

#community_percentile_rankObject

The percentile rank of the company’s Community rating in comparison to all companies within the CSRHub ESG universe.



88
89
90
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 88

def community_percentile_rank
  @community_percentile_rank
end

#community_ratingObject

The Community Category reflects a companys citizenship, charitable giving, and volunteerism. This category covers the company’s human rights record and treatment of its supply chain. It also covers the environmental and social impacts of the companys products and services, and the development of sustainable products, processes and technologies.



31
32
33
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 31

def community_rating
  @community_rating
end

#compensation_and_benefits_percentile_rankObject

The percentile rank of the company’s Compensation and Benefits rating in comparison to all companies within the CSRHub ESG universe.



109
110
111
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 109

def compensation_and_benefits_percentile_rank
  @compensation_and_benefits_percentile_rank
end

#compensation_and_benefits_ratingObject

The Compensation and Benefits subcategory covers a company’s capacity to increase its workforce loyalty and productivity. It includes benefits that engage employees and improve worker development. This subcategory also focuses on long-term employment growth and stability by promotion practices, lay-off practices, and relations with retired employees.



52
53
54
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 52

def compensation_and_benefits_rating
  @compensation_and_benefits_rating
end

#country_average_ratingObject

The average ESG rating of all companies in a particular country in which the company is a peer of.



22
23
24
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 22

def country_average_rating
  @country_average_rating
end

#country_percentile_rankObject

The percentile rank of the company’s ESG rating in comparison to it’s country peers.



79
80
81
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 79

def country_percentile_rank
  @country_percentile_rank
end

#dateObject

Indicates the date on which the ESG Rating was calculated.



19
20
21
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 19

def date
  @date
end

#diversity_and_labor_rights_percentile_rankObject

The percentile rank of the company’s Diversity and Labor Rights rating in comparison to all companies within the CSRHub ESG universe.



112
113
114
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 112

def diversity_and_labor_rights_percentile_rank
  @diversity_and_labor_rights_percentile_rank
end

#diversity_and_labor_rights_ratingObject

The Diversity and Labor Rights subcategory covers workplace policies and practices covering fair and non-discriminatory treatment of employees. It covers a company’s labor-management relations and participation by employees. Fundamental labor rights include freedom of association and protection of the right to organize.



55
56
57
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 55

def diversity_and_labor_rights_rating
  @diversity_and_labor_rights_rating
end

#employee_percentile_rankObject

The percentile rank of the company’s Employee rating in comparison to all companies within the CSRHub ESG universe.



91
92
93
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 91

def employee_percentile_rank
  @employee_percentile_rank
end

#employee_ratingObject

The Employees category includes disclosure of policies, programs, and performance in diversity, labor relations and labor rights. The evaluation focuses on the quality of policies and programs, compliance with national laws and regulations, and proactive management initiatives. The category includes evaluation of inclusive diversity policies, fair treatment of all employees, robust diversity (EEO-1) programs and training.



34
35
36
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 34

def employee_rating
  @employee_rating
end

#energy_climate_change_percentile_rankObject

The percentile rank of the company’s Energy Climate Change rating in comparison to all companies within the CSRHub ESG universe.



118
119
120
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 118

def energy_climate_change_percentile_rank
  @energy_climate_change_percentile_rank
end

#energy_climate_change_ratingObject

The Energy and Climate Change subcategory measures a company’s effectiveness in addressing climate change through appropriate policies and strategies. The subcategory includes energy use, emissions to air of CO2 and other Greenhouse Gas Emissions (GHG) and other alternative environmental technologies.



61
62
63
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 61

def energy_climate_change_rating
  @energy_climate_change_rating
end

#environment_percentile_rankObject

The percentile rank of the company’s Environment rating in comparison to all companies within the CSRHub ESG universe.



94
95
96
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 94

def environment_percentile_rank
  @environment_percentile_rank
end

#environment_policy_and_reporting_percentile_rankObject

The percentile rank of the company’s Environment Policy and Reporting rating in comparison to all companies within the CSRHub ESG universe.



121
122
123
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 121

def environment_policy_and_reporting_percentile_rank
  @environment_policy_and_reporting_percentile_rank
end

#environment_policy_and_reporting_ratingObject

The Environmental Policy and Reporting subcategory includes a company’s policies and intention to reduce the environmental impact of a company. The data includes the company’s environmental reporting performance, adherence to environmental reporting standards and compliance with investor, regulatory and stakeholders’ requests for transparency. Compliance data consists of breaches of regulatory limits and accidental releases.



64
65
66
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 64

def environment_policy_and_reporting_rating
  @environment_policy_and_reporting_rating
end

#environment_ratingObject

The Environment category data covers a company’s interactions with the environment at large, including use of natural resources. The category evaluates corporate environmental performance, compliance with environmental regulations, and mitigation of environmental footprint. It also includes leadership in addressing climate change through appropriate policies and strategies.



37
38
39
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 37

def environment_rating
  @environment_rating
end

#governance_percentile_rankObject

The percentile rank of the company’s Governance rating in comparison to all companies within the CSRHub ESG universe.



97
98
99
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 97

def governance_percentile_rank
  @governance_percentile_rank
end

#governance_ratingObject

Corporate governance refers to leadership structure and the values that determine corporate direction, ethics and performance. The Governance category covers disclosure of policies and procedures, board independence and diversity, executive compensation, attention to stakeholder concerns, and evaluation of a company’s culture of ethical leadership and compliance.



40
41
42
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 40

def governance_rating
  @governance_rating
end

#human_rights_and_supply_chain_percentile_rankObject

The percentile rank of the company’s Human Rights and Supply Chain rating in comparison to all companies within the CSRHub ESG universe.



100
101
102
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 100

def human_rights_and_supply_chain_percentile_rank
  @human_rights_and_supply_chain_percentile_rank
end

#human_rights_and_supply_chain_ratingObject

The Human Rights and Supply Chain subcategory measures a company’s commitment to respecting fundamental human rights conventions. This subcategory covers a company’s transparency in overseas sourcing disclosure and monitoring. The subcategory also covers the relationship with and respect for the human rights of indigenous peoples near its proposed or current operations.



43
44
45
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 43

def human_rights_and_supply_chain_rating
  @human_rights_and_supply_chain_rating
end

#industry_average_ratingObject

The average ESG rating of all companies in a particular industry in which the company is a peer of.



25
26
27
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 25

def industry_average_rating
  @industry_average_rating
end

#industry_percentile_rankObject

The percentile rank of the company’s ESG rating in comparison to it’s industry peers.



82
83
84
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 82

def industry_percentile_rank
  @industry_percentile_rank
end

#leadership_ethics_percentile_rankObject

The percentile rank of the company’s Leadership Ethics rating in comparison to all companies within the CSRHub ESG universe.



130
131
132
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 130

def leadership_ethics_percentile_rank
  @leadership_ethics_percentile_rank
end

#leadership_ethics_ratingObject

The Leadership Ethics subcategory measures how a company manages its relationships with its various stakeholders, including investors, customers, communities, and regulators. It measures a company’s commitment and effectiveness toward the vision of integrating social and environmental aspects into the overall core strategy. It also measures whether sustainability principles are integrated from the top down into the day-to-day operations of the company.



73
74
75
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 73

def leadership_ethics_rating
  @leadership_ethics_rating
end

#overall_percentile_rankObject

The percentile rank of the company’s overall ESG rating in comparison to all companies within the CSRHub ESG universe.



85
86
87
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 85

def overall_percentile_rank
  @overall_percentile_rank
end

#overall_ratingObject

The company’s overall aggregated ESG rating, taking into account its ESG scoring from the Community, Employee, Enviroment, and Governance categories.



28
29
30
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 28

def overall_rating
  @overall_rating
end

#product_percentile_rankObject

The percentile rank of the company’s Product rating in comparison to all companies within the CSRHub ESG universe.



106
107
108
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 106

def product_percentile_rank
  @product_percentile_rank
end

#product_ratingObject

The Product subcategory covers the responsibility of a company for the development, design, and management of its products and services. This subcategory reflects a company’s capacity to reduce environmental costs, create new market opportunities, and produce or market goods and services that enhance the health and quality of life for consumers.



49
50
51
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 49

def product_rating
  @product_rating
end

#resource_management_percentile_rankObject

The percentile rank of the company’s Resource Management rating in comparison to all companies within the CSRHub ESG universe.



124
125
126
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 124

def resource_management_percentile_rank
  @resource_management_percentile_rank
end

#resource_management_ratingObject

The Resource Management subcategory covers how efficiently resources are used in manufacturing and delivering products and services. It includes a company’s capacity to reduce the use of materials, energy or water, and to find more efficient solutions by improving its supply chain management. This subcategory includes environmental performance relative to production size.



67
68
69
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 67

def resource_management_rating
  @resource_management_rating
end

#training_health_and_safety_percentile_rankObject

The percentile rank of the company’s Training, Health, and Safety rating in comparison to all companies within the CSRHub ESG universe.



115
116
117
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 115

def training_health_and_safety_percentile_rank
  @training_health_and_safety_percentile_rank
end

#training_health_and_safety_ratingObject

The Training, Safety and Health subcategory measures a company’s effectiveness in providing a healthy and safe workplace. It includes programs to support the health, well-being and productivity of all employees. This subcategory includes workplace policies and programs that boost employee morale, workplace productivity and worker development.



58
59
60
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 58

def training_health_and_safety_rating
  @training_health_and_safety_rating
end

#transparency_reporting_percentile_rankObject

The percentile rank of the company’s Transaperency Reporting rating in comparison to all companies within the CSRHub ESG universe.



133
134
135
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 133

def transparency_reporting_percentile_rank
  @transparency_reporting_percentile_rank
end

#transparency_reporting_ratingObject

The Transparency and Reporting subcategory rates factors including are corporate policies and practices aligned with sustainability goals. It also covers whether the company is a signatory of Global Compact and other leading global entities. It evaluates the assurance (3rd party audit) of the accuracy, completeness, and reliability of its Sustainability or Corporate Social Responsibility reports.



76
77
78
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 76

def transparency_reporting_rating
  @transparency_reporting_rating
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 137

def self.attribute_map
  {
    :'date' => :'date',
    :'country_average_rating' => :'country_average_rating',
    :'industry_average_rating' => :'industry_average_rating',
    :'overall_rating' => :'overall_rating',
    :'community_rating' => :'community_rating',
    :'employee_rating' => :'employee_rating',
    :'environment_rating' => :'environment_rating',
    :'governance_rating' => :'governance_rating',
    :'human_rights_and_supply_chain_rating' => :'human_rights_and_supply_chain_rating',
    :'community_dev_and_philanthropy_rating' => :'community_dev_and_philanthropy_rating',
    :'product_rating' => :'product_rating',
    :'compensation_and_benefits_rating' => :'compensation_and_benefits_rating',
    :'diversity_and_labor_rights_rating' => :'diversity_and_labor_rights_rating',
    :'training_health_and_safety_rating' => :'training_health_and_safety_rating',
    :'energy_climate_change_rating' => :'energy_climate_change_rating',
    :'environment_policy_and_reporting_rating' => :'environment_policy_and_reporting_rating',
    :'resource_management_rating' => :'resource_management_rating',
    :'board_rating' => :'board_rating',
    :'leadership_ethics_rating' => :'leadership_ethics_rating',
    :'transparency_reporting_rating' => :'transparency_reporting_rating',
    :'country_percentile_rank' => :'country_percentile_rank',
    :'industry_percentile_rank' => :'industry_percentile_rank',
    :'overall_percentile_rank' => :'overall_percentile_rank',
    :'community_percentile_rank' => :'community_percentile_rank',
    :'employee_percentile_rank' => :'employee_percentile_rank',
    :'environment_percentile_rank' => :'environment_percentile_rank',
    :'governance_percentile_rank' => :'governance_percentile_rank',
    :'human_rights_and_supply_chain_percentile_rank' => :'human_rights_and_supply_chain_percentile_rank',
    :'community_dev_and_philanthropy_percentile_rank' => :'community_dev_and_philanthropy_percentile_rank',
    :'product_percentile_rank' => :'product_percentile_rank',
    :'compensation_and_benefits_percentile_rank' => :'compensation_and_benefits_percentile_rank',
    :'diversity_and_labor_rights_percentile_rank' => :'diversity_and_labor_rights_percentile_rank',
    :'training_health_and_safety_percentile_rank' => :'training_health_and_safety_percentile_rank',
    :'energy_climate_change_percentile_rank' => :'energy_climate_change_percentile_rank',
    :'environment_policy_and_reporting_percentile_rank' => :'environment_policy_and_reporting_percentile_rank',
    :'resource_management_percentile_rank' => :'resource_management_percentile_rank',
    :'board_percentile_rank' => :'board_percentile_rank',
    :'leadership_ethics_percentile_rank' => :'leadership_ethics_percentile_rank',
    :'transparency_reporting_percentile_rank' => :'transparency_reporting_percentile_rank'
  }
end

.swagger_typesObject

Attribute type mapping.



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 182

def self.swagger_types
  {
    :'date' => :'Date',
    :'country_average_rating' => :'Float',
    :'industry_average_rating' => :'Float',
    :'overall_rating' => :'Float',
    :'community_rating' => :'Float',
    :'employee_rating' => :'Float',
    :'environment_rating' => :'Float',
    :'governance_rating' => :'Float',
    :'human_rights_and_supply_chain_rating' => :'Float',
    :'community_dev_and_philanthropy_rating' => :'Float',
    :'product_rating' => :'Float',
    :'compensation_and_benefits_rating' => :'Float',
    :'diversity_and_labor_rights_rating' => :'Float',
    :'training_health_and_safety_rating' => :'Float',
    :'energy_climate_change_rating' => :'Float',
    :'environment_policy_and_reporting_rating' => :'Float',
    :'resource_management_rating' => :'Float',
    :'board_rating' => :'Float',
    :'leadership_ethics_rating' => :'Float',
    :'transparency_reporting_rating' => :'Float',
    :'country_percentile_rank' => :'Float',
    :'industry_percentile_rank' => :'Float',
    :'overall_percentile_rank' => :'Float',
    :'community_percentile_rank' => :'Float',
    :'employee_percentile_rank' => :'Float',
    :'environment_percentile_rank' => :'Float',
    :'governance_percentile_rank' => :'Float',
    :'human_rights_and_supply_chain_percentile_rank' => :'Float',
    :'community_dev_and_philanthropy_percentile_rank' => :'Float',
    :'product_percentile_rank' => :'Float',
    :'compensation_and_benefits_percentile_rank' => :'Float',
    :'diversity_and_labor_rights_percentile_rank' => :'Float',
    :'training_health_and_safety_percentile_rank' => :'Float',
    :'energy_climate_change_percentile_rank' => :'Float',
    :'environment_policy_and_reporting_percentile_rank' => :'Float',
    :'resource_management_percentile_rank' => :'Float',
    :'board_percentile_rank' => :'Float',
    :'leadership_ethics_percentile_rank' => :'Float',
    :'transparency_reporting_percentile_rank' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 407

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      country_average_rating == o.country_average_rating &&
      industry_average_rating == o.industry_average_rating &&
      overall_rating == o.overall_rating &&
      community_rating == o.community_rating &&
      employee_rating == o.employee_rating &&
      environment_rating == o.environment_rating &&
      governance_rating == o.governance_rating &&
      human_rights_and_supply_chain_rating == o.human_rights_and_supply_chain_rating &&
      community_dev_and_philanthropy_rating == o.community_dev_and_philanthropy_rating &&
      product_rating == o.product_rating &&
      compensation_and_benefits_rating == o.compensation_and_benefits_rating &&
      diversity_and_labor_rights_rating == o.diversity_and_labor_rights_rating &&
      training_health_and_safety_rating == o.training_health_and_safety_rating &&
      energy_climate_change_rating == o.energy_climate_change_rating &&
      environment_policy_and_reporting_rating == o.environment_policy_and_reporting_rating &&
      resource_management_rating == o.resource_management_rating &&
      board_rating == o.board_rating &&
      leadership_ethics_rating == o.leadership_ethics_rating &&
      transparency_reporting_rating == o.transparency_reporting_rating &&
      country_percentile_rank == o.country_percentile_rank &&
      industry_percentile_rank == o.industry_percentile_rank &&
      overall_percentile_rank == o.overall_percentile_rank &&
      community_percentile_rank == o.community_percentile_rank &&
      employee_percentile_rank == o.employee_percentile_rank &&
      environment_percentile_rank == o.environment_percentile_rank &&
      governance_percentile_rank == o.governance_percentile_rank &&
      human_rights_and_supply_chain_percentile_rank == o.human_rights_and_supply_chain_percentile_rank &&
      community_dev_and_philanthropy_percentile_rank == o.community_dev_and_philanthropy_percentile_rank &&
      product_percentile_rank == o.product_percentile_rank &&
      compensation_and_benefits_percentile_rank == o.compensation_and_benefits_percentile_rank &&
      diversity_and_labor_rights_percentile_rank == o.diversity_and_labor_rights_percentile_rank &&
      training_health_and_safety_percentile_rank == o.training_health_and_safety_percentile_rank &&
      energy_climate_change_percentile_rank == o.energy_climate_change_percentile_rank &&
      environment_policy_and_reporting_percentile_rank == o.environment_policy_and_reporting_percentile_rank &&
      resource_management_percentile_rank == o.resource_management_percentile_rank &&
      board_percentile_rank == o.board_percentile_rank &&
      leadership_ethics_percentile_rank == o.leadership_ethics_percentile_rank &&
      transparency_reporting_percentile_rank == o.transparency_reporting_percentile_rank
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 487

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Intrinio.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



553
554
555
556
557
558
559
560
561
562
563
564
565
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 553

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 466

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


453
454
455
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 453

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



459
460
461
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 459

def hash
  [date, country_average_rating, industry_average_rating, overall_rating, community_rating, employee_rating, environment_rating, governance_rating, human_rights_and_supply_chain_rating, community_dev_and_philanthropy_rating, product_rating, compensation_and_benefits_rating, diversity_and_labor_rights_rating, training_health_and_safety_rating, energy_climate_change_rating, environment_policy_and_reporting_rating, resource_management_rating, board_rating, leadership_ethics_rating, transparency_reporting_rating, country_percentile_rank, industry_percentile_rank, overall_percentile_rank, community_percentile_rank, employee_percentile_rank, environment_percentile_rank, governance_percentile_rank, human_rights_and_supply_chain_percentile_rank, community_dev_and_philanthropy_percentile_rank, product_percentile_rank, compensation_and_benefits_percentile_rank, diversity_and_labor_rights_percentile_rank, training_health_and_safety_percentile_rank, energy_climate_change_percentile_rank, environment_policy_and_reporting_percentile_rank, resource_management_percentile_rank, board_percentile_rank, leadership_ethics_percentile_rank, transparency_reporting_percentile_rank].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



394
395
396
397
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 394

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



533
534
535
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 533

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



539
540
541
542
543
544
545
546
547
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 539

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



527
528
529
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 527

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



401
402
403
# File 'lib/intrinio-sdk/models/esg_comprehensive_rating.rb', line 401

def valid?
  return true
end