candidhealth 0.35.2 → 0.35.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa540971de2f66292e9c032827b1414c52b67ef20ac20c63903b4b985f2d37f4
-  data.tar.gz: 391cdb4f9b8ae154e1c72851e3cd8a962f9bd2910875935481462ae67d6dda2c
+  metadata.gz: 322bb186b5d934fa214e4211428784e97434a7a8306c6c670f4f4fc59d1a6a8d
+  data.tar.gz: 6ee5bb4e1ec74cbaca7d0f1abb83fed9b64bc832c82a89123c110a76c4b3935b
 SHA512:
-  metadata.gz: 181f2f66cce5f5650b4e443bfa316ecfa2a56a5f5b9b6afeae8d373cef2bdad1fddae6030521231fe4605e47db964a4cb771f61c3c6a40b9d4b3b92451f62567
-  data.tar.gz: eefe71988e38d5fbcd6aa78fcf5cf9d5b3c05dcdecabe415e73c73ce71c5339a27cf1c67638d80cdd4457817264fa082a0658c1ca33fa1ad722c484058473b2a
+  metadata.gz: 00fbc482e506e72028c476115e64f700867a012c8815c243e14ffe9c74197eb93507cb51972f315f279bba7d8630e32a16718c81ad86ecbe4b124a942e7c7631
+  data.tar.gz: 8cb7ace54e4a5b6a45bdb53a7520977cf0597d39701d97dead9d8edf7e980bffe15ade49fdcfa41811a356853c5eeb06f1ea433cb92d9bf318c663aff88d8579

data/lib/candidhealth/pre_encounter/appointments/v_1/types/appointment.rb

@@ -17,18 +17,17 @@ module CandidApiClient
           class Appointment
             # @return [String]
             attr_reader :id
-            # @return [String] The organization that owns this appointment.
+            # @return [String] The organization that owns this object.
             attr_reader :organization_id
-            # @return [Boolean] True if the appointment is deactivated. Deactivated appointments are not
-            #  returned in search results but are returned in all other endpoints including
-            #  scan.
+            # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
+            #  search results but are returned in all other endpoints including scan.
             attr_reader :deactivated
-            # @return [Integer] The version of the appointment. Any update to any property of an appointment
-            #  object will create a new version.
+            # @return [Integer] The version of the object. Any update to any property of an object object will
+            #  create a new version.
             attr_reader :version
             # @return [DateTime]
             attr_reader :updated_at
-            # @return [String] The user ID of the user who last updated the appointment.
+            # @return [String] The user ID of the user who last updated the object.
             attr_reader :updating_user_id
             # @return [String] The Candid-defined patient identifier.
             attr_reader :patient_id
@@ -82,14 +81,13 @@ module CandidApiClient
             OMIT = Object.new
 
             # @param id [String]
-            # @param organization_id [String] The organization that owns this appointment.
-            # @param deactivated [Boolean] True if the appointment is deactivated. Deactivated appointments are not
-            #  returned in search results but are returned in all other endpoints including
-            #  scan.
-            # @param version [Integer] The version of the appointment. Any update to any property of an appointment
-            #  object will create a new version.
+            # @param organization_id [String] The organization that owns this object.
+            # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
+            #  search results but are returned in all other endpoints including scan.
+            # @param version [Integer] The version of the object. Any update to any property of an object object will
+            #  create a new version.
             # @param updated_at [DateTime]
-            # @param updating_user_id [String] The user ID of the user who last updated the appointment.
+            # @param updating_user_id [String] The user ID of the user who last updated the object.
             # @param patient_id [String] The Candid-defined patient identifier.
             # @param start_timestamp [DateTime]
             # @param status [CandidApiClient::PreEncounter::Appointments::V1::Types::AppointmentStatus] Defaults to PENDING. If status is NOT_READY, work_queue must be set. If status

data/lib/candidhealth/pre_encounter/client.rb

@@ -1,29 +1,29 @@
 # frozen_string_literal: true
 
 require_relative "../../requests"
-require_relative "patients/client"
+require_relative "tags/client"
 
 module CandidApiClient
   module PreEncounter
     class Client
-      # @return [CandidApiClient::PreEncounter::Patients::Client]
+      # @return [CandidApiClient::PreEncounter::Tags::Client]
       attr_reader :pre_encounter
 
       # @param request_client [CandidApiClient::RequestClient]
       # @return [CandidApiClient::PreEncounter::Client]
       def initialize(request_client:)
-        @pre_encounter = CandidApiClient::PreEncounter::Patients::Client.new(request_client: request_client)
+        @pre_encounter = CandidApiClient::PreEncounter::Tags::Client.new(request_client: request_client)
       end
     end
 
     class AsyncClient
-      # @return [CandidApiClient::PreEncounter::Patients::AsyncClient]
+      # @return [CandidApiClient::PreEncounter::Tags::AsyncClient]
       attr_reader :pre_encounter
 
       # @param request_client [CandidApiClient::AsyncRequestClient]
       # @return [CandidApiClient::PreEncounter::AsyncClient]
       def initialize(request_client:)
-        @pre_encounter = CandidApiClient::PreEncounter::Patients::AsyncClient.new(request_client: request_client)
+        @pre_encounter = CandidApiClient::PreEncounter::Tags::AsyncClient.new(request_client: request_client)
       end
     end
   end

data/lib/candidhealth/pre_encounter/common/types/base_model.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module PreEncounter
+    module Common
+      module Types
+        class BaseModel
+          # @return [String] The organization that owns this object.
+          attr_reader :organization_id
+          # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
+          #  search results but are returned in all other endpoints including scan.
+          attr_reader :deactivated
+          # @return [Integer] The version of the object. Any update to any property of an object object will
+          #  create a new version.
+          attr_reader :version
+          # @return [DateTime]
+          attr_reader :updated_at
+          # @return [String] The user ID of the user who last updated the object.
+          attr_reader :updating_user_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 organization_id [String] The organization that owns this object.
+          # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
+          #  search results but are returned in all other endpoints including scan.
+          # @param version [Integer] The version of the object. Any update to any property of an object object will
+          #  create a new version.
+          # @param updated_at [DateTime]
+          # @param updating_user_id [String] The user ID of the user who last updated the object.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::PreEncounter::Common::Types::BaseModel]
+          def initialize(organization_id:, deactivated:, version:, updated_at:, updating_user_id:,
+                         additional_properties: nil)
+            @organization_id = organization_id
+            @deactivated = deactivated
+            @version = version
+            @updated_at = updated_at
+            @updating_user_id = updating_user_id
+            @additional_properties = additional_properties
+            @_field_set = {
+              "organization_id": organization_id,
+              "deactivated": deactivated,
+              "version": version,
+              "updated_at": updated_at,
+              "updating_user_id": updating_user_id
+            }
+          end
+
+          # Deserialize a JSON object to an instance of BaseModel
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::PreEncounter::Common::Types::BaseModel]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            organization_id = struct["organization_id"]
+            deactivated = struct["deactivated"]
+            version = struct["version"]
+            updated_at = (DateTime.parse(parsed_json["updated_at"]) unless parsed_json["updated_at"].nil?)
+            updating_user_id = struct["updating_user_id"]
+            new(
+              organization_id: organization_id,
+              deactivated: deactivated,
+              version: version,
+              updated_at: updated_at,
+              updating_user_id: updating_user_id,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of BaseModel 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.organization_id.is_a?(String) != false || raise("Passed value for field obj.organization_id is not the expected type, validation failed.")
+            obj.deactivated.is_a?(Boolean) != false || raise("Passed value for field obj.deactivated is not the expected type, validation failed.")
+            obj.version.is_a?(Integer) != false || raise("Passed value for field obj.version is not the expected type, validation failed.")
+            obj.updated_at.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
+            obj.updating_user_id.is_a?(String) != false || raise("Passed value for field obj.updating_user_id is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage.rb

@@ -20,17 +20,17 @@ module CandidApiClient
           class Coverage
             # @return [String]
             attr_reader :id
-            # @return [String] The organization that owns this coverage.
+            # @return [String] The organization that owns this object.
             attr_reader :organization_id
-            # @return [Boolean] True if the coverage is deactivated. Deactivated coverages are not returned in
+            # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
             attr_reader :deactivated
-            # @return [Integer] The version of the coverage. Any update to any property of a coverage object
-            #  will create a new version.
+            # @return [Integer] The version of the object. Any update to any property of an object object will
+            #  create a new version.
             attr_reader :version
             # @return [DateTime]
             attr_reader :updated_at
-            # @return [String] The user ID of the user who last updated the coverage.
+            # @return [String] The user ID of the user who last updated the object.
             attr_reader :updating_user_id
             # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::CoverageStatus] The status indiciating if the coverage is active or not.
             attr_reader :status
@@ -62,13 +62,13 @@ module CandidApiClient
             OMIT = Object.new
 
             # @param id [String]
-            # @param organization_id [String] The organization that owns this coverage.
-            # @param deactivated [Boolean] True if the coverage is deactivated. Deactivated coverages are not returned in
+            # @param organization_id [String] The organization that owns this object.
+            # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
-            # @param version [Integer] The version of the coverage. Any update to any property of a coverage object
-            #  will create a new version.
+            # @param version [Integer] The version of the object. Any update to any property of an object object will
+            #  create a new version.
             # @param updated_at [DateTime]
-            # @param updating_user_id [String] The user ID of the user who last updated the coverage.
+            # @param updating_user_id [String] The user ID of the user who last updated the object.
             # @param status [CandidApiClient::PreEncounter::Coverages::V1::Types::CoverageStatus] The status indiciating if the coverage is active or not.
             # @param subscriber [CandidApiClient::PreEncounter::Coverages::V1::Types::Subscriber] The party who has signed-up for or 'owns' the contractual relationship to the
             #  policy or to whom the benefit of the policy for services rendered to them or

data/lib/candidhealth/pre_encounter/notes/client.rb

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

data/lib/candidhealth/pre_encounter/notes/v_1/client.rb

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+require_relative "../../../../requests"
+require_relative "types/note"
+require_relative "types/mutable_note"
+require "async"
+
+module CandidApiClient
+  module PreEncounter
+    module Notes
+      module V1
+        class V1Client
+          # @return [CandidApiClient::RequestClient]
+          attr_reader :request_client
+
+          # @param request_client [CandidApiClient::RequestClient]
+          # @return [CandidApiClient::PreEncounter::Notes::V1::V1Client]
+          def initialize(request_client:)
+            @request_client = request_client
+          end
+
+          # Gets a note by NoteId.
+          #
+          # @param id [String]
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [CandidApiClient::PreEncounter::Notes::V1::Types::Note]
+          # @example
+          #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+          #  api.pre_encounter.notes.v_1.get(id: "string")
+          def get(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: PreEncounter,
+                                                 request_options: request_options)}/notes/v1/#{id}"
+            end
+            CandidApiClient::PreEncounter::Notes::V1::Types::Note.from_json(json_object: response.body)
+          end
+
+          # Adds a new note.
+          #
+          # @param request [Hash] Request of type CandidApiClient::PreEncounter::Notes::V1::Types::MutableNote, as a Hash
+          #   * :value (String)
+          #   * :author_email (String)
+          #   * :author_name (String)
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [CandidApiClient::PreEncounter::Notes::V1::Types::Note]
+          # @example
+          #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+          #  api.pre_encounter.notes.v_1.create(request: { value: "string", author_email: "string", author_name: "string" })
+          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: PreEncounter, request_options: request_options)}/notes/v1"
+            end
+            CandidApiClient::PreEncounter::Notes::V1::Types::Note.from_json(json_object: response.body)
+          end
+
+          # Updates a note. The path must contain the most recent version to prevent races.
+          #
+          # @param id [String]
+          # @param version [String]
+          # @param request [Hash] Request of type CandidApiClient::PreEncounter::Notes::V1::Types::MutableNote, as a Hash
+          #   * :value (String)
+          #   * :author_email (String)
+          #   * :author_name (String)
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [CandidApiClient::PreEncounter::Notes::V1::Types::Note]
+          # @example
+          #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+          #  api.pre_encounter.notes.v_1.update(
+          #    id: "string",
+          #    version: "string",
+          #    request: { value: "string", author_email: "string", author_name: "string" }
+          #  )
+          def update(id:, version:, request:, request_options: nil)
+            response = @request_client.conn.put 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: PreEncounter,
+                                                 request_options: request_options)}/notes/v1/#{id}/#{version}"
+            end
+            CandidApiClient::PreEncounter::Notes::V1::Types::Note.from_json(json_object: response.body)
+          end
+
+          # Sets a note as deactivated. The path must contain the most recent version to
+          #  prevent races.
+          #
+          # @param id [String]
+          # @param version [String]
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [Void]
+          # @example
+          #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+          #  api.pre_encounter.notes.v_1.deactivate(id: "string", version: "string")
+          def deactivate(id:, version:, 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: PreEncounter,
+                                                 request_options: request_options)}/notes/v1/#{id}/#{version}"
+            end
+          end
+        end
+
+        class AsyncV1Client
+          # @return [CandidApiClient::AsyncRequestClient]
+          attr_reader :request_client
+
+          # @param request_client [CandidApiClient::AsyncRequestClient]
+          # @return [CandidApiClient::PreEncounter::Notes::V1::AsyncV1Client]
+          def initialize(request_client:)
+            @request_client = request_client
+          end
+
+          # Gets a note by NoteId.
+          #
+          # @param id [String]
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [CandidApiClient::PreEncounter::Notes::V1::Types::Note]
+          # @example
+          #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+          #  api.pre_encounter.notes.v_1.get(id: "string")
+          def get(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: PreEncounter,
+                                                   request_options: request_options)}/notes/v1/#{id}"
+              end
+              CandidApiClient::PreEncounter::Notes::V1::Types::Note.from_json(json_object: response.body)
+            end
+          end
+
+          # Adds a new note.
+          #
+          # @param request [Hash] Request of type CandidApiClient::PreEncounter::Notes::V1::Types::MutableNote, as a Hash
+          #   * :value (String)
+          #   * :author_email (String)
+          #   * :author_name (String)
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [CandidApiClient::PreEncounter::Notes::V1::Types::Note]
+          # @example
+          #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+          #  api.pre_encounter.notes.v_1.create(request: { value: "string", author_email: "string", author_name: "string" })
+          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: PreEncounter,
+                                                   request_options: request_options)}/notes/v1"
+              end
+              CandidApiClient::PreEncounter::Notes::V1::Types::Note.from_json(json_object: response.body)
+            end
+          end
+
+          # Updates a note. The path must contain the most recent version to prevent races.
+          #
+          # @param id [String]
+          # @param version [String]
+          # @param request [Hash] Request of type CandidApiClient::PreEncounter::Notes::V1::Types::MutableNote, as a Hash
+          #   * :value (String)
+          #   * :author_email (String)
+          #   * :author_name (String)
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [CandidApiClient::PreEncounter::Notes::V1::Types::Note]
+          # @example
+          #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+          #  api.pre_encounter.notes.v_1.update(
+          #    id: "string",
+          #    version: "string",
+          #    request: { value: "string", author_email: "string", author_name: "string" }
+          #  )
+          def update(id:, version:, request:, request_options: nil)
+            Async do
+              response = @request_client.conn.put 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: PreEncounter,
+                                                   request_options: request_options)}/notes/v1/#{id}/#{version}"
+              end
+              CandidApiClient::PreEncounter::Notes::V1::Types::Note.from_json(json_object: response.body)
+            end
+          end
+
+          # Sets a note as deactivated. The path must contain the most recent version to
+          #  prevent races.
+          #
+          # @param id [String]
+          # @param version [String]
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [Void]
+          # @example
+          #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+          #  api.pre_encounter.notes.v_1.deactivate(id: "string", version: "string")
+          def deactivate(id:, version:, 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: PreEncounter,
+                                                   request_options: request_options)}/notes/v1/#{id}/#{version}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/pre_encounter/notes/v_1/types/mutable_note.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module PreEncounter
+    module Notes
+      module V1
+        module Types
+          # An object representing a Note.
+          class MutableNote
+            # @return [String]
+            attr_reader :value
+            # @return [String]
+            attr_reader :author_email
+            # @return [String]
+            attr_reader :author_name
+            # @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 value [String]
+            # @param author_email [String]
+            # @param author_name [String]
+            # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+            # @return [CandidApiClient::PreEncounter::Notes::V1::Types::MutableNote]
+            def initialize(value:, author_email: OMIT, author_name: OMIT, additional_properties: nil)
+              @value = value
+              @author_email = author_email if author_email != OMIT
+              @author_name = author_name if author_name != OMIT
+              @additional_properties = additional_properties
+              @_field_set = {
+                "value": value,
+                "author_email": author_email,
+                "author_name": author_name
+              }.reject do |_k, v|
+                v == OMIT
+              end
+            end
+
+            # Deserialize a JSON object to an instance of MutableNote
+            #
+            # @param json_object [String]
+            # @return [CandidApiClient::PreEncounter::Notes::V1::Types::MutableNote]
+            def self.from_json(json_object:)
+              struct = JSON.parse(json_object, object_class: OpenStruct)
+              value = struct["value"]
+              author_email = struct["author_email"]
+              author_name = struct["author_name"]
+              new(
+                value: value,
+                author_email: author_email,
+                author_name: author_name,
+                additional_properties: struct
+              )
+            end
+
+            # Serialize an instance of MutableNote 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.value.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+              obj.author_email&.is_a?(String) != false || raise("Passed value for field obj.author_email is not the expected type, validation failed.")
+              obj.author_name&.is_a?(String) != false || raise("Passed value for field obj.author_name is not the expected type, validation failed.")
+            end
+          end
+        end
+      end
+    end
+  end
+end