Class: Candid::Exports::V3::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/candid/exports/v_3/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Candid::Exports::V3::Client 



8
9
10
 
# File 'lib/candid/exports/v_3/client.rb', line 8

def initialize(client:)
  @client = client
end

Instance Method Details

#get_exports(request_options: {}, **params) ⇒ Candid::Exports::V3::Types::GetExportsResponse

<Warning> API-based exports are in the process of being deprecated in favor of Candid Data Share and are not being offered to new customers. Please see the [Candid Data Share docs](docs.joincandidhealth.com/introduction/candid-data-share) for more information. </Warning>

Retrieve CSV-formatted reports on claim submissions and outcomes. This endpoint returns Export objects that contain an authenticated URL to a customer’s reports with a 2min TTL. The schema for the CSV export can be found [here](app.joincandidhealth.com/files/exports_schema.csv).

**Schema changes:** Changing column order, removing columns, or changing the name of a column is considered a [Breaking Change](../../../api-principles/breaking-changes). Adding new columns to the end of the Exports file is not considered a Breaking Change and happens periodically. For this reason, it is important that any downstream automation or processes built on top of Candid Health’s export files be resilient to the addition of new columns at the end of the file.

**SLA guarantees:** Files for a given date are guaranteed to be available after 3 business days. For example, Friday’s file will be available by Wednesday at the latest. If file generation is still in progress upon request before 3 business days have passed, the caller will receive a 422 response. If the file has already been generated, it will be served. Historic files should be available up to 90 days in the past by default. Please email our [Support team]([email protected]) with any data requests outside of these stated guarantees.

Returns:



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/candid/exports/v_3/client.rb', line 32

def get_exports(request_options: {}, **params)
  params = Candid::Internal::Types::Utils.symbolize_keys(params)
  _query_param_names = %i[start_date end_date]
  _query = params.slice(*_query_param_names)
  params.except(*_query_param_names)

  _request = Candid::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Candid::Environment::PRODUCTION,
    method: "GET",
    path: "/api/exports/v3",
    query: _query
  )
  begin
    _response = @client.send(_request)
  rescue Net::HTTPRequestTimeout
    raise Candid::Errors::TimeoutError
  end
  code = _response.code.to_i
  if code.between?(200, 299)
    Candid::Exports::V3::Types::GetExportsResponse.load(_response.body)
  else
    error_class = Candid::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(_response.body, code: code)
  end
end