candidhealth 0.21.0 → 0.24.1

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

@@ -1,15 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "../../../requests"
-require_relative "../../payers/v_3/types/payer_uuid"
-require_relative "../../commons/types/claim_id"
-require_relative "../../commons/types/service_line_id"
-require_relative "../../commons/types/provider_id"
 require_relative "types/insurance_payment_sort_field"
 require_relative "../../commons/types/sort_direction"
-require_relative "../../commons/types/page_token"
 require_relative "types/insurance_payments_page"
-require_relative "types/insurance_payment_id"
 require_relative "types/insurance_payment"
 require_relative "types/insurance_payment_create"
 require "date"
@@ -20,33 +14,49 @@ module CandidApiClient
   module InsurancePayments
     module V1
       class V1Client
+        # @return [CandidApiClient::RequestClient]
         attr_reader :request_client
 
-        # @param request_client [RequestClient]
-        # @return [InsurancePayments::V1::V1Client]
+        # @param request_client [CandidApiClient::RequestClient]
+        # @return [CandidApiClient::InsurancePayments::V1::V1Client]
         def initialize(request_client:)
-          # @type [RequestClient]
           @request_client = request_client
         end
 
         # Returns all non-ERA originated insurance payments satisfying the search criteria
         #
         # @param limit [Integer] Defaults to 100. The value must be greater than 0 and less than 1000.
-        # @param payer_uuid [Payers::V3::PAYER_UUID]
-        # @param claim_id [Commons::CLAIM_ID]
-        # @param service_line_id [Commons::SERVICE_LINE_ID]
-        # @param billing_provider_id [Commons::PROVIDER_ID]
-        # @param sort [InsurancePayments::V1::InsurancePaymentSortField] Defaults to payment_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 [InsurancePayments::V1::InsurancePaymentsPage]
+        # @param payer_uuid [String]
+        # @param claim_id [String]
+        # @param service_line_id [String]
+        # @param billing_provider_id [String]
+        # @param sort [CandidApiClient::InsurancePayments::V1::Types::InsurancePaymentSortField] Defaults to payment_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::InsurancePayments::V1::Types::InsurancePaymentsPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.insurance_payments.v_1.get_multi(
+        #    limit: 1,
+        #    payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    claim_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    service_line_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    billing_provider_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    sort: AMOUNT_CENTS,
+        #    sort_direction: ASC,
+        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
+        #  )
         def get_multi(limit: nil, payer_uuid: nil, claim_id: nil, service_line_id: nil, billing_provider_id: nil,
                       sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
-          response = @request_client.conn.get("/api/insurance-payments/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,
@@ -58,114 +68,173 @@ module CandidApiClient
               "sort_direction": sort_direction,
               "page_token": page_token
             }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/insurance-payments/v1"
           end
-          InsurancePayments::V1::InsurancePaymentsPage.from_json(json_object: response.body)
+          CandidApiClient::InsurancePayments::V1::Types::InsurancePaymentsPage.from_json(json_object: response.body)
         end
 
         # Retrieves a previously created insurance payment by its `insurance_payment_id`.
-        # If the payment does not exist, a `403` will be thrown.
+        #  If the payment does not exist, a `403` will be thrown.
         #
-        # @param insurance_payment_id [InsurancePayments::V1::INSURANCE_PAYMENT_ID]
-        # @param request_options [RequestOptions]
-        # @return [InsurancePayments::V1::InsurancePayment]
+        # @param insurance_payment_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::InsurancePayments::V1::Types::InsurancePayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.insurance_payments.v_1.get(insurance_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def get(insurance_payment_id:, request_options: nil)
-          response = @request_client.conn.get("/api/insurance-payments/v1/#{insurance_payment_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/insurance-payments/v1/#{insurance_payment_id}"
           end
-          InsurancePayments::V1::InsurancePayment.from_json(json_object: response.body)
+          CandidApiClient::InsurancePayments::V1::Types::InsurancePayment.from_json(json_object: response.body)
         end
 
-        # Creates a new insurance payment record and returns the newly created `InsurancePayment` object. This endpoint
-        # should only be used for insurance payments that do not have a corresponding ERA (for example: a settlement check
-        # from a payer). If the payment is an ERA, then you should used the insurance-adjudications API.
+        # Creates a new insurance payment record and returns the newly created
+        #  `InsurancePayment` object. This endpoint
+        #  should only be used for insurance payments that do not have a corresponding ERA
+        #  (for example: a settlement check
+        #  from a payer). If the payment is an ERA, then you should used the
+        #  insurance-adjudications API.
         #
-        # @param request [Hash] Request of type InsurancePayments::V1::InsurancePaymentCreate, as a Hash
+        # @param request [Hash] Request of type CandidApiClient::InsurancePayments::V1::Types::InsurancePaymentCreate, as a Hash
         #   * :payer_identifier (Hash)
         #   * :amount_cents (Integer)
         #   * :payment_timestamp (DateTime)
         #   * :payment_note (String)
-        #   * :allocations (Array<Financials::AllocationCreate>)
-        # @param request_options [RequestOptions]
-        # @return [InsurancePayments::V1::InsurancePayment]
+        #   * :allocations (Array<CandidApiClient::Financials::Types::AllocationCreate>)
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::InsurancePayments::V1::Types::InsurancePayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.insurance_payments.v_1.create(request: { amount_cents: 1, payment_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), payment_note: "string", allocations: [{  }] })
         def create(request:, request_options: nil)
-          response = @request_client.conn.post("/api/insurance-payments/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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/insurance-payments/v1"
           end
-          InsurancePayments::V1::InsurancePayment.from_json(json_object: response.body)
+          CandidApiClient::InsurancePayments::V1::Types::InsurancePayment.from_json(json_object: response.body)
         end
 
-        # Updates the patient payment record matching the provided insurance_payment_id. If updating the payment amount,
-        # then the allocations must be appropriately updated as well.
+        # Updates the patient payment record matching the provided insurance_payment_id.
+        #  If updating the payment amount,
+        #  then the allocations must be appropriately updated as well.
         #
-        # @param insurance_payment_id [InsurancePayments::V1::INSURANCE_PAYMENT_ID]
+        # @param insurance_payment_id [String]
         # @param payment_timestamp [DateTime]
-        # @param payment_note [Financials::NoteUpdate]
-        # @param request_options [RequestOptions]
-        # @return [InsurancePayments::V1::InsurancePayment]
+        # @param payment_note [CandidApiClient::Financials::Types::NoteUpdate]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::InsurancePayments::V1::Types::InsurancePayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.insurance_payments.v_1.update(insurance_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", payment_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z))
         def update(insurance_payment_id:, payment_timestamp: nil, payment_note: nil, request_options: nil)
-          response = @request_client.conn.patch("/api/insurance-payments/v1/#{insurance_payment_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 || {}),
               payment_timestamp: payment_timestamp,
               payment_note: payment_note
             }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/insurance-payments/v1/#{insurance_payment_id}"
           end
-          InsurancePayments::V1::InsurancePayment.from_json(json_object: response.body)
+          CandidApiClient::InsurancePayments::V1::Types::InsurancePayment.from_json(json_object: response.body)
         end
 
-        # Deletes the insurance payment record matching the provided `insurance_payment_id`.
-        # If the matching record's organization_id does not match the authenticated user's
-        # current organization_id, then a response code of `403` will be returned.
+        # Deletes the insurance payment record matching the provided
+        #  `insurance_payment_id`.
+        #  If the matching record's organization_id does not match the authenticated user's
+        #  current organization_id, then a response code of `403` will be returned.
         #
-        # @param insurance_payment_id [InsurancePayments::V1::INSURANCE_PAYMENT_ID]
-        # @param request_options [RequestOptions]
+        # @param insurance_payment_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.insurance_payments.v_1.delete(insurance_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def delete(insurance_payment_id:, request_options: nil)
-          @request_client.conn.delete("/api/insurance-payments/v1/#{insurance_payment_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/insurance-payments/v1/#{insurance_payment_id}"
           end
         end
       end
 
       class AsyncV1Client
+        # @return [CandidApiClient::AsyncRequestClient]
         attr_reader :request_client
 
-        # @param request_client [AsyncRequestClient]
-        # @return [InsurancePayments::V1::AsyncV1Client]
+        # @param request_client [CandidApiClient::AsyncRequestClient]
+        # @return [CandidApiClient::InsurancePayments::V1::AsyncV1Client]
         def initialize(request_client:)
-          # @type [AsyncRequestClient]
           @request_client = request_client
         end
 
         # Returns all non-ERA originated insurance payments satisfying the search criteria
         #
         # @param limit [Integer] Defaults to 100. The value must be greater than 0 and less than 1000.
-        # @param payer_uuid [Payers::V3::PAYER_UUID]
-        # @param claim_id [Commons::CLAIM_ID]
-        # @param service_line_id [Commons::SERVICE_LINE_ID]
-        # @param billing_provider_id [Commons::PROVIDER_ID]
-        # @param sort [InsurancePayments::V1::InsurancePaymentSortField] Defaults to payment_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 [InsurancePayments::V1::InsurancePaymentsPage]
+        # @param payer_uuid [String]
+        # @param claim_id [String]
+        # @param service_line_id [String]
+        # @param billing_provider_id [String]
+        # @param sort [CandidApiClient::InsurancePayments::V1::Types::InsurancePaymentSortField] Defaults to payment_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::InsurancePayments::V1::Types::InsurancePaymentsPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.insurance_payments.v_1.get_multi(
+        #    limit: 1,
+        #    payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    claim_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    service_line_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    billing_provider_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    sort: AMOUNT_CENTS,
+        #    sort_direction: ASC,
+        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
+        #  )
         def get_multi(limit: nil, payer_uuid: nil, claim_id: nil, service_line_id: nil, billing_provider_id: nil,
                       sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
           Async do
-            response = @request_client.conn.get("/api/insurance-payments/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,
@@ -177,89 +246,132 @@ module CandidApiClient
                 "sort_direction": sort_direction,
                 "page_token": page_token
               }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/insurance-payments/v1"
             end
-            InsurancePayments::V1::InsurancePaymentsPage.from_json(json_object: response.body)
+            CandidApiClient::InsurancePayments::V1::Types::InsurancePaymentsPage.from_json(json_object: response.body)
           end
         end
 
         # Retrieves a previously created insurance payment by its `insurance_payment_id`.
-        # If the payment does not exist, a `403` will be thrown.
+        #  If the payment does not exist, a `403` will be thrown.
         #
-        # @param insurance_payment_id [InsurancePayments::V1::INSURANCE_PAYMENT_ID]
-        # @param request_options [RequestOptions]
-        # @return [InsurancePayments::V1::InsurancePayment]
+        # @param insurance_payment_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::InsurancePayments::V1::Types::InsurancePayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.insurance_payments.v_1.get(insurance_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def get(insurance_payment_id:, request_options: nil)
           Async do
-            response = @request_client.conn.get("/api/insurance-payments/v1/#{insurance_payment_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/insurance-payments/v1/#{insurance_payment_id}"
             end
-            InsurancePayments::V1::InsurancePayment.from_json(json_object: response.body)
+            CandidApiClient::InsurancePayments::V1::Types::InsurancePayment.from_json(json_object: response.body)
           end
         end
 
-        # Creates a new insurance payment record and returns the newly created `InsurancePayment` object. This endpoint
-        # should only be used for insurance payments that do not have a corresponding ERA (for example: a settlement check
-        # from a payer). If the payment is an ERA, then you should used the insurance-adjudications API.
+        # Creates a new insurance payment record and returns the newly created
+        #  `InsurancePayment` object. This endpoint
+        #  should only be used for insurance payments that do not have a corresponding ERA
+        #  (for example: a settlement check
+        #  from a payer). If the payment is an ERA, then you should used the
+        #  insurance-adjudications API.
         #
-        # @param request [Hash] Request of type InsurancePayments::V1::InsurancePaymentCreate, as a Hash
+        # @param request [Hash] Request of type CandidApiClient::InsurancePayments::V1::Types::InsurancePaymentCreate, as a Hash
         #   * :payer_identifier (Hash)
         #   * :amount_cents (Integer)
         #   * :payment_timestamp (DateTime)
         #   * :payment_note (String)
-        #   * :allocations (Array<Financials::AllocationCreate>)
-        # @param request_options [RequestOptions]
-        # @return [InsurancePayments::V1::InsurancePayment]
+        #   * :allocations (Array<CandidApiClient::Financials::Types::AllocationCreate>)
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::InsurancePayments::V1::Types::InsurancePayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.insurance_payments.v_1.create(request: { amount_cents: 1, payment_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), payment_note: "string", allocations: [{  }] })
         def create(request:, request_options: nil)
           Async do
-            response = @request_client.conn.post("/api/insurance-payments/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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/insurance-payments/v1"
             end
-            InsurancePayments::V1::InsurancePayment.from_json(json_object: response.body)
+            CandidApiClient::InsurancePayments::V1::Types::InsurancePayment.from_json(json_object: response.body)
           end
         end
 
-        # Updates the patient payment record matching the provided insurance_payment_id. If updating the payment amount,
-        # then the allocations must be appropriately updated as well.
+        # Updates the patient payment record matching the provided insurance_payment_id.
+        #  If updating the payment amount,
+        #  then the allocations must be appropriately updated as well.
         #
-        # @param insurance_payment_id [InsurancePayments::V1::INSURANCE_PAYMENT_ID]
+        # @param insurance_payment_id [String]
         # @param payment_timestamp [DateTime]
-        # @param payment_note [Financials::NoteUpdate]
-        # @param request_options [RequestOptions]
-        # @return [InsurancePayments::V1::InsurancePayment]
+        # @param payment_note [CandidApiClient::Financials::Types::NoteUpdate]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::InsurancePayments::V1::Types::InsurancePayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.insurance_payments.v_1.update(insurance_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", payment_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z))
         def update(insurance_payment_id:, payment_timestamp: nil, payment_note: nil, request_options: nil)
           Async do
-            response = @request_client.conn.patch("/api/insurance-payments/v1/#{insurance_payment_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 || {}),
                 payment_timestamp: payment_timestamp,
                 payment_note: payment_note
               }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/insurance-payments/v1/#{insurance_payment_id}"
             end
-            InsurancePayments::V1::InsurancePayment.from_json(json_object: response.body)
+            CandidApiClient::InsurancePayments::V1::Types::InsurancePayment.from_json(json_object: response.body)
           end
         end
 
-        # Deletes the insurance payment record matching the provided `insurance_payment_id`.
-        # If the matching record's organization_id does not match the authenticated user's
-        # current organization_id, then a response code of `403` will be returned.
+        # Deletes the insurance payment record matching the provided
+        #  `insurance_payment_id`.
+        #  If the matching record's organization_id does not match the authenticated user's
+        #  current organization_id, then a response code of `403` will be returned.
         #
-        # @param insurance_payment_id [InsurancePayments::V1::INSURANCE_PAYMENT_ID]
-        # @param request_options [RequestOptions]
+        # @param insurance_payment_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.insurance_payments.v_1.delete(insurance_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def delete(insurance_payment_id:, request_options: nil)
           Async do
-            @request_client.conn.delete("/api/insurance-payments/v1/#{insurance_payment_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/insurance-payments/v1/#{insurance_payment_id}"
             end
           end
         end