oro-sdk-apis 1.37.0 → 1.38.0

package/dist/services/practice.d.ts

@@ -75,7 +75,17 @@ export declare class PracticeService {
      */
     practiceCreatePaymentsIntent(practiceUuid: Uuid, planId: number, userEmail: string, isoLocality?: string, url_subdomain?: string, consultRequest?: ConsultRequestMetadata): Promise<PracticePaymentIntent>;
     practiceGetPaymentsIntent(practiceUuid: Uuid, paymentIntentId: number): Promise<PracticePaymentIntent>;
-    practiceUpdatePaymentsIntent(practiceUuid: string, idPraticePaymentIntent: number, practicePaymentIntent: PracticePaymentIntent, userEmail: string, promotionCode?: string): Promise<PracticePaymentIntent>;
+    /**
+     * Updates a PracticePaymentIntent
+     * @param practiceUuid the practice uuid
+     * @param idPraticePaymentIntent the id of the PracticePaymentIntent to update
+     * @param practicePaymentIntent the desired PracticePaymentIntent
+     * @param userEmail the email of the user
+     * @param promotionCode (optional) promotional code to apply
+     * @param finalize (optional) if true will finalize the PracticePaymentIntent and related Stripe.Invoice. Once, finalized you cannot modify the PracticePaymentIntent anymore.
+     * @returns the updated PracticePaymentIntent
+     */
+    practiceUpdatePaymentsIntent(practiceUuid: string, idPraticePaymentIntent: number, practicePaymentIntent: PracticePaymentIntent, userEmail: string, promotionCode?: string, finalize?: boolean): Promise<PracticePaymentIntent>;
     /**
      * Invoice
      * @param practiceUuid UUID of the practice to get the invoice from

package/package.json

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

package/src/models/practice.ts

@@ -143,40 +143,40 @@ export enum PracticeConfigKind {
     PracticePharmacyPicker = 'PracticePharmacyPicker',
     PracticePrescriptionFields = 'PracticePrescriptionFields',
     PractitionerChatbox = 'PractitionerChatbox',
-    PractitionerConsultList = 'PractitionerConsultList'
+    PractitionerConsultList = 'PractitionerConsultList',
 }
 
 /**
  * Defines the close consultation types to hide in the close consultation modal of a practice
  */
- export type PracticeConfigPracticeCloseConsultationTypes = PracticeConfig<
- PracticeConfigKind.PracticeCloseConsultationTypes,
- {
-     /**
-      * Should hide item with value "Completed"
-      */
-     hideCompleted?: boolean
-
-     /**
-      * Should hide item with value "Requires-in-person"
-      */
-     hideRequiresInPerson?: boolean
-
-     /**
-      * Should hide item with value "Other"
-      */
-     hideOther?: boolean
-
-     /**
-      * Should hide item with value "Not-a-disease"
-      */
-     hideNotADisease?: boolean
-
-     /**
-      * Should hide item with value "Appropriate-for-virtual"
-      */
-     hideNotAppropriateForVirtual?: boolean
- }
+export type PracticeConfigPracticeCloseConsultationTypes = PracticeConfig<
+    PracticeConfigKind.PracticeCloseConsultationTypes,
+    {
+        /**
+         * Should hide item with value "Completed"
+         */
+        hideCompleted?: boolean
+
+        /**
+         * Should hide item with value "Requires-in-person"
+         */
+        hideRequiresInPerson?: boolean
+
+        /**
+         * Should hide item with value "Other"
+         */
+        hideOther?: boolean
+
+        /**
+         * Should hide item with value "Not-a-disease"
+         */
+        hideNotADisease?: boolean
+
+        /**
+         * Should hide item with value "Appropriate-for-virtual"
+         */
+        hideNotAppropriateForVirtual?: boolean
+    }
 >
 
 /**
@@ -202,95 +202,95 @@ export interface PracticeConfig<K, T> {
 
 /**
  * This type is for test (do not remove without updating the integration tests)
- */ 
- export type PracticeConfigPracticeConfigExample = PracticeConfig<
- PracticeConfigKind.PracticeConfigExample,
- { primaryColor?: string }
+ */
+export type PracticeConfigPracticeConfigExample = PracticeConfig<
+    PracticeConfigKind.PracticeConfigExample,
+    { primaryColor?: string }
 >
 
 /**
  * Defines the practice cookie banner
  */
- export type PracticeConfigPracticeCookieBanner = PracticeConfig<
- PracticeConfigKind.PracticeCookieBanner,
- {
-     showCookieBanner?: boolean
-     policyLink?: string
-     useOfCookieLink?: string
- }
+export type PracticeConfigPracticeCookieBanner = PracticeConfig<
+    PracticeConfigKind.PracticeCookieBanner,
+    {
+        showCookieBanner?: boolean
+        policyLink?: string
+        useOfCookieLink?: string
+    }
 >
 
 /**
  * This interface describes all practice css variables
  * The keys should reflect the exact css name
  */
- export type PracticeConfigPracticeCssVariables = PracticeConfig<
- PracticeConfigKind.PracticeCssVariables,
- Record<string, string>
+export type PracticeConfigPracticeCssVariables = PracticeConfig<
+    PracticeConfigKind.PracticeCssVariables,
+    Record<string, string>
 >
 
 /**
  * Defines the font of the practice css url
  */
- export type PracticeConfigPracticeFontsLinks = PracticeConfig<
- PracticeConfigKind.PracticeFontsLinks,
- {
-     /**
-      * sans serif font family
-      */
-     sansSerif?: string
-     /**
-      * serif font family
-      */
-     serif?: string
- }
+export type PracticeConfigPracticeFontsLinks = PracticeConfig<
+    PracticeConfigKind.PracticeFontsLinks,
+    {
+        /**
+         * sans serif font family
+         */
+        sansSerif?: string
+        /**
+         * serif font family
+         */
+        serif?: string
+    }
 >
 
 /**
  * Defines the locale switcher config
  */
- export type PracticeConfigPracticeLocaleSwitcher = PracticeConfig<
- PracticeConfigKind.PracticeLocaleSwitcher,
- {
-     /**
-      * Should hide the locale switcher
-      */
-     hideLocaleSwitcher?: boolean
- }
+export type PracticeConfigPracticeLocaleSwitcher = PracticeConfig<
+    PracticeConfigKind.PracticeLocaleSwitcher,
+    {
+        /**
+         * Should hide the locale switcher
+         */
+        hideLocaleSwitcher?: boolean
+    }
 >
 
 /**
- * Defines the online pharmacy address of the practice 
+ * Defines the online pharmacy address of the practice
  */
- export type PracticeConfigPracticeOnlinePharmacy = PracticeConfig<
- PracticeConfigKind.PracticePharmacyPicker,
- {
-     /**
-      * The address of the online pharmacy
-      */
-     onlinePharmacy?: PlaceData
- }
+export type PracticeConfigPracticeOnlinePharmacy = PracticeConfig<
+    PracticeConfigKind.PracticePharmacyPicker,
+    {
+        /**
+         * The address of the online pharmacy
+         */
+        onlinePharmacy?: PlaceData
+    }
 >
 
 /**
  * Defines the consultation chatbox configs
  */
- export type PracticeConfigPractitionerChatbox = PracticeConfig<
- PracticeConfigKind.PractitionerChatbox,
- {
-     /**
-      * If defined will replace the automatic chatbox comment notifiying the patient a new treatment plan has been added. Indexed by locale.
-      */
-     planAddedMessage?: { [languageISO639_3: string]: string }
-     /**
-      * If defined will replace the automatic chatbox comment notifiying the patient a new treatment plan has been updated. Indexed by locale.
-      */
-     planUpdatedMessage?: { [languageISO639_3: string]: string }
-     /**
-      * If defined will replace the automatic chatbox comment notifiying the patient a new exam has been dispatched. Indexed by locale.
-      */
-     examsUpdatedMessage?: { [languageISO639_3: string]: string }
- }
+export type PracticeConfigPractitionerChatbox = PracticeConfig<
+    PracticeConfigKind.PractitionerChatbox,
+    {
+        /**
+         * If defined will replace the automatic chatbox comment notifiying the patient a new treatment plan has been added. Indexed by locale.
+         */
+        planAddedMessage?: { [languageISO639_3: string]: string }
+        /**
+         * If defined will replace the automatic chatbox comment notifiying the patient a new treatment plan has been updated. Indexed by locale.
+         */
+        planUpdatedMessage?: { [languageISO639_3: string]: string }
+        /**
+         * If defined will replace the automatic chatbox comment notifiying the patient a new exam has been dispatched. Indexed by locale.
+         */
+        examsUpdatedMessage?: { [languageISO639_3: string]: string }
+    }
 >
 
 /**
@@ -329,7 +329,7 @@ export type PracticeConfigPracticePrescriptionFields = PracticeConfig<
          */
         yCoordinate?: number
     }
-    >
+>
 
 export type PracticeConfigs =
     | PracticeConfigPractitionerConsultList
@@ -444,7 +444,10 @@ export interface PracticePaymentIntent {
     numPlatformFeeAmount: number
     idStripeInvoice: string
     idStripePaymtIntent: string
-    stripeClientSecret: string
+    /**
+     * This value is set only after the PracticePaymentIntent has been finalized and ready to be paid
+     */
+    stripeClientSecret?: string
     dateCreatedAt?: Date
     dateUpdateAt?: Date
 }
@@ -612,4 +615,4 @@ export interface PracticeInvoice {
     subtotal: number
     currency: string
     discount: number
-}
+}

package/src/services/practice.ts

@@ -215,12 +215,23 @@ export class PracticeService {
         )
     }
 
+    /**
+     * Updates a PracticePaymentIntent
+     * @param practiceUuid the practice uuid
+     * @param idPraticePaymentIntent the id of the PracticePaymentIntent to update
+     * @param practicePaymentIntent the desired PracticePaymentIntent
+     * @param userEmail the email of the user
+     * @param promotionCode (optional) promotional code to apply
+     * @param finalize (optional) if true will finalize the PracticePaymentIntent and related Stripe.Invoice. Once, finalized you cannot modify the PracticePaymentIntent anymore.
+     * @returns the updated PracticePaymentIntent
+     */
     public practiceUpdatePaymentsIntent(
         practiceUuid: string,
         idPraticePaymentIntent: number,
         practicePaymentIntent: PracticePaymentIntent,
         userEmail: string,
-        promotionCode?: string
+        promotionCode?: string,
+        finalize?: boolean
     ) {
         return this.api.put<PracticePaymentIntent>(
             `${this.baseURL}/v1/practices/${practiceUuid}/payments/intents/${idPraticePaymentIntent}`,
@@ -228,7 +239,7 @@ export class PracticeService {
                 ...practicePaymentIntent,
                 hashUserEmail: userEmail ? this.getPaymentIntentHashedEmail(userEmail) : undefined,
             },
-            { params: { promotionCode } }
+            { params: { promotionCode, finalize } }
         )
     }