oro-sdk 2.10.1 → 2.12.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 ORO Health Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/helpers/patient-registration.d.ts

@@ -1,5 +1,25 @@
 import { ConsultRequest, MetadataCategory, Uuid, WorkflowData } from 'oro-sdk-apis';
 import { OroClient, RegisterPatientOutput } from '..';
+/**
+ * Completes a registration for a user retrying the complete flow a maximum of 15 times
+ *
+ * @description The order of importance when registering:
+ * Creates a consultation if none exist
+ * Retrieves or create's a lockbox if none exist
+ * Grants the lockbox (if new) to all practitioners in the practice
+ * Stores or fetches the patient data (without images)
+ * Indexes the lockbox to the consult for all practitioners (done after inserting since index can be rebuilt from grants)
+ * Stores the image data - done last since the majority of failure cases occur here
+ * Creates the recovery payloads if they don't exist
+ *
+ * @param patientUuid
+ * @param consultRequest
+ * @param workflow
+ * @param oroClient
+ * @param masterKey
+ * @param recoveryQA
+ * @returns the successful registration
+ */
 export declare function registerPatient(patientUuid: Uuid, consultRequest: ConsultRequest, workflow: WorkflowData, oroClient: OroClient, masterKey?: Uuid, recoveryQA?: {
     recoverySecurityQuestions: string[];
     recoverySecurityAnswers: string[];