Class: CandidApiClient::PreEncounter::Notes::V1::V1Client

Inherits:
Object
  • Object
show all
Defined in:
lib/candidhealth/pre_encounter/notes/v_1/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ CandidApiClient::PreEncounter::Notes::V1::V1Client

Parameters:



18
19
20
 
# File 'lib/candidhealth/pre_encounter/notes/v_1/client.rb', line 18

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ CandidApiClient::RequestClient (readonly)

Returns:



14
15
16
 
# File 'lib/candidhealth/pre_encounter/notes/v_1/client.rb', line 14

def request_client
  @request_client
end

Instance Method Details

#create(request:, request_options: nil) ⇒ CandidApiClient::PreEncounter::Notes::V1::Types::Note

Adds a new note.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.pre_encounter.notes.v_1.create(request: { value: "value" })

Parameters:

  • request (Hash) —

    Request of type CandidApiClient::PreEncounter::Notes::V1::Types::MutableNote, as a Hash

    • :value (String)

    • :author_email (String)

    • :author_name (String)

  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/candidhealth/pre_encounter/notes/v_1/client.rb', line 56

def create(request:, request_options: nil)
  response = @request_client.conn.post do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
    req.url "#{@request_client.get_url(environment: PreEncounter, request_options: request_options)}/notes/v1"
  end
  CandidApiClient::PreEncounter::Notes::V1::Types::Note.from_json(json_object: response.body)
end

#deactivate(id:, version:, request_options: nil) ⇒ Void

Sets a note as deactivated. The path must contain the most recent version to

prevent races.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.pre_encounter.notes.v_1.deactivate(id: "id", version: "version")

Parameters:

Returns:

  • (Void) 


114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/candidhealth/pre_encounter/notes/v_1/client.rb', line 114

def deactivate(id:, version:, request_options: nil)
  @request_client.conn.delete do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.url "#{@request_client.get_url(environment: PreEncounter,
                                       request_options: request_options)}/notes/v1/#{id}/#{version}"
  end
end

#get(id:, request_options: nil) ⇒ CandidApiClient::PreEncounter::Notes::V1::Types::Note

Gets a note by NoteId.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.pre_encounter.notes.v_1.get(id: "id")

Parameters:

Returns:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/candidhealth/pre_encounter/notes/v_1/client.rb', line 30

def get(id:, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.url "#{@request_client.get_url(environment: PreEncounter,
                                       request_options: request_options)}/notes/v1/#{id}"
  end
  CandidApiClient::PreEncounter::Notes::V1::Types::Note.from_json(json_object: response.body)
end

#update(id:, version:, request:, request_options: nil) ⇒ CandidApiClient::PreEncounter::Notes::V1::Types::Note

Updates a note. The path must contain the most recent version to prevent races.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.pre_encounter.notes.v_1.update(
  id: "id",
  version: "version",
  request: { value: "value" }
)

Parameters:

  • id (String)
  • version (String)
  • request (Hash) —

    Request of type CandidApiClient::PreEncounter::Notes::V1::Types::MutableNote, as a Hash

    • :value (String)

    • :author_email (String)

    • :author_name (String)

  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/candidhealth/pre_encounter/notes/v_1/client.rb', line 88

def update(id:, version:, request:, request_options: nil)
  response = @request_client.conn.put do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
    req.url "#{@request_client.get_url(environment: PreEncounter,
                                       request_options: request_options)}/notes/v1/#{id}/#{version}"
  end
  CandidApiClient::PreEncounter::Notes::V1::Types::Note.from_json(json_object: response.body)
end