candidhealth 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a1adb84cd11b812275e563c4043c816e6824a121a01fa03cdf706736527246e
+  data.tar.gz: 7cbe92716d81098bc29656e6ab56652b0cd0afe766ebed733bd664bfba988c91
+SHA512:
+  metadata.gz: a828749f074506bf1074adb98dec7c05ef8b995784caabfb42bbdc291378067938038bd22f2d3053f99afa279c5ede391d1d1b3a1a7b318a31d2d6005ca7f18b
+  data.tar.gz: 3e64f090085799ba849f83b72cad4866d9224eb38e9f3e2341c785f58a90025dc0a231ccb32cf15a50bae4f726b8c51b8324c5094b6b0759bec9d079e0011868

data/lib/candidhealth/auth/client.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "default/client"
+
+module CandidApiClient
+  module Auth
+    class Client
+      # @return [CandidApiClient::Auth::Default::DefaultClient]
+      attr_reader :default
+
+      # @param request_client [CandidApiClient::RequestClient]
+      # @return [CandidApiClient::Auth::Client]
+      def initialize(request_client:)
+        @default = CandidApiClient::Auth::Default::DefaultClient.new(request_client: request_client)
+      end
+    end
+
+    class AsyncClient
+      # @return [CandidApiClient::Auth::Default::AsyncDefaultClient]
+      attr_reader :default
+
+      # @param request_client [CandidApiClient::AsyncRequestClient]
+      # @return [CandidApiClient::Auth::AsyncClient]
+      def initialize(request_client:)
+        @default = CandidApiClient::Auth::Default::AsyncDefaultClient.new(request_client: request_client)
+      end
+    end
+  end
+end

data/lib/candidhealth/auth/default/client.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "types/auth_get_token_response"
+require "async"
+
+module CandidApiClient
+  module Auth
+    module Default
+      class DefaultClient
+        # @return [CandidApiClient::RequestClient]
+        attr_reader :request_client
+
+        # @param request_client [CandidApiClient::RequestClient]
+        # @return [CandidApiClient::Auth::Default::DefaultClient]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # <Callout intent="info">
+        #  Candid Health SDKs automatically handle authentication workflows after
+        #  configuring them with the `client_id` and
+        #  `client_secret`.
+        #  </Callout>
+        #  Candid Health utilizes the [OAuth 2.0 bearer token authentication
+        #  scheme](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) in our
+        #  auth flow. You obtain the bearer token for all
+        #  subsequent API requests via the `/auth/v2/token` endpoint defined below, which
+        #  requires you to provide your `client_id` and `client_secret`. Your `client_id`
+        #  and `client_secret` can be
+        #  incandidhealth.com/hc/en-us/articles/23065219476244--Generating-Candid-API-Keys)
+        #  from the "Users & Credentials" tab by your org admin.
+        #  The `/auth/v2/token` endpoint accepts both `Content-Type: application/json` and
+        #  `Content-Type: application/x-www-form-urlencoded`. The request body should
+        #  contain the `client_id` and `client_secret` as follows:
+        #  ```json
+        #  {
+        #  "client_id": "YOUR_CLIENT_ID",
+        #  "client_secret": "YOUR_CLIENT_SECRET"
+        #  }
+        #  ```
+        #  or as URL-encoded form data:
+        #  ```
+        #  client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET
+        #  ```
+        #  The bearer token is a signed [JWT](https://jwt.io/). The public key for the JWT
+        #  can be found [here](https://candidhealth.auth0.com/pem) for any verification
+        #  workflows.
+        #  The bearer token should be provided in the `Authorization` header for all
+        #  subsequent API calls.
+        #  <Callout intent="warning">
+        #  The bearer token expires 5 hours after it has been created. After it has
+        #  expired, the client will receive an "HTTP 401
+        #  Unauthorized" error, at which point the client should generate a new token. It
+        #  is important that tokens be reused between
+        #  requests; if the client attempts to generate a token too often, it will be
+        #  rate-limited and will receive an `HTTP 429 Too Many Requests` error.
+        #  </Callout>
+        #
+        # @param client_id [String] Your application's Client ID.
+        # @param client_secret [String] Your application's Client Secret.
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::Auth::Default::Types::AuthGetTokenResponse]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.auth.default.get_token(client_id: "YOUR_CLIENT_ID", client_secret: "YOUR_CLIENT_SECRET")
+        def get_token(client_id:, client_secret:, 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_options&.additional_body_parameters || {}),
+              client_id: client_id,
+              client_secret: client_secret
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/auth/v2/token"
+          end
+          CandidApiClient::Auth::Default::Types::AuthGetTokenResponse.from_json(json_object: response.body)
+        end
+      end
+
+      class AsyncDefaultClient
+        # @return [CandidApiClient::AsyncRequestClient]
+        attr_reader :request_client
+
+        # @param request_client [CandidApiClient::AsyncRequestClient]
+        # @return [CandidApiClient::Auth::Default::AsyncDefaultClient]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # <Callout intent="info">
+        #  Candid Health SDKs automatically handle authentication workflows after
+        #  configuring them with the `client_id` and
+        #  `client_secret`.
+        #  </Callout>
+        #  Candid Health utilizes the [OAuth 2.0 bearer token authentication
+        #  scheme](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) in our
+        #  auth flow. You obtain the bearer token for all
+        #  subsequent API requests via the `/auth/v2/token` endpoint defined below, which
+        #  requires you to provide your `client_id` and `client_secret`. Your `client_id`
+        #  and `client_secret` can be
+        #  incandidhealth.com/hc/en-us/articles/23065219476244--Generating-Candid-API-Keys)
+        #  from the "Users & Credentials" tab by your org admin.
+        #  The `/auth/v2/token` endpoint accepts both `Content-Type: application/json` and
+        #  `Content-Type: application/x-www-form-urlencoded`. The request body should
+        #  contain the `client_id` and `client_secret` as follows:
+        #  ```json
+        #  {
+        #  "client_id": "YOUR_CLIENT_ID",
+        #  "client_secret": "YOUR_CLIENT_SECRET"
+        #  }
+        #  ```
+        #  or as URL-encoded form data:
+        #  ```
+        #  client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET
+        #  ```
+        #  The bearer token is a signed [JWT](https://jwt.io/). The public key for the JWT
+        #  can be found [here](https://candidhealth.auth0.com/pem) for any verification
+        #  workflows.
+        #  The bearer token should be provided in the `Authorization` header for all
+        #  subsequent API calls.
+        #  <Callout intent="warning">
+        #  The bearer token expires 5 hours after it has been created. After it has
+        #  expired, the client will receive an "HTTP 401
+        #  Unauthorized" error, at which point the client should generate a new token. It
+        #  is important that tokens be reused between
+        #  requests; if the client attempts to generate a token too often, it will be
+        #  rate-limited and will receive an `HTTP 429 Too Many Requests` error.
+        #  </Callout>
+        #
+        # @param client_id [String] Your application's Client ID.
+        # @param client_secret [String] Your application's Client Secret.
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::Auth::Default::Types::AuthGetTokenResponse]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.auth.default.get_token(client_id: "YOUR_CLIENT_ID", client_secret: "YOUR_CLIENT_SECRET")
+        def get_token(client_id:, client_secret:, 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_options&.additional_body_parameters || {}),
+                client_id: client_id,
+                client_secret: client_secret
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/auth/v2/token"
+            end
+            CandidApiClient::Auth::Default::Types::AuthGetTokenResponse.from_json(json_object: response.body)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/auth/default/types/auth_get_token_response.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Auth
+    module Default
+      module Types
+        class AuthGetTokenResponse
+          # @return [String]
+          attr_reader :access_token
+          # @return [Integer] Time in seconds.
+          attr_reader :expires_in
+          # @return [String]
+          attr_reader :token_type
+          # @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 access_token [String]
+          # @param expires_in [Integer] Time in seconds.
+          # @param token_type [String]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::Auth::Default::Types::AuthGetTokenResponse]
+          def initialize(access_token:, expires_in:, token_type:, additional_properties: nil)
+            @access_token = access_token
+            @expires_in = expires_in
+            @token_type = token_type
+            @additional_properties = additional_properties
+            @_field_set = { "access_token": access_token, "expires_in": expires_in, "token_type": token_type }
+          end
+
+          # Deserialize a JSON object to an instance of AuthGetTokenResponse
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::Auth::Default::Types::AuthGetTokenResponse]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            access_token = struct["access_token"]
+            expires_in = struct["expires_in"]
+            token_type = struct["token_type"]
+            new(
+              access_token: access_token,
+              expires_in: expires_in,
+              token_type: token_type,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of AuthGetTokenResponse 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.access_token.is_a?(String) != false || raise("Passed value for field obj.access_token is not the expected type, validation failed.")
+            obj.expires_in.is_a?(Integer) != false || raise("Passed value for field obj.expires_in is not the expected type, validation failed.")
+            obj.token_type.is_a?(String) != false || raise("Passed value for field obj.token_type is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/auth/default/types/invalid_content_type_error_type.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Auth
+    module Default
+      module Types
+        class InvalidContentTypeErrorType
+          # @return [String]
+          attr_reader :message
+          # @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 message [String]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::Auth::Default::Types::InvalidContentTypeErrorType]
+          def initialize(message:, additional_properties: nil)
+            @message = message
+            @additional_properties = additional_properties
+            @_field_set = { "message": message }
+          end
+
+          # Deserialize a JSON object to an instance of InvalidContentTypeErrorType
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::Auth::Default::Types::InvalidContentTypeErrorType]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            message = struct["message"]
+            new(message: message, additional_properties: struct)
+          end
+
+          # Serialize an instance of InvalidContentTypeErrorType 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.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/auth/default/types/too_many_requests_error_type.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Auth
+    module Default
+      module Types
+        class TooManyRequestsErrorType
+          # @return [String]
+          attr_reader :message
+          # @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 message [String]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::Auth::Default::Types::TooManyRequestsErrorType]
+          def initialize(message:, additional_properties: nil)
+            @message = message
+            @additional_properties = additional_properties
+            @_field_set = { "message": message }
+          end
+
+          # Deserialize a JSON object to an instance of TooManyRequestsErrorType
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::Auth::Default::Types::TooManyRequestsErrorType]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            message = struct["message"]
+            new(message: message, additional_properties: struct)
+          end
+
+          # Serialize an instance of TooManyRequestsErrorType 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.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/billing_notes/client.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "v_2/client"
+
+module CandidApiClient
+  module BillingNotes
+    class Client
+      # @return [CandidApiClient::BillingNotes::V2::V2Client]
+      attr_reader :v_2
+
+      # @param request_client [CandidApiClient::RequestClient]
+      # @return [CandidApiClient::BillingNotes::Client]
+      def initialize(request_client:)
+        @v_2 = CandidApiClient::BillingNotes::V2::V2Client.new(request_client: request_client)
+      end
+    end
+
+    class AsyncClient
+      # @return [CandidApiClient::BillingNotes::V2::AsyncV2Client]
+      attr_reader :v_2
+
+      # @param request_client [CandidApiClient::AsyncRequestClient]
+      # @return [CandidApiClient::BillingNotes::AsyncClient]
+      def initialize(request_client:)
+        @v_2 = CandidApiClient::BillingNotes::V2::AsyncV2Client.new(request_client: request_client)
+      end
+    end
+  end
+end

data/lib/candidhealth/billing_notes/v_2/client.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require "ostruct"
+require_relative "types/billing_note"
+require "async"
+
+module CandidApiClient
+  module BillingNotes
+    module V2
+      class V2Client
+        # @return [CandidApiClient::RequestClient]
+        attr_reader :request_client
+
+        # @param request_client [CandidApiClient::RequestClient]
+        # @return [CandidApiClient::BillingNotes::V2::V2Client]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # @param text [String] Empty string not allowed.
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @param _field_set [Object]
+        # @param encounter_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::BillingNotes::V2::Types::BillingNote]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.billing_notes.v_2.create(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def create(text:, encounter_id:, additional_properties: nil, _field_set: nil, 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_options&.additional_body_parameters || {}),
+              text: text,
+              additional_properties: additional_properties,
+              _field_set: _field_set,
+              encounter_id: encounter_id
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/billing_notes/v2"
+          end
+          CandidApiClient::BillingNotes::V2::Types::BillingNote.from_json(json_object: response.body)
+        end
+
+        # @param billing_note_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.billing_notes.v_2.delete(billing_note_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def delete(billing_note_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/billing_notes/v2/#{billing_note_id}"
+          end
+        end
+
+        # @param billing_note_id [String]
+        # @param text [String] Empty string not allowed.
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::BillingNotes::V2::Types::BillingNote]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.billing_notes.v_2.update(billing_note_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", text: "text")
+        def update(billing_note_id:, text:, 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 || {}), text: text }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/billing_notes/v2/#{billing_note_id}"
+          end
+          CandidApiClient::BillingNotes::V2::Types::BillingNote.from_json(json_object: response.body)
+        end
+      end
+
+      class AsyncV2Client
+        # @return [CandidApiClient::AsyncRequestClient]
+        attr_reader :request_client
+
+        # @param request_client [CandidApiClient::AsyncRequestClient]
+        # @return [CandidApiClient::BillingNotes::V2::AsyncV2Client]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # @param text [String] Empty string not allowed.
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @param _field_set [Object]
+        # @param encounter_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::BillingNotes::V2::Types::BillingNote]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.billing_notes.v_2.create(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def create(text:, encounter_id:, additional_properties: nil, _field_set: nil, 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_options&.additional_body_parameters || {}),
+                text: text,
+                additional_properties: additional_properties,
+                _field_set: _field_set,
+                encounter_id: encounter_id
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/billing_notes/v2"
+            end
+            CandidApiClient::BillingNotes::V2::Types::BillingNote.from_json(json_object: response.body)
+          end
+        end
+
+        # @param billing_note_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.billing_notes.v_2.delete(billing_note_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def delete(billing_note_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/billing_notes/v2/#{billing_note_id}"
+            end
+          end
+        end
+
+        # @param billing_note_id [String]
+        # @param text [String] Empty string not allowed.
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::BillingNotes::V2::Types::BillingNote]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.billing_notes.v_2.update(billing_note_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", text: "text")
+        def update(billing_note_id:, text:, 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 || {}), text: text }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/billing_notes/v2/#{billing_note_id}"
+            end
+            CandidApiClient::BillingNotes::V2::Types::BillingNote.from_json(json_object: response.body)
+          end
+        end
+      end
+    end
+  end
+end