oro-sdk-apis 1.52.0 → 1.54.0

package/dist/services/practice.d.ts

@@ -1,5 +1,5 @@
-import { ConsultRequestMetadata, PracticeAccount, Uuid } from '../models';
-import { Assignment, AssignmentRequest, PlanType, Practice, PracticeConfigKind, PracticeConfigs, PracticeInvoice, PracticePayment, PracticePaymentIntent, PracticePlan, PracticePlanPrices, PracticeWorkflow, PracticeWorkflowWithTagSpecialty, Practitioner, PractitionerLicense, PractitionerPreference, PractitionerQuota, PractitionerRole, WorkflowType } from '../models/practice';
+import { PracticeAccount, Uuid } from '../models';
+import { Assignment, AssignmentRequest, PaymentIntentRequestMetadata, PlanType, Practice, PracticeConfigKind, PracticeConfigs, PracticeInvoice, PracticePayment, PracticePaymentIntent, PracticePlan, PracticePlanPrices, PracticeWorkflow, PracticeWorkflowWithTagSpecialty, Practitioner, PractitionerLicense, PractitionerPreference, PractitionerQuota, PractitionerRole, WorkflowType } from '../models/practice';
 import { APIService } from './api';
 export declare class PracticeService {
     private api;
@@ -76,10 +76,10 @@ export declare class PracticeService {
      * @param isoLocality (optional) the desired locality
      * @param url_subdomain  (optional) the url of the sub domain (@bruno-morel need you to document that)
      * @param promotionCode (optional) promotion code to apply
-     * @param consultRequest (optional) consult request to use. If defined, when payment service call our hooks in practice, it will try to create a consult with these infos.
+     * @param requestMetadata (optional) the request metadata to use. If defined, when payment service call our hooks in practice, it will use it to do required action (create a consult, refill a consult, etc.).
      * @returns
      */
-    practiceCreatePaymentsIntent(practiceUuid: Uuid, planId: number, userEmail: string, isoLocality?: string, url_subdomain?: string, consultRequest?: ConsultRequestMetadata): Promise<PracticePaymentIntent>;
+    practiceCreatePaymentsIntent(practiceUuid: Uuid, planId: number, userEmail: string, isoLocality?: string, url_subdomain?: string, requestMetadata?: PaymentIntentRequestMetadata): Promise<PracticePaymentIntent>;
     practiceGetPaymentsIntent(practiceUuid: Uuid, paymentIntentId: number): Promise<PracticePaymentIntent>;
     /**
      * Updates a PracticePaymentIntent

package/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "1.52.0",
+    "version": "1.54.0",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "files": [

package/src/models/practice.ts

@@ -148,6 +148,8 @@ export enum PracticeConfigKind {
     PractitionerConsultList = 'PractitionerConsultList',
     PractitionerSearch = 'PractitionerSearch',
     PracticeRegisterWalkthrough = 'PracticeRegisterWalkthrough',
+    PracticeExamsAndResults = 'PracticeExamsAndResults',
+    PracticeLayout = 'PracticeLayout',
 }
 
 /**
@@ -375,6 +377,32 @@ export type PracticeConfigPracticeRegisterWalkthrough = PracticeConfig<
     }
 >
 
+/**
+ * This config is used for all configs related to the Exams and Results module
+ */
+export type PracticeConfigPracticeExamsAndResults = PracticeConfig<
+    PracticeConfigKind.PracticeExamsAndResults,
+    {
+        /**
+         * If true, then show the deprecated URL prescription pad
+         */
+        showUrlPrescriptionPad?: boolean
+    }
+>
+
+/**
+ * This config is used for all configs related to the Layout of the app (Navbar, Footer, etc)
+ */
+export type PracticeConfigPracticeLayout = PracticeConfig<
+    PracticeConfigKind.PracticeLayout,
+    {
+        /**
+         * If true, then show the FAQ link in the Navbar
+         */
+        showFaqLink?: boolean
+    }
+>
+
 export type PracticeConfigs =
     | PracticeConfigPractitionerSearch
     | PracticeConfigPractitionerConsultList
@@ -388,6 +416,8 @@ export type PracticeConfigs =
     | PracticeConfigPracticeConfigExample // Here for integration tests only
     | PracticeConfigPracticeConsultTabs
     | PracticeConfigPatientConsultCard
+    | PracticeConfigPracticeExamsAndResults
+    | PracticeConfigPracticeLayout
 
 export interface PracticeWorkflow {
     id?: number ///optional for insertion
@@ -504,11 +534,51 @@ export interface PracticePaymentIntent {
  * It will be used to create the consult when stripe use our hook.
  */
 export interface ConsultRequestMetadata {
+    /**
+     * Defines the kind of `PaymentIntentRequestMetadata` it is
+     *
+     * Note: it can be `undefined` to handle backward compatibility when this interface didn't had a `kind`
+     */
+    kind: 'ConsultRequestMetadata' | undefined
+    /**
+     * The specialty required by the consultation
+     */
     tagSpecialtyRequired: string
+    /**
+     * The locality required for the consultation in iso. COUNTRY (ISO 3166) - PROVINCE - COUNTY - CITY
+     */
     isoLocalityRequired?: string
+    /**
+     * The language required for the consultation. Should respect ISO 639-3 https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes
+     */
     isoLanguageRequired: string
 }
 
+/**
+ * This interface is used as metadata when creating Stripe Invoice.
+ * It will be used to refill a treatment plan of a consult.
+ */
+export interface RefillTreatmentRequestMetadata {
+    /**
+     * Defines the kind of `PaymentIntentRequestMetadata` it is
+     */
+    kind: 'RefillTreatmentRequestMetadata'
+    /**
+     * The consult uuid to refill
+     */
+    consultUuid: string
+    /**
+     * The treatment plan uuid to refill
+     */
+    uuidTreatmentPlan: string
+}
+
+/**
+ * This interface is used as metadata when creating Stripe Invoice.
+ * It will be used when stripe uses our hook.
+ */
+export type PaymentIntentRequestMetadata = ConsultRequestMetadata | RefillTreatmentRequestMetadata
+
 export interface AssignmentRequest {
     uuidAssignor: string //defaulting for insertion to the default practice admin
     uuidPractitioner?: string
@@ -603,6 +673,8 @@ export interface HydratedPracticeConfigs {
     [PracticeConfigKind.PractitionerConsultList]?: PracticeConfigPractitionerConsultList
     [PracticeConfigKind.PractitionerSearch]?: PracticeConfigPractitionerSearch
     [PracticeConfigKind.PracticeRegisterWalkthrough]?: PracticeConfigPracticeRegisterWalkthrough
+    [PracticeConfigKind.PracticeExamsAndResults]?: PracticeConfigPracticeExamsAndResults
+    [PracticeConfigKind.PracticeLayout]?: PracticeConfigPracticeLayout
 }
 
 export interface Practice {

package/src/services/practice.ts

@@ -1,8 +1,9 @@
 import { hashToBase64String } from '../helpers'
-import { ConsultRequestMetadata, PracticeAccount, Uuid } from '../models'
+import { PracticeAccount, Uuid } from '../models'
 import {
     Assignment,
     AssignmentRequest,
+    PaymentIntentRequestMetadata,
     PlanType,
     Practice,
     PracticeConfigKind,
@@ -122,7 +123,7 @@ export class PracticeService {
             params: { kind },
         })
     }
-    
+
     public practiceGetWorkflow(
         practiceUuid: Uuid,
         workflowType: WorkflowType
@@ -193,7 +194,7 @@ export class PracticeService {
      * @param isoLocality (optional) the desired locality
      * @param url_subdomain  (optional) the url of the sub domain (@bruno-morel need you to document that)
      * @param promotionCode (optional) promotion code to apply
-     * @param consultRequest (optional) consult request to use. If defined, when payment service call our hooks in practice, it will try to create a consult with these infos.
+     * @param requestMetadata (optional) the request metadata to use. If defined, when payment service call our hooks in practice, it will use it to do required action (create a consult, refill a consult, etc.).
      * @returns
      */
     public practiceCreatePaymentsIntent(
@@ -202,7 +203,7 @@ export class PracticeService {
         userEmail: string,
         isoLocality?: string,
         url_subdomain?: string,
-        consultRequest?: ConsultRequestMetadata
+        requestMetadata?: PaymentIntentRequestMetadata
     ): Promise<PracticePaymentIntent> {
         return this.api.post<PracticePaymentIntent>(
             `${this.baseURL}/v1/practices/${practiceUuid}/payments/intents/`,
@@ -210,7 +211,7 @@ export class PracticeService {
                 idPlan: planId,
                 hashUserEmail: userEmail ? this.getPaymentIntentHashedEmail(userEmail) : undefined,
                 isoLocality,
-                consultRequest,
+                requestMetadata,
             },
             { params: { url_subdomain } }
         )