candidhealth 0.43.1 → 0.46.0

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

@@ -20,7 +20,7 @@ module CandidApiClient
             @request_client = request_client
           end
 
-          # Adds an image. VersionConflictError is returned if a front or back of this
+          # Adds an image.  VersionConflictError is returned if a front or back of this
           #  coverage already exists.
           #
           # @param request [Hash] Request of type CandidApiClient::PreEncounter::Images::V1::Types::MutableImage, as a Hash
@@ -38,7 +38,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Images::V1::Types::Image]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.images.v_1.create(request: { file_name: "string", display_name: "string", file_type: "string", status: PENDING, coverage: { id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", side: FRONT }, patient: { id: "string", notes: "string" } })
+          #  api.pre_encounter.images.v_1.create(request: { file_name: "file_name", display_name: "display_name", file_type: "file_type", status: PENDING })
           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?
@@ -62,7 +62,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Images::V1::Types::Image]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.images.v_1.get(id: "string")
+          #  api.pre_encounter.images.v_1.get(id: "id")
           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?
@@ -78,7 +78,7 @@ module CandidApiClient
             CandidApiClient::PreEncounter::Images::V1::Types::Image.from_json(json_object: response.body)
           end
 
-          # Updates an Image. The path must contain the most recent version to prevent
+          # Updates an Image.  The path must contain the most recent version to prevent
           #  races.
           #
           # @param id [String]
@@ -99,9 +99,9 @@ module CandidApiClient
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
           #  api.pre_encounter.images.v_1.update(
-          #    id: "string",
-          #    version: "string",
-          #    request: { file_name: "string", display_name: "string", file_type: "string", status: PENDING, coverage: { id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", side: FRONT }, patient: { id: "string", notes: "string" } }
+          #    id: "id",
+          #    version: "version",
+          #    request: { file_name: "file_name", display_name: "display_name", file_type: "file_type", status: PENDING }
           #  )
           def update(id:, version:, request:, request_options: nil)
             response = @request_client.conn.put do |req|
@@ -119,7 +119,7 @@ module CandidApiClient
             CandidApiClient::PreEncounter::Images::V1::Types::Image.from_json(json_object: response.body)
           end
 
-          # Sets an Image as deactivated. The path must contain the most recent version to
+          # Sets an Image as deactivated.  The path must contain the most recent version to
           #  prevent races.
           #
           # @param id [String]
@@ -128,7 +128,7 @@ module CandidApiClient
           # @return [Void]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.images.v_1.deactivate(id: "string", version: "string")
+          #  api.pre_encounter.images.v_1.deactivate(id: "id", version: "version")
           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?
@@ -151,7 +151,7 @@ module CandidApiClient
           # @return [Array<CandidApiClient::PreEncounter::Images::V1::Types::Image>]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.images.v_1.get_multi(patient_id: "string", coverage_id: "string")
+          #  api.pre_encounter.images.v_1.get_multi
           def get_multi(patient_id: nil, coverage_id: 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?
@@ -187,7 +187,7 @@ module CandidApiClient
             @request_client = request_client
           end
 
-          # Adds an image. VersionConflictError is returned if a front or back of this
+          # Adds an image.  VersionConflictError is returned if a front or back of this
           #  coverage already exists.
           #
           # @param request [Hash] Request of type CandidApiClient::PreEncounter::Images::V1::Types::MutableImage, as a Hash
@@ -205,7 +205,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Images::V1::Types::Image]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.images.v_1.create(request: { file_name: "string", display_name: "string", file_type: "string", status: PENDING, coverage: { id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", side: FRONT }, patient: { id: "string", notes: "string" } })
+          #  api.pre_encounter.images.v_1.create(request: { file_name: "file_name", display_name: "display_name", file_type: "file_type", status: PENDING })
           def create(request:, request_options: nil)
             Async do
               response = @request_client.conn.post do |req|
@@ -231,7 +231,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Images::V1::Types::Image]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.images.v_1.get(id: "string")
+          #  api.pre_encounter.images.v_1.get(id: "id")
           def get(id:, request_options: nil)
             Async do
               response = @request_client.conn.get do |req|
@@ -249,7 +249,7 @@ module CandidApiClient
             end
           end
 
-          # Updates an Image. The path must contain the most recent version to prevent
+          # Updates an Image.  The path must contain the most recent version to prevent
           #  races.
           #
           # @param id [String]
@@ -270,9 +270,9 @@ module CandidApiClient
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
           #  api.pre_encounter.images.v_1.update(
-          #    id: "string",
-          #    version: "string",
-          #    request: { file_name: "string", display_name: "string", file_type: "string", status: PENDING, coverage: { id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", side: FRONT }, patient: { id: "string", notes: "string" } }
+          #    id: "id",
+          #    version: "version",
+          #    request: { file_name: "file_name", display_name: "display_name", file_type: "file_type", status: PENDING }
           #  )
           def update(id:, version:, request:, request_options: nil)
             Async do
@@ -292,7 +292,7 @@ module CandidApiClient
             end
           end
 
-          # Sets an Image as deactivated. The path must contain the most recent version to
+          # Sets an Image as deactivated.  The path must contain the most recent version to
           #  prevent races.
           #
           # @param id [String]
@@ -301,7 +301,7 @@ module CandidApiClient
           # @return [Void]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.images.v_1.deactivate(id: "string", version: "string")
+          #  api.pre_encounter.images.v_1.deactivate(id: "id", version: "version")
           def deactivate(id:, version:, request_options: nil)
             Async do
               @request_client.conn.delete do |req|
@@ -326,7 +326,7 @@ module CandidApiClient
           # @return [Array<CandidApiClient::PreEncounter::Images::V1::Types::Image>]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.images.v_1.get_multi(patient_id: "string", coverage_id: "string")
+          #  api.pre_encounter.images.v_1.get_multi
           def get_multi(patient_id: nil, coverage_id: nil, request_options: nil)
             Async do
               response = @request_client.conn.get do |req|

data/lib/candidhealth/pre_encounter/images/v_1/types/image.rb

@@ -16,15 +16,15 @@ module CandidApiClient
           class Image
             # @return [String]
             attr_reader :id
-            # @return [String] A signed URL to the image. This url can be used to upload an image to GCP
+            # @return [String] A signed URL to the image.  This url can be used to upload an image to GCP
             #  storage or to read the image contents.
             attr_reader :signed_url
             # @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
+            # @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
+            # @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]
@@ -52,12 +52,12 @@ module CandidApiClient
             OMIT = Object.new
 
             # @param id [String]
-            # @param signed_url [String] A signed URL to the image. This url can be used to upload an image to GCP
+            # @param signed_url [String] A signed URL to the image.  This url can be used to upload an image to GCP
             #  storage or to read the image contents.
             # @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
+            # @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
+            # @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.

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

@@ -32,13 +32,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Lists::V1::Types::PatientListPage]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.lists.v_1.get_patient_list(
-          #    page_token: "string",
-          #    limit: 1,
-          #    sort_field: "string",
-          #    sort_direction: ASC,
-          #    filters: "string"
-          #  )
+          #  api.pre_encounter.lists.v_1.get_patient_list
           def get_patient_list(page_token: nil, limit: nil, sort_field: nil, sort_direction: nil, filters: nil,
                                request_options: nil)
             response = @request_client.conn.get do |req|
@@ -74,13 +68,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Lists::V1::Types::AppointmentListPage]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.lists.v_1.get_appointment_list(
-          #    sort_field: "string",
-          #    sort_direction: ASC,
-          #    limit: 1,
-          #    page_token: "string",
-          #    filters: "string"
-          #  )
+          #  api.pre_encounter.lists.v_1.get_appointment_list
           def get_appointment_list(sort_field: nil, sort_direction: nil, limit: nil, page_token: nil, filters: nil,
                                    request_options: nil)
             response = @request_client.conn.get do |req|
@@ -128,13 +116,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Lists::V1::Types::PatientListPage]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.lists.v_1.get_patient_list(
-          #    page_token: "string",
-          #    limit: 1,
-          #    sort_field: "string",
-          #    sort_direction: ASC,
-          #    filters: "string"
-          #  )
+          #  api.pre_encounter.lists.v_1.get_patient_list
           def get_patient_list(page_token: nil, limit: nil, sort_field: nil, sort_direction: nil, filters: nil,
                                request_options: nil)
             Async do
@@ -172,13 +154,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Lists::V1::Types::AppointmentListPage]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.lists.v_1.get_appointment_list(
-          #    sort_field: "string",
-          #    sort_direction: ASC,
-          #    limit: 1,
-          #    page_token: "string",
-          #    filters: "string"
-          #  )
+          #  api.pre_encounter.lists.v_1.get_appointment_list
           def get_appointment_list(sort_field: nil, sort_direction: nil, limit: nil, page_token: nil, filters: nil,
                                    request_options: nil)
             Async do

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

@@ -26,7 +26,7 @@ module CandidApiClient
           # @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")
+          #  api.pre_encounter.notes.v_1.get(id: "id")
           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?
@@ -52,7 +52,7 @@ module CandidApiClient
           # @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" })
+          #  api.pre_encounter.notes.v_1.create(request: { value: "value" })
           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?
@@ -81,9 +81,9 @@ module CandidApiClient
           # @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" }
+          #    id: "id",
+          #    version: "version",
+          #    request: { value: "value" }
           #  )
           def update(id:, version:, request:, request_options: nil)
             response = @request_client.conn.put do |req|
@@ -101,7 +101,7 @@ module CandidApiClient
             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
+          # Sets a note as deactivated.  The path must contain the most recent version to
           #  prevent races.
           #
           # @param id [String]
@@ -110,7 +110,7 @@ module CandidApiClient
           # @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")
+          #  api.pre_encounter.notes.v_1.deactivate(id: "id", version: "version")
           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?
@@ -143,7 +143,7 @@ module CandidApiClient
           # @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")
+          #  api.pre_encounter.notes.v_1.get(id: "id")
           def get(id:, request_options: nil)
             Async do
               response = @request_client.conn.get do |req|
@@ -171,7 +171,7 @@ module CandidApiClient
           # @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" })
+          #  api.pre_encounter.notes.v_1.create(request: { value: "value" })
           def create(request:, request_options: nil)
             Async do
               response = @request_client.conn.post do |req|
@@ -203,9 +203,9 @@ module CandidApiClient
           # @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" }
+          #    id: "id",
+          #    version: "version",
+          #    request: { value: "value" }
           #  )
           def update(id:, version:, request:, request_options: nil)
             Async do
@@ -225,7 +225,7 @@ module CandidApiClient
             end
           end
 
-          # Sets a note as deactivated. The path must contain the most recent version to
+          # Sets a note as deactivated.  The path must contain the most recent version to
           #  prevent races.
           #
           # @param id [String]
@@ -234,7 +234,7 @@ module CandidApiClient
           # @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")
+          #  api.pre_encounter.notes.v_1.deactivate(id: "id", version: "version")
           def deactivate(id:, version:, request_options: nil)
             Async do
               @request_client.conn.delete do |req|

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

@@ -17,10 +17,10 @@ module CandidApiClient
             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
+            # @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
+            # @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]
@@ -44,9 +44,9 @@ module CandidApiClient
             # @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
+            # @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
+            # @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.