candidhealth 0.35.1 → 0.35.3

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

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

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module PreEncounter
+    module Notes
+      module V1
+        module Types
+          # A Note object with immutable server-owned properties.
+          class Note
+            # @return [String]
+            attr_reader :id
+            # @return [DateTime]
+            attr_reader :created_at
+            # @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 [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 id [String]
+            # @param created_at [DateTime]
+            # @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 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::Note]
+            def initialize(id:, created_at:, organization_id:, deactivated:, version:, updated_at:, updating_user_id:,
+                           value:, author_email: OMIT, author_name: OMIT, additional_properties: nil)
+              @id = id
+              @created_at = created_at
+              @organization_id = organization_id
+              @deactivated = deactivated
+              @version = version
+              @updated_at = updated_at
+              @updating_user_id = updating_user_id
+              @value = value
+              @author_email = author_email if author_email != OMIT
+              @author_name = author_name if author_name != OMIT
+              @additional_properties = additional_properties
+              @_field_set = {
+                "id": id,
+                "created_at": created_at,
+                "organization_id": organization_id,
+                "deactivated": deactivated,
+                "version": version,
+                "updated_at": updated_at,
+                "updating_user_id": updating_user_id,
+                "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 Note
+            #
+            # @param json_object [String]
+            # @return [CandidApiClient::PreEncounter::Notes::V1::Types::Note]
+            def self.from_json(json_object:)
+              struct = JSON.parse(json_object, object_class: OpenStruct)
+              parsed_json = JSON.parse(json_object)
+              id = struct["id"]
+              created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
+              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"]
+              value = struct["value"]
+              author_email = struct["author_email"]
+              author_name = struct["author_name"]
+              new(
+                id: id,
+                created_at: created_at,
+                organization_id: organization_id,
+                deactivated: deactivated,
+                version: version,
+                updated_at: updated_at,
+                updating_user_id: updating_user_id,
+                value: value,
+                author_email: author_email,
+                author_name: author_name,
+                additional_properties: struct
+              )
+            end
+
+            # Serialize an instance of Note 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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+              obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+              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.")
+              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