Class: CandidApiClient::PreEncounter::Images::V1::V1Client

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:



19
20
21
 
# File 'lib/candidhealth/pre_encounter/images/v_1/client.rb', line 19

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ CandidApiClient::RequestClient (readonly)

Returns:



15
16
17
 
# File 'lib/candidhealth/pre_encounter/images/v_1/client.rb', line 15

def request_client
  @request_client
end

Instance Method Details

#create(request:, request_options: nil) ⇒ CandidApiClient::PreEncounter::Images::V1::Types::Image

Adds an image. VersionConflictError is returned if a front or back of this

coverage already exists.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.pre_encounter.images.v_1.create(request: { file_name: "file_name", display_name: "display_name", file_type: "file_type", status: PENDING })

Parameters:

  • request (Hash) —

    Request of type CandidApiClient::PreEncounter::Images::V1::Types::MutableImage, as a Hash

    • :file_name (String)

    • :display_name (String)

    • :file_type (String)

    • :status (CandidApiClient::PreEncounter::Images::V1::Types::ImageStatus)

    • :coverage (Hash)

      • :id (String)

      • :side (CandidApiClient::PreEncounter::Images::V1::Types::CoverageImageSide)

    • :patient (Hash)

      • :id (String)

      • :notes (String)

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

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/candidhealth/pre_encounter/images/v_1/client.rb', line 42

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)}/images/v1"
  end
  CandidApiClient::PreEncounter::Images::V1::Types::Image.from_json(json_object: response.body)
end

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

Sets an Image 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.images.v_1.deactivate(id: "id", version: "version")

Parameters:

Returns:

  • (Void) 


132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/candidhealth/pre_encounter/images/v_1/client.rb', line 132

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)}/images/v1/#{id}/#{version}"
  end
end

#get(id:, request_options: nil) ⇒ CandidApiClient::PreEncounter::Images::V1::Types::Image

Gets an image by imageId.

Examples:

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

Parameters:

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/candidhealth/pre_encounter/images/v_1/client.rb', line 66

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)}/images/v1/#{id}"
  end
  CandidApiClient::PreEncounter::Images::V1::Types::Image.from_json(json_object: response.body)
end

#get_multi(patient_id: nil, coverage_id: nil, request_options: nil) ⇒ Array<CandidApiClient::PreEncounter::Images::V1::Types::Image>

Searches for images that match the query parameters.

Examples:

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

Parameters:

Returns:



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/candidhealth/pre_encounter/images/v_1/client.rb', line 155

def get_multi(patient_id: nil, coverage_id: nil, 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.params = {
      **(request_options&.additional_query_parameters || {}),
      "patient_id": patient_id,
      "coverage_id": coverage_id
    }.compact
    req.url "#{@request_client.get_url(environment: PreEncounter,
                                       request_options: request_options)}/images/v1"
  end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do |item|
    item = item.to_json
    CandidApiClient::PreEncounter::Images::V1::Types::Image.from_json(json_object: item)
  end
end

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

Updates an Image. 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.images.v_1.update(
  id: "id",
  version: "version",
  request: { file_name: "file_name", display_name: "display_name", file_type: "file_type", status: PENDING }
)

Parameters:

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

    Request of type CandidApiClient::PreEncounter::Images::V1::Types::MutableImage, as a Hash

    • :file_name (String)

    • :display_name (String)

    • :file_type (String)

    • :status (CandidApiClient::PreEncounter::Images::V1::Types::ImageStatus)

    • :coverage (Hash)

      • :id (String)

      • :side (CandidApiClient::PreEncounter::Images::V1::Types::CoverageImageSide)

    • :patient (Hash)

      • :id (String)

      • :notes (String)

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

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/candidhealth/pre_encounter/images/v_1/client.rb', line 106

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)}/images/v1/#{id}/#{version}"
  end
  CandidApiClient::PreEncounter::Images::V1::Types::Image.from_json(json_object: response.body)
end