pharmaobservatory 0.1.13 → 0.1.14

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 (39) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +21 -4
  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/CompanyFinancialsRow.md +18 -0
  9. data/docs/ConditionAdverseEventsRow.md +5 -1
  10. data/docs/SubscriptionsApi.md +282 -0
  11. data/docs/SubscriptionsCreate201Response.md +22 -0
  12. data/docs/SubscriptionsCreate201ResponseSubscription.md +28 -0
  13. data/docs/SubscriptionsCreate201ResponseSubscriptionTarget.md +22 -0
  14. data/docs/SubscriptionsCreateRequest.md +20 -0
  15. data/docs/SubscriptionsDelete200Response.md +24 -0
  16. data/docs/SubscriptionsList200Response.md +22 -0
  17. data/docs/SubscriptionsList200ResponseSubscriptionsInner.md +28 -0
  18. data/docs/SubscriptionsList200ResponseSubscriptionsInnerTarget.md +26 -0
  19. data/docs/SubscriptionsList200ResponseSubscriptionsInnerTargetFilters.md +18 -0
  20. data/lib/pharmaobservatory/api/subscriptions_api.rb +261 -0
  21. data/lib/pharmaobservatory/models/biomarker_validation_row.rb +1 -1
  22. data/lib/pharmaobservatory/models/changes_list200_response.rb +343 -0
  23. data/lib/pharmaobservatory/models/changes_list200_response_build_state.rb +263 -0
  24. data/lib/pharmaobservatory/models/changes_list200_response_items_inner.rb +627 -0
  25. data/lib/pharmaobservatory/models/changes_list200_response_items_inner_entry_keys.rb +237 -0
  26. data/lib/pharmaobservatory/models/company_financials_row.rb +100 -1
  27. data/lib/pharmaobservatory/models/condition_adverse_events_row.rb +27 -5
  28. data/lib/pharmaobservatory/models/subscriptions_create201_response.rb +289 -0
  29. data/lib/pharmaobservatory/models/subscriptions_create201_response_subscription.rb +369 -0
  30. data/lib/pharmaobservatory/models/subscriptions_create201_response_subscription_target.rb +289 -0
  31. data/lib/pharmaobservatory/models/subscriptions_create_request.rb +263 -0
  32. data/lib/pharmaobservatory/models/subscriptions_delete200_response.rb +315 -0
  33. data/lib/pharmaobservatory/models/subscriptions_list200_response.rb +291 -0
  34. data/lib/pharmaobservatory/models/subscriptions_list200_response_subscriptions_inner.rb +369 -0
  35. data/lib/pharmaobservatory/models/subscriptions_list200_response_subscriptions_inner_target.rb +277 -0
  36. data/lib/pharmaobservatory/models/subscriptions_list200_response_subscriptions_inner_target_filters.rb +237 -0
  37. data/lib/pharmaobservatory/version.rb +1 -1
  38. data/lib/pharmaobservatory.rb +14 -0
  39. metadata +30 -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: d76fa5cc1c282ee7fb0c9dbe0d8d175681590bde4ca83e0abc6094fbd30fdefd
4
+ data.tar.gz: fc31c5ca6e2375f4e310ee021fc8a052d7531da6a5f4bda30e86382888597717
5
5
  SHA512:
6
- metadata.gz: c60cd42981cbb37923a33487258e78c2f0e6391efb9a905a0f742bceb1a61ec516667c2ba971b24a48552b304d212e01a1abf67c58092260fdada00b204f106e
7
- data.tar.gz: 01ac5654d2b5eb644ca9cc3184ddab4934fe1e4057956eca641507f15574bffaf705519fbcb5e20a7f14a7188fd459ea743834ff10b21200b83ecfc2aa0879b3
6
+ metadata.gz: 1bbe8120007013c7a4c7f41f1c45d530b4dc5a8d69ad97a04586fe9a86fac92e5ab8fb881d3d5752a1d76154f83791331ed68420213aee3c9b0a2b6f79ae7cd3
7
+ data.tar.gz: 3deb79b544139548d2d8f134737b9a71141b68b92c2b0470fd85edbfc24e8a7e987efceda57a9dd01636771632f8f2cfaa7c6ff1d203d90044ec30f0468bb89d
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.14
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.14.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.14.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.14'
69
69
 
70
70
  ### Install from Git
71
71
 
@@ -390,6 +390,10 @@ Class | Method | HTTP request | Description
390
390
  *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
391
  *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
392
  *PharmaObservatory::SitesApi* | [**sites_site_trials**](docs/SitesApi.md#sites_site_trials) | **GET** /api/v1/sites/{id}/site_trials | Site trials
393
+ *PharmaObservatory::SubscriptionsApi* | [**changes_list**](docs/SubscriptionsApi.md#changes_list) | **GET** /api/v1/changes | Changes since a cursor
394
+ *PharmaObservatory::SubscriptionsApi* | [**subscriptions_create**](docs/SubscriptionsApi.md#subscriptions_create) | **POST** /api/v1/subscriptions | Follow an entity or a dataset query
395
+ *PharmaObservatory::SubscriptionsApi* | [**subscriptions_delete**](docs/SubscriptionsApi.md#subscriptions_delete) | **DELETE** /api/v1/subscriptions/{id} | Stop following
396
+ *PharmaObservatory::SubscriptionsApi* | [**subscriptions_list**](docs/SubscriptionsApi.md#subscriptions_list) | **GET** /api/v1/subscriptions | List your subscriptions
393
397
  *PharmaObservatory::SuppliersApi* | [**suppliers_get**](docs/SuppliersApi.md#suppliers_get) | **GET** /api/v1/suppliers/{id} | One supplier
394
398
  *PharmaObservatory::SuppliersApi* | [**suppliers_list**](docs/SuppliersApi.md#suppliers_list) | **GET** /api/v1/suppliers | List suppliers
395
399
  *PharmaObservatory::SuppliersApi* | [**suppliers_supplier_services**](docs/SuppliersApi.md#suppliers_supplier_services) | **GET** /api/v1/suppliers/{id}/supplier_services | Supplier services
@@ -485,6 +489,10 @@ Class | Method | HTTP request | Description
485
489
  - [PharmaObservatory::CellLinesRecord](docs/CellLinesRecord.md)
486
490
  - [PharmaObservatory::CellLinesResponse](docs/CellLinesResponse.md)
487
491
  - [PharmaObservatory::CellLinesRow](docs/CellLinesRow.md)
492
+ - [PharmaObservatory::ChangesList200Response](docs/ChangesList200Response.md)
493
+ - [PharmaObservatory::ChangesList200ResponseBuildState](docs/ChangesList200ResponseBuildState.md)
494
+ - [PharmaObservatory::ChangesList200ResponseItemsInner](docs/ChangesList200ResponseItemsInner.md)
495
+ - [PharmaObservatory::ChangesList200ResponseItemsInnerEntryKeys](docs/ChangesList200ResponseItemsInnerEntryKeys.md)
488
496
  - [PharmaObservatory::CliaCertificatesResponse](docs/CliaCertificatesResponse.md)
489
497
  - [PharmaObservatory::CliaCertificatesRow](docs/CliaCertificatesRow.md)
490
498
  - [PharmaObservatory::CompaniesRecord](docs/CompaniesRecord.md)
@@ -818,6 +826,15 @@ Class | Method | HTTP request | Description
818
826
  - [PharmaObservatory::SponsorTrialStartForecastRow](docs/SponsorTrialStartForecastRow.md)
819
827
  - [PharmaObservatory::SponsorTrialsResponse](docs/SponsorTrialsResponse.md)
820
828
  - [PharmaObservatory::SponsorTrialsRow](docs/SponsorTrialsRow.md)
829
+ - [PharmaObservatory::SubscriptionsCreate201Response](docs/SubscriptionsCreate201Response.md)
830
+ - [PharmaObservatory::SubscriptionsCreate201ResponseSubscription](docs/SubscriptionsCreate201ResponseSubscription.md)
831
+ - [PharmaObservatory::SubscriptionsCreate201ResponseSubscriptionTarget](docs/SubscriptionsCreate201ResponseSubscriptionTarget.md)
832
+ - [PharmaObservatory::SubscriptionsCreateRequest](docs/SubscriptionsCreateRequest.md)
833
+ - [PharmaObservatory::SubscriptionsDelete200Response](docs/SubscriptionsDelete200Response.md)
834
+ - [PharmaObservatory::SubscriptionsList200Response](docs/SubscriptionsList200Response.md)
835
+ - [PharmaObservatory::SubscriptionsList200ResponseSubscriptionsInner](docs/SubscriptionsList200ResponseSubscriptionsInner.md)
836
+ - [PharmaObservatory::SubscriptionsList200ResponseSubscriptionsInnerTarget](docs/SubscriptionsList200ResponseSubscriptionsInnerTarget.md)
837
+ - [PharmaObservatory::SubscriptionsList200ResponseSubscriptionsInnerTargetFilters](docs/SubscriptionsList200ResponseSubscriptionsInnerTargetFilters.md)
821
838
  - [PharmaObservatory::SupplierCapabilityEsgResponse](docs/SupplierCapabilityEsgResponse.md)
822
839
  - [PharmaObservatory::SupplierCapabilityEsgRow](docs/SupplierCapabilityEsgRow.md)
823
840
  - [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
+
@@ -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'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'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
 
@@ -0,0 +1,282 @@
1
+ # PharmaObservatory::SubscriptionsApi
2
+
3
+ All URIs are relative to *https://pharmaobservatory.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**changes_list**](SubscriptionsApi.md#changes_list) | **GET** /api/v1/changes | Changes since a cursor |
8
+ | [**subscriptions_create**](SubscriptionsApi.md#subscriptions_create) | **POST** /api/v1/subscriptions | Follow an entity or a dataset query |
9
+ | [**subscriptions_delete**](SubscriptionsApi.md#subscriptions_delete) | **DELETE** /api/v1/subscriptions/{id} | Stop following |
10
+ | [**subscriptions_list**](SubscriptionsApi.md#subscriptions_list) | **GET** /api/v1/subscriptions | List your subscriptions |
11
+
12
+
13
+ ## changes_list
14
+
15
+ > <ChangesList200Response> changes_list(opts)
16
+
17
+ Changes since a cursor
18
+
19
+ ### Examples
20
+
21
+ ```ruby
22
+ require 'time'
23
+ require 'pharmaobservatory'
24
+ # setup authorization
25
+ PharmaObservatory.configure do |config|
26
+ # Configure Bearer authorization (JWT): ApiBearerJwt
27
+ config.access_token = 'YOUR_BEARER_TOKEN'
28
+ end
29
+
30
+ api_instance = PharmaObservatory::SubscriptionsApi.new
31
+ opts = {
32
+ cursor: 'eyJ2IjoxLCJvIjoiMjAyNi0xMS0wMlQwNjowMjowMC4wMDAwMDBaIiwiaSI6OTAwMn0', # String |
33
+ limit: 2 # Integer |
34
+ }
35
+
36
+ begin
37
+ # Changes since a cursor
38
+ result = api_instance.changes_list(opts)
39
+ p result
40
+ rescue PharmaObservatory::ApiError => e
41
+ puts "Error when calling SubscriptionsApi->changes_list: #{e}"
42
+ end
43
+ ```
44
+
45
+ #### Using the changes_list_with_http_info variant
46
+
47
+ This returns an Array which contains the response data, status code and headers.
48
+
49
+ > <Array(<ChangesList200Response>, Integer, Hash)> changes_list_with_http_info(opts)
50
+
51
+ ```ruby
52
+ begin
53
+ # Changes since a cursor
54
+ data, status_code, headers = api_instance.changes_list_with_http_info(opts)
55
+ p status_code # => 2xx
56
+ p headers # => { ... }
57
+ p data # => <ChangesList200Response>
58
+ rescue PharmaObservatory::ApiError => e
59
+ puts "Error when calling SubscriptionsApi->changes_list_with_http_info: #{e}"
60
+ end
61
+ ```
62
+
63
+ ### Parameters
64
+
65
+ | Name | Type | Description | Notes |
66
+ | ---- | ---- | ----------- | ----- |
67
+ | **cursor** | **String** | | [optional] |
68
+ | **limit** | **Integer** | | [optional] |
69
+
70
+ ### Return type
71
+
72
+ [**ChangesList200Response**](ChangesList200Response.md)
73
+
74
+ ### Authorization
75
+
76
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: Not defined
81
+ - **Accept**: application/json
82
+
83
+
84
+ ## subscriptions_create
85
+
86
+ > <SubscriptionsCreate201Response> subscriptions_create(opts)
87
+
88
+ Follow an entity or a dataset query
89
+
90
+ ### Examples
91
+
92
+ ```ruby
93
+ require 'time'
94
+ require 'pharmaobservatory'
95
+ # setup authorization
96
+ PharmaObservatory.configure do |config|
97
+ # Configure Bearer authorization (JWT): ApiBearerJwt
98
+ config.access_token = 'YOUR_BEARER_TOKEN'
99
+ end
100
+
101
+ api_instance = PharmaObservatory::SubscriptionsApi.new
102
+ opts = {
103
+ subscriptions_create_request: PharmaObservatory::SubscriptionsCreateRequest.new({object_type: 'object_type_example', entity_id: 'entity_id_example'}) # SubscriptionsCreateRequest |
104
+ }
105
+
106
+ begin
107
+ # Follow an entity or a dataset query
108
+ result = api_instance.subscriptions_create(opts)
109
+ p result
110
+ rescue PharmaObservatory::ApiError => e
111
+ puts "Error when calling SubscriptionsApi->subscriptions_create: #{e}"
112
+ end
113
+ ```
114
+
115
+ #### Using the subscriptions_create_with_http_info variant
116
+
117
+ This returns an Array which contains the response data, status code and headers.
118
+
119
+ > <Array(<SubscriptionsCreate201Response>, Integer, Hash)> subscriptions_create_with_http_info(opts)
120
+
121
+ ```ruby
122
+ begin
123
+ # Follow an entity or a dataset query
124
+ data, status_code, headers = api_instance.subscriptions_create_with_http_info(opts)
125
+ p status_code # => 2xx
126
+ p headers # => { ... }
127
+ p data # => <SubscriptionsCreate201Response>
128
+ rescue PharmaObservatory::ApiError => e
129
+ puts "Error when calling SubscriptionsApi->subscriptions_create_with_http_info: #{e}"
130
+ end
131
+ ```
132
+
133
+ ### Parameters
134
+
135
+ | Name | Type | Description | Notes |
136
+ | ---- | ---- | ----------- | ----- |
137
+ | **subscriptions_create_request** | [**SubscriptionsCreateRequest**](SubscriptionsCreateRequest.md) | | [optional] |
138
+
139
+ ### Return type
140
+
141
+ [**SubscriptionsCreate201Response**](SubscriptionsCreate201Response.md)
142
+
143
+ ### Authorization
144
+
145
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
146
+
147
+ ### HTTP request headers
148
+
149
+ - **Content-Type**: application/json
150
+ - **Accept**: application/json
151
+
152
+
153
+ ## subscriptions_delete
154
+
155
+ > <SubscriptionsDelete200Response> subscriptions_delete(id)
156
+
157
+ Stop following
158
+
159
+ ### Examples
160
+
161
+ ```ruby
162
+ require 'time'
163
+ require 'pharmaobservatory'
164
+ # setup authorization
165
+ PharmaObservatory.configure do |config|
166
+ # Configure Bearer authorization (JWT): ApiBearerJwt
167
+ config.access_token = 'YOUR_BEARER_TOKEN'
168
+ end
169
+
170
+ api_instance = PharmaObservatory::SubscriptionsApi.new
171
+ id = 4242 # Integer |
172
+
173
+ begin
174
+ # Stop following
175
+ result = api_instance.subscriptions_delete(id)
176
+ p result
177
+ rescue PharmaObservatory::ApiError => e
178
+ puts "Error when calling SubscriptionsApi->subscriptions_delete: #{e}"
179
+ end
180
+ ```
181
+
182
+ #### Using the subscriptions_delete_with_http_info variant
183
+
184
+ This returns an Array which contains the response data, status code and headers.
185
+
186
+ > <Array(<SubscriptionsDelete200Response>, Integer, Hash)> subscriptions_delete_with_http_info(id)
187
+
188
+ ```ruby
189
+ begin
190
+ # Stop following
191
+ data, status_code, headers = api_instance.subscriptions_delete_with_http_info(id)
192
+ p status_code # => 2xx
193
+ p headers # => { ... }
194
+ p data # => <SubscriptionsDelete200Response>
195
+ rescue PharmaObservatory::ApiError => e
196
+ puts "Error when calling SubscriptionsApi->subscriptions_delete_with_http_info: #{e}"
197
+ end
198
+ ```
199
+
200
+ ### Parameters
201
+
202
+ | Name | Type | Description | Notes |
203
+ | ---- | ---- | ----------- | ----- |
204
+ | **id** | **Integer** | | |
205
+
206
+ ### Return type
207
+
208
+ [**SubscriptionsDelete200Response**](SubscriptionsDelete200Response.md)
209
+
210
+ ### Authorization
211
+
212
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
213
+
214
+ ### HTTP request headers
215
+
216
+ - **Content-Type**: Not defined
217
+ - **Accept**: application/json
218
+
219
+
220
+ ## subscriptions_list
221
+
222
+ > <SubscriptionsList200Response> subscriptions_list
223
+
224
+ List your subscriptions
225
+
226
+ ### Examples
227
+
228
+ ```ruby
229
+ require 'time'
230
+ require 'pharmaobservatory'
231
+ # setup authorization
232
+ PharmaObservatory.configure do |config|
233
+ # Configure Bearer authorization (JWT): ApiBearerJwt
234
+ config.access_token = 'YOUR_BEARER_TOKEN'
235
+ end
236
+
237
+ api_instance = PharmaObservatory::SubscriptionsApi.new
238
+
239
+ begin
240
+ # List your subscriptions
241
+ result = api_instance.subscriptions_list
242
+ p result
243
+ rescue PharmaObservatory::ApiError => e
244
+ puts "Error when calling SubscriptionsApi->subscriptions_list: #{e}"
245
+ end
246
+ ```
247
+
248
+ #### Using the subscriptions_list_with_http_info variant
249
+
250
+ This returns an Array which contains the response data, status code and headers.
251
+
252
+ > <Array(<SubscriptionsList200Response>, Integer, Hash)> subscriptions_list_with_http_info
253
+
254
+ ```ruby
255
+ begin
256
+ # List your subscriptions
257
+ data, status_code, headers = api_instance.subscriptions_list_with_http_info
258
+ p status_code # => 2xx
259
+ p headers # => { ... }
260
+ p data # => <SubscriptionsList200Response>
261
+ rescue PharmaObservatory::ApiError => e
262
+ puts "Error when calling SubscriptionsApi->subscriptions_list_with_http_info: #{e}"
263
+ end
264
+ ```
265
+
266
+ ### Parameters
267
+
268
+ This endpoint does not need any parameter.
269
+
270
+ ### Return type
271
+
272
+ [**SubscriptionsList200Response**](SubscriptionsList200Response.md)
273
+
274
+ ### Authorization
275
+
276
+ [ApiBearerJwt](../README.md#ApiBearerJwt)
277
+
278
+ ### HTTP request headers
279
+
280
+ - **Content-Type**: Not defined
281
+ - **Accept**: application/json
282
+
@@ -0,0 +1,22 @@
1
+ # PharmaObservatory::SubscriptionsCreate201Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **subscription** | [**SubscriptionsCreate201ResponseSubscription**](SubscriptionsCreate201ResponseSubscription.md) | | |
8
+ | **created** | **Boolean** | | |
9
+ | **build_state** | [**ChangesList200ResponseBuildState**](ChangesList200ResponseBuildState.md) | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'pharmaobservatory'
15
+
16
+ instance = PharmaObservatory::SubscriptionsCreate201Response.new(
17
+ subscription: null,
18
+ created: null,
19
+ build_state: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,28 @@
1
+ # PharmaObservatory::SubscriptionsCreate201ResponseSubscription
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | | |
8
+ | **label** | **String** | | |
9
+ | **target** | [**SubscriptionsCreate201ResponseSubscriptionTarget**](SubscriptionsCreate201ResponseSubscriptionTarget.md) | | |
10
+ | **event_types** | **Array&lt;String&gt;** | | |
11
+ | **paused** | **Boolean** | | |
12
+ | **created_at** | **String** | | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'pharmaobservatory'
18
+
19
+ instance = PharmaObservatory::SubscriptionsCreate201ResponseSubscription.new(
20
+ id: null,
21
+ label: null,
22
+ target: null,
23
+ event_types: null,
24
+ paused: null,
25
+ created_at: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,22 @@
1
+ # PharmaObservatory::SubscriptionsCreate201ResponseSubscriptionTarget
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **kind** | **String** | | |
8
+ | **object_type** | **String** | | |
9
+ | **entity_id** | **String** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'pharmaobservatory'
15
+
16
+ instance = PharmaObservatory::SubscriptionsCreate201ResponseSubscriptionTarget.new(
17
+ kind: null,
18
+ object_type: null,
19
+ entity_id: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # PharmaObservatory::SubscriptionsCreateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **object_type** | **String** | | |
8
+ | **entity_id** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'pharmaobservatory'
14
+
15
+ instance = PharmaObservatory::SubscriptionsCreateRequest.new(
16
+ object_type: null,
17
+ entity_id: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # PharmaObservatory::SubscriptionsDelete200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **deleted** | **Boolean** | | |
8
+ | **id** | **Integer** | | |
9
+ | **label** | **String** | | |
10
+ | **build_state** | [**ChangesList200ResponseBuildState**](ChangesList200ResponseBuildState.md) | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'pharmaobservatory'
16
+
17
+ instance = PharmaObservatory::SubscriptionsDelete200Response.new(
18
+ deleted: null,
19
+ id: null,
20
+ label: null,
21
+ build_state: null
22
+ )
23
+ ```
24
+