candidhealth 0.24.7 → 0.26.0

data/lib/candidhealth/third_party_payer_payments/v_1/types/third_party_payer_payments_page.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative "third_party_payer_payment"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module ThirdPartyPayerPayments
+    module V1
+      module Types
+        class ThirdPartyPayerPaymentsPage
+          # @return [Array<CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment>]
+          attr_reader :items
+          # @return [String]
+          attr_reader :prev_page_token
+          # @return [String]
+          attr_reader :next_page_token
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param items [Array<CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment>]
+          # @param prev_page_token [String]
+          # @param next_page_token [String]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPaymentsPage]
+          def initialize(items:, prev_page_token: OMIT, next_page_token: OMIT, additional_properties: nil)
+            @items = items
+            @prev_page_token = prev_page_token if prev_page_token != OMIT
+            @next_page_token = next_page_token if next_page_token != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "items": items,
+              "prev_page_token": prev_page_token,
+              "next_page_token": next_page_token
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of ThirdPartyPayerPaymentsPage
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPaymentsPage]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            items = parsed_json["items"]&.map do |item|
+              item = item.to_json
+              CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment.from_json(json_object: item)
+            end
+            prev_page_token = struct["prev_page_token"]
+            next_page_token = struct["next_page_token"]
+            new(
+              items: items,
+              prev_page_token: prev_page_token,
+              next_page_token: next_page_token,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of ThirdPartyPayerPaymentsPage to a JSON object
+          #
+          # @return [String]
+          def to_json(*_args)
+            @_field_set&.to_json
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            obj.items.is_a?(Array) != false || raise("Passed value for field obj.items is not the expected type, validation failed.")
+            obj.prev_page_token&.is_a?(String) != false || raise("Passed value for field obj.prev_page_token is not the expected type, validation failed.")
+            obj.next_page_token&.is_a?(String) != false || raise("Passed value for field obj.next_page_token is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/third_party_payer_refunds/client.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "v_1/client"
+
+module CandidApiClient
+  module ThirdPartyPayerRefunds
+    class Client
+      # @return [CandidApiClient::ThirdPartyPayerRefunds::V1::V1Client]
+      attr_reader :v_1
+
+      # @param request_client [CandidApiClient::RequestClient]
+      # @return [CandidApiClient::ThirdPartyPayerRefunds::Client]
+      def initialize(request_client:)
+        @v_1 = CandidApiClient::ThirdPartyPayerRefunds::V1::V1Client.new(request_client: request_client)
+      end
+    end
+
+    class AsyncClient
+      # @return [CandidApiClient::ThirdPartyPayerRefunds::V1::AsyncV1Client]
+      attr_reader :v_1
+
+      # @param request_client [CandidApiClient::AsyncRequestClient]
+      # @return [CandidApiClient::ThirdPartyPayerRefunds::AsyncClient]
+      def initialize(request_client:)
+        @v_1 = CandidApiClient::ThirdPartyPayerRefunds::V1::AsyncV1Client.new(request_client: request_client)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,385 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "types/third_party_payer_refund_sort_field"
+require_relative "../../commons/types/sort_direction"
+require_relative "types/third_party_payer_refunds_page"
+require_relative "types/third_party_payer_refund"
+require_relative "types/third_party_payer_refund_create"
+require "date"
+require_relative "../../financials/types/note_update"
+require_relative "../../financials/types/refund_reason_update"
+require_relative "../../financials/types/invoice_update"
+require "async"
+
+module CandidApiClient
+  module ThirdPartyPayerRefunds
+    module V1
+      class V1Client
+        # @return [CandidApiClient::RequestClient]
+        attr_reader :request_client
+
+        # @param request_client [CandidApiClient::RequestClient]
+        # @return [CandidApiClient::ThirdPartyPayerRefunds::V1::V1Client]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # Returns all third party payer refunds satisfying the search criteria
+        #
+        # @param limit [Integer] Defaults to 100. The value must be greater than 0 and less than 1000.
+        # @param third_party_payer_id [String]
+        # @param check_number [String]
+        # @param invoice_id [String]
+        # @param sort [CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefundSortField] 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::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefundsPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_refunds.v_1.get_multi(
+        #    limit: 1,
+        #    third_party_payer_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    check_number: "string",
+        #    invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    sort: AMOUNT_CENTS,
+        #    sort_direction: ASC,
+        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
+        #  )
+        def get_multi(limit: nil, third_party_payer_id: nil, check_number: nil, invoice_id: nil, sort: nil,
+                      sort_direction: nil, page_token: nil, request_options: nil)
+          response = @request_client.conn.get do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "limit": limit,
+              "third_party_payer_id": third_party_payer_id,
+              "check_number": check_number,
+              "invoice_id": invoice_id,
+              "sort": sort,
+              "sort_direction": sort_direction,
+              "page_token": page_token
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/third-party-payer-refunds/v1"
+          end
+          CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefundsPage.from_json(json_object: response.body)
+        end
+
+        # Retrieves a previously created third party payer refund by its
+        #  `third_party_payer_refund_id`.
+        #
+        # @param third_party_payer_refund_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefund]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_refunds.v_1.get(third_party_payer_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def get(third_party_payer_refund_id:, request_options: nil)
+          response = @request_client.conn.get do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/third-party-payer-refunds/v1/#{third_party_payer_refund_id}"
+          end
+          CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefund.from_json(json_object: response.body)
+        end
+
+        # Creates a new third party payer refund record and returns the newly created
+        #  `ThirdPartyPayerRefund` object.
+        #  The allocations can describe whether the refund is being applied toward a
+        #  specific service line,
+        #  claim, or billing provider.
+        #
+        # @param request [Hash] Request of type CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefundCreate, as a Hash
+        #   * :third_party_payer_id (String)
+        #   * :invoice_id (String)
+        #   * :amount_cents (Integer)
+        #   * :refund_timestamp (DateTime)
+        #   * :refund_note (String)
+        #   * :allocations (Array<CandidApiClient::Financials::Types::AllocationCreate>)
+        #   * :refund_reason (CandidApiClient::Financials::Types::RefundReason)
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefund]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_refunds.v_1.create(request: { third_party_payer_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", amount_cents: 1, refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), refund_note: "string", allocations: [{  }], refund_reason: OVERCHARGED })
+        def create(request:, request_options: nil)
+          response = @request_client.conn.post do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/third-party-payer-refunds/v1"
+          end
+          CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefund.from_json(json_object: response.body)
+        end
+
+        # Updates the third party payer refund record matching the provided
+        #  third_party_payer_refund_id. If updating the refund amount,
+        #  then the allocations must be appropriately updated as well.
+        #
+        # @param third_party_payer_refund_id [String]
+        # @param refund_timestamp [DateTime]
+        # @param refund_note [CandidApiClient::Financials::Types::NoteUpdate]
+        # @param refund_reason [CandidApiClient::Financials::Types::RefundReasonUpdate]
+        # @param invoice_id [CandidApiClient::Financials::Types::InvoiceUpdate]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefund]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_refunds.v_1.update(third_party_payer_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z))
+        def update(third_party_payer_refund_id:, refund_timestamp: nil, refund_note: nil, refund_reason: nil,
+                   invoice_id: nil, request_options: nil)
+          response = @request_client.conn.patch do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.body = {
+              **(request_options&.additional_body_parameters || {}),
+              refund_timestamp: refund_timestamp,
+              refund_note: refund_note,
+              refund_reason: refund_reason,
+              invoice_id: invoice_id
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/third-party-payer-refunds/v1/#{third_party_payer_refund_id}"
+          end
+          CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefund.from_json(json_object: response.body)
+        end
+
+        # Deletes the third party payer refund record matching the provided
+        #  `third_party_payer_refund_id`.
+        #
+        # @param third_party_payer_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.third_party_payer_refunds.v_1.delete(third_party_payer_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def delete(third_party_payer_refund_id:, request_options: nil)
+          @request_client.conn.delete do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/third-party-payer-refunds/v1/#{third_party_payer_refund_id}"
+          end
+        end
+      end
+
+      class AsyncV1Client
+        # @return [CandidApiClient::AsyncRequestClient]
+        attr_reader :request_client
+
+        # @param request_client [CandidApiClient::AsyncRequestClient]
+        # @return [CandidApiClient::ThirdPartyPayerRefunds::V1::AsyncV1Client]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # Returns all third party payer refunds satisfying the search criteria
+        #
+        # @param limit [Integer] Defaults to 100. The value must be greater than 0 and less than 1000.
+        # @param third_party_payer_id [String]
+        # @param check_number [String]
+        # @param invoice_id [String]
+        # @param sort [CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefundSortField] 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::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefundsPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_refunds.v_1.get_multi(
+        #    limit: 1,
+        #    third_party_payer_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    check_number: "string",
+        #    invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    sort: AMOUNT_CENTS,
+        #    sort_direction: ASC,
+        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
+        #  )
+        def get_multi(limit: nil, third_party_payer_id: nil, check_number: nil, invoice_id: nil, sort: nil,
+                      sort_direction: nil, page_token: nil, request_options: nil)
+          Async do
+            response = @request_client.conn.get do |req|
+              req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+              req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.params = {
+                **(request_options&.additional_query_parameters || {}),
+                "limit": limit,
+                "third_party_payer_id": third_party_payer_id,
+                "check_number": check_number,
+                "invoice_id": invoice_id,
+                "sort": sort,
+                "sort_direction": sort_direction,
+                "page_token": page_token
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/third-party-payer-refunds/v1"
+            end
+            CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefundsPage.from_json(json_object: response.body)
+          end
+        end
+
+        # Retrieves a previously created third party payer refund by its
+        #  `third_party_payer_refund_id`.
+        #
+        # @param third_party_payer_refund_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefund]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_refunds.v_1.get(third_party_payer_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def get(third_party_payer_refund_id:, request_options: nil)
+          Async do
+            response = @request_client.conn.get do |req|
+              req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+              req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/third-party-payer-refunds/v1/#{third_party_payer_refund_id}"
+            end
+            CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefund.from_json(json_object: response.body)
+          end
+        end
+
+        # Creates a new third party payer refund record and returns the newly created
+        #  `ThirdPartyPayerRefund` object.
+        #  The allocations can describe whether the refund is being applied toward a
+        #  specific service line,
+        #  claim, or billing provider.
+        #
+        # @param request [Hash] Request of type CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefundCreate, as a Hash
+        #   * :third_party_payer_id (String)
+        #   * :invoice_id (String)
+        #   * :amount_cents (Integer)
+        #   * :refund_timestamp (DateTime)
+        #   * :refund_note (String)
+        #   * :allocations (Array<CandidApiClient::Financials::Types::AllocationCreate>)
+        #   * :refund_reason (CandidApiClient::Financials::Types::RefundReason)
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefund]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_refunds.v_1.create(request: { third_party_payer_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", amount_cents: 1, refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), refund_note: "string", allocations: [{  }], refund_reason: OVERCHARGED })
+        def create(request:, request_options: nil)
+          Async do
+            response = @request_client.conn.post do |req|
+              req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+              req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/third-party-payer-refunds/v1"
+            end
+            CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefund.from_json(json_object: response.body)
+          end
+        end
+
+        # Updates the third party payer refund record matching the provided
+        #  third_party_payer_refund_id. If updating the refund amount,
+        #  then the allocations must be appropriately updated as well.
+        #
+        # @param third_party_payer_refund_id [String]
+        # @param refund_timestamp [DateTime]
+        # @param refund_note [CandidApiClient::Financials::Types::NoteUpdate]
+        # @param refund_reason [CandidApiClient::Financials::Types::RefundReasonUpdate]
+        # @param invoice_id [CandidApiClient::Financials::Types::InvoiceUpdate]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefund]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_refunds.v_1.update(third_party_payer_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z))
+        def update(third_party_payer_refund_id:, refund_timestamp: nil, refund_note: nil, refund_reason: nil,
+                   invoice_id: nil, request_options: nil)
+          Async do
+            response = @request_client.conn.patch do |req|
+              req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+              req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.body = {
+                **(request_options&.additional_body_parameters || {}),
+                refund_timestamp: refund_timestamp,
+                refund_note: refund_note,
+                refund_reason: refund_reason,
+                invoice_id: invoice_id
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/third-party-payer-refunds/v1/#{third_party_payer_refund_id}"
+            end
+            CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefund.from_json(json_object: response.body)
+          end
+        end
+
+        # Deletes the third party payer refund record matching the provided
+        #  `third_party_payer_refund_id`.
+        #
+        # @param third_party_payer_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.third_party_payer_refunds.v_1.delete(third_party_payer_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def delete(third_party_payer_refund_id:, request_options: nil)
+          Async do
+            @request_client.conn.delete do |req|
+              req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+              req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/third-party-payer-refunds/v1/#{third_party_payer_refund_id}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/third_party_payer_refunds/v_1/types/third_party_payer_refund.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require_relative "../../../third_party_payers/v_1/types/third_party_payer"
+require "date"
+require_relative "../../../financials/types/allocation"
+require_relative "../../../financials/types/refund_reason"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module ThirdPartyPayerRefunds
+    module V1
+      module Types
+        class ThirdPartyPayerRefund
+          # @return [String]
+          attr_reader :third_party_payer_refund_id
+          # @return [CandidApiClient::ThirdPartyPayers::V1::Types::ThirdPartyPayer]
+          attr_reader :third_party_payer
+          # @return [Integer]
+          attr_reader :amount_cents
+          # @return [DateTime]
+          attr_reader :refund_timestamp
+          # @return [String]
+          attr_reader :refund_note
+          # @return [Array<CandidApiClient::Financials::Types::Allocation>]
+          attr_reader :allocations
+          # @return [CandidApiClient::Financials::Types::RefundReason]
+          attr_reader :refund_reason
+          # @return [String]
+          attr_reader :invoice_id
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param third_party_payer_refund_id [String]
+          # @param third_party_payer [CandidApiClient::ThirdPartyPayers::V1::Types::ThirdPartyPayer]
+          # @param amount_cents [Integer]
+          # @param refund_timestamp [DateTime]
+          # @param refund_note [String]
+          # @param allocations [Array<CandidApiClient::Financials::Types::Allocation>]
+          # @param refund_reason [CandidApiClient::Financials::Types::RefundReason]
+          # @param invoice_id [String]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefund]
+          def initialize(third_party_payer_refund_id:, third_party_payer:, amount_cents:, allocations:, refund_timestamp: OMIT,
+                         refund_note: OMIT, refund_reason: OMIT, invoice_id: OMIT, additional_properties: nil)
+            @third_party_payer_refund_id = third_party_payer_refund_id
+            @third_party_payer = third_party_payer
+            @amount_cents = amount_cents
+            @refund_timestamp = refund_timestamp if refund_timestamp != OMIT
+            @refund_note = refund_note if refund_note != OMIT
+            @allocations = allocations
+            @refund_reason = refund_reason if refund_reason != OMIT
+            @invoice_id = invoice_id if invoice_id != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "third_party_payer_refund_id": third_party_payer_refund_id,
+              "third_party_payer": third_party_payer,
+              "amount_cents": amount_cents,
+              "refund_timestamp": refund_timestamp,
+              "refund_note": refund_note,
+              "allocations": allocations,
+              "refund_reason": refund_reason,
+              "invoice_id": invoice_id
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of ThirdPartyPayerRefund
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::ThirdPartyPayerRefunds::V1::Types::ThirdPartyPayerRefund]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            third_party_payer_refund_id = struct["third_party_payer_refund_id"]
+            if parsed_json["third_party_payer"].nil?
+              third_party_payer = nil
+            else
+              third_party_payer = parsed_json["third_party_payer"].to_json
+              third_party_payer = CandidApiClient::ThirdPartyPayers::V1::Types::ThirdPartyPayer.from_json(json_object: third_party_payer)
+            end
+            amount_cents = struct["amount_cents"]
+            refund_timestamp = unless parsed_json["refund_timestamp"].nil?
+                                 DateTime.parse(parsed_json["refund_timestamp"])
+                               end
+            refund_note = struct["refund_note"]
+            allocations = parsed_json["allocations"]&.map do |item|
+              item = item.to_json
+              CandidApiClient::Financials::Types::Allocation.from_json(json_object: item)
+            end
+            refund_reason = struct["refund_reason"]
+            invoice_id = struct["invoice_id"]
+            new(
+              third_party_payer_refund_id: third_party_payer_refund_id,
+              third_party_payer: third_party_payer,
+              amount_cents: amount_cents,
+              refund_timestamp: refund_timestamp,
+              refund_note: refund_note,
+              allocations: allocations,
+              refund_reason: refund_reason,
+              invoice_id: invoice_id,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of ThirdPartyPayerRefund to a JSON object
+          #
+          # @return [String]
+          def to_json(*_args)
+            @_field_set&.to_json
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            obj.third_party_payer_refund_id.is_a?(String) != false || raise("Passed value for field obj.third_party_payer_refund_id is not the expected type, validation failed.")
+            CandidApiClient::ThirdPartyPayers::V1::Types::ThirdPartyPayer.validate_raw(obj: obj.third_party_payer)
+            obj.amount_cents.is_a?(Integer) != false || raise("Passed value for field obj.amount_cents is not the expected type, validation failed.")
+            obj.refund_timestamp&.is_a?(DateTime) != false || raise("Passed value for field obj.refund_timestamp is not the expected type, validation failed.")
+            obj.refund_note&.is_a?(String) != false || raise("Passed value for field obj.refund_note is not the expected type, validation failed.")
+            obj.allocations.is_a?(Array) != false || raise("Passed value for field obj.allocations is not the expected type, validation failed.")
+            obj.refund_reason&.is_a?(CandidApiClient::Financials::Types::RefundReason) != false || raise("Passed value for field obj.refund_reason is not the expected type, validation failed.")
+            obj.invoice_id&.is_a?(String) != false || raise("Passed value for field obj.invoice_id is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end