@natch-the-storage/heathershaw-platform-types 1.21.5 → 1.22.1

package/build/validators.d.ts

@@ -312,15 +312,79 @@ export interface OrderAddress {
     address: Address;
     deliveryInstructions?: string;
 }
-export interface ChargeOrder {
+/** Mimics the cardFields in the API, this is what the card field names should look like on the frontend */
+export interface PaymentCardDetails {
     cardNumber: string;
     cardHolder: string;
     cardExpiry: string;
     cvv: string;
     customerIp?: string;
-    orderUpdate?: Omit<OrderUpdate, 'id' | 'directUserProfileId' | 'partnerPharmacyProfileId' | 'patientRecordId'>;
-    patientRecordUpdate?: Omit<PatientRecordUpdate, 'id'>;
-    isStaff?: boolean;
+}
+/** Links to chargeUpdateFields in the API */
+type chargeUpdateFields = {
+    orderUpdate?: Omit<OrderUpdate, 'id' | 'directUserProfileId' | 'partnerPharmacyProfileId' | 'patientRecordId' | 'paymentStatus' | 'paymentLinkToken' | 'paymentReferenceId'>;
+    patientRecordUpdate?: Pick<PatientRecordUpdate, 'addresses' | 'healthInfo'>;
+};
+/** Links to chargeOrderBodySchema in the API */
+export type ScaSessionBodySchema = PaymentCardDetails;
+/** Used for new ScaSession API endpoint, is the expected request body */
+export type ScaSessionBody = {
+    amount: number;
+    patientRecordId: number;
+    cardNumber: string;
+    cardHolder: string;
+    cardExpiry: string;
+    cvv: string;
+    customerIp?: string;
+};
+/** Used for ChargeAndCreateOrder endpoint, for new payment flow */
+export type ChargeAndCreateOrderBody = {
+    order: OrderCreate;
+    cardToken: string;
+    sca: ScaResult;
+    cardType?: string;
+    customerIp?: string;
+};
+/** Links to scaResultSchema in the API */
+export type ScaResult = {
+    xid?: string | null;
+    cavv?: string | null;
+    par?: string | null;
+    ver?: string | null;
+    aav?: string | null;
+    ucaf?: string | null;
+    directoryServerTxnId?: string | null;
+    threedsVersion?: string | null;
+};
+export interface ChargeOrderLegacy {
+    cardNumber: string;
+    cardHolder: string;
+    cardExpiry: string;
+    cvv: string;
+    customerIp?: string;
+}
+/** Links to chargeOrderBodySchema in the API */
+export type ChargeOrder = chargeUpdateFields & {
+    cardToken: string;
+    sca: ScaResult;
+    cardType?: string;
+    customerIp?: string;
+};
+/** Links to chargeOrderMotoBodySchema in the API */
+export type ChargeOrderMotoBody = chargeUpdateFields & PaymentCardDetails;
+/** Links to the openScaSession function in the API
+ * Is the shape of the response
+ */
+export interface ScaSessionResponse {
+    accessToken: string;
+    verification: string;
+    cardToken: string;
+    cardType?: string;
+    reference: string;
+    amount: number;
+    currency: string;
+    username: string;
+    environment: string;
 }
 export interface PaperScriptReminder {
     id: number;
@@ -1223,7 +1287,16 @@ export declare const ApiRoutes: {
         createPaymentLinkToken: string;
         getByPaymentLinkToken: (token: string) => string;
         chargePaymentLink: (token: string) => string;
+        /** Old chargeOrder flow */
         chargeOrder: (id: string) => string;
+        paymentLinkScaSession: (token: string) => string;
+        /** DEPRECATED Sca Session route for old payment flow */
+        internalScaSession: (id: number) => string;
+        adminMoto: (id: number) => string;
+        /** New Sca Session route for updated payment flow */
+        scaSession: string;
+        /** New charge and create route for updated payment flow */
+        chargeAndCreateOrder: string;
     };
     paperScriptReminders: {
         list: string;

package/build/validators.js

@@ -504,7 +504,16 @@ export const ApiRoutes = {
         createPaymentLinkToken: '/api/orders/payment-links',
         getByPaymentLinkToken: (token) => `/api/orders/payment-links/${token}`,
         chargePaymentLink: (token) => `/api/orders/payment-links/${token}/charge`,
+        /** Old chargeOrder flow */
         chargeOrder: (id) => `/api/orders/${id}/charge`,
+        paymentLinkScaSession: (token) => `/api/orders/payment-links/${token}/sca-session`,
+        /** DEPRECATED Sca Session route for old payment flow */
+        internalScaSession: (id) => `/api/orders/${id}/sca-session`,
+        adminMoto: (id) => `/api/orders/${id}/charge/moto`,
+        /** New Sca Session route for updated payment flow */
+        scaSession: `/api/orders/sca-session`,
+        /** New charge and create route for updated payment flow */
+        chargeAndCreateOrder: `/api/orders/charge-and-create`,
     },
     paperScriptReminders: {
         list: '/api/paper-script-reminders',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@natch-the-storage/heathershaw-platform-types",
-  "version": "1.21.5",
+  "version": "1.22.1",
   "description": "Interfaces and routes to use on the client",
   "license": "ISC",
   "author": "Natch Surana",