pharmaobservatory 0.1.13 → 0.1.15

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 (47) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -5
  3. data/docs/BiomarkerValidationRow.md +1 -1
  4. data/docs/ChangesList200Response.md +26 -0
  5. data/docs/ChangesList200ResponseBuildState.md +20 -0
  6. data/docs/ChangesList200ResponseItemsInner.md +48 -0
  7. data/docs/ChangesList200ResponseItemsInnerEntryKeys.md +18 -0
  8. data/docs/CompaniesApi.md +86 -4
  9. data/docs/CompanyAssetCollisionsResponse.md +58 -0
  10. data/docs/CompanyAssetCollisionsRow.md +68 -0
  11. data/docs/CompanyCompetitorsRow.md +16 -32
  12. data/docs/CompanyFinancialsRow.md +18 -0
  13. data/docs/ConditionAdverseEventsRow.md +5 -1
  14. data/docs/SubscriptionsApi.md +282 -0
  15. data/docs/SubscriptionsCreate201Response.md +22 -0
  16. data/docs/SubscriptionsCreate201ResponseSubscription.md +28 -0
  17. data/docs/SubscriptionsCreate201ResponseSubscriptionTarget.md +22 -0
  18. data/docs/SubscriptionsCreateRequest.md +20 -0
  19. data/docs/SubscriptionsDelete200Response.md +24 -0
  20. data/docs/SubscriptionsList200Response.md +22 -0
  21. data/docs/SubscriptionsList200ResponseSubscriptionsInner.md +28 -0
  22. data/docs/SubscriptionsList200ResponseSubscriptionsInnerTarget.md +26 -0
  23. data/docs/SubscriptionsList200ResponseSubscriptionsInnerTargetFilters.md +18 -0
  24. data/lib/pharmaobservatory/api/companies_api.rb +93 -2
  25. data/lib/pharmaobservatory/api/subscriptions_api.rb +261 -0
  26. data/lib/pharmaobservatory/models/biomarker_validation_row.rb +1 -1
  27. data/lib/pharmaobservatory/models/changes_list200_response.rb +343 -0
  28. data/lib/pharmaobservatory/models/changes_list200_response_build_state.rb +263 -0
  29. data/lib/pharmaobservatory/models/changes_list200_response_items_inner.rb +627 -0
  30. data/lib/pharmaobservatory/models/changes_list200_response_items_inner_entry_keys.rb +237 -0
  31. data/lib/pharmaobservatory/models/company_asset_collisions_response.rb +478 -0
  32. data/lib/pharmaobservatory/models/company_asset_collisions_row.rb +502 -0
  33. data/lib/pharmaobservatory/models/company_competitors_row.rb +61 -153
  34. data/lib/pharmaobservatory/models/company_financials_row.rb +100 -1
  35. data/lib/pharmaobservatory/models/condition_adverse_events_row.rb +27 -5
  36. data/lib/pharmaobservatory/models/subscriptions_create201_response.rb +289 -0
  37. data/lib/pharmaobservatory/models/subscriptions_create201_response_subscription.rb +369 -0
  38. data/lib/pharmaobservatory/models/subscriptions_create201_response_subscription_target.rb +289 -0
  39. data/lib/pharmaobservatory/models/subscriptions_create_request.rb +263 -0
  40. data/lib/pharmaobservatory/models/subscriptions_delete200_response.rb +315 -0
  41. data/lib/pharmaobservatory/models/subscriptions_list200_response.rb +291 -0
  42. data/lib/pharmaobservatory/models/subscriptions_list200_response_subscriptions_inner.rb +369 -0
  43. data/lib/pharmaobservatory/models/subscriptions_list200_response_subscriptions_inner_target.rb +277 -0
  44. data/lib/pharmaobservatory/models/subscriptions_list200_response_subscriptions_inner_target_filters.rb +237 -0
  45. data/lib/pharmaobservatory/version.rb +1 -1
  46. data/lib/pharmaobservatory.rb +16 -0
  47. metadata +34 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 71ae86e3ce01b4372a57a9c70f1180e1e31b489d07e8f65aeddf8ae48094f0a9
4
- data.tar.gz: '095ecccdb148e450846277245dbadaa0dcea2af294d5f07545686abd6ff8790d'
3
+ metadata.gz: a650a5fbd88e22cb8d5944c1e9c073f6e75e8f46131279503c697121a04a1177
4
+ data.tar.gz: d8dcdc1cc45826be2f252ed87abe4930db581a3eb54ced7818fa43adea3adc8f
5
5
  SHA512:
6
- metadata.gz: c60cd42981cbb37923a33487258e78c2f0e6391efb9a905a0f742bceb1a61ec516667c2ba971b24a48552b304d212e01a1abf67c58092260fdada00b204f106e
7
- data.tar.gz: 01ac5654d2b5eb644ca9cc3184ddab4934fe1e4057956eca641507f15574bffaf705519fbcb5e20a7f14a7188fd459ea743834ff10b21200b83ecfc2aa0879b3
6
+ metadata.gz: 72a290819dfd7700dd187078be04f0644df2c5e84fc945c5e0a1e28eb521015ea085ea76b9c8fbaf1529d3e8c84367a8afcd4d9537c894dfede3a5f883880935
7
+ data.tar.gz: c76fc84201c4c5d1eeb8a910665d42eadcea0983d89d2e17f5c1f0069af3421417aaadd9a43771e8ccd1f8f01481f86df61d4b38cda72f9cd2d65be6d8e9f77e
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.13
42
+ - Package version: 0.1.15
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.13.gem
59
+ gem install ./pharmaobservatory-0.1.15.gem
60
60
  ```
61
61
 
62
- (for development, run `gem install --dev ./pharmaobservatory-0.1.13.gem` to install the development dependencies)
62
+ (for development, run `gem install --dev ./pharmaobservatory-0.1.15.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.13'
68
+ gem 'pharmaobservatory', '~> 0.1.15'
69
69
 
70
70
  ### Install from Git
71
71
 
@@ -145,11 +145,12 @@ Class | Method | HTTP request | Description
145
145
  *PharmaObservatory::CompaniesApi* | [**companies_biomarker_validation**](docs/CompaniesApi.md#companies_biomarker_validation) | **GET** /api/v1/companies/{id}/biomarker_validation | Biomarker validation ladder
146
146
  *PharmaObservatory::CompaniesApi* | [**companies_catalysts**](docs/CompaniesApi.md#companies_catalysts) | **GET** /api/v1/companies/{id}/catalysts | Catalysts: trial readouts, patent cliffs, FDA decision dates and press-release events
147
147
  *PharmaObservatory::CompaniesApi* | [**companies_clia_certificates**](docs/CompaniesApi.md#companies_clia_certificates) | **GET** /api/v1/companies/{id}/clia_certificates | CLIA laboratory certificates
148
+ *PharmaObservatory::CompaniesApi* | [**companies_company_asset_collisions**](docs/CompaniesApi.md#companies_company_asset_collisions) | **GET** /api/v1/companies/{id}/company_asset_collisions | Company asset collisions
148
149
  *PharmaObservatory::CompaniesApi* | [**companies_company_assets**](docs/CompaniesApi.md#companies_company_assets) | **GET** /api/v1/companies/{id}/company_assets | Company assets (approved and marketed drugs)
149
150
  *PharmaObservatory::CompaniesApi* | [**companies_company_biomarker_capability**](docs/CompaniesApi.md#companies_company_biomarker_capability) | **GET** /api/v1/companies/{id}/company_biomarker_capability | Company biomarker capability
150
151
  *PharmaObservatory::CompaniesApi* | [**companies_company_collaborators**](docs/CompaniesApi.md#companies_company_collaborators) | **GET** /api/v1/companies/{id}/company_collaborators | Company study collaborators by disease area
151
152
  *PharmaObservatory::CompaniesApi* | [**companies_company_competitor_activity**](docs/CompaniesApi.md#companies_company_competitor_activity) | **GET** /api/v1/companies/{id}/company_competitor_activity | Company competitor activity by disease area
152
- *PharmaObservatory::CompaniesApi* | [**companies_company_competitors**](docs/CompaniesApi.md#companies_company_competitors) | **GET** /api/v1/companies/{id}/company_competitors | Company program overlap
153
+ *PharmaObservatory::CompaniesApi* | [**companies_company_competitors**](docs/CompaniesApi.md#companies_company_competitors) | **GET** /api/v1/companies/{id}/company_competitors | Company competitors by asset collision
153
154
  *PharmaObservatory::CompaniesApi* | [**companies_company_cosponsors**](docs/CompaniesApi.md#companies_company_cosponsors) | **GET** /api/v1/companies/{id}/company_cosponsors | Company co-sponsors
154
155
  *PharmaObservatory::CompaniesApi* | [**companies_company_financials**](docs/CompaniesApi.md#companies_company_financials) | **GET** /api/v1/companies/{id}/company_financials | Company SEC financials
155
156
  *PharmaObservatory::CompaniesApi* | [**companies_company_firmographics**](docs/CompaniesApi.md#companies_company_firmographics) | **GET** /api/v1/companies/{id}/company_firmographics | Company firmographics
@@ -390,6 +391,10 @@ Class | Method | HTTP request | Description
390
391
  *PharmaObservatory::SitesApi* | [**sites_site_trial_conditions**](docs/SitesApi.md#sites_site_trial_conditions) | **GET** /api/v1/sites/{id}/site_trial_conditions | Site trial conditions
391
392
  *PharmaObservatory::SitesApi* | [**sites_site_trial_drugs**](docs/SitesApi.md#sites_site_trial_drugs) | **GET** /api/v1/sites/{id}/site_trial_drugs | Site trial drugs
392
393
  *PharmaObservatory::SitesApi* | [**sites_site_trials**](docs/SitesApi.md#sites_site_trials) | **GET** /api/v1/sites/{id}/site_trials | Site trials
394
+ *PharmaObservatory::SubscriptionsApi* | [**changes_list**](docs/SubscriptionsApi.md#changes_list) | **GET** /api/v1/changes | Changes since a cursor
395
+ *PharmaObservatory::SubscriptionsApi* | [**subscriptions_create**](docs/SubscriptionsApi.md#subscriptions_create) | **POST** /api/v1/subscriptions | Follow an entity or a dataset query
396
+ *PharmaObservatory::SubscriptionsApi* | [**subscriptions_delete**](docs/SubscriptionsApi.md#subscriptions_delete) | **DELETE** /api/v1/subscriptions/{id} | Stop following
397
+ *PharmaObservatory::SubscriptionsApi* | [**subscriptions_list**](docs/SubscriptionsApi.md#subscriptions_list) | **GET** /api/v1/subscriptions | List your subscriptions
393
398
  *PharmaObservatory::SuppliersApi* | [**suppliers_get**](docs/SuppliersApi.md#suppliers_get) | **GET** /api/v1/suppliers/{id} | One supplier
394
399
  *PharmaObservatory::SuppliersApi* | [**suppliers_list**](docs/SuppliersApi.md#suppliers_list) | **GET** /api/v1/suppliers | List suppliers
395
400
  *PharmaObservatory::SuppliersApi* | [**suppliers_supplier_services**](docs/SuppliersApi.md#suppliers_supplier_services) | **GET** /api/v1/suppliers/{id}/supplier_services | Supplier services
@@ -485,12 +490,18 @@ Class | Method | HTTP request | Description
485
490
  - [PharmaObservatory::CellLinesRecord](docs/CellLinesRecord.md)
486
491
  - [PharmaObservatory::CellLinesResponse](docs/CellLinesResponse.md)
487
492
  - [PharmaObservatory::CellLinesRow](docs/CellLinesRow.md)
493
+ - [PharmaObservatory::ChangesList200Response](docs/ChangesList200Response.md)
494
+ - [PharmaObservatory::ChangesList200ResponseBuildState](docs/ChangesList200ResponseBuildState.md)
495
+ - [PharmaObservatory::ChangesList200ResponseItemsInner](docs/ChangesList200ResponseItemsInner.md)
496
+ - [PharmaObservatory::ChangesList200ResponseItemsInnerEntryKeys](docs/ChangesList200ResponseItemsInnerEntryKeys.md)
488
497
  - [PharmaObservatory::CliaCertificatesResponse](docs/CliaCertificatesResponse.md)
489
498
  - [PharmaObservatory::CliaCertificatesRow](docs/CliaCertificatesRow.md)
490
499
  - [PharmaObservatory::CompaniesRecord](docs/CompaniesRecord.md)
491
500
  - [PharmaObservatory::CompaniesRecordAttributes](docs/CompaniesRecordAttributes.md)
492
501
  - [PharmaObservatory::CompaniesResponse](docs/CompaniesResponse.md)
493
502
  - [PharmaObservatory::CompaniesRow](docs/CompaniesRow.md)
503
+ - [PharmaObservatory::CompanyAssetCollisionsResponse](docs/CompanyAssetCollisionsResponse.md)
504
+ - [PharmaObservatory::CompanyAssetCollisionsRow](docs/CompanyAssetCollisionsRow.md)
494
505
  - [PharmaObservatory::CompanyAssetsResponse](docs/CompanyAssetsResponse.md)
495
506
  - [PharmaObservatory::CompanyAssetsRow](docs/CompanyAssetsRow.md)
496
507
  - [PharmaObservatory::CompanyBiomarkerCapabilityResponse](docs/CompanyBiomarkerCapabilityResponse.md)
@@ -818,6 +829,15 @@ Class | Method | HTTP request | Description
818
829
  - [PharmaObservatory::SponsorTrialStartForecastRow](docs/SponsorTrialStartForecastRow.md)
819
830
  - [PharmaObservatory::SponsorTrialsResponse](docs/SponsorTrialsResponse.md)
820
831
  - [PharmaObservatory::SponsorTrialsRow](docs/SponsorTrialsRow.md)
832
+ - [PharmaObservatory::SubscriptionsCreate201Response](docs/SubscriptionsCreate201Response.md)
833
+ - [PharmaObservatory::SubscriptionsCreate201ResponseSubscription](docs/SubscriptionsCreate201ResponseSubscription.md)
834
+ - [PharmaObservatory::SubscriptionsCreate201ResponseSubscriptionTarget](docs/SubscriptionsCreate201ResponseSubscriptionTarget.md)
835
+ - [PharmaObservatory::SubscriptionsCreateRequest](docs/SubscriptionsCreateRequest.md)
836
+ - [PharmaObservatory::SubscriptionsDelete200Response](docs/SubscriptionsDelete200Response.md)
837
+ - [PharmaObservatory::SubscriptionsList200Response](docs/SubscriptionsList200Response.md)
838
+ - [PharmaObservatory::SubscriptionsList200ResponseSubscriptionsInner](docs/SubscriptionsList200ResponseSubscriptionsInner.md)
839
+ - [PharmaObservatory::SubscriptionsList200ResponseSubscriptionsInnerTarget](docs/SubscriptionsList200ResponseSubscriptionsInnerTarget.md)
840
+ - [PharmaObservatory::SubscriptionsList200ResponseSubscriptionsInnerTargetFilters](docs/SubscriptionsList200ResponseSubscriptionsInnerTargetFilters.md)
821
841
  - [PharmaObservatory::SupplierCapabilityEsgResponse](docs/SupplierCapabilityEsgResponse.md)
822
842
  - [PharmaObservatory::SupplierCapabilityEsgRow](docs/SupplierCapabilityEsgRow.md)
823
843
  - [PharmaObservatory::SupplierServicesResponse](docs/SupplierServicesResponse.md)
@@ -26,7 +26,7 @@
26
26
  | **evidence_ref_kind** | **String** | What kind of reference evidence_ref is. | [optional] |
27
27
  | **trial_id** | **String** | The trial key (an NCT id) when the evidence is a trial; null otherwise. | [optional] |
28
28
  | **citation_url** | **String** | A link to the cited record. | [optional] |
29
- | **citation_verified** | **Boolean** | False for the FDA Biomarker Qualification Program arm, whose captured links are known to go stale; true otherwise. A link marked false may not resolve. | [optional] |
29
+ | **citation_verified** | **Boolean** | True on every row. Kept for contract stability; the FDA Biomarker Qualification Program links were rebuilt on the current FDA host (#5778). | [optional] |
30
30
  | **evidence_snippet** | **String** | The text span the evidence rests on, where the source gives one. | [optional] |
31
31
  | **biomarker_role** | **String** | The biomarker's role in the evidence, where the source states it. | [optional] |
32
32
  | **is_surrogate_endpoint_claim** | **Boolean** | True when the evidence is a claim that the biomarker is a surrogate endpoint. | [optional] |
@@ -0,0 +1,26 @@
1
+ # PharmaObservatory::ChangesList200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **items** | [**Array<ChangesList200ResponseItemsInner>**](ChangesList200ResponseItemsInner.md) | | |
8
+ | **count** | **Integer** | | |
9
+ | **next_cursor** | **String** | | |
10
+ | **has_more** | **Boolean** | | |
11
+ | **build_state** | [**ChangesList200ResponseBuildState**](ChangesList200ResponseBuildState.md) | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'pharmaobservatory'
17
+
18
+ instance = PharmaObservatory::ChangesList200Response.new(
19
+ items: null,
20
+ count: null,
21
+ next_cursor: null,
22
+ has_more: null,
23
+ build_state: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,20 @@
1
+ # PharmaObservatory::ChangesList200ResponseBuildState
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **built** | **Boolean** | | |
8
+ | **generation** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'pharmaobservatory'
14
+
15
+ instance = PharmaObservatory::ChangesList200ResponseBuildState.new(
16
+ built: null,
17
+ generation: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,48 @@
1
+ # PharmaObservatory::ChangesList200ResponseItemsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | | |
8
+ | **subscription_id** | **Integer** | | |
9
+ | **event_id** | **String** | | |
10
+ | **dataset** | **String** | | |
11
+ | **key** | **String** | | |
12
+ | **title** | **String** | | |
13
+ | **event_type** | **String** | | |
14
+ | **event_label** | **String** | | |
15
+ | **field** | **String** | | |
16
+ | **old_value** | **String** | | |
17
+ | **new_value** | **String** | | |
18
+ | **source_date** | **String** | | |
19
+ | **observed_at** | **String** | | |
20
+ | **match_kind** | **String** | | |
21
+ | **entry_keys** | [**ChangesList200ResponseItemsInnerEntryKeys**](ChangesList200ResponseItemsInnerEntryKeys.md) | | |
22
+ | **source_credit** | **String** | | |
23
+
24
+ ## Example
25
+
26
+ ```ruby
27
+ require 'pharmaobservatory'
28
+
29
+ instance = PharmaObservatory::ChangesList200ResponseItemsInner.new(
30
+ id: null,
31
+ subscription_id: null,
32
+ event_id: null,
33
+ dataset: null,
34
+ key: null,
35
+ title: null,
36
+ event_type: null,
37
+ event_label: null,
38
+ field: null,
39
+ old_value: null,
40
+ new_value: null,
41
+ source_date: null,
42
+ observed_at: null,
43
+ match_kind: null,
44
+ entry_keys: null,
45
+ source_credit: null
46
+ )
47
+ ```
48
+
@@ -0,0 +1,18 @@
1
+ # PharmaObservatory::ChangesList200ResponseItemsInnerEntryKeys
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **trials** | **String** | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'pharmaobservatory'
13
+
14
+ instance = PharmaObservatory::ChangesList200ResponseItemsInnerEntryKeys.new(
15
+ trials: null
16
+ )
17
+ ```
18
+
data/docs/CompaniesApi.md CHANGED
@@ -11,11 +11,12 @@ All URIs are relative to *https://pharmaobservatory.com*
11
11
  | [**companies_biomarker_validation**](CompaniesApi.md#companies_biomarker_validation) | **GET** /api/v1/companies/{id}/biomarker_validation | Biomarker validation ladder |
12
12
  | [**companies_catalysts**](CompaniesApi.md#companies_catalysts) | **GET** /api/v1/companies/{id}/catalysts | Catalysts: trial readouts, patent cliffs, FDA decision dates and press-release events |
13
13
  | [**companies_clia_certificates**](CompaniesApi.md#companies_clia_certificates) | **GET** /api/v1/companies/{id}/clia_certificates | CLIA laboratory certificates |
14
+ | [**companies_company_asset_collisions**](CompaniesApi.md#companies_company_asset_collisions) | **GET** /api/v1/companies/{id}/company_asset_collisions | Company asset collisions |
14
15
  | [**companies_company_assets**](CompaniesApi.md#companies_company_assets) | **GET** /api/v1/companies/{id}/company_assets | Company assets (approved and marketed drugs) |
15
16
  | [**companies_company_biomarker_capability**](CompaniesApi.md#companies_company_biomarker_capability) | **GET** /api/v1/companies/{id}/company_biomarker_capability | Company biomarker capability |
16
17
  | [**companies_company_collaborators**](CompaniesApi.md#companies_company_collaborators) | **GET** /api/v1/companies/{id}/company_collaborators | Company study collaborators by disease area |
17
18
  | [**companies_company_competitor_activity**](CompaniesApi.md#companies_company_competitor_activity) | **GET** /api/v1/companies/{id}/company_competitor_activity | Company competitor activity by disease area |
18
- | [**companies_company_competitors**](CompaniesApi.md#companies_company_competitors) | **GET** /api/v1/companies/{id}/company_competitors | Company program overlap |
19
+ | [**companies_company_competitors**](CompaniesApi.md#companies_company_competitors) | **GET** /api/v1/companies/{id}/company_competitors | Company competitors by asset collision |
19
20
  | [**companies_company_cosponsors**](CompaniesApi.md#companies_company_cosponsors) | **GET** /api/v1/companies/{id}/company_cosponsors | Company co-sponsors |
20
21
  | [**companies_company_financials**](CompaniesApi.md#companies_company_financials) | **GET** /api/v1/companies/{id}/company_financials | Company SEC financials |
21
22
  | [**companies_company_firmographics**](CompaniesApi.md#companies_company_firmographics) | **GET** /api/v1/companies/{id}/company_firmographics | Company firmographics |
@@ -641,6 +642,87 @@ end
641
642
  - **Accept**: application/json
642
643
 
643
644
 
645
+ ## companies_company_asset_collisions
646
+
647
+ > <CompanyAssetCollisionsResponse> companies_company_asset_collisions(id, opts)
648
+
649
+ Company asset collisions
650
+
651
+ ### Examples
652
+
653
+ ```ruby
654
+ require 'time'
655
+ require 'pharmaobservatory'
656
+ # setup authorization
657
+ PharmaObservatory.configure do |config|
658
+ # Configure Bearer authorization (JWT): ApiBearerJwt
659
+ config.access_token = 'YOUR_BEARER_TOKEN'
660
+ end
661
+
662
+ api_instance = PharmaObservatory::CompaniesApi.new
663
+ id = 'company:c0185cf6c39a2536ad436cf6255494c0' # String |
664
+ opts = {
665
+ 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.
666
+ limit: 56, # Integer | Rows per page, up to 500 (default 50).
667
+ sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
668
+ group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
669
+ measure: 'measure_example', # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
670
+ scope: 'company' # String | company (this company only) or group (its corporate group).
671
+ }
672
+
673
+ begin
674
+ # Company asset collisions
675
+ result = api_instance.companies_company_asset_collisions(id, opts)
676
+ p result
677
+ rescue PharmaObservatory::ApiError => e
678
+ puts "Error when calling CompaniesApi->companies_company_asset_collisions: #{e}"
679
+ end
680
+ ```
681
+
682
+ #### Using the companies_company_asset_collisions_with_http_info variant
683
+
684
+ This returns an Array which contains the response data, status code and headers.
685
+
686
+ > <Array(<CompanyAssetCollisionsResponse>, Integer, Hash)> companies_company_asset_collisions_with_http_info(id, opts)
687
+
688
+ ```ruby
689
+ begin
690
+ # Company asset collisions
691
+ data, status_code, headers = api_instance.companies_company_asset_collisions_with_http_info(id, opts)
692
+ p status_code # => 2xx
693
+ p headers # => { ... }
694
+ p data # => <CompanyAssetCollisionsResponse>
695
+ rescue PharmaObservatory::ApiError => e
696
+ puts "Error when calling CompaniesApi->companies_company_asset_collisions_with_http_info: #{e}"
697
+ end
698
+ ```
699
+
700
+ ### Parameters
701
+
702
+ | Name | Type | Description | Notes |
703
+ | ---- | ---- | ----------- | ----- |
704
+ | **id** | **String** | | |
705
+ | **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
706
+ | **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
707
+ | **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
708
+ | **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
709
+ | **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
710
+ | **scope** | **String** | company (this company only) or group (its corporate group). | [optional] |
711
+
712
+ ### Return type
713
+
714
+ [**CompanyAssetCollisionsResponse**](CompanyAssetCollisionsResponse.md)
715
+
716
+ ### Authorization
717
+
718
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
719
+
720
+ ### HTTP request headers
721
+
722
+ - **Content-Type**: Not defined
723
+ - **Accept**: application/json
724
+
725
+
644
726
  ## companies_company_assets
645
727
 
646
728
  > <CompanyAssetsResponse> companies_company_assets(id, opts)
@@ -969,7 +1051,7 @@ end
969
1051
 
970
1052
  > <CompanyCompetitorsResponse> companies_company_competitors(id, opts)
971
1053
 
972
- Company program overlap
1054
+ Company competitors by asset collision
973
1055
 
974
1056
  ### Examples
975
1057
 
@@ -994,7 +1076,7 @@ opts = {
994
1076
  }
995
1077
 
996
1078
  begin
997
- # Company program overlap
1079
+ # Company competitors by asset collision
998
1080
  result = api_instance.companies_company_competitors(id, opts)
999
1081
  p result
1000
1082
  rescue PharmaObservatory::ApiError => e
@@ -1010,7 +1092,7 @@ This returns an Array which contains the response data, status code and headers.
1010
1092
 
1011
1093
  ```ruby
1012
1094
  begin
1013
- # Company program overlap
1095
+ # Company competitors by asset collision
1014
1096
  data, status_code, headers = api_instance.companies_company_competitors_with_http_info(id, opts)
1015
1097
  p status_code # => 2xx
1016
1098
  p headers # => { ... }
@@ -0,0 +1,58 @@
1
+ # PharmaObservatory::CompanyAssetCollisionsResponse
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** | [**AnimalWelfareAssurancesResponseScope**](AnimalWelfareAssurancesResponseScope.md) | | [optional] |
12
+ | **columns** | [**Array&lt;DatasetColumn&gt;**](DatasetColumn.md) | | |
13
+ | **rows** | [**Array&lt;CompanyAssetCollisionsRow&gt;**](CompanyAssetCollisionsRow.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** | [**AnimalWelfareAssurancesResponseFreshness**](AnimalWelfareAssurancesResponseFreshness.md) | | [optional] |
25
+ | **build** | [**AnimalWelfareAssurancesResponseBuild**](AnimalWelfareAssurancesResponseBuild.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::CompanyAssetCollisionsResponse.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,68 @@
1
+ # PharmaObservatory::CompanyAssetCollisionsRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **company_id** | **String** | Company level: the company the row is about; the entry key for the companies object type. | [optional] |
8
+ | **company_name** | **String** | Display name of the company. | [optional] |
9
+ | **group_id** | **String** | Group level: the company&#39;s current ultimate parent; a root&#39;s group is itself. | [optional] |
10
+ | **group_name** | **String** | Display name of the group. | [optional] |
11
+ | **molecule_id** | **String** | Molecule level: the company&#39;s asset, the resolved drug (a drug with two canonical ids is one asset). | [optional] |
12
+ | **molecule_name** | **String** | The asset&#39;s display name, from the company&#39;s most-trialled record of it. | [optional] |
13
+ | **competitor_company_id** | **String** | Company level: the company whose asset collides. | [optional] |
14
+ | **competitor_company_name** | **String** | Display name of the competitor&#39;s company. | [optional] |
15
+ | **competitor_group_id** | **String** | Group level: the competitor&#39;s current ultimate parent; a root&#39;s group is itself. | [optional] |
16
+ | **competitor_group_name** | **String** | Display name of the competitor&#39;s group. | [optional] |
17
+ | **competitor_molecule_id** | **String** | Molecule level: the competitor&#39;s asset, the resolved drug. | [optional] |
18
+ | **competitor_molecule_name** | **String** | The competitor asset&#39;s display name. | [optional] |
19
+ | **target_family** | **String** | The company drug&#39;s target family of the shared gene (the Open Targets target name, so a taxane&#39;s tubulin isotypes are one family; the ChEMBL mechanism text for a drug Open Targets lacks; the gene symbol for a curated investigational asset). | [optional] |
20
+ | **shared_symbols** | **Array&lt;String&gt;** | Gene symbols of the shared genes within the family. | [optional] |
21
+ | **action_type** | **String** | The company drug&#39;s action on the family (Open Targets or ChEMBL vocabulary); null when no source states one. | [optional] |
22
+ | **competitor_action_type** | **String** | The competitor drug&#39;s action on the shared genes; null when no source states one. | [optional] |
23
+ | **same_action** | **Boolean** | True when the two drugs have the same action type on a shared gene of the family. | [optional] |
24
+ | **n_shared_indications** | **Integer** | Disease areas both programs are in, among live programs. | [optional] |
25
+ | **top_shared_indications** | **Array&lt;String&gt;** | Up to 3 shared disease area names, by the pair&#39;s combined trial count. An empty list when none. | [optional] |
26
+ | **stage** | **Integer** | The less advanced of the two programs&#39; furthest phase: 6 Phase 4, 5 Phase 3, 4 Phase 2/3, 3 Phase 2, 2 Phase 1/2, 1 Phase 1, 0 Early Phase 1, -1 phase not applicable. | [optional] |
27
+ | **last_year** | **Integer** | The later of the two programs&#39; last trial start year. | [optional] |
28
+ | **n_head_to_head_trials** | **Integer** | Trials led by either company in which one drug is experimental and the other an active comparator. | [optional] |
29
+ | **ownership_basis** | **String** | Why the company owns the drug. experimental_arm and regulatory_holder rest on evidence; inferred_lead is an inference (no arm data says otherwise). | [optional] |
30
+ | **competitor_ownership_basis** | **String** | Why the competitor owns its drug, same vocabulary as ownership_basis. | [optional] |
31
+ | **family_idf** | **Float** | The rarity weight of the family: the natural log of (companies holding any live, owned target family) over (companies holding this one). | [optional] |
32
+ | **collision_weight** | **Float** | The weight of the pair, family_idf times a factor for same action, a shared indication, the stage, recency and a head-to-head trial. | [optional] |
33
+
34
+ ## Example
35
+
36
+ ```ruby
37
+ require 'pharmaobservatory'
38
+
39
+ instance = PharmaObservatory::CompanyAssetCollisionsRow.new(
40
+ company_id: null,
41
+ company_name: null,
42
+ group_id: null,
43
+ group_name: null,
44
+ molecule_id: null,
45
+ molecule_name: null,
46
+ competitor_company_id: null,
47
+ competitor_company_name: null,
48
+ competitor_group_id: null,
49
+ competitor_group_name: null,
50
+ competitor_molecule_id: null,
51
+ competitor_molecule_name: null,
52
+ target_family: null,
53
+ shared_symbols: null,
54
+ action_type: null,
55
+ competitor_action_type: null,
56
+ same_action: null,
57
+ n_shared_indications: null,
58
+ top_shared_indications: null,
59
+ stage: null,
60
+ last_year: null,
61
+ n_head_to_head_trials: null,
62
+ ownership_basis: null,
63
+ competitor_ownership_basis: null,
64
+ family_idf: null,
65
+ collision_weight: null
66
+ )
67
+ ```
68
+
@@ -13,24 +13,16 @@
13
13
  | **competitor_group_id** | **String** | Group level: the competitor&#39;s current ultimate parent; a root&#39;s group is itself. | [optional] |
14
14
  | **competitor_group_name** | **String** | Display name of the competitor&#39;s group. | [optional] |
15
15
  | **competitor_class** | **String** | The competitor&#39;s class: industry, or non_industry (not classed as industry by the sponsor-class rule: academic, hospital, government, nonprofit, and any record the rule does not reach). competitor_rank restarts at 1 within each class, so filter or sort on this column first. | [optional] |
16
- | **n_class_candidates** | **Integer** | How many companies of this competitor_class were candidates (a shared target, or an indication overlap above the similarity floor) before the top 25 were kept. The same value on every row of one company and class. | [optional] |
16
+ | **n_class_candidates** | **Integer** | How many companies of this competitor_class had at least one asset collision with the company before the top 25 were kept. The same value on every row of one company and class. | [optional] |
17
17
  | **competitor_rank** | **Integer** | The competitor&#39;s rank within its competitor_class for the company by competitor_score (1 is the highest). | [optional] |
18
- | **competitor_score** | **Float** | 100 times the weighted mean of the four similarities below, rounded to four places. | [optional] |
19
- | **target_sim** | **Float** | Jaccard similarity, 0 to 1, of the two companies&#39; molecular target sets. | [optional] |
20
- | **mechanism_sim** | **Float** | Jaccard similarity, 0 to 1, of their mechanism sets (a target and its action). | [optional] |
21
- | **indication_sim** | **Float** | Jaccard similarity, 0 to 1, of their top-25 disease area sets. | [optional] |
22
- | **phase_sim** | **Float** | The fraction, 0 to 1, of the shared targets that both companies have taken to phase 2 or later. | [optional] |
23
- | **n_shared_targets** | **Integer** | Molecular targets both companies pursue. | [optional] |
24
- | **n_shared_mechanisms** | **Integer** | Mechanisms (target and action) both companies pursue. | [optional] |
25
- | **n_shared_indications** | **Integer** | Disease areas both companies are in, within each one&#39;s top 25. | [optional] |
26
- | **n_phase_overlap_targets** | **Integer** | Shared targets that both companies have taken to phase 2 or later. | [optional] |
27
- | **n_company_targets** | **Integer** | Targets the company pursues (the Jaccard denominator). | [optional] |
28
- | **n_competitor_targets** | **Integer** | Targets the competitor pursues. | [optional] |
29
- | **n_company_indications** | **Integer** | Disease areas in the company&#39;s top 25. | [optional] |
30
- | **n_competitor_indications** | **Integer** | Disease areas in the competitor&#39;s top 25. | [optional] |
31
- | **top_shared_targets** | **Array&lt;String&gt;** | Up to 5 shared target gene symbols, by combined phase then combined trials. An empty list when none. | [optional] |
32
- | **top_shared_indications** | **Array&lt;String&gt;** | Up to 5 shared disease area names, by combined trial count. An empty list when none. | [optional] |
33
- | **top_shared_mechanisms** | **Array&lt;String&gt;** | Up to 3 shared mechanisms written as a gene symbol and an action, by combined phase then combined trials. An empty list when none. | [optional] |
18
+ | **competitor_score** | **Float** | The weighted share of the company&#39;s live target families that the competitor&#39;s live assets collide with, 0 to 100, rounded to four places. Each colliding family counts its best collision weight (rarity of the family across companies, times factors for same action, a shared indication, the least advanced stage, recency and a head-to-head trial), capped at the family&#39;s rarity weight; the sum is divided by the rarity weights of ALL the company&#39;s families. | [optional] |
19
+ | **n_collisions** | **Integer** | Asset pairs (a drug of the company, a drug of the competitor) that act on a common target. | [optional] |
20
+ | **n_colliding_families** | **Integer** | Target families of the company&#39;s live assets that the competitor collides with. | [optional] |
21
+ | **n_subject_families** | **Integer** | Target families of the company&#39;s own live, owned assets; the denominator of competitor_score is their rarity weights. | [optional] |
22
+ | **n_same_action** | **Integer** | Asset pairs whose drugs act on the shared target with the same action type. | [optional] |
23
+ | **n_shared_indication_pairs** | **Integer** | Asset pairs whose programs share at least one disease area. | [optional] |
24
+ | **n_head_to_head_trials** | **Integer** | Distinct trials led by either company in which one drug of a pair is experimental and the other an active comparator. | [optional] |
25
+ | **top_collisions** | **Array&lt;String&gt;** | Up to 3 strongest asset pairs as text: \&quot;drug A / drug B: target family, stage, N shared indications\&quot;. The stage is the less advanced of the two programs. An ownership_basis of inferred_lead on the underlying pair (see company_asset_collisions) is an inference. | [optional] |
34
26
  | **n_cosponsored_trials** | **Integer** | Distinct trials on which the company and the competitor are both named as sponsors, counted over their subtrees; 0 when none. A consortium trial (more than 25 sponsor companies) is left out. | [optional] |
35
27
 
36
28
  ## Example
@@ -51,21 +43,13 @@ instance = PharmaObservatory::CompanyCompetitorsRow.new(
51
43
  n_class_candidates: null,
52
44
  competitor_rank: null,
53
45
  competitor_score: null,
54
- target_sim: null,
55
- mechanism_sim: null,
56
- indication_sim: null,
57
- phase_sim: null,
58
- n_shared_targets: null,
59
- n_shared_mechanisms: null,
60
- n_shared_indications: null,
61
- n_phase_overlap_targets: null,
62
- n_company_targets: null,
63
- n_competitor_targets: null,
64
- n_company_indications: null,
65
- n_competitor_indications: null,
66
- top_shared_targets: null,
67
- top_shared_indications: null,
68
- top_shared_mechanisms: null,
46
+ n_collisions: null,
47
+ n_colliding_families: null,
48
+ n_subject_families: null,
49
+ n_same_action: null,
50
+ n_shared_indication_pairs: null,
51
+ n_head_to_head_trials: null,
52
+ top_collisions: null,
69
53
  n_cosponsored_trials: null
70
54
  )
71
55
  ```
@@ -19,6 +19,15 @@
19
19
  | **latest_shares_outstanding** | **Float** | The latest reported cover-page share count of the filer, repeated on every year row (the denominator of an ownership percentage). | [optional] |
20
20
  | **latest_shares_outstanding_fy** | **Integer** | The fiscal year of latest_shares_outstanding. | [optional] |
21
21
  | **latest_financial_fy** | **Integer** | The latest fiscal year the filer reported any line item. | [optional] |
22
+ | **quarter_end_date** | **Date** | The end of the latest reported quarter of the filer that has an operating cash flow figure (a 10-Q, or the Q4 derived from a 10-K); the date of the cash figure below. Repeated on every year row of the filer; null for a company with no quarterly SEC filings. | [optional] |
23
+ | **quarter_filed_date** | **Date** | The date SEC received the filing of that latest quarter. | [optional] |
24
+ | **cash_and_investments_latest_q** | **Float** | Cash plus short-term investments at quarter_end_date, in USD (non-current investments are not counted). | [optional] |
25
+ | **operating_cash_flow_latest_q** | **Float** | Net cash from operating activities of that latest quarter alone (year-to-date figures differenced; Q4 is the full year less nine months), in USD; negative means burning. | [optional] |
26
+ | **burn_basis_quarters** | **Integer** | How many contiguous quarters burn_basis_quarterly_usd averages over, 1 or 2. | [optional] |
27
+ | **burn_basis_quarterly_usd** | **Float** | The mean quarterly operating cash flow over the latest two contiguous quarters (the latest alone when no contiguous earlier quarter has a figure), in USD; negative means burning. | [optional] |
28
+ | **runway_months_quarterly** | **Float** | An estimate, derived not reported: cash_and_investments_latest_q divided by the monthly burn (burn_basis_quarterly_usd over 3), in months at quarter_end_date, rounded to 0.1. Null whenever runway_quarterly_null_reason is set. | [optional] |
29
+ | **runway_quarterly_method** | **String** | The version of the derivation behind runway_months_quarterly; trailing_quarter_mean_v1 is the mean of the latest two contiguous discrete quarters. | [optional] |
30
+ | **runway_quarterly_null_reason** | **String** | Why runway_months_quarterly is null, in precedence order: no_quarterly_facts (no 10-Q cash-flow facts: a private company or a 20-F/40-F filer), stale (the latest quarter ended over a year before the newest SEC filing loaded), no_fx_rate, no_cash_at_quarter_end, or positive_cash_flow (no burn to run out of). Null when the runway is published. | [optional] |
22
31
  | **revenue** | **Float** | Total revenue for the fiscal year, in USD (a non-USD filer is converted at the calendar-year average rate; null when no rate exists). | [optional] |
23
32
  | **net_income** | **Float** | Net income for the fiscal year, in USD. | [optional] |
24
33
  | **rnd** | **Float** | Research and development expense for the fiscal year, in USD. | [optional] |
@@ -72,6 +81,15 @@ instance = PharmaObservatory::CompanyFinancialsRow.new(
72
81
  latest_shares_outstanding: null,
73
82
  latest_shares_outstanding_fy: null,
74
83
  latest_financial_fy: null,
84
+ quarter_end_date: null,
85
+ quarter_filed_date: null,
86
+ cash_and_investments_latest_q: null,
87
+ operating_cash_flow_latest_q: null,
88
+ burn_basis_quarters: null,
89
+ burn_basis_quarterly_usd: null,
90
+ runway_months_quarterly: null,
91
+ runway_quarterly_method: null,
92
+ runway_quarterly_null_reason: null,
75
93
  revenue: null,
76
94
  net_income: null,
77
95
  rnd: null,
@@ -8,6 +8,8 @@
8
8
  | **adverse_event_term** | **String** | The adverse event term as the trials report it. | [optional] |
9
9
  | **subjects_affected** | **Float** | Subjects affected, summed across the condition&#39;s trials. | [optional] |
10
10
  | **n_trials** | **Integer** | Trials for this condition that report the term. | [optional] |
11
+ | **n_terms_total** | **Integer** | Distinct serious adverse event terms across the condition&#39;s trials. The rows are only the top 10 of these, so a row count is not the term count; use this. | [optional] |
12
+ | **n_trials_total** | **Integer** | Results-posting trials of the condition that report at least one serious adverse event term. | [optional] |
11
13
 
12
14
  ## Example
13
15
 
@@ -18,7 +20,9 @@ instance = PharmaObservatory::ConditionAdverseEventsRow.new(
18
20
  condition_id: null,
19
21
  adverse_event_term: null,
20
22
  subjects_affected: null,
21
- n_trials: null
23
+ n_trials: null,
24
+ n_terms_total: null,
25
+ n_trials_total: null
22
26
  )
23
27
  ```
24
28