candidhealth 0.21.0 → 0.24.0.pre.2a6d412

data/lib/candidhealth/patient_refunds/v_1/client.rb

@@ -1,17 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "../../../requests"
-require_relative "../../commons/types/patient_external_id"
-require_relative "../../commons/types/claim_id"
-require_relative "../../commons/types/service_line_id"
-require_relative "../../commons/types/provider_id"
-require_relative "../../commons/types/invoice_id"
 require_relative "../../financials/types/patient_transaction_source"
 require_relative "types/patient_refund_sort_field"
 require_relative "../../commons/types/sort_direction"
-require_relative "../../commons/types/page_token"
 require_relative "types/patient_refunds_page"
-require_relative "types/patient_refund_id"
 require_relative "types/patient_refund"
 require "date"
 require_relative "../../financials/types/allocation_create"
@@ -25,37 +18,57 @@ module CandidApiClient
   module PatientRefunds
     module V1
       class V1Client
+        # @return [CandidApiClient::RequestClient]
         attr_reader :request_client
 
-        # @param request_client [RequestClient]
-        # @return [PatientRefunds::V1::V1Client]
+        # @param request_client [CandidApiClient::RequestClient]
+        # @return [CandidApiClient::PatientRefunds::V1::V1Client]
         def initialize(request_client:)
-          # @type [RequestClient]
           @request_client = request_client
         end
 
-        # Returns all patient refunds satisfying the search criteria AND whose organization_id matches
-        # the current organization_id of the authenticated user.
+        # Returns all patient refunds satisfying the search criteria AND whose
+        #  organization_id matches
+        #  the current organization_id of the authenticated user.
         #
         # @param limit [Integer] Defaults to 100. The value must be greater than 0 and less than 1000.
-        # @param patient_external_id [Commons::PATIENT_EXTERNAL_ID]
-        # @param claim_id [Commons::CLAIM_ID]
-        # @param service_line_id [Commons::SERVICE_LINE_ID]
-        # @param billing_provider_id [Commons::PROVIDER_ID]
+        # @param patient_external_id [String]
+        # @param claim_id [String]
+        # @param service_line_id [String]
+        # @param billing_provider_id [String]
         # @param unattributed [Boolean] returns payments with unattributed allocations if set to true
-        # @param invoice_id [Commons::INVOICE_ID]
-        # @param sources [Financials::PatientTransactionSource]
-        # @param sort [PatientRefunds::V1::PatientRefundSortField] Defaults to refund_timestamp
-        # @param sort_direction [Commons::SortDirection] Sort direction. Defaults to descending order if not provided.
-        # @param page_token [Commons::PAGE_TOKEN]
-        # @param request_options [RequestOptions]
-        # @return [PatientRefunds::V1::PatientRefundsPage]
+        # @param invoice_id [String]
+        # @param sources [CandidApiClient::Financials::Types::PatientTransactionSource]
+        # @param sort [CandidApiClient::PatientRefunds::V1::Types::PatientRefundSortField] Defaults to refund_timestamp
+        # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order if not provided.
+        # @param page_token [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientRefunds::V1::Types::PatientRefundsPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_refunds.v_1.get_multi(
+        #    limit: 1,
+        #    patient_external_id: "string",
+        #    claim_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    service_line_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    billing_provider_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    unattributed: true,
+        #    invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    sources: MANUAL_ENTRY,
+        #    sort: REFUND_SOURCE,
+        #    sort_direction: ASC,
+        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
+        #  )
         def get_multi(limit: nil, patient_external_id: nil, claim_id: nil, service_line_id: nil,
                       billing_provider_id: nil, unattributed: nil, invoice_id: nil, sources: nil, sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
-          response = @request_client.conn.get("/api/patient-refunds/v1") do |req|
+          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_options&.additional_headers || {}) }.compact
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "limit": limit,
@@ -70,45 +83,73 @@ module CandidApiClient
               "sort_direction": sort_direction,
               "page_token": page_token
             }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/patient-refunds/v1"
           end
-          PatientRefunds::V1::PatientRefundsPage.from_json(json_object: response.body)
+          CandidApiClient::PatientRefunds::V1::Types::PatientRefundsPage.from_json(json_object: response.body)
         end
 
         # Retrieves a previously created patient refund by its `patient_refund_id`.
         #
-        # @param patient_refund_id [PatientRefunds::V1::PATIENT_REFUND_ID]
-        # @param request_options [RequestOptions]
-        # @return [PatientRefunds::V1::PatientRefund]
+        # @param patient_refund_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientRefunds::V1::Types::PatientRefund]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_refunds.v_1.get(patient_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def get(patient_refund_id:, request_options: nil)
-          response = @request_client.conn.get("/api/patient-refunds/v1/#{patient_refund_id}") do |req|
+          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_options&.additional_headers || {}) }.compact
+            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/patient-refunds/v1/#{patient_refund_id}"
           end
-          PatientRefunds::V1::PatientRefund.from_json(json_object: response.body)
+          CandidApiClient::PatientRefunds::V1::Types::PatientRefund.from_json(json_object: response.body)
         end
 
-        # Creates a new patient refund record and returns the newly created PatientRefund object.
-        # The allocations can describe whether the refund is being applied toward a specific service line,
-        # claim, or billing provider.
+        # Creates a new patient refund record and returns the newly created PatientRefund
+        #  object.
+        #  The allocations can describe whether the refund is being applied toward a
+        #  specific service line,
+        #  claim, or billing provider.
         #
         # @param amount_cents [Integer]
         # @param refund_timestamp [DateTime]
         # @param refund_note [String]
-        # @param patient_external_id [Commons::PATIENT_EXTERNAL_ID]
-        # @param allocations [Array<Hash>] Request of type Array<Financials::AllocationCreate>, as a Hash
+        # @param patient_external_id [String]
+        # @param allocations [Array<Hash>] Request of type Array<CandidApiClient::Financials::Types::AllocationCreate>, as a Hash
         #   * :amount_cents (Integer)
         #   * :target (Hash)
-        # @param invoice [Commons::INVOICE_ID]
-        # @param refund_reason [Financials::RefundReason]
-        # @param request_options [RequestOptions]
-        # @return [PatientRefunds::V1::PatientRefund]
+        # @param invoice [String]
+        # @param refund_reason [CandidApiClient::Financials::Types::RefundReason]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientRefunds::V1::Types::PatientRefund]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_refunds.v_1.create(
+        #    amount_cents: 1,
+        #    refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z),
+        #    refund_note: "string",
+        #    patient_external_id: "string",
+        #    allocations: [{ amount_cents: 1 }],
+        #    invoice: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    refund_reason: OVERCHARGED
+        #  )
         def create(amount_cents:, patient_external_id:, allocations:, refund_timestamp: nil, refund_note: nil,
                    invoice: nil, refund_reason: nil, request_options: nil)
-          response = @request_client.conn.post("/api/patient-refunds/v1") do |req|
+          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_options&.additional_headers || {}) }.compact
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
             req.body = {
               **(request_options&.additional_body_parameters || {}),
               amount_cents: amount_cents,
@@ -119,25 +160,34 @@ module CandidApiClient
               invoice: invoice,
               refund_reason: refund_reason
             }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/patient-refunds/v1"
           end
-          PatientRefunds::V1::PatientRefund.from_json(json_object: response.body)
+          CandidApiClient::PatientRefunds::V1::Types::PatientRefund.from_json(json_object: response.body)
         end
 
         # Updates the patient refund record matching the provided patient_refund_id.
         #
-        # @param patient_refund_id [PatientRefunds::V1::PATIENT_REFUND_ID]
+        # @param patient_refund_id [String]
         # @param refund_timestamp [DateTime]
-        # @param refund_note [Financials::NoteUpdate]
-        # @param invoice [Financials::InvoiceUpdate]
-        # @param refund_reason [Financials::RefundReasonUpdate]
-        # @param request_options [RequestOptions]
-        # @return [PatientRefunds::V1::PatientRefund]
+        # @param refund_note [CandidApiClient::Financials::Types::NoteUpdate]
+        # @param invoice [CandidApiClient::Financials::Types::InvoiceUpdate]
+        # @param refund_reason [CandidApiClient::Financials::Types::RefundReasonUpdate]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientRefunds::V1::Types::PatientRefund]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_refunds.v_1.update(patient_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z))
         def update(patient_refund_id:, refund_timestamp: nil, refund_note: nil, invoice: nil, refund_reason: nil,
                    request_options: nil)
-          response = @request_client.conn.patch("/api/patient-refunds/v1/#{patient_refund_id}") do |req|
+          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_options&.additional_headers || {}) }.compact
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
             req.body = {
               **(request_options&.additional_body_parameters || {}),
               refund_timestamp: refund_timestamp,
@@ -145,57 +195,88 @@ module CandidApiClient
               invoice: invoice,
               refund_reason: refund_reason
             }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/patient-refunds/v1/#{patient_refund_id}"
           end
-          PatientRefunds::V1::PatientRefund.from_json(json_object: response.body)
+          CandidApiClient::PatientRefunds::V1::Types::PatientRefund.from_json(json_object: response.body)
         end
 
         # Deletes the patient refund record matching the provided patient_refund_id.
         #
-        # @param patient_refund_id [PatientRefunds::V1::PATIENT_REFUND_ID]
-        # @param request_options [RequestOptions]
+        # @param patient_refund_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
         # @return [Void]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_refunds.v_1.delete(patient_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def delete(patient_refund_id:, request_options: nil)
-          @request_client.conn.delete("/api/patient-refunds/v1/#{patient_refund_id}") do |req|
+          @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_options&.additional_headers || {}) }.compact
+            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/patient-refunds/v1/#{patient_refund_id}"
           end
         end
       end
 
       class AsyncV1Client
+        # @return [CandidApiClient::AsyncRequestClient]
         attr_reader :request_client
 
-        # @param request_client [AsyncRequestClient]
-        # @return [PatientRefunds::V1::AsyncV1Client]
+        # @param request_client [CandidApiClient::AsyncRequestClient]
+        # @return [CandidApiClient::PatientRefunds::V1::AsyncV1Client]
         def initialize(request_client:)
-          # @type [AsyncRequestClient]
           @request_client = request_client
         end
 
-        # Returns all patient refunds satisfying the search criteria AND whose organization_id matches
-        # the current organization_id of the authenticated user.
+        # Returns all patient refunds satisfying the search criteria AND whose
+        #  organization_id matches
+        #  the current organization_id of the authenticated user.
         #
         # @param limit [Integer] Defaults to 100. The value must be greater than 0 and less than 1000.
-        # @param patient_external_id [Commons::PATIENT_EXTERNAL_ID]
-        # @param claim_id [Commons::CLAIM_ID]
-        # @param service_line_id [Commons::SERVICE_LINE_ID]
-        # @param billing_provider_id [Commons::PROVIDER_ID]
+        # @param patient_external_id [String]
+        # @param claim_id [String]
+        # @param service_line_id [String]
+        # @param billing_provider_id [String]
         # @param unattributed [Boolean] returns payments with unattributed allocations if set to true
-        # @param invoice_id [Commons::INVOICE_ID]
-        # @param sources [Financials::PatientTransactionSource]
-        # @param sort [PatientRefunds::V1::PatientRefundSortField] Defaults to refund_timestamp
-        # @param sort_direction [Commons::SortDirection] Sort direction. Defaults to descending order if not provided.
-        # @param page_token [Commons::PAGE_TOKEN]
-        # @param request_options [RequestOptions]
-        # @return [PatientRefunds::V1::PatientRefundsPage]
+        # @param invoice_id [String]
+        # @param sources [CandidApiClient::Financials::Types::PatientTransactionSource]
+        # @param sort [CandidApiClient::PatientRefunds::V1::Types::PatientRefundSortField] Defaults to refund_timestamp
+        # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order if not provided.
+        # @param page_token [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientRefunds::V1::Types::PatientRefundsPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_refunds.v_1.get_multi(
+        #    limit: 1,
+        #    patient_external_id: "string",
+        #    claim_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    service_line_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    billing_provider_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    unattributed: true,
+        #    invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    sources: MANUAL_ENTRY,
+        #    sort: REFUND_SOURCE,
+        #    sort_direction: ASC,
+        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
+        #  )
         def get_multi(limit: nil, patient_external_id: nil, claim_id: nil, service_line_id: nil,
                       billing_provider_id: nil, unattributed: nil, invoice_id: nil, sources: nil, sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
           Async do
-            response = @request_client.conn.get("/api/patient-refunds/v1") do |req|
+            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_options&.additional_headers || {}) }.compact
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
               req.params = {
                 **(request_options&.additional_query_parameters || {}),
                 "limit": limit,
@@ -210,49 +291,77 @@ module CandidApiClient
                 "sort_direction": sort_direction,
                 "page_token": page_token
               }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/patient-refunds/v1"
             end
-            PatientRefunds::V1::PatientRefundsPage.from_json(json_object: response.body)
+            CandidApiClient::PatientRefunds::V1::Types::PatientRefundsPage.from_json(json_object: response.body)
           end
         end
 
         # Retrieves a previously created patient refund by its `patient_refund_id`.
         #
-        # @param patient_refund_id [PatientRefunds::V1::PATIENT_REFUND_ID]
-        # @param request_options [RequestOptions]
-        # @return [PatientRefunds::V1::PatientRefund]
+        # @param patient_refund_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientRefunds::V1::Types::PatientRefund]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_refunds.v_1.get(patient_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def get(patient_refund_id:, request_options: nil)
           Async do
-            response = @request_client.conn.get("/api/patient-refunds/v1/#{patient_refund_id}") do |req|
+            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_options&.additional_headers || {}) }.compact
+              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/patient-refunds/v1/#{patient_refund_id}"
             end
-            PatientRefunds::V1::PatientRefund.from_json(json_object: response.body)
+            CandidApiClient::PatientRefunds::V1::Types::PatientRefund.from_json(json_object: response.body)
           end
         end
 
-        # Creates a new patient refund record and returns the newly created PatientRefund object.
-        # The allocations can describe whether the refund is being applied toward a specific service line,
-        # claim, or billing provider.
+        # Creates a new patient refund record and returns the newly created PatientRefund
+        #  object.
+        #  The allocations can describe whether the refund is being applied toward a
+        #  specific service line,
+        #  claim, or billing provider.
         #
         # @param amount_cents [Integer]
         # @param refund_timestamp [DateTime]
         # @param refund_note [String]
-        # @param patient_external_id [Commons::PATIENT_EXTERNAL_ID]
-        # @param allocations [Array<Hash>] Request of type Array<Financials::AllocationCreate>, as a Hash
+        # @param patient_external_id [String]
+        # @param allocations [Array<Hash>] Request of type Array<CandidApiClient::Financials::Types::AllocationCreate>, as a Hash
         #   * :amount_cents (Integer)
         #   * :target (Hash)
-        # @param invoice [Commons::INVOICE_ID]
-        # @param refund_reason [Financials::RefundReason]
-        # @param request_options [RequestOptions]
-        # @return [PatientRefunds::V1::PatientRefund]
+        # @param invoice [String]
+        # @param refund_reason [CandidApiClient::Financials::Types::RefundReason]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientRefunds::V1::Types::PatientRefund]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_refunds.v_1.create(
+        #    amount_cents: 1,
+        #    refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z),
+        #    refund_note: "string",
+        #    patient_external_id: "string",
+        #    allocations: [{ amount_cents: 1 }],
+        #    invoice: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    refund_reason: OVERCHARGED
+        #  )
         def create(amount_cents:, patient_external_id:, allocations:, refund_timestamp: nil, refund_note: nil,
                    invoice: nil, refund_reason: nil, request_options: nil)
           Async do
-            response = @request_client.conn.post("/api/patient-refunds/v1") do |req|
+            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_options&.additional_headers || {}) }.compact
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
               req.body = {
                 **(request_options&.additional_body_parameters || {}),
                 amount_cents: amount_cents,
@@ -263,27 +372,36 @@ module CandidApiClient
                 invoice: invoice,
                 refund_reason: refund_reason
               }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/patient-refunds/v1"
             end
-            PatientRefunds::V1::PatientRefund.from_json(json_object: response.body)
+            CandidApiClient::PatientRefunds::V1::Types::PatientRefund.from_json(json_object: response.body)
           end
         end
 
         # Updates the patient refund record matching the provided patient_refund_id.
         #
-        # @param patient_refund_id [PatientRefunds::V1::PATIENT_REFUND_ID]
+        # @param patient_refund_id [String]
         # @param refund_timestamp [DateTime]
-        # @param refund_note [Financials::NoteUpdate]
-        # @param invoice [Financials::InvoiceUpdate]
-        # @param refund_reason [Financials::RefundReasonUpdate]
-        # @param request_options [RequestOptions]
-        # @return [PatientRefunds::V1::PatientRefund]
+        # @param refund_note [CandidApiClient::Financials::Types::NoteUpdate]
+        # @param invoice [CandidApiClient::Financials::Types::InvoiceUpdate]
+        # @param refund_reason [CandidApiClient::Financials::Types::RefundReasonUpdate]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientRefunds::V1::Types::PatientRefund]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_refunds.v_1.update(patient_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z))
         def update(patient_refund_id:, refund_timestamp: nil, refund_note: nil, invoice: nil, refund_reason: nil,
                    request_options: nil)
           Async do
-            response = @request_client.conn.patch("/api/patient-refunds/v1/#{patient_refund_id}") do |req|
+            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_options&.additional_headers || {}) }.compact
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
               req.body = {
                 **(request_options&.additional_body_parameters || {}),
                 refund_timestamp: refund_timestamp,
@@ -291,22 +409,33 @@ module CandidApiClient
                 invoice: invoice,
                 refund_reason: refund_reason
               }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/patient-refunds/v1/#{patient_refund_id}"
             end
-            PatientRefunds::V1::PatientRefund.from_json(json_object: response.body)
+            CandidApiClient::PatientRefunds::V1::Types::PatientRefund.from_json(json_object: response.body)
           end
         end
 
         # Deletes the patient refund record matching the provided patient_refund_id.
         #
-        # @param patient_refund_id [PatientRefunds::V1::PATIENT_REFUND_ID]
-        # @param request_options [RequestOptions]
+        # @param patient_refund_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
         # @return [Void]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_refunds.v_1.delete(patient_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def delete(patient_refund_id:, request_options: nil)
           Async do
-            @request_client.conn.delete("/api/patient-refunds/v1/#{patient_refund_id}") do |req|
+            @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_options&.additional_headers || {}) }.compact
+              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/patient-refunds/v1/#{patient_refund_id}"
             end
           end
         end