pharmaobservatory 0.1.4 → 0.1.5
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.
- checksums.yaml +4 -4
- data/README.md +8 -4
- data/docs/ApiV1WhoamiGet200Response.md +13 -1
- data/docs/ApiV1WhoamiGet200ResponseLimits.md +32 -0
- data/docs/ApiV1WhoamiGet200ResponseQuota.md +20 -0
- data/docs/ApiV1WhoamiGet200ResponseQuotaBuckets.md +28 -0
- data/docs/ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md +28 -0
- data/docs/CompaniesRow.md +1 -1
- data/docs/ConditionTrialsRow.md +4 -2
- data/docs/LegalEntitiesRow.md +1 -1
- data/docs/SiteTrialsRow.md +3 -1
- data/docs/SponsorTrialsRow.md +4 -2
- data/docs/TrialDeliveryRow.md +7 -5
- data/docs/TrialEnrollmentRateRow.md +5 -3
- data/docs/TrialsRow.md +3 -3
- data/lib/pharmaobservatory/models/api_v1_whoami_get200_response.rb +62 -4
- data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_limits.rb +419 -0
- data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_quota.rb +263 -0
- data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_quota_buckets.rb +367 -0
- data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_quota_buckets_requests_per_minute.rb +367 -0
- data/lib/pharmaobservatory/models/companies_row.rb +1 -1
- data/lib/pharmaobservatory/models/condition_trials_row.rb +14 -3
- data/lib/pharmaobservatory/models/legal_entities_row.rb +1 -1
- data/lib/pharmaobservatory/models/site_trials_row.rb +13 -2
- data/lib/pharmaobservatory/models/sponsor_trials_row.rb +14 -3
- data/lib/pharmaobservatory/models/trial_delivery_row.rb +22 -11
- data/lib/pharmaobservatory/models/trial_enrollment_rate_row.rb +15 -4
- data/lib/pharmaobservatory/models/trials_row.rb +3 -3
- data/lib/pharmaobservatory/version.rb +1 -1
- data/lib/pharmaobservatory.rb +4 -0
- metadata +10 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6ffeec6b419dc15d5c32a280ef1469a180de04fc445f3a3e87e826d99ce4b197
|
|
4
|
+
data.tar.gz: 35d53c85a65df008e5b13a37d219f4a4928454cdabab5862c590fb43f1e34849
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 964df18c43a0df959d7f0d3760e46fe4f0eb1dd7b9757ef3f43b1de864f102d9f42c1c9ebfc5c7ecb9e773f89b4c63e3119740d33003aebcf1b62ab023664832
|
|
7
|
+
data.tar.gz: b8a4ab84755f06f307e02f6b92641bd3fbf0f5c308169585631ba2d300df790340e558a91d9c8cb1f333bd137cb4cc7bd0086c64bfaec59939687f132fe54ca5
|
data/README.md
CHANGED
|
@@ -39,7 +39,7 @@ Read-only REST API over the Pharma Observatory biomedical data platform. Referen
|
|
|
39
39
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
40
40
|
|
|
41
41
|
- API version: 1.0.0
|
|
42
|
-
- Package version: 0.1.
|
|
42
|
+
- Package version: 0.1.5
|
|
43
43
|
- Generator version: 7.13.0
|
|
44
44
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
45
45
|
|
|
@@ -56,16 +56,16 @@ gem build pharmaobservatory.gemspec
|
|
|
56
56
|
Then either install the gem locally:
|
|
57
57
|
|
|
58
58
|
```shell
|
|
59
|
-
gem install ./pharmaobservatory-0.1.
|
|
59
|
+
gem install ./pharmaobservatory-0.1.5.gem
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
(for development, run `gem install --dev ./pharmaobservatory-0.1.
|
|
62
|
+
(for development, run `gem install --dev ./pharmaobservatory-0.1.5.gem` to install the development dependencies)
|
|
63
63
|
|
|
64
64
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
65
65
|
|
|
66
66
|
Finally add this to the Gemfile:
|
|
67
67
|
|
|
68
|
-
gem 'pharmaobservatory', '~> 0.1.
|
|
68
|
+
gem 'pharmaobservatory', '~> 0.1.5'
|
|
69
69
|
|
|
70
70
|
### Install from Git
|
|
71
71
|
|
|
@@ -208,6 +208,10 @@ Class | Method | HTTP request | Description
|
|
|
208
208
|
## Documentation for Models
|
|
209
209
|
|
|
210
210
|
- [PharmaObservatory::ApiV1WhoamiGet200Response](docs/ApiV1WhoamiGet200Response.md)
|
|
211
|
+
- [PharmaObservatory::ApiV1WhoamiGet200ResponseLimits](docs/ApiV1WhoamiGet200ResponseLimits.md)
|
|
212
|
+
- [PharmaObservatory::ApiV1WhoamiGet200ResponseQuota](docs/ApiV1WhoamiGet200ResponseQuota.md)
|
|
213
|
+
- [PharmaObservatory::ApiV1WhoamiGet200ResponseQuotaBuckets](docs/ApiV1WhoamiGet200ResponseQuotaBuckets.md)
|
|
214
|
+
- [PharmaObservatory::ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute](docs/ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md)
|
|
211
215
|
- [PharmaObservatory::AuthError](docs/AuthError.md)
|
|
212
216
|
- [PharmaObservatory::BiomarkerBqpAssertionsResponse](docs/BiomarkerBqpAssertionsResponse.md)
|
|
213
217
|
- [PharmaObservatory::BiomarkerBqpAssertionsRow](docs/BiomarkerBqpAssertionsRow.md)
|
|
@@ -7,6 +7,12 @@
|
|
|
7
7
|
| **ok** | **Boolean** | | |
|
|
8
8
|
| **sub** | **String** | | |
|
|
9
9
|
| **roles** | **Array<String>** | | |
|
|
10
|
+
| **name** | **Object** | | [optional] |
|
|
11
|
+
| **email** | **Object** | | [optional] |
|
|
12
|
+
| **organization** | **Object** | | [optional] |
|
|
13
|
+
| **plan** | **Object** | | [optional] |
|
|
14
|
+
| **limits** | [**ApiV1WhoamiGet200ResponseLimits**](ApiV1WhoamiGet200ResponseLimits.md) | | [optional] |
|
|
15
|
+
| **quota** | [**ApiV1WhoamiGet200ResponseQuota**](ApiV1WhoamiGet200ResponseQuota.md) | | [optional] |
|
|
10
16
|
|
|
11
17
|
## Example
|
|
12
18
|
|
|
@@ -16,7 +22,13 @@ require 'pharmaobservatory'
|
|
|
16
22
|
instance = PharmaObservatory::ApiV1WhoamiGet200Response.new(
|
|
17
23
|
ok: null,
|
|
18
24
|
sub: null,
|
|
19
|
-
roles: null
|
|
25
|
+
roles: null,
|
|
26
|
+
name: null,
|
|
27
|
+
email: null,
|
|
28
|
+
organization: null,
|
|
29
|
+
plan: null,
|
|
30
|
+
limits: null,
|
|
31
|
+
quota: null
|
|
20
32
|
)
|
|
21
33
|
```
|
|
22
34
|
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# PharmaObservatory::ApiV1WhoamiGet200ResponseLimits
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **defaults_from** | **String** | | |
|
|
8
|
+
| **requests_per_minute** | **Integer** | | |
|
|
9
|
+
| **requests_per_day** | **Integer** | | |
|
|
10
|
+
| **rows_per_day** | **Integer** | | |
|
|
11
|
+
| **paging_depth** | **Integer** | | |
|
|
12
|
+
| **rwd_catalogue_calls_per_day** | **Integer** | | |
|
|
13
|
+
| **benzinga_calls_per_day** | **Integer** | | |
|
|
14
|
+
| **query_seconds_per_day** | **Integer** | | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'pharmaobservatory'
|
|
20
|
+
|
|
21
|
+
instance = PharmaObservatory::ApiV1WhoamiGet200ResponseLimits.new(
|
|
22
|
+
defaults_from: null,
|
|
23
|
+
requests_per_minute: null,
|
|
24
|
+
requests_per_day: null,
|
|
25
|
+
rows_per_day: null,
|
|
26
|
+
paging_depth: null,
|
|
27
|
+
rwd_catalogue_calls_per_day: null,
|
|
28
|
+
benzinga_calls_per_day: null,
|
|
29
|
+
query_seconds_per_day: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PharmaObservatory::ApiV1WhoamiGet200ResponseQuota
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **keyed_by** | **String** | | |
|
|
8
|
+
| **buckets** | [**ApiV1WhoamiGet200ResponseQuotaBuckets**](ApiV1WhoamiGet200ResponseQuotaBuckets.md) | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'pharmaobservatory'
|
|
14
|
+
|
|
15
|
+
instance = PharmaObservatory::ApiV1WhoamiGet200ResponseQuota.new(
|
|
16
|
+
keyed_by: null,
|
|
17
|
+
buckets: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# PharmaObservatory::ApiV1WhoamiGet200ResponseQuotaBuckets
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **requests_per_minute** | [**ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute**](ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md) | | |
|
|
8
|
+
| **requests_per_day** | [**ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute**](ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md) | | |
|
|
9
|
+
| **rows_per_day** | [**ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute**](ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md) | | |
|
|
10
|
+
| **rwd_catalogue_calls_per_day** | [**ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute**](ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md) | | |
|
|
11
|
+
| **benzinga_calls_per_day** | [**ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute**](ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md) | | |
|
|
12
|
+
| **query_seconds_per_day** | [**ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute**](ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.md) | | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'pharmaobservatory'
|
|
18
|
+
|
|
19
|
+
instance = PharmaObservatory::ApiV1WhoamiGet200ResponseQuotaBuckets.new(
|
|
20
|
+
requests_per_minute: null,
|
|
21
|
+
requests_per_day: null,
|
|
22
|
+
rows_per_day: null,
|
|
23
|
+
rwd_catalogue_calls_per_day: null,
|
|
24
|
+
benzinga_calls_per_day: null,
|
|
25
|
+
query_seconds_per_day: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# PharmaObservatory::ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **unit** | **String** | | |
|
|
8
|
+
| **window** | **String** | | |
|
|
9
|
+
| **limit** | **Integer** | | |
|
|
10
|
+
| **used** | **Integer** | | |
|
|
11
|
+
| **remaining** | **Integer** | | |
|
|
12
|
+
| **resets_at** | **String** | | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'pharmaobservatory'
|
|
18
|
+
|
|
19
|
+
instance = PharmaObservatory::ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute.new(
|
|
20
|
+
unit: null,
|
|
21
|
+
window: null,
|
|
22
|
+
limit: null,
|
|
23
|
+
used: null,
|
|
24
|
+
remaining: null,
|
|
25
|
+
resets_at: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/CompaniesRow.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **company_name** | **String** | The company's display name: its own legal entity's name where one is known. | [optional] |
|
|
9
9
|
| **name_basis** | **String** | Which source supplied the name: gleif_legal_name, edgar_registrant, ror or sponsor_display_name. | [optional] |
|
|
10
10
|
| **country** | **String** | Country of the company's own legal entity, as the source states it. | [optional] |
|
|
11
|
-
| **org_type** | **String** | The organization type of the company's representative record. | [optional] |
|
|
11
|
+
| **org_type** | **String** | The organization type of the company's representative record: Academic, Government, Hospital, Industry, Nonprofit or Other (from the ROR record or the filing), or the lowercase tags investor and manufacturer that mark a minted adviser or manufacturer record. | [optional] |
|
|
12
12
|
| **org_kinds** | **Array<String>** | The roles the company's organizations play (Manufacturer, Sponsor and so on). | [optional] |
|
|
13
13
|
| **edgar_cik** | **String** | Central index key (CIK) in EDGAR, the US Securities and Exchange Commission (SEC) filing system, of the representative record, when it files. | [optional] |
|
|
14
14
|
| **edgar_ticker** | **String** | Exchange ticker of the representative record, when listed. | [optional] |
|
data/docs/ConditionTrialsRow.md
CHANGED
|
@@ -10,7 +10,8 @@
|
|
|
10
10
|
| **is_direct** | **Boolean** | True when the trial is tagged with this condition itself; false when it is tagged with a condition beneath it in the MeSH tree. | [optional] |
|
|
11
11
|
| **trial_title** | **String** | The trial's brief title. | [optional] |
|
|
12
12
|
| **study_type** | **String** | The registry's study type (INTERVENTIONAL, OBSERVATIONAL or EXPANDED_ACCESS). | [optional] |
|
|
13
|
-
| **phase** | **String** | The
|
|
13
|
+
| **phase** | **String** | The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA and so on). Null when the registry gives no phase (observational and expanded-access trials); phase_label carries the display label for those. | [optional] |
|
|
14
|
+
| **phase_label** | **String** | The trial phase as a display label (Phase 2, Phase 3, Observational, Not applicable, Expanded access, Unknown). The same trial's phase column holds the registry code. | [optional] |
|
|
14
15
|
| **overall_status** | **String** | The registry's overall recruitment status (COMPLETED, RECRUITING, TERMINATED and so on). | [optional] |
|
|
15
16
|
| **start_date** | **Date** | Trial start date as registered. | [optional] |
|
|
16
17
|
| **start_year** | **Integer** | Calendar year of the start date. | [optional] |
|
|
@@ -24,7 +25,7 @@
|
|
|
24
25
|
| **sponsor_company_name** | **String** | The lead sponsor's company name. | [optional] |
|
|
25
26
|
| **sponsor_group_id** | **String** | Group level: the current ultimate parent of the lead sponsor's company; dated links are in company_members. | [optional] |
|
|
26
27
|
| **sponsor_group_name** | **String** | Display name of the lead sponsor's group. | [optional] |
|
|
27
|
-
| **sponsor_agency_class** | **String** | The registry
|
|
28
|
+
| **sponsor_agency_class** | **String** | The funder class the registry declared for the sponsor (INDUSTRY, NIH, FED, OTHER_GOV, NETWORK, OTHER, INDIV, AMBIG, UNKNOWN). UNKNOWN is the registry's own code for a class it does not state. Null when the trial has no lead sponsor row. | [optional] |
|
|
28
29
|
|
|
29
30
|
## Example
|
|
30
31
|
|
|
@@ -39,6 +40,7 @@ instance = PharmaObservatory::ConditionTrialsRow.new(
|
|
|
39
40
|
trial_title: null,
|
|
40
41
|
study_type: null,
|
|
41
42
|
phase: null,
|
|
43
|
+
phase_label: null,
|
|
42
44
|
overall_status: null,
|
|
43
45
|
start_date: null,
|
|
44
46
|
start_year: null,
|
data/docs/LegalEntitiesRow.md
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **is_name_resolved_sponsor** | **Boolean** | True for a sponsor resolved from a filed name alone rather than from a registration. | [optional] |
|
|
10
10
|
| **org_origin** | **String** | How the organization record was minted. | [optional] |
|
|
11
11
|
| **country** | **String** | Country as the source states it. | [optional] |
|
|
12
|
-
| **org_type** | **String** | Organization type. | [optional] |
|
|
12
|
+
| **org_type** | **String** | Organization type: Academic, Government, Hospital, Industry, Nonprofit or Other (from the ROR record or the filing), or the lowercase tags investor and manufacturer that mark a minted adviser or manufacturer record. | [optional] |
|
|
13
13
|
| **edgar_cik** | **String** | Central index key (CIK) in EDGAR, the US Securities and Exchange Commission (SEC) filing system, when it files. | [optional] |
|
|
14
14
|
| **edgar_ticker** | **String** | Exchange ticker, when listed. | [optional] |
|
|
15
15
|
| **ror_id** | **String** | Research Organization Registry id, when it has one. | [optional] |
|
data/docs/SiteTrialsRow.md
CHANGED
|
@@ -8,7 +8,8 @@
|
|
|
8
8
|
| **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
|
|
9
9
|
| **trial_title** | **String** | The trial's brief title. | [optional] |
|
|
10
10
|
| **study_type** | **String** | INTERVENTIONAL or OBSERVATIONAL. | [optional] |
|
|
11
|
-
| **phase** | **String** | The
|
|
11
|
+
| **phase** | **String** | The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA and so on). Null when the registry gives no phase (observational and expanded-access trials); phase_label carries the display label for those. | [optional] |
|
|
12
|
+
| **phase_label** | **String** | The trial phase as a display label (Phase 2, Phase 3, Observational, Not applicable, Expanded access, Unknown). The same trial's phase column holds the registry code. | [optional] |
|
|
12
13
|
| **overall_status** | **String** | The registry's overall status. | [optional] |
|
|
13
14
|
| **start_date** | **Date** | Trial start date. | [optional] |
|
|
14
15
|
| **start_year** | **Integer** | Year of the trial start. | [optional] |
|
|
@@ -31,6 +32,7 @@ instance = PharmaObservatory::SiteTrialsRow.new(
|
|
|
31
32
|
trial_title: null,
|
|
32
33
|
study_type: null,
|
|
33
34
|
phase: null,
|
|
35
|
+
phase_label: null,
|
|
34
36
|
overall_status: null,
|
|
35
37
|
start_date: null,
|
|
36
38
|
start_year: null,
|
data/docs/SponsorTrialsRow.md
CHANGED
|
@@ -12,11 +12,12 @@
|
|
|
12
12
|
| **sponsor_company_name** | **String** | Display name of the sponsor's company. | [optional] |
|
|
13
13
|
| **sponsor_group_id** | **String** | Group level: the sponsor's current ultimate parent company; a root company's group is itself. | [optional] |
|
|
14
14
|
| **sponsor_group_name** | **String** | Display name of the sponsor's group. | [optional] |
|
|
15
|
-
| **sponsor_agency_class** | **String** | The registry
|
|
15
|
+
| **sponsor_agency_class** | **String** | The funder class the registry declared for the sponsor (INDUSTRY, NIH, FED, OTHER_GOV, NETWORK, OTHER, INDIV, AMBIG, UNKNOWN). UNKNOWN is the registry's own code for a class it does not state. | [optional] |
|
|
16
16
|
| **sponsor_resolution_method** | **String** | How the sponsor name was resolved to an organization record. | [optional] |
|
|
17
17
|
| **trial_title** | **String** | The trial's brief title. | [optional] |
|
|
18
18
|
| **study_type** | **String** | INTERVENTIONAL or OBSERVATIONAL. | [optional] |
|
|
19
|
-
| **phase** | **String** | The
|
|
19
|
+
| **phase** | **String** | The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA and so on). Null when the registry gives no phase (observational and expanded-access trials); phase_label carries the display label for those. | [optional] |
|
|
20
|
+
| **phase_label** | **String** | The trial phase as a display label (Phase 2, Phase 3, Observational, Not applicable, Expanded access, Unknown). The same trial's phase column holds the registry code. | [optional] |
|
|
20
21
|
| **overall_status** | **String** | The registry's overall status. | [optional] |
|
|
21
22
|
| **start_date** | **Date** | Trial start date. | [optional] |
|
|
22
23
|
| **start_year** | **Integer** | Year of the trial start. | [optional] |
|
|
@@ -45,6 +46,7 @@ instance = PharmaObservatory::SponsorTrialsRow.new(
|
|
|
45
46
|
trial_title: null,
|
|
46
47
|
study_type: null,
|
|
47
48
|
phase: null,
|
|
49
|
+
phase_label: null,
|
|
48
50
|
overall_status: null,
|
|
49
51
|
start_date: null,
|
|
50
52
|
start_year: null,
|
data/docs/TrialDeliveryRow.md
CHANGED
|
@@ -8,22 +8,23 @@
|
|
|
8
8
|
| **lead_sponsor_name** | **String** | The lead sponsor name as filed. | [optional] |
|
|
9
9
|
| **overall_status_summary** | **String** | A coarse status label (Recruiting, Completed and so on). | [optional] |
|
|
10
10
|
| **study_type** | **String** | INTERVENTIONAL, OBSERVATIONAL or EXPANDED_ACCESS. | [optional] |
|
|
11
|
-
| **phase** | **String** | The registry's phase code. | [optional] |
|
|
11
|
+
| **phase** | **String** | The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA and so on). Null when the registry gives no phase (observational and expanded-access trials); phase_label carries the display label for those. | [optional] |
|
|
12
|
+
| **phase_label** | **String** | The trial phase as a display label (Phase 2, Phase 3, Observational, Not applicable, Expanded access, Unknown). The same trial's phase column holds the registry code. | [optional] |
|
|
12
13
|
| **planned_enrollment** | **Integer** | Planned enrollment from the earliest snapshot typed ESTIMATED. | [optional] |
|
|
13
14
|
| **actual_enrollment** | **Integer** | Enrollment from the latest observation typed ACTUAL. | [optional] |
|
|
14
15
|
| **enrollment_type** | **String** | Enrollment type on the current record (ACTUAL or ESTIMATED). | [optional] |
|
|
15
16
|
| **enrollment_delta** | **Integer** | Actual minus planned enrollment (null without both). | [optional] |
|
|
16
17
|
| **enrollment_attainment_pct** | **Float** | Actual as a percentage of planned enrollment (null without both). | [optional] |
|
|
17
18
|
| **enrollment_met** | **Boolean** | Whether actual enrollment reached the plan (null without both). | [optional] |
|
|
18
|
-
| **
|
|
19
|
+
| **enrollment_delta_known** | **Boolean** | Whether a planned and an actual enrollment are both recorded. | [optional] |
|
|
19
20
|
| **planned_basis** | **String** | Where the planned enrollment came from: history_earliest_estimated, type_estimated_current or none. | [optional] |
|
|
20
21
|
| **actual_basis** | **String** | How the actual enrollment was taken (from the snapshot history, from the current record, or none). | [optional] |
|
|
21
22
|
| **planned_primary_completion_date** | **Date** | Planned primary completion date from the earliest snapshot typed ESTIMATED. | [optional] |
|
|
22
23
|
| **actual_primary_completion_date** | **Date** | Primary completion date once typed ACTUAL. | [optional] |
|
|
23
24
|
| **planned_completion_date** | **Date** | Planned completion date from the earliest snapshot typed ESTIMATED. | [optional] |
|
|
24
25
|
| **actual_completion_date** | **Date** | Completion date once typed ACTUAL. | [optional] |
|
|
25
|
-
| **primary_completion_date_type** | **String** |
|
|
26
|
-
| **completion_date_type** | **String** |
|
|
26
|
+
| **primary_completion_date_type** | **String** | ACTUAL (a date that has occurred) or ESTIMATED (a planned date). The registry's older ANTICIPATED is published as ESTIMATED. | [optional] |
|
|
27
|
+
| **completion_date_type** | **String** | ACTUAL (a date that has occurred) or ESTIMATED (a planned date). The registry's older ANTICIPATED is published as ESTIMATED. | [optional] |
|
|
27
28
|
| **primary_completion_slip_days** | **Integer** | Actual minus planned primary completion date; positive is later than planned (null without both). | [optional] |
|
|
28
29
|
| **completion_slip_days** | **Integer** | Actual minus planned completion date; positive is later than planned (null without both). | [optional] |
|
|
29
30
|
| **completion_slipped** | **Boolean** | Whether the primary completion came later than planned (null without both). | [optional] |
|
|
@@ -40,13 +41,14 @@ instance = PharmaObservatory::TrialDeliveryRow.new(
|
|
|
40
41
|
overall_status_summary: null,
|
|
41
42
|
study_type: null,
|
|
42
43
|
phase: null,
|
|
44
|
+
phase_label: null,
|
|
43
45
|
planned_enrollment: null,
|
|
44
46
|
actual_enrollment: null,
|
|
45
47
|
enrollment_type: null,
|
|
46
48
|
enrollment_delta: null,
|
|
47
49
|
enrollment_attainment_pct: null,
|
|
48
50
|
enrollment_met: null,
|
|
49
|
-
|
|
51
|
+
enrollment_delta_known: null,
|
|
50
52
|
planned_basis: null,
|
|
51
53
|
actual_basis: null,
|
|
52
54
|
planned_primary_completion_date: null,
|
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
|
|
8
|
-
| **phase** | **String** | The registry's phase code. | [optional] |
|
|
8
|
+
| **phase** | **String** | The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA and so on). Null when the registry gives no phase (observational and expanded-access trials); phase_label carries the display label for those. | [optional] |
|
|
9
|
+
| **phase_label** | **String** | The trial phase as a display label (Phase 2, Phase 3, Observational, Not applicable, Expanded access, Unknown). The same trial's phase column holds the registry code. | [optional] |
|
|
9
10
|
| **lead_sponsor_name** | **String** | The lead sponsor name as filed. | [optional] |
|
|
10
11
|
| **overall_status_summary** | **String** | A coarse status label (Completed and so on). | [optional] |
|
|
11
12
|
| **actual_enrollment** | **Integer** | Enrollment typed ACTUAL. | [optional] |
|
|
@@ -17,8 +18,8 @@
|
|
|
17
18
|
| **start_date** | **Date** | Trial start date. | [optional] |
|
|
18
19
|
| **primary_completion_date** | **Date** | Primary completion date. | [optional] |
|
|
19
20
|
| **completion_date** | **Date** | Completion date. | [optional] |
|
|
20
|
-
| **primary_completion_date_type** | **String** | ACTUAL or ESTIMATED. | [optional] |
|
|
21
|
-
| **completion_date_type** | **String** | ACTUAL or ESTIMATED. | [optional] |
|
|
21
|
+
| **primary_completion_date_type** | **String** | ACTUAL (a date that has occurred) or ESTIMATED (a planned date). The registry's older ANTICIPATED is published as ESTIMATED. | [optional] |
|
|
22
|
+
| **completion_date_type** | **String** | ACTUAL (a date that has occurred) or ESTIMATED (a planned date). The registry's older ANTICIPATED is published as ESTIMATED. | [optional] |
|
|
22
23
|
| **is_rate_computable** | **Boolean** | Whether the inputs support a rate. | [optional] |
|
|
23
24
|
| **rate_flag_reason** | **String** | Why a rate could not be computed (null when it could). | [optional] |
|
|
24
25
|
| **duration_months** | **Float** | Months from start to primary completion. | [optional] |
|
|
@@ -34,6 +35,7 @@ require 'pharmaobservatory'
|
|
|
34
35
|
instance = PharmaObservatory::TrialEnrollmentRateRow.new(
|
|
35
36
|
trial_id: null,
|
|
36
37
|
phase: null,
|
|
38
|
+
phase_label: null,
|
|
37
39
|
lead_sponsor_name: null,
|
|
38
40
|
overall_status_summary: null,
|
|
39
41
|
actual_enrollment: null,
|
data/docs/TrialsRow.md
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **study_type** | **String** | INTERVENTIONAL, OBSERVATIONAL or EXPANDED_ACCESS. | [optional] |
|
|
11
11
|
| **overall_status** | **String** | The registry's overall status code (RECRUITING, COMPLETED, TERMINATED and so on). | [optional] |
|
|
12
12
|
| **overall_status_summary** | **String** | A coarse status label derived from the overall status (Recruiting, Completed, Discontinued and so on). | [optional] |
|
|
13
|
-
| **phase** | **String** | The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA). | [optional] |
|
|
13
|
+
| **phase** | **String** | The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA and so on). Null when the registry gives no phase (observational and expanded-access trials); phase_label carries the display label for those. | [optional] |
|
|
14
14
|
| **phase_label** | **String** | The trial phase as a label (Phase 2, Phase 3, Observational, Not applicable). | [optional] |
|
|
15
15
|
| **phase_by_status** | **String** | The phase code and the status summary joined with a colon (PHASE2:Completed). | [optional] |
|
|
16
16
|
| **enrollment** | **Integer** | Enrollment as registered: a planned target or an achieved count (see enrollment_type). | [optional] |
|
|
@@ -20,9 +20,9 @@
|
|
|
20
20
|
| **start_date** | **Date** | Trial start date. | [optional] |
|
|
21
21
|
| **start_year** | **Integer** | Year of the trial start. | [optional] |
|
|
22
22
|
| **primary_completion_date** | **Date** | Primary completion date. | [optional] |
|
|
23
|
-
| **primary_completion_date_type** | **String** | ACTUAL (a date that has occurred) or ESTIMATED (a planned date). | [optional] |
|
|
23
|
+
| **primary_completion_date_type** | **String** | ACTUAL (a date that has occurred) or ESTIMATED (a planned date). The registry's older ANTICIPATED is published as ESTIMATED. | [optional] |
|
|
24
24
|
| **completion_date** | **Date** | Completion date. | [optional] |
|
|
25
|
-
| **completion_date_type** | **String** | ACTUAL (a date that has occurred) or ESTIMATED (a planned date). | [optional] |
|
|
25
|
+
| **completion_date_type** | **String** | ACTUAL (a date that has occurred) or ESTIMATED (a planned date). The registry's older ANTICIPATED is published as ESTIMATED. | [optional] |
|
|
26
26
|
| **study_first_posted_date** | **Date** | Date the study was first posted to the registry. | [optional] |
|
|
27
27
|
| **last_update_posted_date** | **Date** | Date the registry record was last updated. | [optional] |
|
|
28
28
|
| **why_stopped** | **String** | The sponsor's stated reason a trial was stopped early, as filed. | [optional] |
|
|
@@ -21,12 +21,30 @@ module PharmaObservatory
|
|
|
21
21
|
|
|
22
22
|
attr_accessor :roles
|
|
23
23
|
|
|
24
|
+
attr_accessor :name
|
|
25
|
+
|
|
26
|
+
attr_accessor :email
|
|
27
|
+
|
|
28
|
+
attr_accessor :organization
|
|
29
|
+
|
|
30
|
+
attr_accessor :plan
|
|
31
|
+
|
|
32
|
+
attr_accessor :limits
|
|
33
|
+
|
|
34
|
+
attr_accessor :quota
|
|
35
|
+
|
|
24
36
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
25
37
|
def self.attribute_map
|
|
26
38
|
{
|
|
27
39
|
:'ok' => :'ok',
|
|
28
40
|
:'sub' => :'sub',
|
|
29
|
-
:'roles' => :'roles'
|
|
41
|
+
:'roles' => :'roles',
|
|
42
|
+
:'name' => :'name',
|
|
43
|
+
:'email' => :'email',
|
|
44
|
+
:'organization' => :'organization',
|
|
45
|
+
:'plan' => :'plan',
|
|
46
|
+
:'limits' => :'limits',
|
|
47
|
+
:'quota' => :'quota'
|
|
30
48
|
}
|
|
31
49
|
end
|
|
32
50
|
|
|
@@ -45,13 +63,23 @@ module PharmaObservatory
|
|
|
45
63
|
{
|
|
46
64
|
:'ok' => :'Boolean',
|
|
47
65
|
:'sub' => :'String',
|
|
48
|
-
:'roles' => :'Array<String>'
|
|
66
|
+
:'roles' => :'Array<String>',
|
|
67
|
+
:'name' => :'Object',
|
|
68
|
+
:'email' => :'Object',
|
|
69
|
+
:'organization' => :'Object',
|
|
70
|
+
:'plan' => :'Object',
|
|
71
|
+
:'limits' => :'ApiV1WhoamiGet200ResponseLimits',
|
|
72
|
+
:'quota' => :'ApiV1WhoamiGet200ResponseQuota'
|
|
49
73
|
}
|
|
50
74
|
end
|
|
51
75
|
|
|
52
76
|
# List of attributes with nullable: true
|
|
53
77
|
def self.openapi_nullable
|
|
54
78
|
Set.new([
|
|
79
|
+
:'name',
|
|
80
|
+
:'email',
|
|
81
|
+
:'organization',
|
|
82
|
+
:'plan',
|
|
55
83
|
])
|
|
56
84
|
end
|
|
57
85
|
|
|
@@ -90,6 +118,30 @@ module PharmaObservatory
|
|
|
90
118
|
else
|
|
91
119
|
self.roles = nil
|
|
92
120
|
end
|
|
121
|
+
|
|
122
|
+
if attributes.key?(:'name')
|
|
123
|
+
self.name = attributes[:'name']
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
if attributes.key?(:'email')
|
|
127
|
+
self.email = attributes[:'email']
|
|
128
|
+
end
|
|
129
|
+
|
|
130
|
+
if attributes.key?(:'organization')
|
|
131
|
+
self.organization = attributes[:'organization']
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
if attributes.key?(:'plan')
|
|
135
|
+
self.plan = attributes[:'plan']
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
if attributes.key?(:'limits')
|
|
139
|
+
self.limits = attributes[:'limits']
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
if attributes.key?(:'quota')
|
|
143
|
+
self.quota = attributes[:'quota']
|
|
144
|
+
end
|
|
93
145
|
end
|
|
94
146
|
|
|
95
147
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -159,7 +211,13 @@ module PharmaObservatory
|
|
|
159
211
|
self.class == o.class &&
|
|
160
212
|
ok == o.ok &&
|
|
161
213
|
sub == o.sub &&
|
|
162
|
-
roles == o.roles
|
|
214
|
+
roles == o.roles &&
|
|
215
|
+
name == o.name &&
|
|
216
|
+
email == o.email &&
|
|
217
|
+
organization == o.organization &&
|
|
218
|
+
plan == o.plan &&
|
|
219
|
+
limits == o.limits &&
|
|
220
|
+
quota == o.quota
|
|
163
221
|
end
|
|
164
222
|
|
|
165
223
|
# @see the `==` method
|
|
@@ -171,7 +229,7 @@ module PharmaObservatory
|
|
|
171
229
|
# Calculates hash code according to all attributes.
|
|
172
230
|
# @return [Integer] Hash code
|
|
173
231
|
def hash
|
|
174
|
-
[ok, sub, roles].hash
|
|
232
|
+
[ok, sub, roles, name, email, organization, plan, limits, quota].hash
|
|
175
233
|
end
|
|
176
234
|
|
|
177
235
|
# Builds the object from hash
|