oro-sdk-apis 1.10.0 → 1.11.0

package/dist/services/practice.d.ts

@@ -1,4 +1,4 @@
-import { PracticeAccount, Uuid } from '../models';
+import { ConsultRequestMetadata, PracticeAccount, Uuid } from '../models';
 import { Assignment, 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 {
@@ -62,7 +62,18 @@ export declare class PracticeService {
      * @returns a hashed email
      */
     getPaymentIntentHashedEmail(email: string): string;
-    practiceCreatePaymentsIntent(practiceUuid: Uuid, planId: number, userEmail: string, isoLocality?: string, url_subdomain?: string, promotionCode?: string): Promise<PracticePaymentIntent>;
+    /**
+     * Creates a PracticePaymentIntent
+     * @param practiceUuid the uuid of the practice
+     * @param planId the plan id to use
+     * @param userEmail the email address of the user
+     * @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.
+     * @returns
+     */
+    practiceCreatePaymentsIntent(practiceUuid: Uuid, planId: number, userEmail: string, isoLocality?: string, url_subdomain?: string, promotionCode?: 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>;
     /**

package/package.json

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

package/src/models/practice.ts

@@ -291,6 +291,16 @@ export interface PracticePaymentIntent {
     dateUpdateAt?: Date
 }
 
+/**
+ * This interface is used as metadata when creating Stripe Invoice.
+ * It will be used to create the consult when stripe use our hook.
+ */
+export interface ConsultRequestMetadata {
+    tagSpecialtyRequired: string
+    isoLocalityRequired?: string
+    isoLanguageRequired: string
+}
+
 export interface Assignment {
     id?: number ///optional for insertion
     uuidPractice: string
@@ -428,4 +438,4 @@ export interface PracticeInvoice {
     subtotal: number
     currency: string
     discount: number
-}
+}

package/src/services/practice.ts

@@ -1,6 +1,6 @@
 import { Buffer } from 'buffer/'
 import { sha256 } from 'hash.js'
-import { PracticeAccount, Uuid } from '../models'
+import { ConsultRequestMetadata, PracticeAccount, Uuid } from '../models'
 import {
     Assignment,
     PlanType,
@@ -178,13 +178,25 @@ export class PracticeService {
         return Buffer.from(sha256().update(email.toLowerCase()).digest('hex'), 'hex').toString('base64')
     }
 
+    /**
+     * Creates a PracticePaymentIntent
+     * @param practiceUuid the uuid of the practice
+     * @param planId the plan id to use
+     * @param userEmail the email address of the user
+     * @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.
+     * @returns
+     */
     public practiceCreatePaymentsIntent(
         practiceUuid: Uuid,
         planId: number,
         userEmail: string,
         isoLocality?: string,
         url_subdomain?: string,
-        promotionCode?: string
+        promotionCode?: string,
+        consultRequest?: ConsultRequestMetadata
     ): Promise<PracticePaymentIntent> {
         return this.api.post<PracticePaymentIntent>(
             `${this.baseURL}/v1/practices/${practiceUuid}/payments/intents/`,
@@ -192,6 +204,7 @@ export class PracticeService {
                 idPlan: planId,
                 hashUserEmail: userEmail ? this.getPaymentIntentHashedEmail(userEmail) : undefined,
                 isoLocality,
+                consultRequest,
             },
             { params: { url_subdomain, promotionCode } }
         )
@@ -225,12 +238,9 @@ export class PracticeService {
      * @param practiceUuid UUID of the practice to get the invoice from
      * @param invoiceId ID of the invoice in stripe
      */
-    public getInvoice(
-        practiceUuid: Uuid,
-        invoiceId: string
-    ): Promise<PracticeInvoice> {
+    public getInvoice(practiceUuid: Uuid, invoiceId: string): Promise<PracticeInvoice> {
         return this.api.get<PracticeInvoice>(
-            `${this.baseURL}/v1/practices/${practiceUuid}/payments/invoices/${invoiceId}`,
+            `${this.baseURL}/v1/practices/${practiceUuid}/payments/invoices/${invoiceId}`
         )
     }