Class: CandidApiClient::NonInsurancePayers::V1::V1Client

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:



22
23
24
 
# File 'lib/candidhealth/non_insurance_payers/v_1/client.rb', line 22

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ CandidApiClient::RequestClient (readonly)

Returns:



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

def request_client
  @request_client
end

Instance Method Details

#create(request:, request_options: nil) ⇒ CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayer

Examples:

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

Parameters:

  • request (Hash) —

    Request of type CandidApiClient::NonInsurancePayers::V1::Types::CreateNonInsurancePayerRequest, as a Hash

    • :name (String)

    • :description (String)

    • :category (String)

    • :address (Hash)

      • :zip_plus_four_code (String)

      • :address_1 (String)

      • :address_2 (String)

      • :city (String)

      • :state (CandidApiClient::Commons::Types::State)

      • :zip_code (String)

    • :clinical_trials (Array<CandidApiClient::ClinicalTrials::V1::Types::MutableClinicalTrial>)

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

Returns:



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

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: CandidApi,
                                       request_options: request_options)}/api/non-insurance-payers/v1"
  end
  CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayer.from_json(json_object: response.body)
end

#delete(non_insurance_payer_id:, request_options: nil) ⇒ Void

Examples:

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

Parameters:

Returns:

  • (Void) 


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

def delete(non_insurance_payer_id:, 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: CandidApi,
                                       request_options: request_options)}/api/non-insurance-payers/v1/#{non_insurance_payer_id}"
  end
end

#get(non_insurance_payer_id:, request_options: nil) ⇒ CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayer

Examples:

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

Parameters:

Returns:



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

def get(non_insurance_payer_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/non-insurance-payers/v1/#{non_insurance_payer_id}"
  end
  CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayer.from_json(json_object: response.body)
end

#get_multi(name: nil, category: nil, enabled: nil, sort: nil, sort_direction: nil, limit: nil, page_token: nil, request_options: nil) ⇒ CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayerPage

Examples:

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

Parameters:

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/candidhealth/non_insurance_payers/v_1/client.rb', line 95

def get_multi(name: nil, category: nil, enabled: nil, sort: nil, sort_direction: nil, limit: nil,
              page_token: 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 || {}),
      "name": name,
      "category": category,
      "enabled": enabled,
      "sort": sort,
      "sort_direction": sort_direction,
      "limit": limit,
      "page_token": page_token
    }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/non-insurance-payers/v1"
  end
  CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayerPage.from_json(json_object: response.body)
end

#toggle_enablement(non_insurance_payer_id:, request:, request_options: nil) ⇒ CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayer

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.non_insurance_payers.v_1.toggle_enablement(non_insurance_payer_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { enabled: true })

Parameters:

  • non_insurance_payer_id (String)
  • request (Hash) —

    Request of type CandidApiClient::NonInsurancePayers::V1::Types::ToggleNonInsurancePayerEnablementRequest, as a Hash

    • :enabled (Boolean)

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

Returns:



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

def toggle_enablement(non_insurance_payer_id:, request:, request_options: nil)
  response = @request_client.conn.patch 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: CandidApi,
                                       request_options: request_options)}/api/non-insurance-payers/v1/#{non_insurance_payer_id}/toggle_enablement"
  end
  CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayer.from_json(json_object: response.body)
end

#update(non_insurance_payer_id:, request:, request_options: nil) ⇒ CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayer

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.non_insurance_payers.v_1.update(non_insurance_payer_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: {  })

Parameters:

  • non_insurance_payer_id (String)
  • request (Hash) —

    Request of type CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayerUpdateRequest, as a Hash

    • :name (String)

    • :description (Hash)

    • :category (Hash)

    • :address (Hash)

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

Returns:



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

def update(non_insurance_payer_id:, request:, request_options: nil)
  response = @request_client.conn.patch 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: CandidApi,
                                       request_options: request_options)}/api/non-insurance-payers/v1/#{non_insurance_payer_id}"
  end
  CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayer.from_json(json_object: response.body)
end