candidhealth 0.21.0 → 0.24.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (439) hide show
  1. checksums.yaml +4 -4
  2. data/lib/candidhealth/auth/client.rb +8 -6
  3. data/lib/candidhealth/auth/v_2/client.rb +86 -38
  4. data/lib/candidhealth/auth/v_2/types/auth_get_token_response.rb +61 -43
  5. data/lib/candidhealth/auth/v_2/types/too_many_requests_error_type.rb +44 -33
  6. data/lib/candidhealth/billing_notes/client.rb +8 -6
  7. data/lib/candidhealth/billing_notes/v_2/client.rb +43 -21
  8. data/lib/candidhealth/billing_notes/v_2/types/billing_note.rb +95 -72
  9. data/lib/candidhealth/billing_notes/v_2/types/billing_note_base.rb +44 -33
  10. data/lib/candidhealth/claim_submission/v_1/types/claim_frequency_type_code.rb +6 -4
  11. data/lib/candidhealth/claim_submission/v_1/types/claim_submission_record_create.rb +80 -59
  12. data/lib/candidhealth/claim_submission/v_1/types/external_claim_submission_create.rb +78 -56
  13. data/lib/candidhealth/claims/types/claim.rb +114 -86
  14. data/lib/candidhealth/claims/types/claim_status.rb +19 -17
  15. data/lib/candidhealth/commons/types/claim_adjustment_group_codes.rb +14 -12
  16. data/lib/candidhealth/commons/types/claim_submission_payer_responsibility_type.rb +6 -4
  17. data/lib/candidhealth/commons/types/date_range_optional_end.rb +57 -40
  18. data/lib/candidhealth/commons/types/delay_reason_code.rb +19 -17
  19. data/lib/candidhealth/commons/types/emr_payer_crosswalk.rb +6 -4
  20. data/lib/candidhealth/commons/types/entity_conflict_error_message.rb +45 -34
  21. data/lib/candidhealth/commons/types/entity_not_found_error_message.rb +45 -34
  22. data/lib/candidhealth/commons/types/facility_type_code.rb +58 -55
  23. data/lib/candidhealth/commons/types/http_service_unavailable_error_message.rb +47 -34
  24. data/lib/candidhealth/commons/types/insurance_type_code.rb +76 -73
  25. data/lib/candidhealth/commons/types/intended_submission_medium.rb +9 -5
  26. data/lib/candidhealth/commons/types/network_type.rb +23 -21
  27. data/lib/candidhealth/commons/types/organization_not_authorized_error_message.rb +46 -34
  28. data/lib/candidhealth/commons/types/patient_relationship_to_insured_code_all.rb +28 -26
  29. data/lib/candidhealth/commons/types/phone_number.rb +55 -39
  30. data/lib/candidhealth/commons/types/phone_number_type.rb +7 -5
  31. data/lib/candidhealth/commons/types/procedure_modifier.rb +391 -389
  32. data/lib/candidhealth/commons/types/qualifier_code.rb +14 -0
  33. data/lib/candidhealth/commons/types/region_national.rb +39 -29
  34. data/lib/candidhealth/commons/types/region_states.rb +45 -34
  35. data/lib/candidhealth/commons/types/regions.rb +78 -72
  36. data/lib/candidhealth/commons/types/removable_date_range_optional_end.rb +77 -71
  37. data/lib/candidhealth/commons/types/request_validation_error.rb +57 -39
  38. data/lib/candidhealth/commons/types/resource_page.rb +57 -40
  39. data/lib/candidhealth/commons/types/service_line_units.rb +6 -4
  40. data/lib/candidhealth/commons/types/sort_direction.rb +6 -4
  41. data/lib/candidhealth/commons/types/source_of_payment_code.rb +28 -26
  42. data/lib/candidhealth/commons/types/state.rb +66 -64
  43. data/lib/candidhealth/commons/types/street_address_base.rb +84 -61
  44. data/lib/candidhealth/commons/types/street_address_long_zip.rb +93 -68
  45. data/lib/candidhealth/commons/types/street_address_short_zip.rb +93 -68
  46. data/lib/candidhealth/commons/types/unauthorized_error_message.rb +47 -34
  47. data/lib/candidhealth/commons/types/unprocessable_entity_error_message.rb +47 -34
  48. data/lib/candidhealth/commons/types/updates_disabled_due_to_external_system_integration_error_message.rb +49 -34
  49. data/lib/candidhealth/contracts/client.rb +8 -6
  50. data/lib/candidhealth/contracts/v_2/client.rb +251 -127
  51. data/lib/candidhealth/contracts/v_2/types/authorized_signatory.rb +92 -67
  52. data/lib/candidhealth/contracts/v_2/types/authorized_signatory_update.rb +76 -70
  53. data/lib/candidhealth/contracts/v_2/types/contract.rb +178 -141
  54. data/lib/candidhealth/contracts/v_2/types/contract_base.rb +134 -106
  55. data/lib/candidhealth/contracts/v_2/types/contract_is_linked_to_fee_schedule_error.rb +44 -33
  56. data/lib/candidhealth/contracts/v_2/types/contract_status.rb +6 -4
  57. data/lib/candidhealth/contracts/v_2/types/contract_with_providers.rb +191 -152
  58. data/lib/candidhealth/contracts/v_2/types/contracts_page.rb +70 -47
  59. data/lib/candidhealth/contracts/v_2/types/date_update.rb +76 -71
  60. data/lib/candidhealth/contracts/v_2/types/insurance_types.rb +86 -80
  61. data/lib/candidhealth/contracts/v_2/types/regions_update.rb +76 -70
  62. data/lib/candidhealth/diagnoses/types/diagnosis.rb +126 -91
  63. data/lib/candidhealth/diagnoses/types/diagnosis_create.rb +88 -58
  64. data/lib/candidhealth/diagnoses/types/diagnosis_type_code.rb +14 -12
  65. data/lib/candidhealth/diagnoses/types/standalone_diagnosis_create.rb +100 -64
  66. data/lib/candidhealth/eligibility/client.rb +8 -6
  67. data/lib/candidhealth/eligibility/v_2/client.rb +210 -124
  68. data/lib/candidhealth/encounter_providers/v_2/types/billing_provider.rb +126 -86
  69. data/lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb +128 -85
  70. data/lib/candidhealth/encounter_providers/v_2/types/encounter_provider_base.rb +73 -44
  71. data/lib/candidhealth/encounter_providers/v_2/types/initial_referring_provider.rb +132 -0
  72. data/lib/candidhealth/encounter_providers/v_2/types/ordering_provider.rb +123 -0
  73. data/lib/candidhealth/encounter_providers/v_2/types/referring_provider.rb +105 -73
  74. data/lib/candidhealth/encounter_providers/v_2/types/rendering_provider.rb +105 -73
  75. data/lib/candidhealth/encounter_providers/v_2/types/supervising_provider.rb +123 -0
  76. data/lib/candidhealth/encounters/client.rb +8 -6
  77. data/lib/candidhealth/encounters/v_4/client.rb +1021 -476
  78. data/lib/candidhealth/encounters/v_4/types/billable_status_type.rb +5 -3
  79. data/lib/candidhealth/encounters/v_4/types/cash_pay_payer_error_message.rb +44 -33
  80. data/lib/candidhealth/encounters/v_4/types/clinical_note.rb +76 -50
  81. data/lib/candidhealth/encounters/v_4/types/clinical_note_category.rb +70 -45
  82. data/lib/candidhealth/encounters/v_4/types/clinical_note_category_create.rb +57 -40
  83. data/lib/candidhealth/encounters/v_4/types/coding_attribution_type.rb +7 -5
  84. data/lib/candidhealth/encounters/v_4/types/encounter.rb +719 -482
  85. data/lib/candidhealth/encounters/v_4/types/encounter_base.rb +304 -223
  86. data/lib/candidhealth/encounters/v_4/types/encounter_external_id_uniqueness_error_type.rb +47 -34
  87. data/lib/candidhealth/encounters/v_4/types/encounter_guarantor_missing_contact_info_error_type.rb +46 -33
  88. data/lib/candidhealth/encounters/v_4/types/encounter_owner_of_next_action_type.rb +7 -5
  89. data/lib/candidhealth/encounters/v_4/types/encounter_page.rb +70 -47
  90. data/lib/candidhealth/encounters/v_4/types/encounter_patient_control_number_uniqueness_error_type.rb +46 -33
  91. data/lib/candidhealth/encounters/v_4/types/encounter_sort_options.rb +7 -5
  92. data/lib/candidhealth/encounters/v_4/types/encounter_submission_origin_type.rb +5 -3
  93. data/lib/candidhealth/encounters/v_4/types/intake_follow_up.rb +63 -44
  94. data/lib/candidhealth/encounters/v_4/types/intake_question.rb +66 -46
  95. data/lib/candidhealth/encounters/v_4/types/intake_response_and_follow_ups.rb +59 -40
  96. data/lib/candidhealth/encounters/v_4/types/intervention.rb +92 -66
  97. data/lib/candidhealth/encounters/v_4/types/intervention_category.rb +7 -5
  98. data/lib/candidhealth/encounters/v_4/types/lab.rb +63 -43
  99. data/lib/candidhealth/encounters/v_4/types/lab_code_type.rb +5 -3
  100. data/lib/candidhealth/encounters/v_4/types/medication.rb +92 -68
  101. data/lib/candidhealth/encounters/v_4/types/note_category.rb +17 -15
  102. data/lib/candidhealth/encounters/v_4/types/patient_history_category.rb +57 -40
  103. data/lib/candidhealth/encounters/v_4/types/patient_history_category_enum.rb +7 -5
  104. data/lib/candidhealth/encounters/v_4/types/responsible_party_type.rb +6 -4
  105. data/lib/candidhealth/encounters/v_4/types/service_authorization_exception_code.rb +14 -10
  106. data/lib/candidhealth/encounters/v_4/types/synchronicity_type.rb +5 -3
  107. data/lib/candidhealth/encounters/v_4/types/vitals.rb +84 -62
  108. data/lib/candidhealth/era/types/era.rb +62 -46
  109. data/lib/candidhealth/era/types/era_base.rb +55 -40
  110. data/lib/candidhealth/era/types/era_not_fully_processed_error_message.rb +55 -40
  111. data/lib/candidhealth/era_commons/types/claim_status_code_create.rb +14 -12
  112. data/lib/candidhealth/expected_network_status/client.rb +16 -10
  113. data/lib/candidhealth/expected_network_status/v_1/client.rb +76 -29
  114. data/lib/candidhealth/expected_network_status/v_1/types/expected_network_status.rb +6 -4
  115. data/lib/candidhealth/expected_network_status/v_1/types/expected_network_status_response.rb +69 -49
  116. data/lib/candidhealth/expected_network_status/v_2/client.rb +108 -69
  117. data/lib/candidhealth/expected_network_status/v_2/types/compute_all_in_network_providers_request.rb +129 -96
  118. data/lib/candidhealth/expected_network_status/v_2/types/compute_all_in_network_providers_response.rb +62 -47
  119. data/lib/candidhealth/expected_network_status/v_2/types/compute_all_in_network_rendering_providers_result.rb +89 -82
  120. data/lib/candidhealth/expected_network_status/v_2/types/expected_network_status_check_error_message.rb +45 -33
  121. data/lib/candidhealth/expected_network_status/v_2/types/expected_network_status_request_v_2.rb +129 -96
  122. data/lib/candidhealth/expected_network_status/v_2/types/expected_network_status_response_v_2.rb +59 -44
  123. data/lib/candidhealth/expected_network_status/v_2/types/expected_network_status_subscriber_information.rb +68 -49
  124. data/lib/candidhealth/expected_network_status/v_2/types/expected_network_status_v_2.rb +88 -82
  125. data/lib/candidhealth/expected_network_status/v_2/types/explanation.rb +11 -9
  126. data/lib/candidhealth/expected_network_status/v_2/types/in_network_rendering_providers_detail.rb +66 -51
  127. data/lib/candidhealth/expected_network_status/v_2/types/in_network_status.rb +57 -41
  128. data/lib/candidhealth/expected_network_status/v_2/types/indeterminate_network_status.rb +76 -57
  129. data/lib/candidhealth/expected_network_status/v_2/types/insurance_type.rb +59 -43
  130. data/lib/candidhealth/expected_network_status/v_2/types/insurance_type_codes.rb +86 -80
  131. data/lib/candidhealth/expected_network_status/v_2/types/line_of_business.rb +6 -4
  132. data/lib/candidhealth/expected_network_status/v_2/types/out_of_network_status.rb +65 -50
  133. data/lib/candidhealth/expected_network_status/v_2/types/service_type.rb +44 -42
  134. data/lib/candidhealth/exports/client.rb +8 -6
  135. data/lib/candidhealth/exports/v_3/client.rb +88 -48
  136. data/lib/candidhealth/exports/v_3/types/get_exports_response.rb +79 -58
  137. data/lib/candidhealth/external_payment_account_config/client.rb +30 -0
  138. data/lib/candidhealth/external_payment_account_config/v_1/client.rb +89 -0
  139. data/lib/candidhealth/external_payment_account_config/v_1/types/external_payment_account_config.rb +70 -0
  140. data/lib/candidhealth/external_payment_account_config/v_1/types/external_payment_account_config_page.rb +88 -0
  141. data/lib/candidhealth/fee_schedules/client.rb +8 -6
  142. data/lib/candidhealth/fee_schedules/v_3/client.rb +429 -181
  143. data/lib/candidhealth/fee_schedules/v_3/types/dimension_match.rb +159 -130
  144. data/lib/candidhealth/fee_schedules/v_3/types/dimension_name.rb +7 -5
  145. data/lib/candidhealth/fee_schedules/v_3/types/dimensions.rb +146 -117
  146. data/lib/candidhealth/fee_schedules/v_3/types/dimensions_page.rb +70 -51
  147. data/lib/candidhealth/fee_schedules/v_3/types/match_cpt_code.rb +62 -44
  148. data/lib/candidhealth/fee_schedules/v_3/types/match_date.rb +65 -44
  149. data/lib/candidhealth/fee_schedules/v_3/types/match_facility_type_code.rb +64 -44
  150. data/lib/candidhealth/fee_schedules/v_3/types/match_geo.rb +76 -49
  151. data/lib/candidhealth/fee_schedules/v_3/types/match_license_type.rb +64 -44
  152. data/lib/candidhealth/fee_schedules/v_3/types/match_modifiers.rb +67 -48
  153. data/lib/candidhealth/fee_schedules/v_3/types/match_network_types.rb +67 -48
  154. data/lib/candidhealth/fee_schedules/v_3/types/match_payer.rb +62 -45
  155. data/lib/candidhealth/fee_schedules/v_3/types/match_provider.rb +64 -45
  156. data/lib/candidhealth/fee_schedules/v_3/types/match_result.rb +59 -43
  157. data/lib/candidhealth/fee_schedules/v_3/types/match_test_result.rb +63 -46
  158. data/lib/candidhealth/fee_schedules/v_3/types/new_rate.rb +61 -44
  159. data/lib/candidhealth/fee_schedules/v_3/types/new_rate_version.rb +70 -46
  160. data/lib/candidhealth/fee_schedules/v_3/types/optional_dimensions.rb +148 -117
  161. data/lib/candidhealth/fee_schedules/v_3/types/overlapping_rate_entries_error.rb +71 -52
  162. data/lib/candidhealth/fee_schedules/v_3/types/payer_threshold.rb +77 -50
  163. data/lib/candidhealth/fee_schedules/v_3/types/payer_thresholds_page.rb +70 -51
  164. data/lib/candidhealth/fee_schedules/v_3/types/rate.rb +100 -75
  165. data/lib/candidhealth/fee_schedules/v_3/types/rate_entry.rb +79 -55
  166. data/lib/candidhealth/fee_schedules/v_3/types/rate_upload.rb +77 -71
  167. data/lib/candidhealth/fee_schedules/v_3/types/rate_upload_with_possible_errors.rb +79 -55
  168. data/lib/candidhealth/fee_schedules/v_3/types/rates_page.rb +70 -47
  169. data/lib/candidhealth/fee_schedules/v_3/types/threshold_match.rb +79 -54
  170. data/lib/candidhealth/fee_schedules/v_3/types/validation_error.rb +108 -102
  171. data/lib/candidhealth/financials/types/account_type.rb +6 -4
  172. data/lib/candidhealth/financials/types/allocation.rb +60 -43
  173. data/lib/candidhealth/financials/types/allocation_create.rb +63 -45
  174. data/lib/candidhealth/financials/types/allocation_target.rb +102 -95
  175. data/lib/candidhealth/financials/types/allocation_target_create.rb +113 -110
  176. data/lib/candidhealth/financials/types/billing_provider_allocation_target.rb +45 -35
  177. data/lib/candidhealth/financials/types/claim_allocation_target.rb +55 -41
  178. data/lib/candidhealth/financials/types/invoice_update.rb +77 -72
  179. data/lib/candidhealth/financials/types/note_update.rb +77 -71
  180. data/lib/candidhealth/financials/types/patient_transaction_source.rb +11 -9
  181. data/lib/candidhealth/financials/types/refund_reason.rb +5 -3
  182. data/lib/candidhealth/financials/types/refund_reason_update.rb +77 -71
  183. data/lib/candidhealth/financials/types/service_line_allocation_target.rb +62 -48
  184. data/lib/candidhealth/guarantor/client.rb +8 -6
  185. data/lib/candidhealth/guarantor/v_1/client.rb +136 -63
  186. data/lib/candidhealth/guarantor/v_1/types/encounter_has_existing_guarantor_error_type.rb +45 -33
  187. data/lib/candidhealth/guarantor/v_1/types/guarantor.rb +131 -100
  188. data/lib/candidhealth/guarantor/v_1/types/guarantor_base.rb +89 -65
  189. data/lib/candidhealth/guarantor/v_1/types/guarantor_create.rb +123 -93
  190. data/lib/candidhealth/identifiers/types/identifier.rb +85 -64
  191. data/lib/candidhealth/identifiers/types/identifier_base.rb +77 -53
  192. data/lib/candidhealth/identifiers/types/identifier_code.rb +6 -4
  193. data/lib/candidhealth/identifiers/types/identifier_create.rb +77 -53
  194. data/lib/candidhealth/identifiers/types/identifier_update.rb +86 -65
  195. data/lib/candidhealth/identifiers/types/identifier_value.rb +78 -72
  196. data/lib/candidhealth/identifiers/types/medicaid_provider_identifier.rb +55 -39
  197. data/lib/candidhealth/identifiers/types/medicare_provider_identifier.rb +55 -39
  198. data/lib/candidhealth/identifiers/types/updatable_identifier.rb +89 -84
  199. data/lib/candidhealth/import_invoice/client.rb +8 -6
  200. data/lib/candidhealth/import_invoice/v_1/client.rb +182 -86
  201. data/lib/candidhealth/import_invoice/v_1/types/create_import_invoice_request.rb +123 -83
  202. data/lib/candidhealth/import_invoice/v_1/types/import_invoice.rb +145 -110
  203. data/lib/candidhealth/import_invoice/v_1/types/import_invoice_update_request.rb +89 -65
  204. data/lib/candidhealth/import_invoice/v_1/types/import_invoices_page.rb +70 -47
  205. data/lib/candidhealth/import_invoice/v_1/types/invoice_item_info_update.rb +61 -42
  206. data/lib/candidhealth/import_invoice/v_1/types/invoice_item_update_type.rb +5 -3
  207. data/lib/candidhealth/individual/types/gender.rb +9 -7
  208. data/lib/candidhealth/individual/types/individual_base.rb +62 -44
  209. data/lib/candidhealth/individual/types/patient.rb +145 -108
  210. data/lib/candidhealth/individual/types/patient_base.rb +101 -73
  211. data/lib/candidhealth/individual/types/patient_create.rb +137 -101
  212. data/lib/candidhealth/individual/types/subscriber.rb +119 -91
  213. data/lib/candidhealth/individual/types/subscriber_base.rb +99 -74
  214. data/lib/candidhealth/individual/types/subscriber_create.rb +111 -84
  215. data/lib/candidhealth/insurance_adjudications/client.rb +8 -6
  216. data/lib/candidhealth/insurance_adjudications/v_1/client.rb +106 -47
  217. data/lib/candidhealth/insurance_adjudications/v_1/types/claim_adjudication.rb +106 -81
  218. data/lib/candidhealth/insurance_adjudications/v_1/types/claim_adjudication_create.rb +98 -74
  219. data/lib/candidhealth/insurance_adjudications/v_1/types/insurance_adjudication.rb +104 -80
  220. data/lib/candidhealth/insurance_adjudications/v_1/types/insurance_adjudication_create.rb +113 -87
  221. data/lib/candidhealth/insurance_adjudications/v_1/types/service_line_adjudication.rb +121 -91
  222. data/lib/candidhealth/insurance_adjudications/v_1/types/service_line_adjudication_create.rb +113 -84
  223. data/lib/candidhealth/insurance_cards/v_2/types/insurance_card.rb +140 -105
  224. data/lib/candidhealth/insurance_cards/v_2/types/insurance_card_base.rb +76 -55
  225. data/lib/candidhealth/insurance_cards/v_2/types/insurance_card_create.rb +140 -104
  226. data/lib/candidhealth/insurance_payments/client.rb +8 -6
  227. data/lib/candidhealth/insurance_payments/v_1/client.rb +214 -102
  228. data/lib/candidhealth/insurance_payments/v_1/types/insurance_payment.rb +101 -77
  229. data/lib/candidhealth/insurance_payments/v_1/types/insurance_payment_create.rb +93 -70
  230. data/lib/candidhealth/insurance_payments/v_1/types/insurance_payment_sort_field.rb +6 -4
  231. data/lib/candidhealth/insurance_payments/v_1/types/insurance_payments_page.rb +70 -47
  232. data/lib/candidhealth/insurance_refunds/client.rb +8 -6
  233. data/lib/candidhealth/insurance_refunds/v_1/client.rb +218 -108
  234. data/lib/candidhealth/insurance_refunds/v_1/types/insurance_refund.rb +109 -83
  235. data/lib/candidhealth/insurance_refunds/v_1/types/insurance_refund_create.rb +101 -76
  236. data/lib/candidhealth/insurance_refunds/v_1/types/insurance_refund_sort_field.rb +7 -5
  237. data/lib/candidhealth/insurance_refunds/v_1/types/insurance_refunds_page.rb +70 -47
  238. data/lib/candidhealth/invoices/types/invoice.rb +152 -117
  239. data/lib/candidhealth/invoices/types/invoice_item.rb +55 -40
  240. data/lib/candidhealth/invoices/types/invoice_status.rb +10 -8
  241. data/lib/candidhealth/invoices/v_2/types/claim_invoice_item.rb +54 -39
  242. data/lib/candidhealth/invoices/v_2/types/claim_invoice_item_info.rb +66 -48
  243. data/lib/candidhealth/invoices/v_2/types/invoice.rb +151 -114
  244. data/lib/candidhealth/invoices/v_2/types/invoice_destination.rb +8 -5
  245. data/lib/candidhealth/invoices/v_2/types/invoice_destination_metadata.rb +78 -55
  246. data/lib/candidhealth/invoices/v_2/types/invoice_info.rb +66 -48
  247. data/lib/candidhealth/invoices/v_2/types/invoice_item_attribution_create.rb +88 -84
  248. data/lib/candidhealth/invoices/v_2/types/invoice_item_create.rb +59 -42
  249. data/lib/candidhealth/invoices/v_2/types/invoice_item_info.rb +59 -43
  250. data/lib/candidhealth/invoices/v_2/types/invoice_sort_field.rb +9 -7
  251. data/lib/candidhealth/invoices/v_2/types/invoice_status.rb +9 -7
  252. data/lib/candidhealth/invoices/v_2/types/service_line_invoice_item.rb +54 -39
  253. data/lib/candidhealth/invoices/v_2/types/unattributed_invoice_item.rb +44 -33
  254. data/lib/candidhealth/organization_providers/client.rb +8 -6
  255. data/lib/candidhealth/organization_providers/v_2/types/address_type.rb +4 -2
  256. data/lib/candidhealth/organization_providers/v_2/types/employment_status.rb +5 -3
  257. data/lib/candidhealth/organization_providers/v_2/types/license_type.rb +71 -69
  258. data/lib/candidhealth/organization_providers/v_2/types/organization_provider.rb +189 -138
  259. data/lib/candidhealth/organization_providers/v_2/types/organization_provider_address.rb +59 -42
  260. data/lib/candidhealth/organization_providers/v_2/types/organization_provider_base.rb +157 -112
  261. data/lib/candidhealth/organization_providers/v_2/types/organization_provider_sort_options.rb +7 -5
  262. data/lib/candidhealth/organization_providers/v_2/types/provider_type.rb +5 -3
  263. data/lib/candidhealth/organization_providers/v_3/client.rb +166 -80
  264. data/lib/candidhealth/organization_providers/v_3/types/organization_provider_create_v_2.rb +171 -124
  265. data/lib/candidhealth/organization_providers/v_3/types/organization_provider_page_v_2.rb +70 -47
  266. data/lib/candidhealth/organization_providers/v_3/types/organization_provider_update_v_2.rb +169 -121
  267. data/lib/candidhealth/organization_providers/v_3/types/organization_provider_v_2.rb +179 -131
  268. data/lib/candidhealth/organization_service_facilities/client.rb +8 -6
  269. data/lib/candidhealth/organization_service_facilities/v_2/client.rb +186 -90
  270. data/lib/candidhealth/organization_service_facilities/v_2/types/organization_service_facility.rb +149 -111
  271. data/lib/candidhealth/organization_service_facilities/v_2/types/organization_service_facility_create.rb +141 -104
  272. data/lib/candidhealth/organization_service_facilities/v_2/types/organization_service_facility_page.rb +70 -47
  273. data/lib/candidhealth/organization_service_facilities/v_2/types/organization_service_facility_update.rb +141 -104
  274. data/lib/candidhealth/organization_service_facilities/v_2/types/service_facility_mode.rb +5 -3
  275. data/lib/candidhealth/organization_service_facilities/v_2/types/service_facility_operational_status.rb +9 -7
  276. data/lib/candidhealth/organization_service_facilities/v_2/types/service_facility_physical_type.rb +17 -15
  277. data/lib/candidhealth/organization_service_facilities/v_2/types/service_facility_status.rb +6 -4
  278. data/lib/candidhealth/organization_service_facilities/v_2/types/service_facility_type.rb +126 -124
  279. data/lib/candidhealth/patient_payments/client.rb +8 -6
  280. data/lib/candidhealth/patient_payments/v_3/types/patient_payment.rb +143 -111
  281. data/lib/candidhealth/patient_payments/v_3/types/patient_payment_source.rb +12 -10
  282. data/lib/candidhealth/patient_payments/v_3/types/patient_payment_status.rb +14 -12
  283. data/lib/candidhealth/patient_payments/v_4/client.rb +230 -103
  284. data/lib/candidhealth/patient_payments/v_4/types/patient_payment.rb +129 -100
  285. data/lib/candidhealth/patient_payments/v_4/types/patient_payment_sort_field.rb +7 -5
  286. data/lib/candidhealth/patient_payments/v_4/types/patient_payments_page.rb +70 -47
  287. data/lib/candidhealth/patient_refunds/client.rb +8 -6
  288. data/lib/candidhealth/patient_refunds/v_1/client.rb +236 -107
  289. data/lib/candidhealth/patient_refunds/v_1/types/patient_refund.rb +137 -106
  290. data/lib/candidhealth/patient_refunds/v_1/types/patient_refund_sort_field.rb +8 -6
  291. data/lib/candidhealth/patient_refunds/v_1/types/patient_refunds_page.rb +70 -47
  292. data/lib/candidhealth/payers/client.rb +8 -6
  293. data/lib/candidhealth/payers/v_3/client.rb +73 -32
  294. data/lib/candidhealth/payers/v_3/types/payer.rb +61 -44
  295. data/lib/candidhealth/payers/v_3/types/payer_identifier.rb +77 -72
  296. data/lib/candidhealth/payers/v_3/types/payer_info.rb +54 -40
  297. data/lib/candidhealth/payers/v_3/types/payer_page.rb +70 -47
  298. data/lib/candidhealth/pre_encounter/client.rb +30 -0
  299. data/lib/candidhealth/pre_encounter/common/types/address.rb +123 -0
  300. data/lib/candidhealth/pre_encounter/common/types/address_use.rb +17 -0
  301. data/lib/candidhealth/pre_encounter/common/types/contact_point.rb +87 -0
  302. data/lib/candidhealth/pre_encounter/common/types/contact_point_use.rb +17 -0
  303. data/lib/candidhealth/pre_encounter/common/types/error_base.rb +60 -0
  304. data/lib/candidhealth/pre_encounter/common/types/gender.rb +16 -0
  305. data/lib/candidhealth/pre_encounter/common/types/human_name.rb +94 -0
  306. data/lib/candidhealth/pre_encounter/common/types/name_use.rb +19 -0
  307. data/lib/candidhealth/pre_encounter/common/types/not_found_error_body.rb +70 -0
  308. data/lib/candidhealth/pre_encounter/common/types/period.rb +74 -0
  309. data/lib/candidhealth/pre_encounter/common/types/relationship.rb +17 -0
  310. data/lib/candidhealth/pre_encounter/common/types/version_conflict_error_body.rb +77 -0
  311. data/lib/candidhealth/pre_encounter/coverages/client.rb +32 -0
  312. data/lib/candidhealth/pre_encounter/coverages/v_1/client.rb +34 -0
  313. data/lib/candidhealth/pre_encounter/coverages/v_1/coverages/client.rb +487 -0
  314. data/lib/candidhealth/pre_encounter/coverages/v_1/coverages/types/coverage.rb +185 -0
  315. data/lib/candidhealth/pre_encounter/coverages/v_1/coverages/types/coverage_status.rb +22 -0
  316. data/lib/candidhealth/pre_encounter/coverages/v_1/coverages/types/coverage_type.rb +18 -0
  317. data/lib/candidhealth/pre_encounter/coverages/v_1/coverages/types/insurance_plan.rb +136 -0
  318. data/lib/candidhealth/pre_encounter/coverages/v_1/coverages/types/mutable_coverage.rb +131 -0
  319. data/lib/candidhealth/pre_encounter/coverages/v_1/coverages/types/subscriber.rb +90 -0
  320. data/lib/candidhealth/pre_encounter/patients/client.rb +32 -0
  321. data/lib/candidhealth/pre_encounter/patients/v_1/client.rb +34 -0
  322. data/lib/candidhealth/pre_encounter/patients/v_1/patients/client.rb +590 -0
  323. data/lib/candidhealth/pre_encounter/patients/v_1/patients/types/contact.rb +135 -0
  324. data/lib/candidhealth/pre_encounter/patients/v_1/patients/types/external_provenance.rb +75 -0
  325. data/lib/candidhealth/pre_encounter/patients/v_1/patients/types/external_provider.rb +116 -0
  326. data/lib/candidhealth/pre_encounter/patients/v_1/patients/types/marital_status.rb +28 -0
  327. data/lib/candidhealth/pre_encounter/patients/v_1/patients/types/mutable_patient.rb +242 -0
  328. data/lib/candidhealth/pre_encounter/patients/v_1/patients/types/patient.rb +294 -0
  329. data/lib/candidhealth/remits/v_1/types/payee.rb +59 -42
  330. data/lib/candidhealth/remits/v_1/types/payee_identifier.rb +84 -80
  331. data/lib/candidhealth/service_facility/client.rb +58 -27
  332. data/lib/candidhealth/service_facility/types/encounter_service_facility.rb +87 -62
  333. data/lib/candidhealth/service_facility/types/encounter_service_facility_base.rb +87 -57
  334. data/lib/candidhealth/service_lines/v_2/types/denial_reason_content.rb +33 -31
  335. data/lib/candidhealth/service_lines/v_2/types/drug_identification.rb +92 -68
  336. data/lib/candidhealth/service_lines/v_2/types/measurement_unit_code.rb +8 -6
  337. data/lib/candidhealth/service_lines/v_2/types/service_id_qualifier.rb +10 -8
  338. data/lib/candidhealth/service_lines/v_2/types/service_line.rb +352 -222
  339. data/lib/candidhealth/service_lines/v_2/types/service_line_adjustment.rb +85 -62
  340. data/lib/candidhealth/service_lines/v_2/types/service_line_create.rb +235 -113
  341. data/lib/candidhealth/service_lines/v_2/types/service_line_denial_reason.rb +49 -35
  342. data/lib/candidhealth/service_lines/v_2/types/service_line_era_data.rb +60 -44
  343. data/lib/candidhealth/tags/types/tag.rb +69 -51
  344. data/lib/candidhealth/tags/types/tag_color_enum.rb +14 -12
  345. data/lib/candidhealth/tags/types/tag_create.rb +62 -45
  346. data/lib/candidhealth/tasks/client.rb +8 -6
  347. data/lib/candidhealth/tasks/commons/types/task_category.rb +45 -43
  348. data/lib/candidhealth/tasks/commons/types/task_status.rb +11 -9
  349. data/lib/candidhealth/tasks/commons/types/task_type.rb +16 -14
  350. data/lib/candidhealth/tasks/v_3/client.rb +208 -96
  351. data/lib/candidhealth/tasks/v_3/types/task.rb +193 -146
  352. data/lib/candidhealth/tasks/v_3/types/task_action.rb +66 -47
  353. data/lib/candidhealth/tasks/v_3/types/task_action_execution_method.rb +65 -59
  354. data/lib/candidhealth/tasks/v_3/types/task_action_type.rb +5 -3
  355. data/lib/candidhealth/tasks/v_3/types/task_actions.rb +47 -35
  356. data/lib/candidhealth/tasks/v_3/types/task_assignment.rb +59 -40
  357. data/lib/candidhealth/tasks/v_3/types/task_create_v_3.rb +100 -77
  358. data/lib/candidhealth/tasks/v_3/types/task_note.rb +83 -62
  359. data/lib/candidhealth/tasks/v_3/types/task_page.rb +70 -47
  360. data/lib/candidhealth/tasks/v_3/types/task_sort_options.rb +25 -23
  361. data/lib/candidhealth/tasks/v_3/types/task_update_v_3.rb +68 -49
  362. data/lib/candidhealth/tasks/v_3/types/task_updated_to_deprecated_status_error_type.rb +47 -33
  363. data/lib/candidhealth/write_offs/client.rb +8 -6
  364. data/lib/candidhealth/write_offs/v_1/client.rb +168 -83
  365. data/lib/candidhealth/write_offs/v_1/types/create_write_offs_response.rb +47 -35
  366. data/lib/candidhealth/write_offs/v_1/types/insurance_write_off.rb +127 -97
  367. data/lib/candidhealth/write_offs/v_1/types/insurance_write_off_create.rb +103 -78
  368. data/lib/candidhealth/write_offs/v_1/types/insurance_write_off_reason.rb +19 -17
  369. data/lib/candidhealth/write_offs/v_1/types/insurance_write_off_target.rb +84 -81
  370. data/lib/candidhealth/write_offs/v_1/types/patient_write_off.rb +111 -84
  371. data/lib/candidhealth/write_offs/v_1/types/patient_write_off_create.rb +87 -65
  372. data/lib/candidhealth/write_offs/v_1/types/patient_write_off_reason.rb +12 -10
  373. data/lib/candidhealth/write_offs/v_1/types/write_off.rb +77 -71
  374. data/lib/candidhealth/write_offs/v_1/types/write_off_create.rb +77 -71
  375. data/lib/candidhealth/write_offs/v_1/types/write_off_sort_field.rb +6 -4
  376. data/lib/candidhealth/write_offs/v_1/types/write_offs_page.rb +70 -47
  377. data/lib/candidhealth/x_12/v_1/types/carc.rb +406 -404
  378. data/lib/candidhealth/x_12/v_1/types/claim_adjustment_reason_code.rb +61 -44
  379. data/lib/candidhealth/x_12/v_1/types/rarc.rb +1063 -1061
  380. data/lib/candidhealth/x_12/v_1/types/remittance_advice_remark_code.rb +44 -33
  381. data/lib/candidhealth.rb +189 -87
  382. data/lib/core/oauth.rb +62 -0
  383. data/lib/environment.rb +8 -2
  384. data/lib/requests.rb +98 -48
  385. data/lib/types_export.rb +30 -53
  386. metadata +42 -55
  387. data/lib/candidhealth/billing_notes/v_2/types/billing_note_id.rb +0 -9
  388. data/lib/candidhealth/commons/types/claim_id.rb +0 -7
  389. data/lib/candidhealth/commons/types/date.rb +0 -7
  390. data/lib/candidhealth/commons/types/decimal.rb +0 -7
  391. data/lib/candidhealth/commons/types/email.rb +0 -7
  392. data/lib/candidhealth/commons/types/encounter_external_id.rb +0 -7
  393. data/lib/candidhealth/commons/types/encounter_id.rb +0 -7
  394. data/lib/candidhealth/commons/types/error_message.rb +0 -7
  395. data/lib/candidhealth/commons/types/invoice_id.rb +0 -7
  396. data/lib/candidhealth/commons/types/link_url.rb +0 -7
  397. data/lib/candidhealth/commons/types/npi.rb +0 -7
  398. data/lib/candidhealth/commons/types/organization_id.rb +0 -7
  399. data/lib/candidhealth/commons/types/page_token.rb +0 -7
  400. data/lib/candidhealth/commons/types/patient_external_id.rb +0 -7
  401. data/lib/candidhealth/commons/types/provider_id.rb +0 -7
  402. data/lib/candidhealth/commons/types/rate_id.rb +0 -7
  403. data/lib/candidhealth/commons/types/service_line_id.rb +0 -7
  404. data/lib/candidhealth/commons/types/task_assignment_id.rb +0 -7
  405. data/lib/candidhealth/commons/types/task_id.rb +0 -7
  406. data/lib/candidhealth/commons/types/task_note_id.rb +0 -7
  407. data/lib/candidhealth/commons/types/tax_id.rb +0 -7
  408. data/lib/candidhealth/commons/types/user_id.rb +0 -7
  409. data/lib/candidhealth/commons/types/work_queue_id.rb +0 -7
  410. data/lib/candidhealth/contracts/v_2/types/contract_id.rb +0 -9
  411. data/lib/candidhealth/contracts/v_2/types/contracting_provider_id.rb +0 -9
  412. data/lib/candidhealth/contracts/v_2/types/rendering_providerid.rb +0 -9
  413. data/lib/candidhealth/diagnoses/types/diagnosis_id.rb +0 -7
  414. data/lib/candidhealth/encounter_providers/v_2/types/provider_id.rb +0 -9
  415. data/lib/candidhealth/encounters/v_4/types/intake_follow_up_id.rb +0 -9
  416. data/lib/candidhealth/encounters/v_4/types/intake_question_id.rb +0 -9
  417. data/lib/candidhealth/encounters/v_4/types/prior_authorization_number.rb +0 -9
  418. data/lib/candidhealth/encounters/v_4/types/rx_cui.rb +0 -9
  419. data/lib/candidhealth/era/types/era_id.rb +0 -7
  420. data/lib/candidhealth/expected_network_status/v_2/types/network_status_check_id.rb +0 -9
  421. data/lib/candidhealth/guarantor/v_1/types/guarantor_id.rb +0 -9
  422. data/lib/candidhealth/identifiers/types/identifier_id.rb +0 -7
  423. data/lib/candidhealth/individual/types/individual_id.rb +0 -7
  424. data/lib/candidhealth/insurance_adjudications/v_1/types/insurance_adjudication_id.rb +0 -9
  425. data/lib/candidhealth/insurance_adjudications/v_1/types/service_line_adjudication_id.rb +0 -9
  426. data/lib/candidhealth/insurance_cards/v_2/types/insurance_card_id.rb +0 -9
  427. data/lib/candidhealth/insurance_payments/v_1/types/insurance_payment_id.rb +0 -9
  428. data/lib/candidhealth/insurance_refunds/v_1/types/insurance_refund_id.rb +0 -9
  429. data/lib/candidhealth/organization_providers/v_2/types/organization_provider_id.rb +0 -9
  430. data/lib/candidhealth/organization_service_facilities/v_2/types/organization_service_facility_id.rb +0 -9
  431. data/lib/candidhealth/patient_payments/v_3/types/patient_payment_id.rb +0 -9
  432. data/lib/candidhealth/patient_payments/v_4/types/patient_payment_id.rb +0 -9
  433. data/lib/candidhealth/patient_refunds/v_1/types/patient_refund_id.rb +0 -9
  434. data/lib/candidhealth/payers/v_3/types/payer_id.rb +0 -9
  435. data/lib/candidhealth/payers/v_3/types/payer_name.rb +0 -9
  436. data/lib/candidhealth/payers/v_3/types/payer_uuid.rb +0 -9
  437. data/lib/candidhealth/service_facility/types/service_facility_id.rb +0 -7
  438. data/lib/candidhealth/tags/types/tag_id.rb +0 -7
  439. data/lib/candidhealth/write_offs/v_1/types/write_off_id.rb +0 -9
@@ -1,15 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require_relative "../../../requests"
4
- require_relative "../../payers/v_3/types/payer_uuid"
5
- require_relative "../../commons/types/claim_id"
6
- require_relative "../../commons/types/service_line_id"
7
- require_relative "../../commons/types/provider_id"
8
4
  require_relative "types/insurance_refund_sort_field"
9
5
  require_relative "../../commons/types/sort_direction"
10
- require_relative "../../commons/types/page_token"
11
6
  require_relative "types/insurance_refunds_page"
12
- require_relative "types/insurance_refund_id"
13
7
  require_relative "types/insurance_refund"
14
8
  require_relative "types/insurance_refund_create"
15
9
  require "date"
@@ -21,34 +15,51 @@ module CandidApiClient
21
15
  module InsuranceRefunds
22
16
  module V1
23
17
  class V1Client
18
+ # @return [CandidApiClient::RequestClient]
24
19
  attr_reader :request_client
25
20
 
26
- # @param request_client [RequestClient]
27
- # @return [InsuranceRefunds::V1::V1Client]
21
+ # @param request_client [CandidApiClient::RequestClient]
22
+ # @return [CandidApiClient::InsuranceRefunds::V1::V1Client]
28
23
  def initialize(request_client:)
29
- # @type [RequestClient]
30
24
  @request_client = request_client
31
25
  end
32
26
 
33
- # Returns all insurance refunds satisfying the search criteria AND whose organization_id matches
34
- # the current organization_id of the authenticated user.
27
+ # Returns all insurance refunds satisfying the search criteria AND whose
28
+ # organization_id matches
29
+ # the current organization_id of the authenticated user.
35
30
  #
36
31
  # @param limit [Integer] Defaults to 100. The value must be greater than 0 and less than 1000.
37
- # @param payer_uuid [Payers::V3::PAYER_UUID]
38
- # @param claim_id [Commons::CLAIM_ID]
39
- # @param service_line_id [Commons::SERVICE_LINE_ID]
40
- # @param billing_provider_id [Commons::PROVIDER_ID]
41
- # @param sort [InsuranceRefunds::V1::InsuranceRefundSortField] Defaults to refund_timestamp
42
- # @param sort_direction [Commons::SortDirection] Sort direction. Defaults to descending order if not provided.
43
- # @param page_token [Commons::PAGE_TOKEN]
44
- # @param request_options [RequestOptions]
45
- # @return [InsuranceRefunds::V1::InsuranceRefundsPage]
32
+ # @param payer_uuid [String]
33
+ # @param claim_id [String]
34
+ # @param service_line_id [String]
35
+ # @param billing_provider_id [String]
36
+ # @param sort [CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefundSortField] Defaults to refund_timestamp
37
+ # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order if not provided.
38
+ # @param page_token [String]
39
+ # @param request_options [CandidApiClient::RequestOptions]
40
+ # @return [CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefundsPage]
41
+ # @example
42
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
43
+ # api.insurance_refunds.v_1.get_multi(
44
+ # limit: 1,
45
+ # payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
46
+ # claim_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
47
+ # service_line_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
48
+ # billing_provider_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
49
+ # sort: AMOUNT_CENTS,
50
+ # sort_direction: ASC,
51
+ # page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
52
+ # )
46
53
  def get_multi(limit: nil, payer_uuid: nil, claim_id: nil, service_line_id: nil, billing_provider_id: nil,
47
54
  sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
48
- response = @request_client.conn.get("/api/insurance-refunds/v1") do |req|
55
+ response = @request_client.conn.get do |req|
49
56
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
50
57
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
51
- req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
58
+ req.headers = {
59
+ **(req.headers || {}),
60
+ **@request_client.get_headers,
61
+ **(request_options&.additional_headers || {})
62
+ }.compact
52
63
  req.params = {
53
64
  **(request_options&.additional_query_parameters || {}),
54
65
  "limit": limit,
@@ -60,119 +71,177 @@ module CandidApiClient
60
71
  "sort_direction": sort_direction,
61
72
  "page_token": page_token
62
73
  }.compact
74
+ req.url "#{@request_client.get_url(environment: CandidApi,
75
+ request_options: request_options)}/api/insurance-refunds/v1"
63
76
  end
64
- InsuranceRefunds::V1::InsuranceRefundsPage.from_json(json_object: response.body)
77
+ CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefundsPage.from_json(json_object: response.body)
65
78
  end
66
79
 
67
80
  # Retrieves a previously created insurance refund by its `insurance_refund_id`.
68
- # If the refund does not exist, a `403` will be thrown.
81
+ # If the refund does not exist, a `403` will be thrown.
69
82
  #
70
- # @param insurance_refund_id [InsuranceRefunds::V1::INSURANCE_REFUND_ID]
71
- # @param request_options [RequestOptions]
72
- # @return [InsuranceRefunds::V1::InsuranceRefund]
83
+ # @param insurance_refund_id [String]
84
+ # @param request_options [CandidApiClient::RequestOptions]
85
+ # @return [CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefund]
86
+ # @example
87
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
88
+ # api.insurance_refunds.v_1.get(insurance_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
73
89
  def get(insurance_refund_id:, request_options: nil)
74
- response = @request_client.conn.get("/api/insurance-refunds/v1/#{insurance_refund_id}") do |req|
90
+ response = @request_client.conn.get do |req|
75
91
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
76
92
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
77
- req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
93
+ req.headers = {
94
+ **(req.headers || {}),
95
+ **@request_client.get_headers,
96
+ **(request_options&.additional_headers || {})
97
+ }.compact
98
+ req.url "#{@request_client.get_url(environment: CandidApi,
99
+ request_options: request_options)}/api/insurance-refunds/v1/#{insurance_refund_id}"
78
100
  end
79
- InsuranceRefunds::V1::InsuranceRefund.from_json(json_object: response.body)
101
+ CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefund.from_json(json_object: response.body)
80
102
  end
81
103
 
82
- # Creates a new insurance refund record and returns the newly created `InsuranceRefund` object.
83
- # The allocations can describe whether the refund is being applied toward a specific service line,
84
- # claim, or billing provider.
104
+ # Creates a new insurance refund record and returns the newly created
105
+ # `InsuranceRefund` object.
106
+ # The allocations can describe whether the refund is being applied toward a
107
+ # specific service line,
108
+ # claim, or billing provider.
85
109
  #
86
- # @param request [Hash] Request of type InsuranceRefunds::V1::InsuranceRefundCreate, as a Hash
110
+ # @param request [Hash] Request of type CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefundCreate, as a Hash
87
111
  # * :payer_identifier (Hash)
88
112
  # * :amount_cents (Integer)
89
113
  # * :refund_timestamp (DateTime)
90
114
  # * :refund_note (String)
91
- # * :allocations (Array<Financials::AllocationCreate>)
92
- # * :refund_reason (Financials::RefundReason)
93
- # @param request_options [RequestOptions]
94
- # @return [InsuranceRefunds::V1::InsuranceRefund]
115
+ # * :allocations (Array<CandidApiClient::Financials::Types::AllocationCreate>)
116
+ # * :refund_reason (CandidApiClient::Financials::Types::RefundReason)
117
+ # @param request_options [CandidApiClient::RequestOptions]
118
+ # @return [CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefund]
119
+ # @example
120
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
121
+ # api.insurance_refunds.v_1.create(request: { amount_cents: 1, refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), refund_note: "string", allocations: [{ }], refund_reason: OVERCHARGED })
95
122
  def create(request:, request_options: nil)
96
- response = @request_client.conn.post("/api/insurance-refunds/v1") do |req|
123
+ response = @request_client.conn.post do |req|
97
124
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
98
125
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
99
- req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
126
+ req.headers = {
127
+ **(req.headers || {}),
128
+ **@request_client.get_headers,
129
+ **(request_options&.additional_headers || {})
130
+ }.compact
100
131
  req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
132
+ req.url "#{@request_client.get_url(environment: CandidApi,
133
+ request_options: request_options)}/api/insurance-refunds/v1"
101
134
  end
102
- InsuranceRefunds::V1::InsuranceRefund.from_json(json_object: response.body)
135
+ CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefund.from_json(json_object: response.body)
103
136
  end
104
137
 
105
- # Updates the patient refund record matching the provided insurance_refund_id. If updating the refund amount,
106
- # then the allocations must be appropriately updated as well.
138
+ # Updates the patient refund record matching the provided insurance_refund_id. If
139
+ # updating the refund amount,
140
+ # then the allocations must be appropriately updated as well.
107
141
  #
108
- # @param insurance_refund_id [InsuranceRefunds::V1::INSURANCE_REFUND_ID]
142
+ # @param insurance_refund_id [String]
109
143
  # @param refund_timestamp [DateTime]
110
- # @param refund_note [Financials::NoteUpdate]
111
- # @param refund_reason [Financials::RefundReasonUpdate]
112
- # @param request_options [RequestOptions]
113
- # @return [InsuranceRefunds::V1::InsuranceRefund]
144
+ # @param refund_note [CandidApiClient::Financials::Types::NoteUpdate]
145
+ # @param refund_reason [CandidApiClient::Financials::Types::RefundReasonUpdate]
146
+ # @param request_options [CandidApiClient::RequestOptions]
147
+ # @return [CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefund]
148
+ # @example
149
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
150
+ # api.insurance_refunds.v_1.update(insurance_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z))
114
151
  def update(insurance_refund_id:, refund_timestamp: nil, refund_note: nil, refund_reason: nil,
115
152
  request_options: nil)
116
- response = @request_client.conn.patch("/api/insurance-refunds/v1/#{insurance_refund_id}") do |req|
153
+ response = @request_client.conn.patch do |req|
117
154
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
118
155
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
119
- req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
156
+ req.headers = {
157
+ **(req.headers || {}),
158
+ **@request_client.get_headers,
159
+ **(request_options&.additional_headers || {})
160
+ }.compact
120
161
  req.body = {
121
162
  **(request_options&.additional_body_parameters || {}),
122
163
  refund_timestamp: refund_timestamp,
123
164
  refund_note: refund_note,
124
165
  refund_reason: refund_reason
125
166
  }.compact
167
+ req.url "#{@request_client.get_url(environment: CandidApi,
168
+ request_options: request_options)}/api/insurance-refunds/v1/#{insurance_refund_id}"
126
169
  end
127
- InsuranceRefunds::V1::InsuranceRefund.from_json(json_object: response.body)
170
+ CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefund.from_json(json_object: response.body)
128
171
  end
129
172
 
130
173
  # Deletes the insurance refund record matching the provided `insurance_refund_id`.
131
- # If the matching record's organization_id does not match the authenticated user's
132
- # current organization_id, then a response code of `403` will be returned.
174
+ # If the matching record's organization_id does not match the authenticated user's
175
+ # current organization_id, then a response code of `403` will be returned.
133
176
  #
134
- # @param insurance_refund_id [InsuranceRefunds::V1::INSURANCE_REFUND_ID]
135
- # @param request_options [RequestOptions]
177
+ # @param insurance_refund_id [String]
178
+ # @param request_options [CandidApiClient::RequestOptions]
136
179
  # @return [Void]
180
+ # @example
181
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
182
+ # api.insurance_refunds.v_1.delete(insurance_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
137
183
  def delete(insurance_refund_id:, request_options: nil)
138
- @request_client.conn.delete("/api/insurance-refunds/v1/#{insurance_refund_id}") do |req|
184
+ @request_client.conn.delete do |req|
139
185
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
140
186
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
141
- req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
187
+ req.headers = {
188
+ **(req.headers || {}),
189
+ **@request_client.get_headers,
190
+ **(request_options&.additional_headers || {})
191
+ }.compact
192
+ req.url "#{@request_client.get_url(environment: CandidApi,
193
+ request_options: request_options)}/api/insurance-refunds/v1/#{insurance_refund_id}"
142
194
  end
143
195
  end
144
196
  end
145
197
 
146
198
  class AsyncV1Client
199
+ # @return [CandidApiClient::AsyncRequestClient]
147
200
  attr_reader :request_client
148
201
 
149
- # @param request_client [AsyncRequestClient]
150
- # @return [InsuranceRefunds::V1::AsyncV1Client]
202
+ # @param request_client [CandidApiClient::AsyncRequestClient]
203
+ # @return [CandidApiClient::InsuranceRefunds::V1::AsyncV1Client]
151
204
  def initialize(request_client:)
152
- # @type [AsyncRequestClient]
153
205
  @request_client = request_client
154
206
  end
155
207
 
156
- # Returns all insurance refunds satisfying the search criteria AND whose organization_id matches
157
- # the current organization_id of the authenticated user.
208
+ # Returns all insurance refunds satisfying the search criteria AND whose
209
+ # organization_id matches
210
+ # the current organization_id of the authenticated user.
158
211
  #
159
212
  # @param limit [Integer] Defaults to 100. The value must be greater than 0 and less than 1000.
160
- # @param payer_uuid [Payers::V3::PAYER_UUID]
161
- # @param claim_id [Commons::CLAIM_ID]
162
- # @param service_line_id [Commons::SERVICE_LINE_ID]
163
- # @param billing_provider_id [Commons::PROVIDER_ID]
164
- # @param sort [InsuranceRefunds::V1::InsuranceRefundSortField] Defaults to refund_timestamp
165
- # @param sort_direction [Commons::SortDirection] Sort direction. Defaults to descending order if not provided.
166
- # @param page_token [Commons::PAGE_TOKEN]
167
- # @param request_options [RequestOptions]
168
- # @return [InsuranceRefunds::V1::InsuranceRefundsPage]
213
+ # @param payer_uuid [String]
214
+ # @param claim_id [String]
215
+ # @param service_line_id [String]
216
+ # @param billing_provider_id [String]
217
+ # @param sort [CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefundSortField] Defaults to refund_timestamp
218
+ # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order if not provided.
219
+ # @param page_token [String]
220
+ # @param request_options [CandidApiClient::RequestOptions]
221
+ # @return [CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefundsPage]
222
+ # @example
223
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
224
+ # api.insurance_refunds.v_1.get_multi(
225
+ # limit: 1,
226
+ # payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
227
+ # claim_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
228
+ # service_line_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
229
+ # billing_provider_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
230
+ # sort: AMOUNT_CENTS,
231
+ # sort_direction: ASC,
232
+ # page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
233
+ # )
169
234
  def get_multi(limit: nil, payer_uuid: nil, claim_id: nil, service_line_id: nil, billing_provider_id: nil,
170
235
  sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
171
236
  Async do
172
- response = @request_client.conn.get("/api/insurance-refunds/v1") do |req|
237
+ response = @request_client.conn.get do |req|
173
238
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
174
239
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
175
- req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
240
+ req.headers = {
241
+ **(req.headers || {}),
242
+ **@request_client.get_headers,
243
+ **(request_options&.additional_headers || {})
244
+ }.compact
176
245
  req.params = {
177
246
  **(request_options&.additional_query_parameters || {}),
178
247
  "limit": limit,
@@ -184,93 +253,134 @@ module CandidApiClient
184
253
  "sort_direction": sort_direction,
185
254
  "page_token": page_token
186
255
  }.compact
256
+ req.url "#{@request_client.get_url(environment: CandidApi,
257
+ request_options: request_options)}/api/insurance-refunds/v1"
187
258
  end
188
- InsuranceRefunds::V1::InsuranceRefundsPage.from_json(json_object: response.body)
259
+ CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefundsPage.from_json(json_object: response.body)
189
260
  end
190
261
  end
191
262
 
192
263
  # Retrieves a previously created insurance refund by its `insurance_refund_id`.
193
- # If the refund does not exist, a `403` will be thrown.
264
+ # If the refund does not exist, a `403` will be thrown.
194
265
  #
195
- # @param insurance_refund_id [InsuranceRefunds::V1::INSURANCE_REFUND_ID]
196
- # @param request_options [RequestOptions]
197
- # @return [InsuranceRefunds::V1::InsuranceRefund]
266
+ # @param insurance_refund_id [String]
267
+ # @param request_options [CandidApiClient::RequestOptions]
268
+ # @return [CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefund]
269
+ # @example
270
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
271
+ # api.insurance_refunds.v_1.get(insurance_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
198
272
  def get(insurance_refund_id:, request_options: nil)
199
273
  Async do
200
- response = @request_client.conn.get("/api/insurance-refunds/v1/#{insurance_refund_id}") do |req|
274
+ response = @request_client.conn.get do |req|
201
275
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
202
276
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
203
- req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
277
+ req.headers = {
278
+ **(req.headers || {}),
279
+ **@request_client.get_headers,
280
+ **(request_options&.additional_headers || {})
281
+ }.compact
282
+ req.url "#{@request_client.get_url(environment: CandidApi,
283
+ request_options: request_options)}/api/insurance-refunds/v1/#{insurance_refund_id}"
204
284
  end
205
- InsuranceRefunds::V1::InsuranceRefund.from_json(json_object: response.body)
285
+ CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefund.from_json(json_object: response.body)
206
286
  end
207
287
  end
208
288
 
209
- # Creates a new insurance refund record and returns the newly created `InsuranceRefund` object.
210
- # The allocations can describe whether the refund is being applied toward a specific service line,
211
- # claim, or billing provider.
289
+ # Creates a new insurance refund record and returns the newly created
290
+ # `InsuranceRefund` object.
291
+ # The allocations can describe whether the refund is being applied toward a
292
+ # specific service line,
293
+ # claim, or billing provider.
212
294
  #
213
- # @param request [Hash] Request of type InsuranceRefunds::V1::InsuranceRefundCreate, as a Hash
295
+ # @param request [Hash] Request of type CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefundCreate, as a Hash
214
296
  # * :payer_identifier (Hash)
215
297
  # * :amount_cents (Integer)
216
298
  # * :refund_timestamp (DateTime)
217
299
  # * :refund_note (String)
218
- # * :allocations (Array<Financials::AllocationCreate>)
219
- # * :refund_reason (Financials::RefundReason)
220
- # @param request_options [RequestOptions]
221
- # @return [InsuranceRefunds::V1::InsuranceRefund]
300
+ # * :allocations (Array<CandidApiClient::Financials::Types::AllocationCreate>)
301
+ # * :refund_reason (CandidApiClient::Financials::Types::RefundReason)
302
+ # @param request_options [CandidApiClient::RequestOptions]
303
+ # @return [CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefund]
304
+ # @example
305
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
306
+ # api.insurance_refunds.v_1.create(request: { amount_cents: 1, refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), refund_note: "string", allocations: [{ }], refund_reason: OVERCHARGED })
222
307
  def create(request:, request_options: nil)
223
308
  Async do
224
- response = @request_client.conn.post("/api/insurance-refunds/v1") do |req|
309
+ response = @request_client.conn.post do |req|
225
310
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
226
311
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
227
- req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
312
+ req.headers = {
313
+ **(req.headers || {}),
314
+ **@request_client.get_headers,
315
+ **(request_options&.additional_headers || {})
316
+ }.compact
228
317
  req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
318
+ req.url "#{@request_client.get_url(environment: CandidApi,
319
+ request_options: request_options)}/api/insurance-refunds/v1"
229
320
  end
230
- InsuranceRefunds::V1::InsuranceRefund.from_json(json_object: response.body)
321
+ CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefund.from_json(json_object: response.body)
231
322
  end
232
323
  end
233
324
 
234
- # Updates the patient refund record matching the provided insurance_refund_id. If updating the refund amount,
235
- # then the allocations must be appropriately updated as well.
325
+ # Updates the patient refund record matching the provided insurance_refund_id. If
326
+ # updating the refund amount,
327
+ # then the allocations must be appropriately updated as well.
236
328
  #
237
- # @param insurance_refund_id [InsuranceRefunds::V1::INSURANCE_REFUND_ID]
329
+ # @param insurance_refund_id [String]
238
330
  # @param refund_timestamp [DateTime]
239
- # @param refund_note [Financials::NoteUpdate]
240
- # @param refund_reason [Financials::RefundReasonUpdate]
241
- # @param request_options [RequestOptions]
242
- # @return [InsuranceRefunds::V1::InsuranceRefund]
331
+ # @param refund_note [CandidApiClient::Financials::Types::NoteUpdate]
332
+ # @param refund_reason [CandidApiClient::Financials::Types::RefundReasonUpdate]
333
+ # @param request_options [CandidApiClient::RequestOptions]
334
+ # @return [CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefund]
335
+ # @example
336
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
337
+ # api.insurance_refunds.v_1.update(insurance_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z))
243
338
  def update(insurance_refund_id:, refund_timestamp: nil, refund_note: nil, refund_reason: nil,
244
339
  request_options: nil)
245
340
  Async do
246
- response = @request_client.conn.patch("/api/insurance-refunds/v1/#{insurance_refund_id}") do |req|
341
+ response = @request_client.conn.patch do |req|
247
342
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
248
343
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
249
- req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
344
+ req.headers = {
345
+ **(req.headers || {}),
346
+ **@request_client.get_headers,
347
+ **(request_options&.additional_headers || {})
348
+ }.compact
250
349
  req.body = {
251
350
  **(request_options&.additional_body_parameters || {}),
252
351
  refund_timestamp: refund_timestamp,
253
352
  refund_note: refund_note,
254
353
  refund_reason: refund_reason
255
354
  }.compact
355
+ req.url "#{@request_client.get_url(environment: CandidApi,
356
+ request_options: request_options)}/api/insurance-refunds/v1/#{insurance_refund_id}"
256
357
  end
257
- InsuranceRefunds::V1::InsuranceRefund.from_json(json_object: response.body)
358
+ CandidApiClient::InsuranceRefunds::V1::Types::InsuranceRefund.from_json(json_object: response.body)
258
359
  end
259
360
  end
260
361
 
261
362
  # Deletes the insurance refund record matching the provided `insurance_refund_id`.
262
- # If the matching record's organization_id does not match the authenticated user's
263
- # current organization_id, then a response code of `403` will be returned.
363
+ # If the matching record's organization_id does not match the authenticated user's
364
+ # current organization_id, then a response code of `403` will be returned.
264
365
  #
265
- # @param insurance_refund_id [InsuranceRefunds::V1::INSURANCE_REFUND_ID]
266
- # @param request_options [RequestOptions]
366
+ # @param insurance_refund_id [String]
367
+ # @param request_options [CandidApiClient::RequestOptions]
267
368
  # @return [Void]
369
+ # @example
370
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
371
+ # api.insurance_refunds.v_1.delete(insurance_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
268
372
  def delete(insurance_refund_id:, request_options: nil)
269
373
  Async do
270
- @request_client.conn.delete("/api/insurance-refunds/v1/#{insurance_refund_id}") do |req|
374
+ @request_client.conn.delete do |req|
271
375
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
272
376
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
273
- req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
377
+ req.headers = {
378
+ **(req.headers || {}),
379
+ **@request_client.get_headers,
380
+ **(request_options&.additional_headers || {})
381
+ }.compact
382
+ req.url "#{@request_client.get_url(environment: CandidApi,
383
+ request_options: request_options)}/api/insurance-refunds/v1/#{insurance_refund_id}"
274
384
  end
275
385
  end
276
386
  end