pharmaobservatory 0.1.7 → 0.1.8

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 (117) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +83 -4
  3. data/docs/BiomarkerAlleleFrequenciesResponse.md +58 -0
  4. data/docs/BiomarkerAlleleFrequenciesRow.md +62 -0
  5. data/docs/BiomarkerAssayProvidersResponse.md +58 -0
  6. data/docs/BiomarkerAssayProvidersRow.md +72 -0
  7. data/docs/BiomarkerEvidenceByYearResponse.md +58 -0
  8. data/docs/BiomarkerEvidenceByYearRow.md +32 -0
  9. data/docs/BiomarkerTraversalStatusResponse.md +58 -0
  10. data/docs/BiomarkerTraversalStatusRow.md +36 -0
  11. data/docs/BiomarkersApi.md +320 -0
  12. data/docs/CompaniesApi.md +1001 -99
  13. data/docs/CompanyAssetsRow.md +5 -1
  14. data/docs/CompanyBiomarkerCapabilityResponse.md +58 -0
  15. data/docs/CompanyBiomarkerCapabilityRow.md +68 -0
  16. data/docs/CompanyProgramsRow.md +5 -1
  17. data/docs/CompanyRareDiseaseDeclarationsResponse.md +58 -0
  18. data/docs/CompanyRareDiseaseDeclarationsRow.md +52 -0
  19. data/docs/GxpFacilitiesRow.md +22 -0
  20. data/docs/LegalEntitiesApi.md +981 -101
  21. data/docs/LegalEntitiesRecordAttributes.md +6 -0
  22. data/docs/LegalEntitySecFilingsResponse.md +58 -0
  23. data/docs/LegalEntitySecFilingsRow.md +44 -0
  24. data/docs/OrgDisclosureTrendResponse.md +58 -0
  25. data/docs/OrgDisclosureTrendRow.md +62 -0
  26. data/docs/OwnershipSourceCoverageResponse.md +58 -0
  27. data/docs/OwnershipSourceCoverageRow.md +62 -0
  28. data/docs/ProgramLicensingCandidatesRow.md +5 -1
  29. data/docs/ProgramsRow.md +1 -1
  30. data/docs/RwdConductorDeliveryResponse.md +58 -0
  31. data/docs/RwdConductorDeliveryRow.md +74 -0
  32. data/docs/RwdConductorFootprintResponse.md +58 -0
  33. data/docs/RwdConductorFootprintRow.md +40 -0
  34. data/docs/RwdConductorStudiesResponse.md +58 -0
  35. data/docs/RwdConductorStudiesRow.md +42 -0
  36. data/docs/RwdConductorsApi.md +393 -0
  37. data/docs/RwdConductorsRecord.md +38 -0
  38. data/docs/RwdConductorsResponse.md +58 -0
  39. data/docs/RwdConductorsRow.md +72 -0
  40. data/docs/RwdInstitutionsApi.md +153 -0
  41. data/docs/RwdInstitutionsRecord.md +38 -0
  42. data/docs/RwdInstitutionsResponse.md +58 -0
  43. data/docs/RwdInstitutionsRow.md +154 -0
  44. data/docs/RwdNetworksApi.md +153 -0
  45. data/docs/RwdNetworksRecord.md +38 -0
  46. data/docs/RwdNetworksResponse.md +58 -0
  47. data/docs/RwdNetworksRow.md +110 -0
  48. data/docs/RwdStudiesApi.md +80 -0
  49. data/docs/SbtiCrosscheckResponse.md +58 -0
  50. data/docs/SbtiCrosscheckRow.md +48 -0
  51. data/docs/SponsorDeliveryResponse.md +58 -0
  52. data/docs/SponsorDeliveryRow.md +52 -0
  53. data/docs/SponsorPatentMentionsResponse.md +58 -0
  54. data/docs/SponsorPatentMentionsRow.md +42 -0
  55. data/docs/SponsorTrialConditionsResponse.md +58 -0
  56. data/docs/SponsorTrialConditionsRow.md +36 -0
  57. data/docs/SponsorTrialDrugsResponse.md +58 -0
  58. data/docs/SponsorTrialDrugsRow.md +34 -0
  59. data/lib/pharmaobservatory/api/biomarkers_api.rb +336 -0
  60. data/lib/pharmaobservatory/api/companies_api.rb +1131 -130
  61. data/lib/pharmaobservatory/api/legal_entities_api.rb +1047 -123
  62. data/lib/pharmaobservatory/api/rwd_conductors_api.rb +413 -0
  63. data/lib/pharmaobservatory/api/rwd_institutions_api.rb +161 -0
  64. data/lib/pharmaobservatory/api/rwd_networks_api.rb +161 -0
  65. data/lib/pharmaobservatory/api/rwd_studies_api.rb +84 -0
  66. data/lib/pharmaobservatory/models/biomarker_allele_frequencies_response.rb +478 -0
  67. data/lib/pharmaobservatory/models/biomarker_allele_frequencies_row.rb +465 -0
  68. data/lib/pharmaobservatory/models/biomarker_assay_providers_response.rb +478 -0
  69. data/lib/pharmaobservatory/models/biomarker_assay_providers_row.rb +520 -0
  70. data/lib/pharmaobservatory/models/biomarker_evidence_by_year_response.rb +478 -0
  71. data/lib/pharmaobservatory/models/biomarker_evidence_by_year_row.rb +300 -0
  72. data/lib/pharmaobservatory/models/biomarker_traversal_status_response.rb +478 -0
  73. data/lib/pharmaobservatory/models/biomarker_traversal_status_row.rb +322 -0
  74. data/lib/pharmaobservatory/models/company_assets_row.rb +24 -2
  75. data/lib/pharmaobservatory/models/company_biomarker_capability_response.rb +478 -0
  76. data/lib/pharmaobservatory/models/company_biomarker_capability_row.rb +498 -0
  77. data/lib/pharmaobservatory/models/company_programs_row.rb +24 -2
  78. data/lib/pharmaobservatory/models/company_rare_disease_declarations_response.rb +478 -0
  79. data/lib/pharmaobservatory/models/company_rare_disease_declarations_row.rb +410 -0
  80. data/lib/pharmaobservatory/models/gxp_facilities_row.rb +122 -1
  81. data/lib/pharmaobservatory/models/legal_entities_record_attributes.rb +28 -1
  82. data/lib/pharmaobservatory/models/legal_entity_sec_filings_response.rb +478 -0
  83. data/lib/pharmaobservatory/models/legal_entity_sec_filings_row.rb +370 -0
  84. data/lib/pharmaobservatory/models/org_disclosure_trend_response.rb +478 -0
  85. data/lib/pharmaobservatory/models/org_disclosure_trend_row.rb +465 -0
  86. data/lib/pharmaobservatory/models/ownership_source_coverage_response.rb +478 -0
  87. data/lib/pharmaobservatory/models/ownership_source_coverage_row.rb +465 -0
  88. data/lib/pharmaobservatory/models/program_licensing_candidates_row.rb +24 -2
  89. data/lib/pharmaobservatory/models/programs_row.rb +1 -1
  90. data/lib/pharmaobservatory/models/rwd_conductor_delivery_response.rb +478 -0
  91. data/lib/pharmaobservatory/models/rwd_conductor_delivery_row.rb +537 -0
  92. data/lib/pharmaobservatory/models/rwd_conductor_footprint_response.rb +478 -0
  93. data/lib/pharmaobservatory/models/rwd_conductor_footprint_row.rb +346 -0
  94. data/lib/pharmaobservatory/models/rwd_conductor_studies_response.rb +478 -0
  95. data/lib/pharmaobservatory/models/rwd_conductor_studies_row.rb +355 -0
  96. data/lib/pharmaobservatory/models/rwd_conductors_record.rb +385 -0
  97. data/lib/pharmaobservatory/models/rwd_conductors_response.rb +478 -0
  98. data/lib/pharmaobservatory/models/rwd_conductors_row.rb +526 -0
  99. data/lib/pharmaobservatory/models/rwd_institutions_record.rb +385 -0
  100. data/lib/pharmaobservatory/models/rwd_institutions_response.rb +478 -0
  101. data/lib/pharmaobservatory/models/rwd_institutions_row.rb +981 -0
  102. data/lib/pharmaobservatory/models/rwd_networks_record.rb +385 -0
  103. data/lib/pharmaobservatory/models/rwd_networks_response.rb +478 -0
  104. data/lib/pharmaobservatory/models/rwd_networks_row.rb +733 -0
  105. data/lib/pharmaobservatory/models/sbti_crosscheck_response.rb +478 -0
  106. data/lib/pharmaobservatory/models/sbti_crosscheck_row.rb +388 -0
  107. data/lib/pharmaobservatory/models/sponsor_delivery_response.rb +478 -0
  108. data/lib/pharmaobservatory/models/sponsor_delivery_row.rb +410 -0
  109. data/lib/pharmaobservatory/models/sponsor_patent_mentions_response.rb +478 -0
  110. data/lib/pharmaobservatory/models/sponsor_patent_mentions_row.rb +355 -0
  111. data/lib/pharmaobservatory/models/sponsor_trial_conditions_response.rb +478 -0
  112. data/lib/pharmaobservatory/models/sponsor_trial_conditions_row.rb +322 -0
  113. data/lib/pharmaobservatory/models/sponsor_trial_drugs_response.rb +478 -0
  114. data/lib/pharmaobservatory/models/sponsor_trial_drugs_row.rb +311 -0
  115. data/lib/pharmaobservatory/version.rb +1 -1
  116. data/lib/pharmaobservatory.rb +46 -0
  117. metadata +94 -2
@@ -0,0 +1,110 @@
1
+ # PharmaObservatory::RwdNetworksRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **network_id** | **String** | The register's own Network ID. The entry key of the rwd_networks object type. | [optional] |
8
+ | **network_name** | **String** | The network's name as the register spells it. | [optional] |
9
+ | **network_name_key** | **String** | The normalised name key the study and member edges join on. | [optional] |
10
+ | **register_state** | **String** | self_registered_profile when the entry declares at least one of description, countries, therapeutic areas or funding source, catalogue_name_entry otherwise. is_encepp_partner is null on a catalogue name entry. | [optional] |
11
+ | **is_self_registered_profile** | **Boolean** | True when registration_state is self_registered_profile. | [optional] |
12
+ | **declared_profile_fields** | **Integer** | How many of the declarable profile fields the entry answered. | [optional] |
13
+ | **declarable_profile_fields** | **Integer** | How many profile fields the register offers; the denominator of declared_profile_fields. | [optional] |
14
+ | **network_countries** | **String** | The country text the network declares, as typed. | [optional] |
15
+ | **primary_therapeutic_disease_areas** | **String** | The primary therapeutic and disease areas the network declares, as typed; blank on most networks, so a facet over it would remove the largest networks. | [optional] |
16
+ | **has_declared_therapeutic_area** | **Boolean** | Whether the network declares a therapeutic area at all (the blank is the registrant's silence). | [optional] |
17
+ | **sources_of_funding** | **String** | The sources of funding the network declares, as typed. | [optional] |
18
+ | **network_website** | **String** | The network's website as the register holds it. | [optional] |
19
+ | **catalogue_url** | **String** | The address of this entry on the HMA-EMA catalogue site (the register's URL LINK). | [optional] |
20
+ | **is_encepp_partner** | **Boolean** | Whether the entry declares an ENCePP partnership; null on a catalogue name entry, where the export writes a default No that is not an answer. | [optional] |
21
+ | **declared_member_count** | **Integer** | How many member institutions the network's own list names; zero says the network named nobody, not that it has no members. | [optional] |
22
+ | **declared_member_name_keys** | **Array<String>** | The normalised name keys of the declared members. | [optional] |
23
+ | **declared_member_names** | **Array<String>** | The names of the declared members as the register spells them. | [optional] |
24
+ | **lists_any_member** | **Boolean** | Whether the network's own list names at least one member. | [optional] |
25
+ | **delivered_studies_lifetime** | **Integer** | Distinct registered studies that named the network. Declared membership and delivered work are different facts and never share a column. | [optional] |
26
+ | **delivered_studies_last_5_years** | **Integer** | Delivered studies that started within five years of the snapshot. | [optional] |
27
+ | **delivered_studies_ongoing** | **Integer** | Delivered studies whose status is Ongoing. | [optional] |
28
+ | **delivered_studies_planned** | **Integer** | Delivered studies whose status is Planned. | [optional] |
29
+ | **most_recent_study_start_on** | **Date** | The latest actual start date among the studies it conducted (or delivered, for a network). | [optional] |
30
+ | **record_updated_at** | **Time** | When the registrant last edited this catalogue entry. A different clock from last_refreshed_on: it dates the web form, not the database. | [optional] |
31
+ | **record_updated_is_mass_edit** | **Boolean** | True when the record's last update date is a mass-edit date: one shared by an outsized part of the register, so it dates a migration and not the registrant. | [optional] |
32
+ | **record_updated_at_attested** | **Time** | record_updated_at with the mass-edit dates removed (null for a mass-edit date or no timestamp): the column to sort a freshness question on. | [optional] |
33
+ | **record_updated_date_share** | **Float** | The share of the register whose last update carries the same date, on every row so a mass-edit date is visible. | [optional] |
34
+ | **record_first_published_at** | **Time** | When the catalogue entry was first published. | [optional] |
35
+ | **is_outdated** | **Boolean** | EMA's own Outdated flag, carried through untouched; the register flags none of the data sources, so read false as EMA's answer and not as a currency finding. | [optional] |
36
+ | **network_register_total** | **Integer** | The number of networks in the whole network register at the snapshot. | [optional] |
37
+ | **networks_listing_any_member** | **Integer** | How many register networks list at least one member. | [optional] |
38
+ | **membership_edge_total** | **Integer** | How many network-to-institution membership edges the member lists hold. | [optional] |
39
+ | **institutions_in_any_member_list** | **Integer** | How many register institutions at least one network member list names. | [optional] |
40
+ | **institution_name_key_total** | **Integer** | How many distinct institution name keys the register holds. | [optional] |
41
+ | **networks_declaring_a_therapeutic_area** | **Integer** | How many register networks declare a therapeutic area. | [optional] |
42
+ | **networks_with_any_delivered_study** | **Integer** | How many register networks at least one registered study named. | [optional] |
43
+ | **self_registered_profile_total** | **Integer** | How many register entries are self-registered profiles. | [optional] |
44
+ | **catalogue_name_entry_total** | **Integer** | How many register entries are catalogue name entries. | [optional] |
45
+ | **self_registered_profile_encepp_yes_total** | **Integer** | How many self-registered networks declare an ENCePP partnership. | [optional] |
46
+ | **catalogue_name_entry_encepp_yes_total** | **Integer** | How many catalogue name entries declare one (the mart nulls the declaration there, so this is the false-No check). | [optional] |
47
+ | **register_source_count** | **Integer** | The number of data sources in the whole data source register at the snapshot: the denominator every source count is over. Not a count of real-world data sources in the world. | [optional] |
48
+ | **study_register_total** | **Integer** | The number of studies in the whole study register at the snapshot. | [optional] |
49
+ | **studies_naming_a_registered_source** | **Integer** | How many registered studies name at least one data source that is itself registered; the denominator under study_count. | [optional] |
50
+ | **snapshot_label** | **String** | The label of the catalogue snapshot the row was read from (a date). | [optional] |
51
+ | **accessed_month** | **String** | The month and year the catalogue was accessed (YYYY-MM), which EMA's site asks to be cited with its URL. | [optional] |
52
+ | **restriction_tier** | **String** | The license restriction tier of the row's source. Every row of this dataset is licensable (PROVISIONAL, legal read pending). | [optional] |
53
+ | **attribution** | **String** | The attribution line EMA requires, including the catalogue URL and the access month; quote it with any figure taken from the row. | [optional] |
54
+
55
+ ## Example
56
+
57
+ ```ruby
58
+ require 'pharmaobservatory'
59
+
60
+ instance = PharmaObservatory::RwdNetworksRow.new(
61
+ network_id: null,
62
+ network_name: null,
63
+ network_name_key: null,
64
+ register_state: null,
65
+ is_self_registered_profile: null,
66
+ declared_profile_fields: null,
67
+ declarable_profile_fields: null,
68
+ network_countries: null,
69
+ primary_therapeutic_disease_areas: null,
70
+ has_declared_therapeutic_area: null,
71
+ sources_of_funding: null,
72
+ network_website: null,
73
+ catalogue_url: null,
74
+ is_encepp_partner: null,
75
+ declared_member_count: null,
76
+ declared_member_name_keys: null,
77
+ declared_member_names: null,
78
+ lists_any_member: null,
79
+ delivered_studies_lifetime: null,
80
+ delivered_studies_last_5_years: null,
81
+ delivered_studies_ongoing: null,
82
+ delivered_studies_planned: null,
83
+ most_recent_study_start_on: null,
84
+ record_updated_at: null,
85
+ record_updated_is_mass_edit: null,
86
+ record_updated_at_attested: null,
87
+ record_updated_date_share: null,
88
+ record_first_published_at: null,
89
+ is_outdated: null,
90
+ network_register_total: null,
91
+ networks_listing_any_member: null,
92
+ membership_edge_total: null,
93
+ institutions_in_any_member_list: null,
94
+ institution_name_key_total: null,
95
+ networks_declaring_a_therapeutic_area: null,
96
+ networks_with_any_delivered_study: null,
97
+ self_registered_profile_total: null,
98
+ catalogue_name_entry_total: null,
99
+ self_registered_profile_encepp_yes_total: null,
100
+ catalogue_name_entry_encepp_yes_total: null,
101
+ register_source_count: null,
102
+ study_register_total: null,
103
+ studies_naming_a_registered_source: null,
104
+ snapshot_label: null,
105
+ accessed_month: null,
106
+ restriction_tier: null,
107
+ attribution: null
108
+ )
109
+ ```
110
+
@@ -6,6 +6,7 @@ All URIs are relative to *https://pharmaobservatory.com*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**rwd_studies_get**](RwdStudiesApi.md#rwd_studies_get) | **GET** /api/v1/rwd_studies/{id} | One real-world data study |
8
8
  | [**rwd_studies_list**](RwdStudiesApi.md#rwd_studies_list) | **GET** /api/v1/rwd_studies | List real-world data studies |
9
+ | [**rwd_studies_rwd_conductor_studies**](RwdStudiesApi.md#rwd_studies_rwd_conductor_studies) | **GET** /api/v1/rwd_studies/{id}/rwd_conductor_studies | Real-world data study conductor studies (HMA-EMA catalogue) |
9
10
  | [**rwd_studies_rwd_study_conditions**](RwdStudiesApi.md#rwd_studies_rwd_study_conditions) | **GET** /api/v1/rwd_studies/{id}/rwd_study_conditions | Registered real-world data study conditions |
10
11
  | [**rwd_studies_rwd_study_data_sources**](RwdStudiesApi.md#rwd_studies_rwd_study_data_sources) | **GET** /api/v1/rwd_studies/{id}/rwd_study_data_sources | Registered real-world data study data sources |
11
12
  | [**rwd_studies_rwd_study_drugs**](RwdStudiesApi.md#rwd_studies_rwd_study_drugs) | **GET** /api/v1/rwd_studies/{id}/rwd_study_drugs | Registered real-world data study drugs |
@@ -156,6 +157,85 @@ end
156
157
  - **Accept**: application/json
157
158
 
158
159
 
160
+ ## rwd_studies_rwd_conductor_studies
161
+
162
+ > <RwdConductorStudiesResponse> rwd_studies_rwd_conductor_studies(id, opts)
163
+
164
+ Real-world data study conductor studies (HMA-EMA catalogue)
165
+
166
+ ### Examples
167
+
168
+ ```ruby
169
+ require 'time'
170
+ require 'pharmaobservatory'
171
+ # setup authorization
172
+ PharmaObservatory.configure do |config|
173
+ # Configure Bearer authorization (JWT): ApiBearerJwt
174
+ config.access_token = 'YOUR_BEARER_TOKEN'
175
+ end
176
+
177
+ api_instance = PharmaObservatory::RwdStudiesApi.new
178
+ id = 900000301 # Integer |
179
+ opts = {
180
+ cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
181
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
182
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
183
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
184
+ measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
185
+ }
186
+
187
+ begin
188
+ # Real-world data study conductor studies (HMA-EMA catalogue)
189
+ result = api_instance.rwd_studies_rwd_conductor_studies(id, opts)
190
+ p result
191
+ rescue PharmaObservatory::ApiError => e
192
+ puts "Error when calling RwdStudiesApi->rwd_studies_rwd_conductor_studies: #{e}"
193
+ end
194
+ ```
195
+
196
+ #### Using the rwd_studies_rwd_conductor_studies_with_http_info variant
197
+
198
+ This returns an Array which contains the response data, status code and headers.
199
+
200
+ > <Array(<RwdConductorStudiesResponse>, Integer, Hash)> rwd_studies_rwd_conductor_studies_with_http_info(id, opts)
201
+
202
+ ```ruby
203
+ begin
204
+ # Real-world data study conductor studies (HMA-EMA catalogue)
205
+ data, status_code, headers = api_instance.rwd_studies_rwd_conductor_studies_with_http_info(id, opts)
206
+ p status_code # => 2xx
207
+ p headers # => { ... }
208
+ p data # => <RwdConductorStudiesResponse>
209
+ rescue PharmaObservatory::ApiError => e
210
+ puts "Error when calling RwdStudiesApi->rwd_studies_rwd_conductor_studies_with_http_info: #{e}"
211
+ end
212
+ ```
213
+
214
+ ### Parameters
215
+
216
+ | Name | Type | Description | Notes |
217
+ | ---- | ---- | ----------- | ----- |
218
+ | **id** | **Integer** | | |
219
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
220
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
221
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
222
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
223
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
224
+
225
+ ### Return type
226
+
227
+ [**RwdConductorStudiesResponse**](RwdConductorStudiesResponse.md)
228
+
229
+ ### Authorization
230
+
231
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
232
+
233
+ ### HTTP request headers
234
+
235
+ - **Content-Type**: Not defined
236
+ - **Accept**: application/json
237
+
238
+
159
239
  ## rwd_studies_rwd_study_conditions
160
240
 
161
241
  > <RwdStudyConditionsResponse> rwd_studies_rwd_study_conditions(id, opts)
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::SbtiCrosscheckResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **dataset** | **String** | | |
8
+ | **grain** | **String** | | [optional] |
9
+ | **object_type** | **String** | | [optional] |
10
+ | **id** | **String** | | [optional] |
11
+ | **scope** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) | | [optional] |
12
+ | **columns** | [**Array&lt;DatasetColumn&gt;**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array&lt;SbtiCrosscheckRow&gt;**](SbtiCrosscheckRow.md) | | |
14
+ | **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
15
+ | **next_cursor** | **String** | | [optional] |
16
+ | **sort** | **Array&lt;String&gt;** | | [optional] |
17
+ | **filters** | **Array&lt;Hash&lt;String, Object&gt;&gt;** | | [optional] |
18
+ | **group_by** | **Array&lt;String&gt;** | | [optional] |
19
+ | **measures** | **Array&lt;String&gt;** | | [optional] |
20
+ | **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) | | [optional] |
21
+ | **source_credit** | **String** | | [optional] |
22
+ | **withheld_tiers** | **Array&lt;String&gt;** | | [optional] |
23
+ | **withheld_columns** | **Array&lt;String&gt;** | | [optional] |
24
+ | **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) | | [optional] |
25
+ | **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) | | [optional] |
26
+ | **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
27
+ | **restriction** | **Hash&lt;String, Object&gt;** | | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'pharmaobservatory'
33
+
34
+ instance = PharmaObservatory::SbtiCrosscheckResponse.new(
35
+ dataset: null,
36
+ grain: null,
37
+ object_type: null,
38
+ id: null,
39
+ scope: null,
40
+ columns: null,
41
+ rows: null,
42
+ total: null,
43
+ next_cursor: null,
44
+ sort: null,
45
+ filters: null,
46
+ group_by: null,
47
+ measures: null,
48
+ attribution: null,
49
+ source_credit: null,
50
+ withheld_tiers: null,
51
+ withheld_columns: null,
52
+ freshness: null,
53
+ build: null,
54
+ build_state: null,
55
+ restriction: null
56
+ )
57
+ ```
58
+
@@ -0,0 +1,48 @@
1
+ # PharmaObservatory::SbtiCrosscheckRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **org_id** | **String** | Legal-entity level: the organization the cross-check is for. | [optional] |
8
+ | **org_name** | **String** | Display name of the organization record. | [optional] |
9
+ | **company_id** | **String** | Company level: the company the organization belongs to (null when unresolved). | [optional] |
10
+ | **company_name** | **String** | Display name of the organization&#39;s company. | [optional] |
11
+ | **group_id** | **String** | Group level: the organization&#39;s current ultimate parent company; a root company&#39;s group is itself. | [optional] |
12
+ | **group_name** | **String** | Display name of the organization&#39;s group. | [optional] |
13
+ | **reported_company_name** | **String** | The company name as the SBTi list or the disclosure gives it. | [optional] |
14
+ | **recon_status** | **String** | The cross-check result: agree, extracted_only, sbti_only, target_year_conflict or self_claim_conflict. | [optional] |
15
+ | **has_net_zero_target** | **Boolean** | Whether a net-zero target is stated (SBTi&#39;s value where it lists the organization, else the disclosure&#39;s). | [optional] |
16
+ | **net_zero_year** | **Integer** | The net-zero target year. | [optional] |
17
+ | **has_near_term_target** | **Boolean** | Whether a near-term target is stated. | [optional] |
18
+ | **near_term_target_year** | **Integer** | The near-term target year. | [optional] |
19
+ | **sbti_validated** | **Boolean** | Whether SBTi lists the targets as validated; null when SBTi does not list the organization. | [optional] |
20
+ | **claimed_sbti_status** | **String** | The SBTi status the organization&#39;s own filing claims. | [optional] |
21
+ | **in_sbti** | **Boolean** | Whether the SBTi list carries the organization. | [optional] |
22
+ | **in_extracted** | **Boolean** | Whether an extraction of the organization&#39;s own filing exists. | [optional] |
23
+
24
+ ## Example
25
+
26
+ ```ruby
27
+ require 'pharmaobservatory'
28
+
29
+ instance = PharmaObservatory::SbtiCrosscheckRow.new(
30
+ org_id: null,
31
+ org_name: null,
32
+ company_id: null,
33
+ company_name: null,
34
+ group_id: null,
35
+ group_name: null,
36
+ reported_company_name: null,
37
+ recon_status: null,
38
+ has_net_zero_target: null,
39
+ net_zero_year: null,
40
+ has_near_term_target: null,
41
+ near_term_target_year: null,
42
+ sbti_validated: null,
43
+ claimed_sbti_status: null,
44
+ in_sbti: null,
45
+ in_extracted: null
46
+ )
47
+ ```
48
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::SponsorDeliveryResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **dataset** | **String** | | |
8
+ | **grain** | **String** | | [optional] |
9
+ | **object_type** | **String** | | [optional] |
10
+ | **id** | **String** | | [optional] |
11
+ | **scope** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) | | [optional] |
12
+ | **columns** | [**Array&lt;DatasetColumn&gt;**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array&lt;SponsorDeliveryRow&gt;**](SponsorDeliveryRow.md) | | |
14
+ | **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
15
+ | **next_cursor** | **String** | | [optional] |
16
+ | **sort** | **Array&lt;String&gt;** | | [optional] |
17
+ | **filters** | **Array&lt;Hash&lt;String, Object&gt;&gt;** | | [optional] |
18
+ | **group_by** | **Array&lt;String&gt;** | | [optional] |
19
+ | **measures** | **Array&lt;String&gt;** | | [optional] |
20
+ | **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) | | [optional] |
21
+ | **source_credit** | **String** | | [optional] |
22
+ | **withheld_tiers** | **Array&lt;String&gt;** | | [optional] |
23
+ | **withheld_columns** | **Array&lt;String&gt;** | | [optional] |
24
+ | **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) | | [optional] |
25
+ | **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) | | [optional] |
26
+ | **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
27
+ | **restriction** | **Hash&lt;String, Object&gt;** | | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'pharmaobservatory'
33
+
34
+ instance = PharmaObservatory::SponsorDeliveryResponse.new(
35
+ dataset: null,
36
+ grain: null,
37
+ object_type: null,
38
+ id: null,
39
+ scope: null,
40
+ columns: null,
41
+ rows: null,
42
+ total: null,
43
+ next_cursor: null,
44
+ sort: null,
45
+ filters: null,
46
+ group_by: null,
47
+ measures: null,
48
+ attribution: null,
49
+ source_credit: null,
50
+ withheld_tiers: null,
51
+ withheld_columns: null,
52
+ freshness: null,
53
+ build: null,
54
+ build_state: null,
55
+ restriction: null
56
+ )
57
+ ```
58
+
@@ -0,0 +1,52 @@
1
+ # PharmaObservatory::SponsorDeliveryRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sponsor_org_id** | **String** | Legal-entity level: the lead sponsor organization record. | [optional] |
8
+ | **sponsor_name** | **String** | Display name of the sponsor organization record. | [optional] |
9
+ | **sponsor_company_id** | **String** | Company level: the company the sponsor belongs to (null when unresolved). | [optional] |
10
+ | **sponsor_company_name** | **String** | Display name of the sponsor&#39;s company. | [optional] |
11
+ | **sponsor_group_id** | **String** | Group level: the sponsor&#39;s current ultimate parent company; a root company&#39;s group is itself. | [optional] |
12
+ | **sponsor_group_name** | **String** | Display name of the sponsor&#39;s group. | [optional] |
13
+ | **n_trials_total** | **Integer** | Lead-sponsored trials of the organization. | [optional] |
14
+ | **n_trials_with_observed_plan** | **Integer** | Trials whose planned dates come from the earliest estimate in the registry&#39;s own history. | [optional] |
15
+ | **n_trials_with_enrollment_delta** | **Integer** | Trials with a measured difference between planned and actual enrollment; the base of the enrollment rate. | [optional] |
16
+ | **n_trials_with_completion_delta** | **Integer** | Trials with a measured difference between planned and actual primary completion; the base of the on-time rate. | [optional] |
17
+ | **n_enrollment_met** | **Integer** | Trials with an enrollment delta that reached their planned enrollment. | [optional] |
18
+ | **n_enrollment_missed** | **Integer** | Trials with an enrollment delta that did not reach their planned enrollment. | [optional] |
19
+ | **enrollment_hit_rate** | **Float** | n_enrollment_met divided by n_trials_with_enrollment_delta; null when that base is zero. | [optional] |
20
+ | **median_enrollment_attainment_pct** | **Float** | Median of actual enrollment as a percentage of planned, over trials with an enrollment delta. | [optional] |
21
+ | **n_ontime** | **Integer** | Trials with a completion delta that were not delayed past their planned primary completion. | [optional] |
22
+ | **n_slipped** | **Integer** | Trials with a completion delta that completed or are projected after their planned primary completion. | [optional] |
23
+ | **on_time_rate** | **Float** | n_ontime divided by n_trials_with_completion_delta; null when that base is zero. | [optional] |
24
+ | **median_completion_slip_days** | **Float** | Median days between planned and actual primary completion, over trials with a completion delta. | [optional] |
25
+
26
+ ## Example
27
+
28
+ ```ruby
29
+ require 'pharmaobservatory'
30
+
31
+ instance = PharmaObservatory::SponsorDeliveryRow.new(
32
+ sponsor_org_id: null,
33
+ sponsor_name: null,
34
+ sponsor_company_id: null,
35
+ sponsor_company_name: null,
36
+ sponsor_group_id: null,
37
+ sponsor_group_name: null,
38
+ n_trials_total: null,
39
+ n_trials_with_observed_plan: null,
40
+ n_trials_with_enrollment_delta: null,
41
+ n_trials_with_completion_delta: null,
42
+ n_enrollment_met: null,
43
+ n_enrollment_missed: null,
44
+ enrollment_hit_rate: null,
45
+ median_enrollment_attainment_pct: null,
46
+ n_ontime: null,
47
+ n_slipped: null,
48
+ on_time_rate: null,
49
+ median_completion_slip_days: null
50
+ )
51
+ ```
52
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::SponsorPatentMentionsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **dataset** | **String** | | |
8
+ | **grain** | **String** | | [optional] |
9
+ | **object_type** | **String** | | [optional] |
10
+ | **id** | **String** | | [optional] |
11
+ | **scope** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) | | [optional] |
12
+ | **columns** | [**Array&lt;DatasetColumn&gt;**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array&lt;SponsorPatentMentionsRow&gt;**](SponsorPatentMentionsRow.md) | | |
14
+ | **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
15
+ | **next_cursor** | **String** | | [optional] |
16
+ | **sort** | **Array&lt;String&gt;** | | [optional] |
17
+ | **filters** | **Array&lt;Hash&lt;String, Object&gt;&gt;** | | [optional] |
18
+ | **group_by** | **Array&lt;String&gt;** | | [optional] |
19
+ | **measures** | **Array&lt;String&gt;** | | [optional] |
20
+ | **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) | | [optional] |
21
+ | **source_credit** | **String** | | [optional] |
22
+ | **withheld_tiers** | **Array&lt;String&gt;** | | [optional] |
23
+ | **withheld_columns** | **Array&lt;String&gt;** | | [optional] |
24
+ | **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) | | [optional] |
25
+ | **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) | | [optional] |
26
+ | **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
27
+ | **restriction** | **Hash&lt;String, Object&gt;** | | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'pharmaobservatory'
33
+
34
+ instance = PharmaObservatory::SponsorPatentMentionsResponse.new(
35
+ dataset: null,
36
+ grain: null,
37
+ object_type: null,
38
+ id: null,
39
+ scope: null,
40
+ columns: null,
41
+ rows: null,
42
+ total: null,
43
+ next_cursor: null,
44
+ sort: null,
45
+ filters: null,
46
+ group_by: null,
47
+ measures: null,
48
+ attribution: null,
49
+ source_credit: null,
50
+ withheld_tiers: null,
51
+ withheld_columns: null,
52
+ freshness: null,
53
+ build: null,
54
+ build_state: null,
55
+ restriction: null
56
+ )
57
+ ```
58
+
@@ -0,0 +1,42 @@
1
+ # PharmaObservatory::SponsorPatentMentionsRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sponsor_org_id** | **String** | Legal-entity level: the lead sponsor organization record. | [optional] |
8
+ | **sponsor_name** | **String** | Display name of the sponsor organization record. | [optional] |
9
+ | **sponsor_company_id** | **String** | Company level: the company the sponsor belongs to (null when unresolved). | [optional] |
10
+ | **sponsor_company_name** | **String** | Display name of the sponsor&#39;s company. | [optional] |
11
+ | **sponsor_group_id** | **String** | Group level: the sponsor&#39;s current ultimate parent company; a root company&#39;s group is itself. | [optional] |
12
+ | **sponsor_group_name** | **String** | Display name of the sponsor&#39;s group. | [optional] |
13
+ | **drug_id** | **String** | The drug key. | [optional] |
14
+ | **drug_name** | **String** | The drug&#39;s name. | [optional] |
15
+ | **patent_number** | **String** | The patent&#39;s publication number. | [optional] |
16
+ | **country** | **String** | The patent office&#39;s country code. | [optional] |
17
+ | **publication_date** | **Date** | The patent&#39;s publication date. | [optional] |
18
+ | **title** | **String** | The patent title. | [optional] |
19
+ | **assignee** | **String** | The patent&#39;s applicant as filed, free text. | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'pharmaobservatory'
25
+
26
+ instance = PharmaObservatory::SponsorPatentMentionsRow.new(
27
+ sponsor_org_id: null,
28
+ sponsor_name: null,
29
+ sponsor_company_id: null,
30
+ sponsor_company_name: null,
31
+ sponsor_group_id: null,
32
+ sponsor_group_name: null,
33
+ drug_id: null,
34
+ drug_name: null,
35
+ patent_number: null,
36
+ country: null,
37
+ publication_date: null,
38
+ title: null,
39
+ assignee: null
40
+ )
41
+ ```
42
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::SponsorTrialConditionsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **dataset** | **String** | | |
8
+ | **grain** | **String** | | [optional] |
9
+ | **object_type** | **String** | | [optional] |
10
+ | **id** | **String** | | [optional] |
11
+ | **scope** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) | | [optional] |
12
+ | **columns** | [**Array&lt;DatasetColumn&gt;**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array&lt;SponsorTrialConditionsRow&gt;**](SponsorTrialConditionsRow.md) | | |
14
+ | **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
15
+ | **next_cursor** | **String** | | [optional] |
16
+ | **sort** | **Array&lt;String&gt;** | | [optional] |
17
+ | **filters** | **Array&lt;Hash&lt;String, Object&gt;&gt;** | | [optional] |
18
+ | **group_by** | **Array&lt;String&gt;** | | [optional] |
19
+ | **measures** | **Array&lt;String&gt;** | | [optional] |
20
+ | **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) | | [optional] |
21
+ | **source_credit** | **String** | | [optional] |
22
+ | **withheld_tiers** | **Array&lt;String&gt;** | | [optional] |
23
+ | **withheld_columns** | **Array&lt;String&gt;** | | [optional] |
24
+ | **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) | | [optional] |
25
+ | **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) | | [optional] |
26
+ | **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
27
+ | **restriction** | **Hash&lt;String, Object&gt;** | | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'pharmaobservatory'
33
+
34
+ instance = PharmaObservatory::SponsorTrialConditionsResponse.new(
35
+ dataset: null,
36
+ grain: null,
37
+ object_type: null,
38
+ id: null,
39
+ scope: null,
40
+ columns: null,
41
+ rows: null,
42
+ total: null,
43
+ next_cursor: null,
44
+ sort: null,
45
+ filters: null,
46
+ group_by: null,
47
+ measures: null,
48
+ attribution: null,
49
+ source_credit: null,
50
+ withheld_tiers: null,
51
+ withheld_columns: null,
52
+ freshness: null,
53
+ build: null,
54
+ build_state: null,
55
+ restriction: null
56
+ )
57
+ ```
58
+
@@ -0,0 +1,36 @@
1
+ # PharmaObservatory::SponsorTrialConditionsRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sponsor_org_id** | **String** | Legal-entity level: the organization record of the sponsor as filed. | [optional] |
8
+ | **sponsor_name** | **String** | Display name of the sponsor organization record. | [optional] |
9
+ | **sponsor_company_id** | **String** | Company level: the company the sponsor belongs to (null when unresolved). | [optional] |
10
+ | **sponsor_company_name** | **String** | Display name of the sponsor&#39;s company. | [optional] |
11
+ | **sponsor_group_id** | **String** | Group level: the sponsor&#39;s current ultimate parent company; a root company&#39;s group is itself. | [optional] |
12
+ | **sponsor_group_name** | **String** | Display name of the sponsor&#39;s group. | [optional] |
13
+ | **sponsor_role** | **String** | lead or collaborator. | [optional] |
14
+ | **trial_id** | **String** | The trial&#39;s ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
15
+ | **condition_id** | **String** | The condition key, a MeSH descriptor id (D followed by six to nine digits). | [optional] |
16
+ | **condition_name** | **String** | The condition&#39;s MeSH heading. | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'pharmaobservatory'
22
+
23
+ instance = PharmaObservatory::SponsorTrialConditionsRow.new(
24
+ sponsor_org_id: null,
25
+ sponsor_name: null,
26
+ sponsor_company_id: null,
27
+ sponsor_company_name: null,
28
+ sponsor_group_id: null,
29
+ sponsor_group_name: null,
30
+ sponsor_role: null,
31
+ trial_id: null,
32
+ condition_id: null,
33
+ condition_name: null
34
+ )
35
+ ```
36
+