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,58 @@
1
+ # PharmaObservatory::RwdConductorStudiesResponse
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<DatasetColumn>**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array<RwdConductorStudiesRow>**](RwdConductorStudiesRow.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<String>** | | [optional] |
17
+ | **filters** | **Array<Hash<String, Object>>** | | [optional] |
18
+ | **group_by** | **Array<String>** | | [optional] |
19
+ | **measures** | **Array<String>** | | [optional] |
20
+ | **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) | | [optional] |
21
+ | **source_credit** | **String** | | [optional] |
22
+ | **withheld_tiers** | **Array<String>** | | [optional] |
23
+ | **withheld_columns** | **Array<String>** | | [optional] |
24
+ | **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) | | [optional] |
25
+ | **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) | | [optional] |
26
+ | **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
27
+ | **restriction** | **Hash<String, Object>** | | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'pharmaobservatory'
33
+
34
+ instance = PharmaObservatory::RwdConductorStudiesResponse.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::RwdConductorStudiesRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **conductor_id** | **String** | The conductor slug: the register's normalised institution name key with spaces as hyphens, the id in the web page address (/rwd-conductors/<id>). The entry key of the rwd_conductors object type; injective because no name key carries a hyphen. | [optional] |
8
+ | **study_id** | **String** | The register's own Study ID. The entry key of the rwd_studies object type; the EU PAS number is an attribute. | [optional] |
9
+ | **conductor_role** | **String** | conducting when the register names the conductor as an institution conducting the study, additional when as an additional institution. | [optional] |
10
+ | **study_title** | **String** | The study's title as registered. | [optional] |
11
+ | **study_status** | **String** | The study's status as the register words it (Planned, Ongoing, Finalised, and so on). | [optional] |
12
+ | **mandate_stratum** | **String** | mandated when a regulator required the study (a post-authorisation obligation), voluntary when the registrant says it did not, unknown when unanswered. Delivery timeliness is only comparable within a stratum. | [optional] |
13
+ | **study_start_actual_on** | **Date** | Actual study start date. | [optional] |
14
+ | **final_report_slip_days** | **Integer** | Actual minus planned final report date in days (positive is late); null when either date is missing or the two dates are equal (a backfill). | [optional] |
15
+ | **final_report_is_backfilled** | **Boolean** | True when the planned and actual final report dates are both present and equal to the day, which reads as a plan entered after the fact rather than perfect delivery. | [optional] |
16
+ | **snapshot_label** | **String** | The label of the catalogue snapshot the row was read from (a date). | [optional] |
17
+ | **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] |
18
+ | **restriction_tier** | **String** | The license restriction tier of the row's source. Every row of this dataset is licensable (PROVISIONAL, legal read pending). | [optional] |
19
+ | **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] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'pharmaobservatory'
25
+
26
+ instance = PharmaObservatory::RwdConductorStudiesRow.new(
27
+ conductor_id: null,
28
+ study_id: null,
29
+ conductor_role: null,
30
+ study_title: null,
31
+ study_status: null,
32
+ mandate_stratum: null,
33
+ study_start_actual_on: null,
34
+ final_report_slip_days: null,
35
+ final_report_is_backfilled: null,
36
+ snapshot_label: null,
37
+ accessed_month: null,
38
+ restriction_tier: null,
39
+ attribution: null
40
+ )
41
+ ```
42
+
@@ -0,0 +1,393 @@
1
+ # PharmaObservatory::RwdConductorsApi
2
+
3
+ All URIs are relative to *https://pharmaobservatory.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**rwd_conductors_get**](RwdConductorsApi.md#rwd_conductors_get) | **GET** /api/v1/rwd_conductors/{id} | One real-world data study conductor |
8
+ | [**rwd_conductors_list**](RwdConductorsApi.md#rwd_conductors_list) | **GET** /api/v1/rwd_conductors | List real-world data study conductors |
9
+ | [**rwd_conductors_rwd_conductor_delivery**](RwdConductorsApi.md#rwd_conductors_rwd_conductor_delivery) | **GET** /api/v1/rwd_conductors/{id}/rwd_conductor_delivery | Real-world data study conductor delivery by mandate (HMA-EMA catalogue) |
10
+ | [**rwd_conductors_rwd_conductor_footprint**](RwdConductorsApi.md#rwd_conductors_rwd_conductor_footprint) | **GET** /api/v1/rwd_conductors/{id}/rwd_conductor_footprint | Real-world data study conductor footprint (HMA-EMA catalogue) |
11
+ | [**rwd_conductors_rwd_conductor_studies**](RwdConductorsApi.md#rwd_conductors_rwd_conductor_studies) | **GET** /api/v1/rwd_conductors/{id}/rwd_conductor_studies | Real-world data study conductor studies (HMA-EMA catalogue) |
12
+
13
+
14
+ ## rwd_conductors_get
15
+
16
+ > <RwdConductorsRecord> rwd_conductors_get(id)
17
+
18
+ One real-world data study conductor
19
+
20
+ ### Examples
21
+
22
+ ```ruby
23
+ require 'time'
24
+ require 'pharmaobservatory'
25
+ # setup authorization
26
+ PharmaObservatory.configure do |config|
27
+ # Configure Bearer authorization (JWT): ApiBearerJwt
28
+ config.access_token = 'YOUR_BEARER_TOKEN'
29
+ end
30
+
31
+ api_instance = PharmaObservatory::RwdConductorsApi.new
32
+ id = 'seedmark-consulting' # String |
33
+
34
+ begin
35
+ # One real-world data study conductor
36
+ result = api_instance.rwd_conductors_get(id)
37
+ p result
38
+ rescue PharmaObservatory::ApiError => e
39
+ puts "Error when calling RwdConductorsApi->rwd_conductors_get: #{e}"
40
+ end
41
+ ```
42
+
43
+ #### Using the rwd_conductors_get_with_http_info variant
44
+
45
+ This returns an Array which contains the response data, status code and headers.
46
+
47
+ > <Array(<RwdConductorsRecord>, Integer, Hash)> rwd_conductors_get_with_http_info(id)
48
+
49
+ ```ruby
50
+ begin
51
+ # One real-world data study conductor
52
+ data, status_code, headers = api_instance.rwd_conductors_get_with_http_info(id)
53
+ p status_code # => 2xx
54
+ p headers # => { ... }
55
+ p data # => <RwdConductorsRecord>
56
+ rescue PharmaObservatory::ApiError => e
57
+ puts "Error when calling RwdConductorsApi->rwd_conductors_get_with_http_info: #{e}"
58
+ end
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+ | Name | Type | Description | Notes |
64
+ | ---- | ---- | ----------- | ----- |
65
+ | **id** | **String** | | |
66
+
67
+ ### Return type
68
+
69
+ [**RwdConductorsRecord**](RwdConductorsRecord.md)
70
+
71
+ ### Authorization
72
+
73
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
74
+
75
+ ### HTTP request headers
76
+
77
+ - **Content-Type**: Not defined
78
+ - **Accept**: application/json
79
+
80
+
81
+ ## rwd_conductors_list
82
+
83
+ > <RwdConductorsResponse> rwd_conductors_list(opts)
84
+
85
+ List real-world data study conductors
86
+
87
+ ### Examples
88
+
89
+ ```ruby
90
+ require 'time'
91
+ require 'pharmaobservatory'
92
+ # setup authorization
93
+ PharmaObservatory.configure do |config|
94
+ # Configure Bearer authorization (JWT): ApiBearerJwt
95
+ config.access_token = 'YOUR_BEARER_TOKEN'
96
+ end
97
+
98
+ api_instance = PharmaObservatory::RwdConductorsApi.new
99
+ opts = {
100
+ 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.
101
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
102
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
103
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
104
+ measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
105
+ }
106
+
107
+ begin
108
+ # List real-world data study conductors
109
+ result = api_instance.rwd_conductors_list(opts)
110
+ p result
111
+ rescue PharmaObservatory::ApiError => e
112
+ puts "Error when calling RwdConductorsApi->rwd_conductors_list: #{e}"
113
+ end
114
+ ```
115
+
116
+ #### Using the rwd_conductors_list_with_http_info variant
117
+
118
+ This returns an Array which contains the response data, status code and headers.
119
+
120
+ > <Array(<RwdConductorsResponse>, Integer, Hash)> rwd_conductors_list_with_http_info(opts)
121
+
122
+ ```ruby
123
+ begin
124
+ # List real-world data study conductors
125
+ data, status_code, headers = api_instance.rwd_conductors_list_with_http_info(opts)
126
+ p status_code # => 2xx
127
+ p headers # => { ... }
128
+ p data # => <RwdConductorsResponse>
129
+ rescue PharmaObservatory::ApiError => e
130
+ puts "Error when calling RwdConductorsApi->rwd_conductors_list_with_http_info: #{e}"
131
+ end
132
+ ```
133
+
134
+ ### Parameters
135
+
136
+ | Name | Type | Description | Notes |
137
+ | ---- | ---- | ----------- | ----- |
138
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
139
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
140
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
141
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
142
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
143
+
144
+ ### Return type
145
+
146
+ [**RwdConductorsResponse**](RwdConductorsResponse.md)
147
+
148
+ ### Authorization
149
+
150
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
151
+
152
+ ### HTTP request headers
153
+
154
+ - **Content-Type**: Not defined
155
+ - **Accept**: application/json
156
+
157
+
158
+ ## rwd_conductors_rwd_conductor_delivery
159
+
160
+ > <RwdConductorDeliveryResponse> rwd_conductors_rwd_conductor_delivery(id, opts)
161
+
162
+ Real-world data study conductor delivery by mandate (HMA-EMA catalogue)
163
+
164
+ ### Examples
165
+
166
+ ```ruby
167
+ require 'time'
168
+ require 'pharmaobservatory'
169
+ # setup authorization
170
+ PharmaObservatory.configure do |config|
171
+ # Configure Bearer authorization (JWT): ApiBearerJwt
172
+ config.access_token = 'YOUR_BEARER_TOKEN'
173
+ end
174
+
175
+ api_instance = PharmaObservatory::RwdConductorsApi.new
176
+ id = 'seedmark-consulting' # String |
177
+ opts = {
178
+ 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.
179
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
180
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
181
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
182
+ measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
183
+ }
184
+
185
+ begin
186
+ # Real-world data study conductor delivery by mandate (HMA-EMA catalogue)
187
+ result = api_instance.rwd_conductors_rwd_conductor_delivery(id, opts)
188
+ p result
189
+ rescue PharmaObservatory::ApiError => e
190
+ puts "Error when calling RwdConductorsApi->rwd_conductors_rwd_conductor_delivery: #{e}"
191
+ end
192
+ ```
193
+
194
+ #### Using the rwd_conductors_rwd_conductor_delivery_with_http_info variant
195
+
196
+ This returns an Array which contains the response data, status code and headers.
197
+
198
+ > <Array(<RwdConductorDeliveryResponse>, Integer, Hash)> rwd_conductors_rwd_conductor_delivery_with_http_info(id, opts)
199
+
200
+ ```ruby
201
+ begin
202
+ # Real-world data study conductor delivery by mandate (HMA-EMA catalogue)
203
+ data, status_code, headers = api_instance.rwd_conductors_rwd_conductor_delivery_with_http_info(id, opts)
204
+ p status_code # => 2xx
205
+ p headers # => { ... }
206
+ p data # => <RwdConductorDeliveryResponse>
207
+ rescue PharmaObservatory::ApiError => e
208
+ puts "Error when calling RwdConductorsApi->rwd_conductors_rwd_conductor_delivery_with_http_info: #{e}"
209
+ end
210
+ ```
211
+
212
+ ### Parameters
213
+
214
+ | Name | Type | Description | Notes |
215
+ | ---- | ---- | ----------- | ----- |
216
+ | **id** | **String** | | |
217
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
218
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
219
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
220
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
221
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
222
+
223
+ ### Return type
224
+
225
+ [**RwdConductorDeliveryResponse**](RwdConductorDeliveryResponse.md)
226
+
227
+ ### Authorization
228
+
229
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
230
+
231
+ ### HTTP request headers
232
+
233
+ - **Content-Type**: Not defined
234
+ - **Accept**: application/json
235
+
236
+
237
+ ## rwd_conductors_rwd_conductor_footprint
238
+
239
+ > <RwdConductorFootprintResponse> rwd_conductors_rwd_conductor_footprint(id, opts)
240
+
241
+ Real-world data study conductor footprint (HMA-EMA catalogue)
242
+
243
+ ### Examples
244
+
245
+ ```ruby
246
+ require 'time'
247
+ require 'pharmaobservatory'
248
+ # setup authorization
249
+ PharmaObservatory.configure do |config|
250
+ # Configure Bearer authorization (JWT): ApiBearerJwt
251
+ config.access_token = 'YOUR_BEARER_TOKEN'
252
+ end
253
+
254
+ api_instance = PharmaObservatory::RwdConductorsApi.new
255
+ id = 'seedmark-consulting' # String |
256
+ opts = {
257
+ 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.
258
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
259
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
260
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
261
+ measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
262
+ }
263
+
264
+ begin
265
+ # Real-world data study conductor footprint (HMA-EMA catalogue)
266
+ result = api_instance.rwd_conductors_rwd_conductor_footprint(id, opts)
267
+ p result
268
+ rescue PharmaObservatory::ApiError => e
269
+ puts "Error when calling RwdConductorsApi->rwd_conductors_rwd_conductor_footprint: #{e}"
270
+ end
271
+ ```
272
+
273
+ #### Using the rwd_conductors_rwd_conductor_footprint_with_http_info variant
274
+
275
+ This returns an Array which contains the response data, status code and headers.
276
+
277
+ > <Array(<RwdConductorFootprintResponse>, Integer, Hash)> rwd_conductors_rwd_conductor_footprint_with_http_info(id, opts)
278
+
279
+ ```ruby
280
+ begin
281
+ # Real-world data study conductor footprint (HMA-EMA catalogue)
282
+ data, status_code, headers = api_instance.rwd_conductors_rwd_conductor_footprint_with_http_info(id, opts)
283
+ p status_code # => 2xx
284
+ p headers # => { ... }
285
+ p data # => <RwdConductorFootprintResponse>
286
+ rescue PharmaObservatory::ApiError => e
287
+ puts "Error when calling RwdConductorsApi->rwd_conductors_rwd_conductor_footprint_with_http_info: #{e}"
288
+ end
289
+ ```
290
+
291
+ ### Parameters
292
+
293
+ | Name | Type | Description | Notes |
294
+ | ---- | ---- | ----------- | ----- |
295
+ | **id** | **String** | | |
296
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
297
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
298
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
299
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
300
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
301
+
302
+ ### Return type
303
+
304
+ [**RwdConductorFootprintResponse**](RwdConductorFootprintResponse.md)
305
+
306
+ ### Authorization
307
+
308
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
309
+
310
+ ### HTTP request headers
311
+
312
+ - **Content-Type**: Not defined
313
+ - **Accept**: application/json
314
+
315
+
316
+ ## rwd_conductors_rwd_conductor_studies
317
+
318
+ > <RwdConductorStudiesResponse> rwd_conductors_rwd_conductor_studies(id, opts)
319
+
320
+ Real-world data study conductor studies (HMA-EMA catalogue)
321
+
322
+ ### Examples
323
+
324
+ ```ruby
325
+ require 'time'
326
+ require 'pharmaobservatory'
327
+ # setup authorization
328
+ PharmaObservatory.configure do |config|
329
+ # Configure Bearer authorization (JWT): ApiBearerJwt
330
+ config.access_token = 'YOUR_BEARER_TOKEN'
331
+ end
332
+
333
+ api_instance = PharmaObservatory::RwdConductorsApi.new
334
+ id = 'seedmark-consulting' # String |
335
+ opts = {
336
+ 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.
337
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
338
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
339
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
340
+ measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
341
+ }
342
+
343
+ begin
344
+ # Real-world data study conductor studies (HMA-EMA catalogue)
345
+ result = api_instance.rwd_conductors_rwd_conductor_studies(id, opts)
346
+ p result
347
+ rescue PharmaObservatory::ApiError => e
348
+ puts "Error when calling RwdConductorsApi->rwd_conductors_rwd_conductor_studies: #{e}"
349
+ end
350
+ ```
351
+
352
+ #### Using the rwd_conductors_rwd_conductor_studies_with_http_info variant
353
+
354
+ This returns an Array which contains the response data, status code and headers.
355
+
356
+ > <Array(<RwdConductorStudiesResponse>, Integer, Hash)> rwd_conductors_rwd_conductor_studies_with_http_info(id, opts)
357
+
358
+ ```ruby
359
+ begin
360
+ # Real-world data study conductor studies (HMA-EMA catalogue)
361
+ data, status_code, headers = api_instance.rwd_conductors_rwd_conductor_studies_with_http_info(id, opts)
362
+ p status_code # => 2xx
363
+ p headers # => { ... }
364
+ p data # => <RwdConductorStudiesResponse>
365
+ rescue PharmaObservatory::ApiError => e
366
+ puts "Error when calling RwdConductorsApi->rwd_conductors_rwd_conductor_studies_with_http_info: #{e}"
367
+ end
368
+ ```
369
+
370
+ ### Parameters
371
+
372
+ | Name | Type | Description | Notes |
373
+ | ---- | ---- | ----------- | ----- |
374
+ | **id** | **String** | | |
375
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
376
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
377
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
378
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
379
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
380
+
381
+ ### Return type
382
+
383
+ [**RwdConductorStudiesResponse**](RwdConductorStudiesResponse.md)
384
+
385
+ ### Authorization
386
+
387
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
388
+
389
+ ### HTTP request headers
390
+
391
+ - **Content-Type**: Not defined
392
+ - **Accept**: application/json
393
+
@@ -0,0 +1,38 @@
1
+ # PharmaObservatory::RwdConductorsRecord
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **object_type** | **String** | | |
8
+ | **id** | **String** | | |
9
+ | **record** | [**RwdConductorsRow**](RwdConductorsRow.md) | | |
10
+ | **attributes** | **Object** | | [optional] |
11
+ | **datasets** | [**Array&lt;DatasetListing&gt;**](DatasetListing.md) | | |
12
+ | **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) | | [optional] |
13
+ | **source_credit** | **String** | | [optional] |
14
+ | **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) | | [optional] |
15
+ | **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) | | [optional] |
16
+ | **build_state** | [**DatasetBuildState**](DatasetBuildState.md) | | [optional] |
17
+ | **restriction** | **Hash&lt;String, Object&gt;** | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'pharmaobservatory'
23
+
24
+ instance = PharmaObservatory::RwdConductorsRecord.new(
25
+ object_type: null,
26
+ id: null,
27
+ record: null,
28
+ attributes: null,
29
+ datasets: null,
30
+ attribution: null,
31
+ source_credit: null,
32
+ freshness: null,
33
+ build: null,
34
+ build_state: null,
35
+ restriction: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::RwdConductorsResponse
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;RwdConductorsRow&gt;**](RwdConductorsRow.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::RwdConductorsResponse.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,72 @@
1
+ # PharmaObservatory::RwdConductorsRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **conductor_id** | **String** | The conductor slug: the register&#39;s normalised institution name key with spaces as hyphens, the id in the web page address (/rwd-conductors/&lt;id&gt;). The entry key of the rwd_conductors object type; injective because no name key carries a hyphen. | [optional] |
8
+ | **conductor_name_key** | **String** | The normalised institution name key the conductor rollup is keyed on; every register institution whose name folds to it is one conductor. | [optional] |
9
+ | **conductor_name** | **String** | The conductor&#39;s display name: one register spelling of the key. | [optional] |
10
+ | **conductor_names** | **Array&lt;String&gt;** | Every register spelling of the key, as the study lists name it. | [optional] |
11
+ | **register_institution_ids** | **Array&lt;String&gt;** | The register Institution IDs of every register row that folds to this conductor (more than one when the register lists the name twice). | [optional] |
12
+ | **register_row_count** | **Integer** | How many register institution rows fold to this conductor; above one means the register lists the name more than once and the counts are per name, not per row. | [optional] |
13
+ | **declared_office_countries** | **Array&lt;String&gt;** | The office country text the register institutions declare, one element per distinct declaration; the office is not where the conductor delivered studies (see rwd_conductor_footprint). | [optional] |
14
+ | **any_encepp_partner** | **Boolean** | True when any register row of the conductor declares itself an ENCePP (European Network of Centres for Pharmacoepidemiology and Pharmacovigilance) partner. | [optional] |
15
+ | **lifetime_studies** | **Integer** | Distinct registered studies the conductor is named as conducting institution on. Not additive with additional_role_studies. | [optional] |
16
+ | **recent_studies** | **Integer** | Conducting studies that started within five years of the snapshot. | [optional] |
17
+ | **ongoing_studies** | **Integer** | Conducting studies whose status is Ongoing. | [optional] |
18
+ | **additional_role_studies** | **Integer** | Distinct registered studies the conductor is named on as an additional institution; a different claim from conducting, never added to it. | [optional] |
19
+ | **mandated_studies** | **Integer** | Conducting studies a regulator required (mandate_stratum mandated). | [optional] |
20
+ | **mandated_share** | **Float** | mandated_studies over lifetime_studies; null when the conductor has no conducting study. | [optional] |
21
+ | **final_report_pairs** | **Integer** | Conducting studies with both a planned and an actual final report date. | [optional] |
22
+ | **backfilled_pairs** | **Integer** | Of those pairs, the studies whose planned and actual date are equal to the day (a likely backfill). | [optional] |
23
+ | **comparable_pairs** | **Integer** | Conducting studies with a final report slip (both dates present and different); the denominator of the delivery figures. | [optional] |
24
+ | **backfilled_share** | **Float** | backfilled_pairs over final_report_pairs; null when there is no pair. | [optional] |
25
+ | **n_floor** | **Integer** | The floor on comparable_pairs below which the median, quartiles and late count are null (suppressed, not zero). | [optional] |
26
+ | **meets_n_floor** | **Boolean** | True when comparable_pairs reaches n_floor, so the slip figures are shown. | [optional] |
27
+ | **median_slip_days** | **Float** | Median final report slip in days (positive is late) over the conductor&#39;s comparable pairs; null below the floor. | [optional] |
28
+ | **p25_slip_days** | **Float** | First quartile of the final report slip in days; null below the floor. | [optional] |
29
+ | **p75_slip_days** | **Float** | Third quartile of the final report slip in days; null below the floor. | [optional] |
30
+ | **late_over_30d** | **Integer** | Comparable studies whose final report slipped more than 30 days; null below the floor. | [optional] |
31
+ | **snapshot_label** | **String** | The label of the catalogue snapshot the row was read from (a date). | [optional] |
32
+ | **accessed_month** | **String** | The month and year the catalogue was accessed (YYYY-MM), which EMA&#39;s site asks to be cited with its URL. | [optional] |
33
+ | **restriction_tier** | **String** | The license restriction tier of the row&#39;s source. Every row of this dataset is licensable (PROVISIONAL, legal read pending). | [optional] |
34
+ | **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] |
35
+
36
+ ## Example
37
+
38
+ ```ruby
39
+ require 'pharmaobservatory'
40
+
41
+ instance = PharmaObservatory::RwdConductorsRow.new(
42
+ conductor_id: null,
43
+ conductor_name_key: null,
44
+ conductor_name: null,
45
+ conductor_names: null,
46
+ register_institution_ids: null,
47
+ register_row_count: null,
48
+ declared_office_countries: null,
49
+ any_encepp_partner: null,
50
+ lifetime_studies: null,
51
+ recent_studies: null,
52
+ ongoing_studies: null,
53
+ additional_role_studies: null,
54
+ mandated_studies: null,
55
+ mandated_share: null,
56
+ final_report_pairs: null,
57
+ backfilled_pairs: null,
58
+ comparable_pairs: null,
59
+ backfilled_share: null,
60
+ n_floor: null,
61
+ meets_n_floor: null,
62
+ median_slip_days: null,
63
+ p25_slip_days: null,
64
+ p75_slip_days: null,
65
+ late_over_30d: null,
66
+ snapshot_label: null,
67
+ accessed_month: null,
68
+ restriction_tier: null,
69
+ attribution: null
70
+ )
71
+ ```
72
+