pharmaobservatory 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (175) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +101 -4
  3. data/docs/BiomarkerBqpAssertionsRow.md +1 -1
  4. data/docs/BiomarkerEvidenceRow.md +1 -1
  5. data/docs/BiomarkerLiteratureRow.md +1 -1
  6. data/docs/BiomarkerRelationsResponse.md +58 -0
  7. data/docs/BiomarkerRelationsRow.md +54 -0
  8. data/docs/BiomarkerSampleCoverageResponse.md +58 -0
  9. data/docs/BiomarkerSampleCoverageRow.md +36 -0
  10. data/docs/BiomarkerSamplePrevalenceResponse.md +58 -0
  11. data/docs/BiomarkerSamplePrevalenceRow.md +56 -0
  12. data/docs/BiomarkerValidationResponse.md +58 -0
  13. data/docs/BiomarkerValidationRow.md +70 -0
  14. data/docs/BiomarkersApi.md +320 -0
  15. data/docs/BiomarkersRow.md +2 -2
  16. data/docs/CellLinesRow.md +1 -1
  17. data/docs/CompaniesApi.md +410 -0
  18. data/docs/CompaniesRecord.md +1 -1
  19. data/docs/CompaniesRecordAttributes.md +18 -0
  20. data/docs/CompaniesRow.md +7 -3
  21. data/docs/CompanyAssetsResponse.md +58 -0
  22. data/docs/CompanyAssetsRow.md +42 -0
  23. data/docs/CompanyFundingEventsResponse.md +58 -0
  24. data/docs/CompanyFundingEventsRow.md +62 -0
  25. data/docs/CompanyFundingSummaryResponse.md +58 -0
  26. data/docs/CompanyFundingSummaryRow.md +46 -0
  27. data/docs/CompanyProgramsRow.md +2 -2
  28. data/docs/ConditionAdverseEventsResponse.md +58 -0
  29. data/docs/ConditionAdverseEventsRow.md +24 -0
  30. data/docs/ConditionBurdenResponse.md +58 -0
  31. data/docs/ConditionBurdenRow.md +32 -0
  32. data/docs/ConditionDeliveryResponse.md +58 -0
  33. data/docs/ConditionDeliveryRow.md +44 -0
  34. data/docs/ConditionDrugsResponse.md +58 -0
  35. data/docs/ConditionDrugsRow.md +26 -0
  36. data/docs/ConditionPrevalenceResponse.md +58 -0
  37. data/docs/ConditionPrevalenceRow.md +62 -0
  38. data/docs/ConditionPublicationsResponse.md +58 -0
  39. data/docs/ConditionPublicationsRow.md +32 -0
  40. data/docs/ConditionSitesResponse.md +58 -0
  41. data/docs/ConditionSitesRow.md +28 -0
  42. data/docs/ConditionTrialsResponse.md +58 -0
  43. data/docs/ConditionTrialsRow.md +58 -0
  44. data/docs/ConditionsApi.md +953 -0
  45. data/docs/ConditionsRecord.md +38 -0
  46. data/docs/ConditionsRecordAttributes.md +20 -0
  47. data/docs/ConditionsResponse.md +58 -0
  48. data/docs/ConditionsRow.md +32 -0
  49. data/docs/DrugPatentCliffRow.md +1 -1
  50. data/docs/InstitutionalHoldingsRow.md +3 -1
  51. data/docs/LegalEntitiesApi.md +160 -0
  52. data/docs/LegalEntitiesRow.md +1 -1
  53. data/docs/OwnershipPositionsResponse.md +58 -0
  54. data/docs/OwnershipPositionsRow.md +100 -0
  55. data/docs/PdufaDatesRow.md +2 -2
  56. data/docs/SiteCroTrialsRow.md +1 -1
  57. data/docs/SiteTrialConditionsRow.md +1 -1
  58. data/docs/SiteTrialDrugsRow.md +1 -1
  59. data/docs/SiteTrialsRow.md +1 -1
  60. data/docs/SponsorRecruitmentByPhaseRow.md +2 -2
  61. data/docs/SponsorRecruitmentDurationRow.md +1 -1
  62. data/docs/SponsorTrialsRow.md +2 -2
  63. data/docs/TrialAdverseEventsResponse.md +58 -0
  64. data/docs/TrialAdverseEventsRow.md +28 -0
  65. data/docs/TrialChangesResponse.md +58 -0
  66. data/docs/TrialChangesRow.md +36 -0
  67. data/docs/TrialDeliveryResponse.md +58 -0
  68. data/docs/TrialDeliveryRow.md +64 -0
  69. data/docs/TrialDemographicsResponse.md +58 -0
  70. data/docs/TrialDemographicsRow.md +32 -0
  71. data/docs/TrialDrugsResponse.md +58 -0
  72. data/docs/TrialDrugsRow.md +30 -0
  73. data/docs/TrialEnrollmentHistoryResponse.md +58 -0
  74. data/docs/TrialEnrollmentHistoryRow.md +36 -0
  75. data/docs/TrialEnrollmentRateResponse.md +58 -0
  76. data/docs/TrialEnrollmentRateRow.md +58 -0
  77. data/docs/TrialExtractedEndpointsResponse.md +58 -0
  78. data/docs/TrialExtractedEndpointsRow.md +40 -0
  79. data/docs/TrialOutcomeMeasuresResponse.md +58 -0
  80. data/docs/TrialOutcomeMeasuresRow.md +28 -0
  81. data/docs/TrialSitesResponse.md +58 -0
  82. data/docs/TrialSitesRow.md +46 -0
  83. data/docs/TrialsApi.md +1033 -0
  84. data/docs/TrialsRecord.md +38 -0
  85. data/docs/TrialsRecordAttributes.md +24 -0
  86. data/docs/TrialsResponse.md +58 -0
  87. data/docs/TrialsRow.md +116 -0
  88. data/lib/pharmaobservatory/api/biomarkers_api.rb +336 -0
  89. data/lib/pharmaobservatory/api/companies_api.rb +455 -0
  90. data/lib/pharmaobservatory/api/conditions_api.rb +1001 -0
  91. data/lib/pharmaobservatory/api/legal_entities_api.rb +168 -0
  92. data/lib/pharmaobservatory/api/trials_api.rb +1085 -0
  93. data/lib/pharmaobservatory/models/biomarker_bqp_assertions_row.rb +1 -1
  94. data/lib/pharmaobservatory/models/biomarker_evidence_row.rb +1 -1
  95. data/lib/pharmaobservatory/models/biomarker_literature_row.rb +1 -1
  96. data/lib/pharmaobservatory/models/biomarker_relations_response.rb +478 -0
  97. data/lib/pharmaobservatory/models/biomarker_relations_row.rb +421 -0
  98. data/lib/pharmaobservatory/models/biomarker_sample_coverage_response.rb +478 -0
  99. data/lib/pharmaobservatory/models/biomarker_sample_coverage_row.rb +322 -0
  100. data/lib/pharmaobservatory/models/biomarker_sample_prevalence_response.rb +478 -0
  101. data/lib/pharmaobservatory/models/biomarker_sample_prevalence_row.rb +436 -0
  102. data/lib/pharmaobservatory/models/biomarker_validation_response.rb +478 -0
  103. data/lib/pharmaobservatory/models/biomarker_validation_row.rb +509 -0
  104. data/lib/pharmaobservatory/models/biomarkers_row.rb +2 -2
  105. data/lib/pharmaobservatory/models/cell_lines_row.rb +1 -1
  106. data/lib/pharmaobservatory/models/companies_record.rb +1 -1
  107. data/lib/pharmaobservatory/models/companies_record_attributes.rb +220 -0
  108. data/lib/pharmaobservatory/models/companies_row.rb +29 -7
  109. data/lib/pharmaobservatory/models/company_assets_response.rb +478 -0
  110. data/lib/pharmaobservatory/models/company_assets_row.rb +355 -0
  111. data/lib/pharmaobservatory/models/company_funding_events_response.rb +478 -0
  112. data/lib/pharmaobservatory/models/company_funding_events_row.rb +465 -0
  113. data/lib/pharmaobservatory/models/company_funding_summary_response.rb +478 -0
  114. data/lib/pharmaobservatory/models/company_funding_summary_row.rb +377 -0
  115. data/lib/pharmaobservatory/models/company_programs_row.rb +2 -2
  116. data/lib/pharmaobservatory/models/condition_adverse_events_response.rb +478 -0
  117. data/lib/pharmaobservatory/models/condition_adverse_events_row.rb +256 -0
  118. data/lib/pharmaobservatory/models/condition_burden_response.rb +478 -0
  119. data/lib/pharmaobservatory/models/condition_burden_row.rb +300 -0
  120. data/lib/pharmaobservatory/models/condition_delivery_response.rb +478 -0
  121. data/lib/pharmaobservatory/models/condition_delivery_row.rb +366 -0
  122. data/lib/pharmaobservatory/models/condition_drugs_response.rb +478 -0
  123. data/lib/pharmaobservatory/models/condition_drugs_row.rb +267 -0
  124. data/lib/pharmaobservatory/models/condition_prevalence_response.rb +478 -0
  125. data/lib/pharmaobservatory/models/condition_prevalence_row.rb +465 -0
  126. data/lib/pharmaobservatory/models/condition_publications_response.rb +478 -0
  127. data/lib/pharmaobservatory/models/condition_publications_row.rb +300 -0
  128. data/lib/pharmaobservatory/models/condition_sites_response.rb +478 -0
  129. data/lib/pharmaobservatory/models/condition_sites_row.rb +278 -0
  130. data/lib/pharmaobservatory/models/condition_trials_response.rb +478 -0
  131. data/lib/pharmaobservatory/models/condition_trials_row.rb +443 -0
  132. data/lib/pharmaobservatory/models/conditions_record.rb +385 -0
  133. data/lib/pharmaobservatory/models/conditions_record_attributes.rb +229 -0
  134. data/lib/pharmaobservatory/models/conditions_response.rb +478 -0
  135. data/lib/pharmaobservatory/models/conditions_row.rb +304 -0
  136. data/lib/pharmaobservatory/models/drug_patent_cliff_row.rb +1 -1
  137. data/lib/pharmaobservatory/models/institutional_holdings_row.rb +13 -2
  138. data/lib/pharmaobservatory/models/legal_entities_row.rb +1 -1
  139. data/lib/pharmaobservatory/models/ownership_positions_response.rb +478 -0
  140. data/lib/pharmaobservatory/models/ownership_positions_row.rb +674 -0
  141. data/lib/pharmaobservatory/models/pdufa_dates_row.rb +2 -2
  142. data/lib/pharmaobservatory/models/site_cro_trials_row.rb +1 -1
  143. data/lib/pharmaobservatory/models/site_trial_conditions_row.rb +1 -1
  144. data/lib/pharmaobservatory/models/site_trial_drugs_row.rb +1 -1
  145. data/lib/pharmaobservatory/models/site_trials_row.rb +1 -1
  146. data/lib/pharmaobservatory/models/sponsor_recruitment_by_phase_row.rb +2 -2
  147. data/lib/pharmaobservatory/models/sponsor_recruitment_duration_row.rb +1 -1
  148. data/lib/pharmaobservatory/models/sponsor_trials_row.rb +2 -2
  149. data/lib/pharmaobservatory/models/trial_adverse_events_response.rb +478 -0
  150. data/lib/pharmaobservatory/models/trial_adverse_events_row.rb +278 -0
  151. data/lib/pharmaobservatory/models/trial_changes_response.rb +478 -0
  152. data/lib/pharmaobservatory/models/trial_changes_row.rb +328 -0
  153. data/lib/pharmaobservatory/models/trial_delivery_response.rb +478 -0
  154. data/lib/pharmaobservatory/models/trial_delivery_row.rb +476 -0
  155. data/lib/pharmaobservatory/models/trial_demographics_response.rb +478 -0
  156. data/lib/pharmaobservatory/models/trial_demographics_row.rb +300 -0
  157. data/lib/pharmaobservatory/models/trial_drugs_response.rb +478 -0
  158. data/lib/pharmaobservatory/models/trial_drugs_row.rb +291 -0
  159. data/lib/pharmaobservatory/models/trial_enrollment_history_response.rb +478 -0
  160. data/lib/pharmaobservatory/models/trial_enrollment_history_row.rb +322 -0
  161. data/lib/pharmaobservatory/models/trial_enrollment_rate_response.rb +478 -0
  162. data/lib/pharmaobservatory/models/trial_enrollment_rate_row.rb +443 -0
  163. data/lib/pharmaobservatory/models/trial_extracted_endpoints_response.rb +478 -0
  164. data/lib/pharmaobservatory/models/trial_extracted_endpoints_row.rb +346 -0
  165. data/lib/pharmaobservatory/models/trial_outcome_measures_response.rb +478 -0
  166. data/lib/pharmaobservatory/models/trial_outcome_measures_row.rb +278 -0
  167. data/lib/pharmaobservatory/models/trial_sites_response.rb +478 -0
  168. data/lib/pharmaobservatory/models/trial_sites_row.rb +377 -0
  169. data/lib/pharmaobservatory/models/trials_record.rb +385 -0
  170. data/lib/pharmaobservatory/models/trials_record_attributes.rb +247 -0
  171. data/lib/pharmaobservatory/models/trials_response.rb +478 -0
  172. data/lib/pharmaobservatory/models/trials_row.rb +784 -0
  173. data/lib/pharmaobservatory/version.rb +1 -1
  174. data/lib/pharmaobservatory.rb +63 -0
  175. metadata +127 -1
@@ -0,0 +1,674 @@
1
+ =begin
2
+ #Pharma Observatory Public REST API
3
+
4
+ #Read-only REST API over the Pharma Observatory biomedical data platform. Reference: https://pharmaobservatory.com/api-reference
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.13.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module PharmaObservatory
17
+ # One row of the ownership_positions dataset: one row per owner, owned company, filing family and measured dimension (the owner's consolidated current position). A grouped request returns the group columns and the measures instead, as additional properties.
18
+ class OwnershipPositionsRow
19
+ # The position id. For a position whose owner name is withheld it is an opaque handle that derives nothing from the owner and is stable only while the other positions of the same owned company, filing family and dimension are unchanged.
20
+ attr_accessor :position_id
21
+
22
+ # The filing family: sec_forms_3_4_5 (insiders), sec_schedules_13d_g (beneficial owners), sec_form_adv (investment adviser control persons) or sec_def_14a (proxy-statement tables).
23
+ attr_accessor :source_class
24
+
25
+ # What the position measures: insider_reporting, beneficial_ownership, voting_power, economic_interest or control. Positions of different dimensions are different measurements and are not added.
26
+ attr_accessor :ownership_dimension
27
+
28
+ # The owner's relationship to the company as the filing family states it.
29
+ attr_accessor :relationship_type
30
+
31
+ # The owned company as filed.
32
+ attr_accessor :subject_name
33
+
34
+ # Legal-entity level: the owned company's organization record.
35
+ attr_accessor :subject_org_id
36
+
37
+ # Company level: the owned company (null when unresolved).
38
+ attr_accessor :subject_company_id
39
+
40
+ # Display name of the owned company.
41
+ attr_accessor :subject_company_name
42
+
43
+ # Group level: the owned company's current ultimate parent; a root's group is itself.
44
+ attr_accessor :subject_group_id
45
+
46
+ # Display name of the owned company's group.
47
+ attr_accessor :subject_group_name
48
+
49
+ # The owner's name as filed. Null for an owner whose filing does not mark the name public (see owner_name_is_public).
50
+ attr_accessor :owner_name
51
+
52
+ # True when the filing marks the owner's name public. When false every column that could identify the owner is null (name, identity key, person id, investor id, organization and company columns, source_url and the dates); the position and its figures stay.
53
+ attr_accessor :owner_name_is_public
54
+
55
+ # What the owner is: organization, natural_person, reporting_group or unknown.
56
+ attr_accessor :owner_kind
57
+
58
+ # The owner's stable identity (an SEC registration number or an adviser registration number); null when the name is withheld.
59
+ attr_accessor :owner_identity_key
60
+
61
+ # The key of an owner who is a natural person; null for other owners and when the name is withheld.
62
+ attr_accessor :owner_person_id
63
+
64
+ # The key of the owner in the investor directory when it is one; null when the name is withheld.
65
+ attr_accessor :owner_investor_id
66
+
67
+ # Legal-entity level: the owner's organization record (null when the owner is not an organization, is unresolved or is withheld).
68
+ attr_accessor :owner_org_id
69
+
70
+ # Company level: the owner's company (null when unresolved or when the name is withheld).
71
+ attr_accessor :owner_company_id
72
+
73
+ # Display name of the owner's company.
74
+ attr_accessor :owner_company_name
75
+
76
+ # Group level: the owner's current ultimate parent; a root's group is itself (null when the owner is withheld).
77
+ attr_accessor :owner_group_id
78
+
79
+ # Display name of the owner's group.
80
+ attr_accessor :owner_group_name
81
+
82
+ # How the share figure was reached: sum_standing_balances (insider balances), group_reported_maximum (a joint filing's maximum, never a sum of its filers) or no_quantity (the source gives none). Read a share figure with its basis.
83
+ attr_accessor :shares_basis
84
+
85
+ # Shares the owner holds, on the shares_basis. Null when the source gives no quantity.
86
+ attr_accessor :shares
87
+
88
+ # Of those shares, the part held directly.
89
+ attr_accessor :shares_direct
90
+
91
+ # Of those shares, the part held indirectly.
92
+ attr_accessor :shares_indirect
93
+
94
+ # Shares underlying derivative positions such as options, reported apart and never added to shares.
95
+ attr_accessor :derivative_underlying_shares
96
+
97
+ # How the percentage was reached, for example single_reporting_person, uniform_group_percent or single_band.
98
+ attr_accessor :percent_basis
99
+
100
+ # The percentage the filing reports, on the percentage_basis.
101
+ attr_accessor :reported_percent
102
+
103
+ # The low end of a reported band, for a source that reports a band.
104
+ attr_accessor :reported_percent_low
105
+
106
+ # The high end of a reported band, for a source that reports a band.
107
+ attr_accessor :reported_percent_high
108
+
109
+ # What the percentage is of: beneficial_ownership, voting_power or economic_interest. Percentages of different bases are not comparable.
110
+ attr_accessor :percentage_basis
111
+
112
+ # standing, ceased or no_longer_reported, for the owner's position as a whole.
113
+ attr_accessor :edge_state
114
+
115
+ # Positions the row consolidates.
116
+ attr_accessor :position_count
117
+
118
+ # Of those, positions still standing.
119
+ attr_accessor :standing_position_count
120
+
121
+ # Of those, positions reported ceased.
122
+ attr_accessor :ceased_position_count
123
+
124
+ # Of those, positions the filer no longer reports.
125
+ attr_accessor :no_longer_reported_position_count
126
+
127
+ # Date the position was first reported; null when the owner's name is withheld.
128
+ attr_accessor :first_observed_date
129
+
130
+ # Date of the latest reported activity; null when the owner's name is withheld.
131
+ attr_accessor :last_activity_date
132
+
133
+ # Date of the latest filing; null when the owner's name is withheld.
134
+ attr_accessor :last_filing_date
135
+
136
+ # A link to the latest filing; null when the owner's name is withheld, because the filing names the owner.
137
+ attr_accessor :source_url
138
+
139
+ # True when the row names a natural person.
140
+ attr_accessor :contains_personal_data
141
+
142
+ # The filing's privacy status for the owner: not_applicable, pending_review, approved_public_fields, restricted or protected.
143
+ attr_accessor :privacy_status
144
+
145
+ # Attribute mapping from ruby-style variable name to JSON key.
146
+ def self.attribute_map
147
+ {
148
+ :'position_id' => :'position_id',
149
+ :'source_class' => :'source_class',
150
+ :'ownership_dimension' => :'ownership_dimension',
151
+ :'relationship_type' => :'relationship_type',
152
+ :'subject_name' => :'subject_name',
153
+ :'subject_org_id' => :'subject_org_id',
154
+ :'subject_company_id' => :'subject_company_id',
155
+ :'subject_company_name' => :'subject_company_name',
156
+ :'subject_group_id' => :'subject_group_id',
157
+ :'subject_group_name' => :'subject_group_name',
158
+ :'owner_name' => :'owner_name',
159
+ :'owner_name_is_public' => :'owner_name_is_public',
160
+ :'owner_kind' => :'owner_kind',
161
+ :'owner_identity_key' => :'owner_identity_key',
162
+ :'owner_person_id' => :'owner_person_id',
163
+ :'owner_investor_id' => :'owner_investor_id',
164
+ :'owner_org_id' => :'owner_org_id',
165
+ :'owner_company_id' => :'owner_company_id',
166
+ :'owner_company_name' => :'owner_company_name',
167
+ :'owner_group_id' => :'owner_group_id',
168
+ :'owner_group_name' => :'owner_group_name',
169
+ :'shares_basis' => :'shares_basis',
170
+ :'shares' => :'shares',
171
+ :'shares_direct' => :'shares_direct',
172
+ :'shares_indirect' => :'shares_indirect',
173
+ :'derivative_underlying_shares' => :'derivative_underlying_shares',
174
+ :'percent_basis' => :'percent_basis',
175
+ :'reported_percent' => :'reported_percent',
176
+ :'reported_percent_low' => :'reported_percent_low',
177
+ :'reported_percent_high' => :'reported_percent_high',
178
+ :'percentage_basis' => :'percentage_basis',
179
+ :'edge_state' => :'edge_state',
180
+ :'position_count' => :'position_count',
181
+ :'standing_position_count' => :'standing_position_count',
182
+ :'ceased_position_count' => :'ceased_position_count',
183
+ :'no_longer_reported_position_count' => :'no_longer_reported_position_count',
184
+ :'first_observed_date' => :'first_observed_date',
185
+ :'last_activity_date' => :'last_activity_date',
186
+ :'last_filing_date' => :'last_filing_date',
187
+ :'source_url' => :'source_url',
188
+ :'contains_personal_data' => :'contains_personal_data',
189
+ :'privacy_status' => :'privacy_status'
190
+ }
191
+ end
192
+
193
+ # Returns attribute mapping this model knows about
194
+ def self.acceptable_attribute_map
195
+ attribute_map
196
+ end
197
+
198
+ # Returns all the JSON keys this model knows about
199
+ def self.acceptable_attributes
200
+ acceptable_attribute_map.values
201
+ end
202
+
203
+ # Attribute type mapping.
204
+ def self.openapi_types
205
+ {
206
+ :'position_id' => :'String',
207
+ :'source_class' => :'String',
208
+ :'ownership_dimension' => :'String',
209
+ :'relationship_type' => :'String',
210
+ :'subject_name' => :'String',
211
+ :'subject_org_id' => :'String',
212
+ :'subject_company_id' => :'String',
213
+ :'subject_company_name' => :'String',
214
+ :'subject_group_id' => :'String',
215
+ :'subject_group_name' => :'String',
216
+ :'owner_name' => :'String',
217
+ :'owner_name_is_public' => :'Boolean',
218
+ :'owner_kind' => :'String',
219
+ :'owner_identity_key' => :'String',
220
+ :'owner_person_id' => :'String',
221
+ :'owner_investor_id' => :'String',
222
+ :'owner_org_id' => :'String',
223
+ :'owner_company_id' => :'String',
224
+ :'owner_company_name' => :'String',
225
+ :'owner_group_id' => :'String',
226
+ :'owner_group_name' => :'String',
227
+ :'shares_basis' => :'String',
228
+ :'shares' => :'Float',
229
+ :'shares_direct' => :'Float',
230
+ :'shares_indirect' => :'Float',
231
+ :'derivative_underlying_shares' => :'Float',
232
+ :'percent_basis' => :'String',
233
+ :'reported_percent' => :'Float',
234
+ :'reported_percent_low' => :'Float',
235
+ :'reported_percent_high' => :'Float',
236
+ :'percentage_basis' => :'String',
237
+ :'edge_state' => :'String',
238
+ :'position_count' => :'Integer',
239
+ :'standing_position_count' => :'Integer',
240
+ :'ceased_position_count' => :'Integer',
241
+ :'no_longer_reported_position_count' => :'Integer',
242
+ :'first_observed_date' => :'Date',
243
+ :'last_activity_date' => :'Date',
244
+ :'last_filing_date' => :'Date',
245
+ :'source_url' => :'String',
246
+ :'contains_personal_data' => :'Boolean',
247
+ :'privacy_status' => :'String'
248
+ }
249
+ end
250
+
251
+ # List of attributes with nullable: true
252
+ def self.openapi_nullable
253
+ Set.new([
254
+ :'position_id',
255
+ :'source_class',
256
+ :'ownership_dimension',
257
+ :'relationship_type',
258
+ :'subject_name',
259
+ :'subject_org_id',
260
+ :'subject_company_id',
261
+ :'subject_company_name',
262
+ :'subject_group_id',
263
+ :'subject_group_name',
264
+ :'owner_name',
265
+ :'owner_name_is_public',
266
+ :'owner_kind',
267
+ :'owner_identity_key',
268
+ :'owner_person_id',
269
+ :'owner_investor_id',
270
+ :'owner_org_id',
271
+ :'owner_company_id',
272
+ :'owner_company_name',
273
+ :'owner_group_id',
274
+ :'owner_group_name',
275
+ :'shares_basis',
276
+ :'shares',
277
+ :'shares_direct',
278
+ :'shares_indirect',
279
+ :'derivative_underlying_shares',
280
+ :'percent_basis',
281
+ :'reported_percent',
282
+ :'reported_percent_low',
283
+ :'reported_percent_high',
284
+ :'percentage_basis',
285
+ :'edge_state',
286
+ :'position_count',
287
+ :'standing_position_count',
288
+ :'ceased_position_count',
289
+ :'no_longer_reported_position_count',
290
+ :'first_observed_date',
291
+ :'last_activity_date',
292
+ :'last_filing_date',
293
+ :'source_url',
294
+ :'contains_personal_data',
295
+ :'privacy_status'
296
+ ])
297
+ end
298
+
299
+ # Initializes the object
300
+ # @param [Hash] attributes Model attributes in the form of hash
301
+ def initialize(attributes = {})
302
+ if (!attributes.is_a?(Hash))
303
+ fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::OwnershipPositionsRow` initialize method"
304
+ end
305
+
306
+ # check to see if the attribute exists and convert string to symbol for hash key
307
+ acceptable_attribute_map = self.class.acceptable_attribute_map
308
+ attributes = attributes.each_with_object({}) { |(k, v), h|
309
+ if (!acceptable_attribute_map.key?(k.to_sym))
310
+ fail ArgumentError, "`#{k}` is not a valid attribute in `PharmaObservatory::OwnershipPositionsRow`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
311
+ end
312
+ h[k.to_sym] = v
313
+ }
314
+
315
+ if attributes.key?(:'position_id')
316
+ self.position_id = attributes[:'position_id']
317
+ end
318
+
319
+ if attributes.key?(:'source_class')
320
+ self.source_class = attributes[:'source_class']
321
+ end
322
+
323
+ if attributes.key?(:'ownership_dimension')
324
+ self.ownership_dimension = attributes[:'ownership_dimension']
325
+ end
326
+
327
+ if attributes.key?(:'relationship_type')
328
+ self.relationship_type = attributes[:'relationship_type']
329
+ end
330
+
331
+ if attributes.key?(:'subject_name')
332
+ self.subject_name = attributes[:'subject_name']
333
+ end
334
+
335
+ if attributes.key?(:'subject_org_id')
336
+ self.subject_org_id = attributes[:'subject_org_id']
337
+ end
338
+
339
+ if attributes.key?(:'subject_company_id')
340
+ self.subject_company_id = attributes[:'subject_company_id']
341
+ end
342
+
343
+ if attributes.key?(:'subject_company_name')
344
+ self.subject_company_name = attributes[:'subject_company_name']
345
+ end
346
+
347
+ if attributes.key?(:'subject_group_id')
348
+ self.subject_group_id = attributes[:'subject_group_id']
349
+ end
350
+
351
+ if attributes.key?(:'subject_group_name')
352
+ self.subject_group_name = attributes[:'subject_group_name']
353
+ end
354
+
355
+ if attributes.key?(:'owner_name')
356
+ self.owner_name = attributes[:'owner_name']
357
+ end
358
+
359
+ if attributes.key?(:'owner_name_is_public')
360
+ self.owner_name_is_public = attributes[:'owner_name_is_public']
361
+ end
362
+
363
+ if attributes.key?(:'owner_kind')
364
+ self.owner_kind = attributes[:'owner_kind']
365
+ end
366
+
367
+ if attributes.key?(:'owner_identity_key')
368
+ self.owner_identity_key = attributes[:'owner_identity_key']
369
+ end
370
+
371
+ if attributes.key?(:'owner_person_id')
372
+ self.owner_person_id = attributes[:'owner_person_id']
373
+ end
374
+
375
+ if attributes.key?(:'owner_investor_id')
376
+ self.owner_investor_id = attributes[:'owner_investor_id']
377
+ end
378
+
379
+ if attributes.key?(:'owner_org_id')
380
+ self.owner_org_id = attributes[:'owner_org_id']
381
+ end
382
+
383
+ if attributes.key?(:'owner_company_id')
384
+ self.owner_company_id = attributes[:'owner_company_id']
385
+ end
386
+
387
+ if attributes.key?(:'owner_company_name')
388
+ self.owner_company_name = attributes[:'owner_company_name']
389
+ end
390
+
391
+ if attributes.key?(:'owner_group_id')
392
+ self.owner_group_id = attributes[:'owner_group_id']
393
+ end
394
+
395
+ if attributes.key?(:'owner_group_name')
396
+ self.owner_group_name = attributes[:'owner_group_name']
397
+ end
398
+
399
+ if attributes.key?(:'shares_basis')
400
+ self.shares_basis = attributes[:'shares_basis']
401
+ end
402
+
403
+ if attributes.key?(:'shares')
404
+ self.shares = attributes[:'shares']
405
+ end
406
+
407
+ if attributes.key?(:'shares_direct')
408
+ self.shares_direct = attributes[:'shares_direct']
409
+ end
410
+
411
+ if attributes.key?(:'shares_indirect')
412
+ self.shares_indirect = attributes[:'shares_indirect']
413
+ end
414
+
415
+ if attributes.key?(:'derivative_underlying_shares')
416
+ self.derivative_underlying_shares = attributes[:'derivative_underlying_shares']
417
+ end
418
+
419
+ if attributes.key?(:'percent_basis')
420
+ self.percent_basis = attributes[:'percent_basis']
421
+ end
422
+
423
+ if attributes.key?(:'reported_percent')
424
+ self.reported_percent = attributes[:'reported_percent']
425
+ end
426
+
427
+ if attributes.key?(:'reported_percent_low')
428
+ self.reported_percent_low = attributes[:'reported_percent_low']
429
+ end
430
+
431
+ if attributes.key?(:'reported_percent_high')
432
+ self.reported_percent_high = attributes[:'reported_percent_high']
433
+ end
434
+
435
+ if attributes.key?(:'percentage_basis')
436
+ self.percentage_basis = attributes[:'percentage_basis']
437
+ end
438
+
439
+ if attributes.key?(:'edge_state')
440
+ self.edge_state = attributes[:'edge_state']
441
+ end
442
+
443
+ if attributes.key?(:'position_count')
444
+ self.position_count = attributes[:'position_count']
445
+ end
446
+
447
+ if attributes.key?(:'standing_position_count')
448
+ self.standing_position_count = attributes[:'standing_position_count']
449
+ end
450
+
451
+ if attributes.key?(:'ceased_position_count')
452
+ self.ceased_position_count = attributes[:'ceased_position_count']
453
+ end
454
+
455
+ if attributes.key?(:'no_longer_reported_position_count')
456
+ self.no_longer_reported_position_count = attributes[:'no_longer_reported_position_count']
457
+ end
458
+
459
+ if attributes.key?(:'first_observed_date')
460
+ self.first_observed_date = attributes[:'first_observed_date']
461
+ end
462
+
463
+ if attributes.key?(:'last_activity_date')
464
+ self.last_activity_date = attributes[:'last_activity_date']
465
+ end
466
+
467
+ if attributes.key?(:'last_filing_date')
468
+ self.last_filing_date = attributes[:'last_filing_date']
469
+ end
470
+
471
+ if attributes.key?(:'source_url')
472
+ self.source_url = attributes[:'source_url']
473
+ end
474
+
475
+ if attributes.key?(:'contains_personal_data')
476
+ self.contains_personal_data = attributes[:'contains_personal_data']
477
+ end
478
+
479
+ if attributes.key?(:'privacy_status')
480
+ self.privacy_status = attributes[:'privacy_status']
481
+ end
482
+ end
483
+
484
+ # Show invalid properties with the reasons. Usually used together with valid?
485
+ # @return Array for valid properties with the reasons
486
+ def list_invalid_properties
487
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
488
+ invalid_properties = Array.new
489
+ invalid_properties
490
+ end
491
+
492
+ # Check to see if the all the properties in the model are valid
493
+ # @return true if the model is valid
494
+ def valid?
495
+ warn '[DEPRECATED] the `valid?` method is obsolete'
496
+ true
497
+ end
498
+
499
+ # Checks equality by comparing each attribute.
500
+ # @param [Object] Object to be compared
501
+ def ==(o)
502
+ return true if self.equal?(o)
503
+ self.class == o.class &&
504
+ position_id == o.position_id &&
505
+ source_class == o.source_class &&
506
+ ownership_dimension == o.ownership_dimension &&
507
+ relationship_type == o.relationship_type &&
508
+ subject_name == o.subject_name &&
509
+ subject_org_id == o.subject_org_id &&
510
+ subject_company_id == o.subject_company_id &&
511
+ subject_company_name == o.subject_company_name &&
512
+ subject_group_id == o.subject_group_id &&
513
+ subject_group_name == o.subject_group_name &&
514
+ owner_name == o.owner_name &&
515
+ owner_name_is_public == o.owner_name_is_public &&
516
+ owner_kind == o.owner_kind &&
517
+ owner_identity_key == o.owner_identity_key &&
518
+ owner_person_id == o.owner_person_id &&
519
+ owner_investor_id == o.owner_investor_id &&
520
+ owner_org_id == o.owner_org_id &&
521
+ owner_company_id == o.owner_company_id &&
522
+ owner_company_name == o.owner_company_name &&
523
+ owner_group_id == o.owner_group_id &&
524
+ owner_group_name == o.owner_group_name &&
525
+ shares_basis == o.shares_basis &&
526
+ shares == o.shares &&
527
+ shares_direct == o.shares_direct &&
528
+ shares_indirect == o.shares_indirect &&
529
+ derivative_underlying_shares == o.derivative_underlying_shares &&
530
+ percent_basis == o.percent_basis &&
531
+ reported_percent == o.reported_percent &&
532
+ reported_percent_low == o.reported_percent_low &&
533
+ reported_percent_high == o.reported_percent_high &&
534
+ percentage_basis == o.percentage_basis &&
535
+ edge_state == o.edge_state &&
536
+ position_count == o.position_count &&
537
+ standing_position_count == o.standing_position_count &&
538
+ ceased_position_count == o.ceased_position_count &&
539
+ no_longer_reported_position_count == o.no_longer_reported_position_count &&
540
+ first_observed_date == o.first_observed_date &&
541
+ last_activity_date == o.last_activity_date &&
542
+ last_filing_date == o.last_filing_date &&
543
+ source_url == o.source_url &&
544
+ contains_personal_data == o.contains_personal_data &&
545
+ privacy_status == o.privacy_status
546
+ end
547
+
548
+ # @see the `==` method
549
+ # @param [Object] Object to be compared
550
+ def eql?(o)
551
+ self == o
552
+ end
553
+
554
+ # Calculates hash code according to all attributes.
555
+ # @return [Integer] Hash code
556
+ def hash
557
+ [position_id, source_class, ownership_dimension, relationship_type, subject_name, subject_org_id, subject_company_id, subject_company_name, subject_group_id, subject_group_name, owner_name, owner_name_is_public, owner_kind, owner_identity_key, owner_person_id, owner_investor_id, owner_org_id, owner_company_id, owner_company_name, owner_group_id, owner_group_name, shares_basis, shares, shares_direct, shares_indirect, derivative_underlying_shares, percent_basis, reported_percent, reported_percent_low, reported_percent_high, percentage_basis, edge_state, position_count, standing_position_count, ceased_position_count, no_longer_reported_position_count, first_observed_date, last_activity_date, last_filing_date, source_url, contains_personal_data, privacy_status].hash
558
+ end
559
+
560
+ # Builds the object from hash
561
+ # @param [Hash] attributes Model attributes in the form of hash
562
+ # @return [Object] Returns the model itself
563
+ def self.build_from_hash(attributes)
564
+ return nil unless attributes.is_a?(Hash)
565
+ attributes = attributes.transform_keys(&:to_sym)
566
+ transformed_hash = {}
567
+ openapi_types.each_pair do |key, type|
568
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
569
+ transformed_hash["#{key}"] = nil
570
+ elsif type =~ /\AArray<(.*)>/i
571
+ # check to ensure the input is an array given that the attribute
572
+ # is documented as an array but the input is not
573
+ if attributes[attribute_map[key]].is_a?(Array)
574
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
575
+ end
576
+ elsif !attributes[attribute_map[key]].nil?
577
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
578
+ end
579
+ end
580
+ new(transformed_hash)
581
+ end
582
+
583
+ # Deserializes the data based on type
584
+ # @param string type Data type
585
+ # @param string value Value to be deserialized
586
+ # @return [Object] Deserialized data
587
+ def self._deserialize(type, value)
588
+ case type.to_sym
589
+ when :Time
590
+ Time.parse(value)
591
+ when :Date
592
+ Date.parse(value)
593
+ when :String
594
+ value.to_s
595
+ when :Integer
596
+ value.to_i
597
+ when :Float
598
+ value.to_f
599
+ when :Boolean
600
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
601
+ true
602
+ else
603
+ false
604
+ end
605
+ when :Object
606
+ # generic object (usually a Hash), return directly
607
+ value
608
+ when /\AArray<(?<inner_type>.+)>\z/
609
+ inner_type = Regexp.last_match[:inner_type]
610
+ value.map { |v| _deserialize(inner_type, v) }
611
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
612
+ k_type = Regexp.last_match[:k_type]
613
+ v_type = Regexp.last_match[:v_type]
614
+ {}.tap do |hash|
615
+ value.each do |k, v|
616
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
617
+ end
618
+ end
619
+ else # model
620
+ # models (e.g. Pet) or oneOf
621
+ klass = PharmaObservatory.const_get(type)
622
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
623
+ end
624
+ end
625
+
626
+ # Returns the string representation of the object
627
+ # @return [String] String presentation of the object
628
+ def to_s
629
+ to_hash.to_s
630
+ end
631
+
632
+ # to_body is an alias to to_hash (backward compatibility)
633
+ # @return [Hash] Returns the object in the form of hash
634
+ def to_body
635
+ to_hash
636
+ end
637
+
638
+ # Returns the object in the form of hash
639
+ # @return [Hash] Returns the object in the form of hash
640
+ def to_hash
641
+ hash = {}
642
+ self.class.attribute_map.each_pair do |attr, param|
643
+ value = self.send(attr)
644
+ if value.nil?
645
+ is_nullable = self.class.openapi_nullable.include?(attr)
646
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
647
+ end
648
+
649
+ hash[param] = _to_hash(value)
650
+ end
651
+ hash
652
+ end
653
+
654
+ # Outputs non-array value in the form of hash
655
+ # For object, use to_hash. Otherwise, just return the value
656
+ # @param [Object] value Any valid value
657
+ # @return [Hash] Returns the value in the form of hash
658
+ def _to_hash(value)
659
+ if value.is_a?(Array)
660
+ value.compact.map { |v| _to_hash(v) }
661
+ elsif value.is_a?(Hash)
662
+ {}.tap do |hash|
663
+ value.each { |k, v| hash[k] = _to_hash(v) }
664
+ end
665
+ elsif value.respond_to? :to_hash
666
+ value.to_hash
667
+ else
668
+ value
669
+ end
670
+ end
671
+
672
+ end
673
+
674
+ end
@@ -22,10 +22,10 @@ module PharmaObservatory
22
22
  # Which lane the row came from: benzinga, sec_extraction or both.
23
23
  attr_accessor :source
24
24
 
25
- # none for a row from SEC filings; licensable for a row from the Benzinga calendar.
25
+ # none for a row from SEC filings; licensable for a row from the Benzinga calendar (the filings are those made to the US Securities and Exchange Commission).
26
26
  attr_accessor :restriction_tier
27
27
 
28
- # The FDA decision date (PDUFA is the date under the Prescription Drug User Fee Act).
28
+ # The decision date of the US Food and Drug Administration (FDA); a PDUFA date is the goal date under the Prescription Drug User Fee Act.
29
29
  attr_accessor :decision_date
30
30
 
31
31
  # Start of the date interval the source states.
@@ -19,7 +19,7 @@ module PharmaObservatory
19
19
  # The site key: one facility spelling from the registry.
20
20
  attr_accessor :site_id
21
21
 
22
- # The trial's registry id (NCT number).
22
+ # The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number).
23
23
  attr_accessor :trial_id
24
24
 
25
25
  # Legal-entity level: the CRO's organization record.