Class: CandidApiClient::WriteOffs::V1::V1Client

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ CandidApiClient::WriteOffs::V1::V1Client

Parameters:



23
24
25
 
# File 'lib/candidhealth/write_offs/v_1/client.rb', line 23

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ CandidApiClient::RequestClient (readonly)

Returns:



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

def request_client
  @request_client
end

Instance Method Details

#create(write_offs:, request_options: nil) ⇒ CandidApiClient::WriteOffs::V1::Types::CreateWriteOffsResponse

Creates one or many write-offs applied toward a specific service line,

claim, or billing provider.

Examples:

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

Parameters:

  • write_offs (Array<Hash>) —

    Request of type Array<CandidApiClient::WriteOffs::V1::Types::WriteOffCreate>, as a Hash

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

Returns:



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

def create(write_offs:, 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_options&.additional_body_parameters || {}), write_offs: write_offs }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/write-offs/v1"
  end
  CandidApiClient::WriteOffs::V1::Types::CreateWriteOffsResponse.from_json(json_object: response.body)
end

#get(write_off_id:, request_options: nil) ⇒ CandidApiClient::WriteOffs::V1::Types::WriteOff

Retrieves a previously created write off by its ‘write_off_id`.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.write_offs.v_1.get(write_off_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/candidhealth/write_offs/v_1/client.rb', line 81

def get(write_off_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: CandidApi,
                                       request_options: request_options)}/api/write-offs/v1/#{write_off_id}"
  end
  CandidApiClient::WriteOffs::V1::Types::WriteOff.from_json(json_object: response.body)
end

#get_multi(limit: nil, patient_external_id: nil, payer_uuid: nil, service_line_id: nil, claim_id: nil, billing_provider_id: nil, sort: nil, sort_direction: nil, page_token: nil, account_types: nil, request_options: nil) ⇒ CandidApiClient::WriteOffs::V1::Types::WriteOffsPage

Returns all write-offs satisfying the search criteria.

Examples:

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

Parameters:

Returns:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/candidhealth/write_offs/v_1/client.rb', line 44

def get_multi(limit: nil, patient_external_id: nil, payer_uuid: nil, service_line_id: nil, claim_id: nil,
              billing_provider_id: nil, sort: nil, sort_direction: nil, page_token: nil, account_types: 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 || {}),
      "limit": limit,
      "patient_external_id": patient_external_id,
      "payer_uuid": payer_uuid,
      "service_line_id": service_line_id,
      "claim_id": claim_id,
      "billing_provider_id": billing_provider_id,
      "sort": sort,
      "sort_direction": sort_direction,
      "page_token": page_token,
      "account_types": 
    }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/write-offs/v1"
  end
  CandidApiClient::WriteOffs::V1::Types::WriteOffsPage.from_json(json_object: response.body)
end

#revert(write_off_id:, request_options: nil) ⇒ CandidApiClient::WriteOffs::V1::Types::WriteOff

Reverts a write off given a ‘write_off_id`.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.write_offs.v_1.revert(write_off_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:



129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/candidhealth/write_offs/v_1/client.rb', line 129

def revert(write_off_id:, 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.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/write-offs/v1/#{write_off_id}/revert"
  end
  CandidApiClient::WriteOffs::V1::Types::WriteOff.from_json(json_object: response.body)
end

#revert_era_originated_insurance_balance_adjustment(adjustment_id:, request_options: nil) ⇒ String

Reverts an ERA-originated Insurance Balance Adjustment given an ‘adjustment_id`

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.write_offs.v_1.revert_era_originated_insurance_balance_adjustment(adjustment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:

  • (String) 


175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/candidhealth/write_offs/v_1/client.rb', line 175

def revert_era_originated_insurance_balance_adjustment(adjustment_id:, 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.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/write-offs/v1/#{adjustment_id}/revert-era-originated"
  end
  JSON.parse(response.body)
end

#revert_insurance_balance_adjustment(adjustment_id:, request_options: nil) ⇒ CandidApiClient::WriteOffs::V1::Types::WriteOff

Reverts an Insurance Balance Adjustment given an ‘adjustment_id`

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.write_offs.v_1.revert_insurance_balance_adjustment(adjustment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:



152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/candidhealth/write_offs/v_1/client.rb', line 152

def revert_insurance_balance_adjustment(adjustment_id:, 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.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/write-offs/v1/#{adjustment_id}/revert"
  end
  CandidApiClient::WriteOffs::V1::Types::WriteOff.from_json(json_object: response.body)
end