casemanager_client

CasemanagerClient - the Ruby gem for the SPX: CaseManager

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.1.1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build casemanager_client.gemspec

Then either install the gem locally:

gem install ./casemanager_client-1.0.0.gem

(for development, run gem install --dev ./casemanager_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'casemanager_client', '~> 1.0.0'

Install from Git

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:

gem 'casemanager_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'casemanager_client'

# Setup authorization
CasemanagerClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = CasemanagerClient::DefaultApi.new
v = 'v_example' # String | Version of the CaseManager API. Required to be `v=root_v1`
source_type = 'source_type_example' # String | The type of item being updated or created
source_identifier = 'source_identifier_example' # String | The ID or key of the item
opts = {
  case_key: 'case_key_example' # String | If this item is known to belong to a case, the case key can be provided
}

begin
  #Creates or updates case items
  api_instance.case_items_post(v, source_type, source_identifier, opts)
rescue CasemanagerClient::ApiError => e
  puts "Exception when calling DefaultApi->case_items_post: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://casemanager.dev.cmmint.net

Class	Method	HTTP request	Description
CasemanagerClient::DefaultApi	case_items_post	POST /case_items	Creates or updates case items
CasemanagerClient::DefaultApi	cases_key_events_post	POST /cases/key/events	Apply an event to a case.
CasemanagerClient::DefaultApi	list_patients	GET /patients	List all Patients with Cases. Allows optional search parameters; search parameters are ANDed together.
CasemanagerClient::DefaultApi	show_case	GET /cases/key	Get the details of a specific case

Documentation for Models

• CasemanagerClient::CaseItem
• CasemanagerClient::CaseWithPatient
• CasemanagerClient::Error
• CasemanagerClient::ModelCase
• CasemanagerClient::Patient
• CasemanagerClient::PatientWithCases
• CasemanagerClient::Workflow
• CasemanagerClient::WorkflowTask

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication