casemanager_client 0.0.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 +7 -0
- data/Gemfile +8 -0
- data/Gemfile.lock +79 -0
- data/README.md +111 -0
- data/Rakefile +10 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/casemanager_client.gemspec +45 -0
- data/docs/CaseItem.md +10 -0
- data/docs/CaseWithPatient.md +12 -0
- data/docs/DefaultApi.md +238 -0
- data/docs/Error.md +9 -0
- data/docs/ModelCase.md +11 -0
- data/docs/Patient.md +14 -0
- data/docs/PatientWithCases.md +15 -0
- data/docs/Patients.md +8 -0
- data/docs/Workflow.md +9 -0
- data/docs/WorkflowTask.md +14 -0
- data/gen.sh +3 -0
- data/git_push.sh +55 -0
- data/lib/casemanager_client.rb +48 -0
- data/lib/casemanager_client/api/default_api.rb +301 -0
- data/lib/casemanager_client/api_client.rb +390 -0
- data/lib/casemanager_client/api_error.rb +38 -0
- data/lib/casemanager_client/configuration.rb +259 -0
- data/lib/casemanager_client/models/case_item.rb +250 -0
- data/lib/casemanager_client/models/case_with_patient.rb +236 -0
- data/lib/casemanager_client/models/error.rb +202 -0
- data/lib/casemanager_client/models/model_case.rb +222 -0
- data/lib/casemanager_client/models/patient.rb +242 -0
- data/lib/casemanager_client/models/patient_with_cases.rb +258 -0
- data/lib/casemanager_client/models/patients.rb +190 -0
- data/lib/casemanager_client/models/workflow.rb +204 -0
- data/lib/casemanager_client/models/workflow_task.rb +272 -0
- data/lib/casemanager_client/version.rb +15 -0
- data/pkg/casemanager_client-0.0.5.gem +0 -0
- data/spec/api/default_api_spec.rb +60 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/case_item_spec.rb +53 -0
- data/spec/models/case_with_patient_spec.rb +59 -0
- data/spec/models/error_spec.rb +47 -0
- data/spec/models/model_case_spec.rb +53 -0
- data/spec/models/patient_spec.rb +53 -0
- data/spec/models/patient_with_cases_spec.rb +59 -0
- data/spec/models/workflow_spec.rb +47 -0
- data/spec/models/workflow_task_spec.rb +77 -0
- data/spec/spec_helper.rb +111 -0
- metadata +283 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA1:
|
|
3
|
+
metadata.gz: ecdc706df52551d7fb41d9bbfde891a033e6d9ba
|
|
4
|
+
data.tar.gz: 5400263dbe8f263ba347f530121e25207532e688
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 7b2f080752a055816276cb254884d8077900452f7271e7d0098473c400b5fccea264e4192b3db7c0c14fcbc84933014066cd6992dd1956570bc4f5b667e7c558
|
|
7
|
+
data.tar.gz: f9628a9510bca9029737008357dba8fe841333221f8f9b8dbec93d903b887ca8896ec19da8df2875db4be11ebbc53fdf53dc71d28d226a3786a7feb807ab1948
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
PATH
|
|
2
|
+
remote: .
|
|
3
|
+
specs:
|
|
4
|
+
casemanager_client (0.0.5)
|
|
5
|
+
json (~> 2.1, >= 2.1.0)
|
|
6
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
|
7
|
+
|
|
8
|
+
GEM
|
|
9
|
+
remote: https://rubygems.org/
|
|
10
|
+
specs:
|
|
11
|
+
ZenTest (4.11.1)
|
|
12
|
+
addressable (2.5.2)
|
|
13
|
+
public_suffix (>= 2.0.2, < 4.0)
|
|
14
|
+
autotest (4.4.6)
|
|
15
|
+
ZenTest (>= 4.4.1)
|
|
16
|
+
autotest-fsevent (0.2.14)
|
|
17
|
+
sys-uname
|
|
18
|
+
autotest-growl (0.2.16)
|
|
19
|
+
autotest-rails-pure (4.1.2)
|
|
20
|
+
byebug (10.0.2)
|
|
21
|
+
coderay (1.1.2)
|
|
22
|
+
crack (0.4.3)
|
|
23
|
+
safe_yaml (~> 1.0.0)
|
|
24
|
+
diff-lcs (1.3)
|
|
25
|
+
ethon (0.11.0)
|
|
26
|
+
ffi (>= 1.3.0)
|
|
27
|
+
ffi (1.9.25)
|
|
28
|
+
hashdiff (0.3.7)
|
|
29
|
+
json (2.1.0)
|
|
30
|
+
method_source (0.9.0)
|
|
31
|
+
pry (0.11.3)
|
|
32
|
+
coderay (~> 1.1.0)
|
|
33
|
+
method_source (~> 0.9.0)
|
|
34
|
+
pry-byebug (3.6.0)
|
|
35
|
+
byebug (~> 10.0)
|
|
36
|
+
pry (~> 0.10)
|
|
37
|
+
public_suffix (3.0.3)
|
|
38
|
+
rake (12.0.0)
|
|
39
|
+
rspec (3.8.0)
|
|
40
|
+
rspec-core (~> 3.8.0)
|
|
41
|
+
rspec-expectations (~> 3.8.0)
|
|
42
|
+
rspec-mocks (~> 3.8.0)
|
|
43
|
+
rspec-core (3.8.0)
|
|
44
|
+
rspec-support (~> 3.8.0)
|
|
45
|
+
rspec-expectations (3.8.1)
|
|
46
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
47
|
+
rspec-support (~> 3.8.0)
|
|
48
|
+
rspec-mocks (3.8.0)
|
|
49
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
50
|
+
rspec-support (~> 3.8.0)
|
|
51
|
+
rspec-support (3.8.0)
|
|
52
|
+
safe_yaml (1.0.4)
|
|
53
|
+
sys-uname (1.0.3)
|
|
54
|
+
ffi (>= 1.0.0)
|
|
55
|
+
typhoeus (1.3.1)
|
|
56
|
+
ethon (>= 0.9.0)
|
|
57
|
+
vcr (3.0.3)
|
|
58
|
+
webmock (1.24.6)
|
|
59
|
+
addressable (>= 2.3.6)
|
|
60
|
+
crack (>= 0.3.2)
|
|
61
|
+
hashdiff
|
|
62
|
+
|
|
63
|
+
PLATFORMS
|
|
64
|
+
ruby
|
|
65
|
+
|
|
66
|
+
DEPENDENCIES
|
|
67
|
+
autotest (~> 4.4, >= 4.4.6)
|
|
68
|
+
autotest-fsevent (~> 0.2, >= 0.2.12)
|
|
69
|
+
autotest-growl (~> 0.2, >= 0.2.16)
|
|
70
|
+
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
|
71
|
+
casemanager_client!
|
|
72
|
+
pry-byebug
|
|
73
|
+
rake (~> 12.0.0)
|
|
74
|
+
rspec (~> 3.6, >= 3.6.0)
|
|
75
|
+
vcr (~> 3.0, >= 3.0.1)
|
|
76
|
+
webmock (~> 1.24, >= 1.24.3)
|
|
77
|
+
|
|
78
|
+
BUNDLED WITH
|
|
79
|
+
1.16.2
|
data/README.md
ADDED
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# casemanager_client
|
|
2
|
+
|
|
3
|
+
CasemanagerClient - the Ruby gem for the SPX: CaseManager
|
|
4
|
+
|
|
5
|
+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
+
|
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
|
+
|
|
9
|
+
- API version: 1.1.1
|
|
10
|
+
- Package version: 1.0.0
|
|
11
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
### Build a gem
|
|
16
|
+
|
|
17
|
+
To build the Ruby code into a gem:
|
|
18
|
+
|
|
19
|
+
```shell
|
|
20
|
+
gem build casemanager_client.gemspec
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Then either install the gem locally:
|
|
24
|
+
|
|
25
|
+
```shell
|
|
26
|
+
gem install ./casemanager_client-1.0.0.gem
|
|
27
|
+
```
|
|
28
|
+
(for development, run `gem install --dev ./casemanager_client-1.0.0.gem` to install the development dependencies)
|
|
29
|
+
|
|
30
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
31
|
+
|
|
32
|
+
Finally add this to the Gemfile:
|
|
33
|
+
|
|
34
|
+
gem 'casemanager_client', '~> 1.0.0'
|
|
35
|
+
|
|
36
|
+
### Install from Git
|
|
37
|
+
|
|
38
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
|
39
|
+
|
|
40
|
+
gem 'casemanager_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
|
41
|
+
|
|
42
|
+
### Include the Ruby code directly
|
|
43
|
+
|
|
44
|
+
Include the Ruby code directly using `-I` as follows:
|
|
45
|
+
|
|
46
|
+
```shell
|
|
47
|
+
ruby -Ilib script.rb
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Getting Started
|
|
51
|
+
|
|
52
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
|
53
|
+
```ruby
|
|
54
|
+
# Load the gem
|
|
55
|
+
require 'casemanager_client'
|
|
56
|
+
|
|
57
|
+
# Setup authorization
|
|
58
|
+
CasemanagerClient.configure do |config|
|
|
59
|
+
# Configure HTTP basic authorization: basicAuth
|
|
60
|
+
config.username = 'YOUR USERNAME'
|
|
61
|
+
config.password = 'YOUR PASSWORD'
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
api_instance = CasemanagerClient::DefaultApi.new
|
|
65
|
+
v = 'v_example' # String | Version of the CaseManager API. Required to be `v=root_v1`
|
|
66
|
+
source_type = 'source_type_example' # String | The type of item being updated or created
|
|
67
|
+
source_identifier = 'source_identifier_example' # String | The ID or key of the item
|
|
68
|
+
opts = {
|
|
69
|
+
case_key: 'case_key_example' # String | If this item is known to belong to a case, the case key can be provided
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
begin
|
|
73
|
+
#Creates or updates case items
|
|
74
|
+
api_instance.case_items_post(v, source_type, source_identifier, opts)
|
|
75
|
+
rescue CasemanagerClient::ApiError => e
|
|
76
|
+
puts "Exception when calling DefaultApi->case_items_post: #{e}"
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Documentation for API Endpoints
|
|
82
|
+
|
|
83
|
+
All URIs are relative to *http://casemanager.dev.cmmint.net*
|
|
84
|
+
|
|
85
|
+
Class | Method | HTTP request | Description
|
|
86
|
+
------------ | ------------- | ------------- | -------------
|
|
87
|
+
*CasemanagerClient::DefaultApi* | [**case_items_post**](docs/DefaultApi.md#case_items_post) | **POST** /case_items | Creates or updates case items
|
|
88
|
+
*CasemanagerClient::DefaultApi* | [**cases_key_events_post**](docs/DefaultApi.md#cases_key_events_post) | **POST** /cases/{key}/events | Apply an event to a case.
|
|
89
|
+
*CasemanagerClient::DefaultApi* | [**list_patients**](docs/DefaultApi.md#list_patients) | **GET** /patients | List all Patients with Cases. Allows optional search parameters; search parameters are ANDed together.
|
|
90
|
+
*CasemanagerClient::DefaultApi* | [**show_case**](docs/DefaultApi.md#show_case) | **GET** /cases/{key} | Get the details of a specific case
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
## Documentation for Models
|
|
94
|
+
|
|
95
|
+
- [CasemanagerClient::CaseItem](docs/CaseItem.md)
|
|
96
|
+
- [CasemanagerClient::CaseWithPatient](docs/CaseWithPatient.md)
|
|
97
|
+
- [CasemanagerClient::Error](docs/Error.md)
|
|
98
|
+
- [CasemanagerClient::ModelCase](docs/ModelCase.md)
|
|
99
|
+
- [CasemanagerClient::Patient](docs/Patient.md)
|
|
100
|
+
- [CasemanagerClient::PatientWithCases](docs/PatientWithCases.md)
|
|
101
|
+
- [CasemanagerClient::Workflow](docs/Workflow.md)
|
|
102
|
+
- [CasemanagerClient::WorkflowTask](docs/WorkflowTask.md)
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
## Documentation for Authorization
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
### basicAuth
|
|
109
|
+
|
|
110
|
+
- **Type**: HTTP basic authentication
|
|
111
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
|
|
3
|
+
require "bundler/setup"
|
|
4
|
+
require "casemanager_client"
|
|
5
|
+
|
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
|
8
|
+
|
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
|
10
|
+
require "pry"
|
|
11
|
+
Pry.start
|
|
12
|
+
|
|
13
|
+
#require "irb"
|
|
14
|
+
#IRB.start(__FILE__)
|
data/bin/setup
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
|
2
|
+
|
|
3
|
+
=begin
|
|
4
|
+
#SPX: CaseManager
|
|
5
|
+
|
|
6
|
+
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
7
|
+
|
|
8
|
+
OpenAPI spec version: 1.1.1
|
|
9
|
+
|
|
10
|
+
Generated by: https://openapi-generator.tech
|
|
11
|
+
OpenAPI Generator version: 3.3.4
|
|
12
|
+
|
|
13
|
+
=end
|
|
14
|
+
|
|
15
|
+
$:.push File.expand_path("../lib", __FILE__)
|
|
16
|
+
require "casemanager_client/version"
|
|
17
|
+
|
|
18
|
+
Gem::Specification.new do |s|
|
|
19
|
+
s.name = "casemanager_client"
|
|
20
|
+
s.version = CasemanagerClient::VERSION
|
|
21
|
+
s.platform = Gem::Platform::RUBY
|
|
22
|
+
s.authors = ["OpenAPI-Generator"]
|
|
23
|
+
s.email = [""]
|
|
24
|
+
s.homepage = "https://openapi-generator.tech"
|
|
25
|
+
s.summary = "SPX: CaseManager Ruby Gem"
|
|
26
|
+
s.description = "No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)"
|
|
27
|
+
s.license = "Unlicense"
|
|
28
|
+
s.required_ruby_version = ">= 1.9"
|
|
29
|
+
|
|
30
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
|
31
|
+
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
|
32
|
+
|
|
33
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
|
34
|
+
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
|
35
|
+
s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
|
|
36
|
+
s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
|
|
37
|
+
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
|
38
|
+
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
|
39
|
+
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
|
|
40
|
+
|
|
41
|
+
s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
|
|
42
|
+
s.test_files = `find spec/*`.split("\n")
|
|
43
|
+
s.executables = []
|
|
44
|
+
s.require_paths = ["lib"]
|
|
45
|
+
end
|
data/docs/CaseItem.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CasemanagerClient::CaseWithPatient
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**key** | **String** | |
|
|
7
|
+
**patient** | [**Patient**](Patient.md) | |
|
|
8
|
+
**items** | [**Array<CaseItem>**](CaseItem.md) | |
|
|
9
|
+
**created_at** | **String** | | [optional]
|
|
10
|
+
**workflow** | [**Workflow**](Workflow.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
data/docs/DefaultApi.md
ADDED
|
@@ -0,0 +1,238 @@
|
|
|
1
|
+
# CasemanagerClient::DefaultApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://casemanager.dev.cmmint.net*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**case_items_post**](DefaultApi.md#case_items_post) | **POST** /case_items | Creates or updates case items
|
|
8
|
+
[**cases_key_events_post**](DefaultApi.md#cases_key_events_post) | **POST** /cases/{key}/events | Apply an event to a case.
|
|
9
|
+
[**list_patients**](DefaultApi.md#list_patients) | **GET** /patients | List all Patients with Cases. Allows optional search parameters; search parameters are ANDed together.
|
|
10
|
+
[**show_case**](DefaultApi.md#show_case) | **GET** /cases/{key} | Get the details of a specific case
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
# **case_items_post**
|
|
14
|
+
> case_items_post(v, source_type, source_identifier, opts)
|
|
15
|
+
|
|
16
|
+
Creates or updates case items
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
```ruby
|
|
20
|
+
# load the gem
|
|
21
|
+
require 'casemanager_client'
|
|
22
|
+
# setup authorization
|
|
23
|
+
CasemanagerClient.configure do |config|
|
|
24
|
+
# Configure HTTP basic authorization: basicAuth
|
|
25
|
+
config.username = 'YOUR USERNAME'
|
|
26
|
+
config.password = 'YOUR PASSWORD'
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
api_instance = CasemanagerClient::DefaultApi.new
|
|
30
|
+
v = 'v_example' # String | Version of the CaseManager API. Required to be `v=root_v1`
|
|
31
|
+
source_type = 'source_type_example' # String | The type of item being updated or created
|
|
32
|
+
source_identifier = 'source_identifier_example' # String | The ID or key of the item
|
|
33
|
+
opts = {
|
|
34
|
+
case_key: 'case_key_example' # String | If this item is known to belong to a case, the case key can be provided
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
#Creates or updates case items
|
|
39
|
+
api_instance.case_items_post(v, source_type, source_identifier, opts)
|
|
40
|
+
rescue CasemanagerClient::ApiError => e
|
|
41
|
+
puts "Exception when calling DefaultApi->case_items_post: #{e}"
|
|
42
|
+
end
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Parameters
|
|
46
|
+
|
|
47
|
+
Name | Type | Description | Notes
|
|
48
|
+
------------- | ------------- | ------------- | -------------
|
|
49
|
+
**v** | **String**| Version of the CaseManager API. Required to be `v=root_v1` |
|
|
50
|
+
**source_type** | **String**| The type of item being updated or created |
|
|
51
|
+
**source_identifier** | **String**| The ID or key of the item |
|
|
52
|
+
**case_key** | **String**| If this item is known to belong to a case, the case key can be provided | [optional]
|
|
53
|
+
|
|
54
|
+
### Return type
|
|
55
|
+
|
|
56
|
+
nil (empty response body)
|
|
57
|
+
|
|
58
|
+
### Authorization
|
|
59
|
+
|
|
60
|
+
[basicAuth](../README.md#basicAuth)
|
|
61
|
+
|
|
62
|
+
### HTTP request headers
|
|
63
|
+
|
|
64
|
+
- **Content-Type**: Not defined
|
|
65
|
+
- **Accept**: Not defined
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
# **cases_key_events_post**
|
|
70
|
+
> cases_key_events_post(v, user_id, event_type, key)
|
|
71
|
+
|
|
72
|
+
Apply an event to a case.
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
```ruby
|
|
76
|
+
# load the gem
|
|
77
|
+
require 'casemanager_client'
|
|
78
|
+
# setup authorization
|
|
79
|
+
CasemanagerClient.configure do |config|
|
|
80
|
+
# Configure HTTP basic authorization: basicAuth
|
|
81
|
+
config.username = 'YOUR USERNAME'
|
|
82
|
+
config.password = 'YOUR PASSWORD'
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
api_instance = CasemanagerClient::DefaultApi.new
|
|
86
|
+
v = 'v_example' # String | Version of the CaseManager API. Required to be `v=sudo_v1`
|
|
87
|
+
user_id = 56 # Integer | the CMM2 T_Users ID
|
|
88
|
+
event_type = 'event_type_example' # String | The type of event to be applied to the case
|
|
89
|
+
key = 'key_example' # String | The key of the case that the event applies to
|
|
90
|
+
|
|
91
|
+
begin
|
|
92
|
+
#Apply an event to a case.
|
|
93
|
+
api_instance.cases_key_events_post(v, user_id, event_type, key)
|
|
94
|
+
rescue CasemanagerClient::ApiError => e
|
|
95
|
+
puts "Exception when calling DefaultApi->cases_key_events_post: #{e}"
|
|
96
|
+
end
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Parameters
|
|
100
|
+
|
|
101
|
+
Name | Type | Description | Notes
|
|
102
|
+
------------- | ------------- | ------------- | -------------
|
|
103
|
+
**v** | **String**| Version of the CaseManager API. Required to be `v=sudo_v1` |
|
|
104
|
+
**user_id** | **Integer**| the CMM2 T_Users ID |
|
|
105
|
+
**event_type** | **String**| The type of event to be applied to the case |
|
|
106
|
+
**key** | **String**| The key of the case that the event applies to |
|
|
107
|
+
|
|
108
|
+
### Return type
|
|
109
|
+
|
|
110
|
+
nil (empty response body)
|
|
111
|
+
|
|
112
|
+
### Authorization
|
|
113
|
+
|
|
114
|
+
[basicAuth](../README.md#basicAuth)
|
|
115
|
+
|
|
116
|
+
### HTTP request headers
|
|
117
|
+
|
|
118
|
+
- **Content-Type**: Not defined
|
|
119
|
+
- **Accept**: Not defined
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
# **list_patients**
|
|
124
|
+
> Array<PatientWithCases> list_patients(user_id, v, opts)
|
|
125
|
+
|
|
126
|
+
List all Patients with Cases. Allows optional search parameters; search parameters are ANDed together.
|
|
127
|
+
|
|
128
|
+
### Example
|
|
129
|
+
```ruby
|
|
130
|
+
# load the gem
|
|
131
|
+
require 'casemanager_client'
|
|
132
|
+
# setup authorization
|
|
133
|
+
CasemanagerClient.configure do |config|
|
|
134
|
+
# Configure HTTP basic authorization: basicAuth
|
|
135
|
+
config.username = 'YOUR USERNAME'
|
|
136
|
+
config.password = 'YOUR PASSWORD'
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
api_instance = CasemanagerClient::DefaultApi.new
|
|
140
|
+
user_id = 56 # Integer | the CMM2 T_Users ID
|
|
141
|
+
v = 'v_example' # String | Version of the CaseManager API. Required to be `v=sudo_v1`
|
|
142
|
+
opts = {
|
|
143
|
+
first_name: 'first_name_example', # String | Search by patient's first name (substring search)
|
|
144
|
+
middle_name: 'middle_name_example', # String | Search by patient's middle name (substring search)
|
|
145
|
+
last_name: 'last_name_example', # String | Search by patient's last name (substring search)
|
|
146
|
+
date_of_birth: 'date_of_birth_example', # String | Search by patient's date of birth (exact match)
|
|
147
|
+
zipcode: 'zipcode_example' # String | Search by patient's zipcode (exact match)
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
begin
|
|
151
|
+
#List all Patients with Cases. Allows optional search parameters; search parameters are ANDed together.
|
|
152
|
+
result = api_instance.list_patients(user_id, v, opts)
|
|
153
|
+
p result
|
|
154
|
+
rescue CasemanagerClient::ApiError => e
|
|
155
|
+
puts "Exception when calling DefaultApi->list_patients: #{e}"
|
|
156
|
+
end
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
### Parameters
|
|
160
|
+
|
|
161
|
+
Name | Type | Description | Notes
|
|
162
|
+
------------- | ------------- | ------------- | -------------
|
|
163
|
+
**user_id** | **Integer**| the CMM2 T_Users ID |
|
|
164
|
+
**v** | **String**| Version of the CaseManager API. Required to be `v=sudo_v1` |
|
|
165
|
+
**first_name** | **String**| Search by patient's first name (substring search) | [optional]
|
|
166
|
+
**middle_name** | **String**| Search by patient's middle name (substring search) | [optional]
|
|
167
|
+
**last_name** | **String**| Search by patient's last name (substring search) | [optional]
|
|
168
|
+
**date_of_birth** | **String**| Search by patient's date of birth (exact match) | [optional]
|
|
169
|
+
**zipcode** | **String**| Search by patient's zipcode (exact match) | [optional]
|
|
170
|
+
|
|
171
|
+
### Return type
|
|
172
|
+
|
|
173
|
+
[**Array<PatientWithCases>**](PatientWithCases.md)
|
|
174
|
+
|
|
175
|
+
### Authorization
|
|
176
|
+
|
|
177
|
+
[basicAuth](../README.md#basicAuth)
|
|
178
|
+
|
|
179
|
+
### HTTP request headers
|
|
180
|
+
|
|
181
|
+
- **Content-Type**: Not defined
|
|
182
|
+
- **Accept**: application/json
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
# **show_case**
|
|
187
|
+
> CaseWithPatient show_case(key, user_id, v)
|
|
188
|
+
|
|
189
|
+
Get the details of a specific case
|
|
190
|
+
|
|
191
|
+
### Example
|
|
192
|
+
```ruby
|
|
193
|
+
# load the gem
|
|
194
|
+
require 'casemanager_client'
|
|
195
|
+
# setup authorization
|
|
196
|
+
CasemanagerClient.configure do |config|
|
|
197
|
+
# Configure HTTP basic authorization: basicAuth
|
|
198
|
+
config.username = 'YOUR USERNAME'
|
|
199
|
+
config.password = 'YOUR PASSWORD'
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
api_instance = CasemanagerClient::DefaultApi.new
|
|
203
|
+
key = 'key_example' # String |
|
|
204
|
+
user_id = 56 # Integer | the CMM2 T_Users ID
|
|
205
|
+
v = 'v_example' # String | Version of the CaseManager API. Required to be `v=sudo_v1`
|
|
206
|
+
|
|
207
|
+
begin
|
|
208
|
+
#Get the details of a specific case
|
|
209
|
+
result = api_instance.show_case(key, user_id, v)
|
|
210
|
+
p result
|
|
211
|
+
rescue CasemanagerClient::ApiError => e
|
|
212
|
+
puts "Exception when calling DefaultApi->show_case: #{e}"
|
|
213
|
+
end
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### Parameters
|
|
217
|
+
|
|
218
|
+
Name | Type | Description | Notes
|
|
219
|
+
------------- | ------------- | ------------- | -------------
|
|
220
|
+
**key** | **String**| |
|
|
221
|
+
**user_id** | **Integer**| the CMM2 T_Users ID |
|
|
222
|
+
**v** | **String**| Version of the CaseManager API. Required to be `v=sudo_v1` |
|
|
223
|
+
|
|
224
|
+
### Return type
|
|
225
|
+
|
|
226
|
+
[**CaseWithPatient**](CaseWithPatient.md)
|
|
227
|
+
|
|
228
|
+
### Authorization
|
|
229
|
+
|
|
230
|
+
[basicAuth](../README.md#basicAuth)
|
|
231
|
+
|
|
232
|
+
### HTTP request headers
|
|
233
|
+
|
|
234
|
+
- **Content-Type**: Not defined
|
|
235
|
+
- **Accept**: application/json
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|