Implementing the wallet payment endpoints (#15)

* Implementing the wallet payment endpoints
---------

Co-authored-by: shagufa-ali <80478231+shagufa-ali@users.noreply.github.com>

Author: Shagufa92

src/index.ts

@@ -34,6 +34,7 @@ export * from './orderMetaData';
 export * from './paymentIframe';
 export * from './order';
 export * from './externalPaymentGateway';
+export * from './walletPay';
 export {
     getApplicationState,
     getAddresses,

src/payment/createPaymentGatewayOrder.ts

@@ -2,5 +2,4 @@ export * from './addPayment';
 export * from './deletePayment';
 export * from './deleteGiftCardPayment';
 export * from './getPaymentList';
-export * from './createPaymentGatewayOrder';
 export * from './updatePayment';

src/payment/index.ts

@@ -17,7 +17,9 @@ export interface IApiSuccessResponse {
         ICssStylingPaymentIframeResponse |
         ICheckInventoryResponse |
         IAddPaymentResponse |
-        ICreatePaymentGatewayOrderResponse |
+        IWalletPayCreateOrderResponse |
+        IWalletPayOnShippingResponse |
+        IWalletPayOnApproveResponse |
         IUpdateLineItemQuantityResponse |
         IProcessOrderResponse |
         IPatchOrderMetaDataResponse |
@@ -214,12 +216,22 @@ export interface IAddPaymentResponse {
     application_state: IApplicationState | undefined;
 }
 
-export interface ICreatePaymentGatewayOrderPaypalResponse {
+export interface IWalletPayCreateOrderPaypalResponse {
     id: string
 }
 
-export interface ICreatePaymentGatewayOrderResponse {
-    payment_data: ICreatePaymentGatewayOrderPaypalResponse | Record<string, unknown>;
+export interface IWalletPayCreateOrderResponse {
+    payment_data: IWalletPayCreateOrderPaypalResponse | Record<string, unknown>;
+    application_state: IApplicationState | undefined;
+}
+
+export interface IWalletPayOnShippingResponse {
+    payment_data: Record<string, unknown>;
+    application_state: IApplicationState | undefined;
+}
+
+export interface IWalletPayOnApproveResponse {
+    payment_data: Record<string, unknown>;
     application_state: IApplicationState | undefined;
 }
 
@@ -273,14 +285,16 @@ export interface IApiTypes {
     checkInventory: IApiTypesDetail;
     validateDiscount: IApiTypesDetail;
     getPaymentList: IApiTypesDetail;
-    createPaymentGatewayOrder: IApiTypesDetail;
     addPayment: IApiTypesDetail;
     updatePayment: IApiTypesDetail;
     deletePayment: IApiTypesDetail;
     deleteGiftCardPayment: IApiTypesDetail;
     patchOrderMetaData: IApiTypesDetail;
     batchRequest: IApiTypesDetail;
     addLog: IApiTypesDetail;
+    walletPayCreateOrder: IApiTypesDetail,
+    walletPayOnShipping: IApiTypesDetail,
+    walletPayOnApprove: IApiTypesDetail,
 }
 
 export interface IApiTypeKeys {
@@ -311,13 +325,15 @@ export interface IApiTypeKeys {
     validateDiscount: keyof  IApiTypes;
     getPaymentList: keyof  IApiTypes;
     addPayment: keyof  IApiTypes;
-    createPaymentGatewayOrder: keyof  IApiTypes;
     updatePayment: keyof  IApiTypes;
     deletePayment: keyof  IApiTypes;
     deleteGiftCardPayment: keyof  IApiTypes;
     patchOrderMetaData: keyof IApiTypes;
     batchRequest: keyof IApiTypes;
     addLog: keyof IApiTypes;
+    walletPayCreateOrder: keyof  IApiTypes;
+    walletPayOnShipping: keyof  IApiTypes;
+    walletPayOnApprove: keyof  IApiTypes;
 }
 
 export interface IValidateAddress {
@@ -758,14 +774,38 @@ export interface IAddPaymentRequest {
     wallet_pay_type?: 'applepay'|'paywithgoogle'|'paypal',
 }
 
-export interface ICreatePaymentGatewayOrderPaypalPayload {
+export interface IWalletPayCreateOrderPaypalPayload {
     payment_type: string;
     locale: string;
 }
 
-export interface ICreatePaymentGatewayOrderRequest{
+export interface IWalletPayOnShippingPaypalPayload {
+    payment_action_type: string;
+    locale: string;
+    paypal_order_id: string;
+    shipping_address?: Record<string, unknown>;
+    shipping_options?: Record<string, unknown>;
+}
+
+export interface IWalletPayOnApprovePaypalPayload {
+    payment_action_type: string;
+    locale: string;
+    paypal_order_id: string;
+}
+
+export interface IWalletPayCreateOrderRequest{
+    gateway_type: string;
+    payment_data: IWalletPayCreateOrderPaypalPayload | Record<string, unknown>
+}
+
+export interface IWalletPayOnShippingRequest{
+    gateway_type: string;
+    payment_data: IWalletPayOnShippingPaypalPayload | Record<string, unknown>
+}
+
+export interface IWalletPayOnApproveRequest{
     gateway_type: string;
-    payment_data: ICreatePaymentGatewayOrderPaypalPayload | Record<string, unknown>
+    payment_data: IWalletPayOnApprovePaypalPayload | Record<string, unknown>
 }
 
 export type IUpdatePaymentRequest = IAddPaymentRequest;
@@ -796,7 +836,9 @@ export type IGetApiOptionsBody =
     IUpdatePaymentRequest |
     IDeletePaymentRequest |
     IPatchOrderMetaDataRequest |
-    ICreatePaymentGatewayOrderRequest |
+    IWalletPayOnApproveRequest |
+    IWalletPayCreateOrderRequest |
+    IWalletPayOnShippingRequest |
     Record<string, unknown>;
 
 export interface IShippingLine {

src/types/apiInterfaces.ts

@@ -256,12 +256,6 @@ export const apiTypes: IApiTypes = {
         useJwt: true,
         keysToTest: [...appStateKeysToTest]
     },
-    createPaymentGatewayOrder: {
-        path: '/payment_gateway_order',
-        method: methods.POST,
-        useJwt: true,
-        keysToTest: [...appStateKeysToTest]
-    },
     addPayment: {
         path: '/payments',
         method: methods.POST,
@@ -303,7 +297,25 @@ export const apiTypes: IApiTypes = {
         method: methods.POST,
         useJwt: true,
         keysToTest: [keysToTestFromResponse.data]
-    }
+    },
+    walletPayCreateOrder: {
+        path: '/wallet_pay/create_order',
+        method: methods.POST,
+        useJwt: true,
+        keysToTest: [...appStateKeysToTest]
+    },
+    walletPayOnShipping: {
+        path: '/wallet_pay/on_shipping',
+        method: methods.POST,
+        useJwt: true,
+        keysToTest: [...appStateKeysToTest]
+    },
+    walletPayOnApprove: {
+        path: '/wallet_pay/on_approve',
+        method: methods.POST,
+        useJwt: true,
+        keysToTest: [...appStateKeysToTest]
+    },
 };
 
 export const apiTypeKeys: IApiTypeKeys = {
@@ -333,14 +345,16 @@ export const apiTypeKeys: IApiTypeKeys = {
     updateItem: 'updateItem',
     checkInventory: 'checkInventory',
     getPaymentList: 'getPaymentList',
-    createPaymentGatewayOrder: 'createPaymentGatewayOrder',
     addPayment: 'addPayment',
     updatePayment: 'updatePayment',
     deletePayment: 'deletePayment',
     deleteGiftCardPayment: 'deleteGiftCardPayment',
     patchOrderMetaData: 'patchOrderMetaData',
     batchRequest: 'batchRequest',
-    addLog: 'addLog'
+    addLog: 'addLog',
+    walletPayCreateOrder: 'walletPayCreateOrder',
+    walletPayOnShipping: 'walletPayOnShipping',
+    walletPayOnApprove: 'walletPayOnApprove',
 };
 
 export const baseReturnObject: IApiReturnObject = {

src/variables/constants.ts

@@ -0,0 +1,3 @@
+export * from './walletPayOnShipping';
+export * from './walletPayOnApprove';
+export * from './walletPayCreateOrder';

src/walletPay/index.ts

@@ -0,0 +1,27 @@
+import {
+    apiTypeKeys,
+    checkApiResponse,
+    fetchAPI,
+    getApiOptions,
+    getApiUrl,
+    IApiReturnObject,
+    IWalletPayCreateOrderRequest,
+    keysToTestFromResponse,
+} from 'src';
+
+/** walletPayCreateOrder
+ *
+ * create new order on payment gateway
+ *
+ * @param {@link IWalletPayCreateOrderRequest} requestBody - create payment gateway order for specific payment gateways.
+ * @param {number} [numOfRetries=0] - Number of retries for some HTTP errors - Number from 0 to 5
+ *
+ * @returns {Promise<IApiReturnObject>} response
+ */
+export async function walletPayCreateOrder(requestBody: IWalletPayCreateOrderRequest, numOfRetries= 0): Promise<IApiReturnObject> {
+    const {walletPayCreateOrder} = apiTypeKeys;
+    const options = getApiOptions(walletPayCreateOrder, requestBody);
+    const url = getApiUrl(walletPayCreateOrder);
+    const fetchRes = await fetchAPI(url, options, numOfRetries);
+    return checkApiResponse(fetchRes, [keysToTestFromResponse.data, keysToTestFromResponse.applicationState]);
+}

src/walletPay/walletPayCreateOrder.ts

@@ -0,0 +1,27 @@
+import {
+    apiTypeKeys,
+    checkApiResponse,
+    fetchAPI,
+    getApiOptions,
+    getApiUrl,
+    IApiReturnObject,
+    IWalletPayOnApproveRequest,
+    keysToTestFromResponse,
+} from 'src';
+
+/** walletPayOnApprove
+ *
+ * handles the on approve change event for wallet pay
+ *
+ * @param {@link IWalletPayOnApproveRequest} requestBody - on approve data from the wallet payment
+ * @param {number} [numOfRetries=0] - Number of retries for some HTTP errors - Number from 0 to 5
+ *
+ * @returns {Promise<IApiReturnObject>} response
+ */
+export async function walletPayOnApprove(requestBody: IWalletPayOnApproveRequest, numOfRetries= 0): Promise<IApiReturnObject> {
+    const {walletPayOnApprove} = apiTypeKeys;
+    const options = getApiOptions(walletPayOnApprove, requestBody);
+    const url = getApiUrl(walletPayOnApprove);
+    const fetchRes = await fetchAPI(url, options, numOfRetries);
+    return checkApiResponse(fetchRes, [keysToTestFromResponse.data, keysToTestFromResponse.applicationState]);
+}

src/walletPay/walletPayOnApprove.ts

@@ -0,0 +1,27 @@
+import {
+    apiTypeKeys,
+    checkApiResponse,
+    fetchAPI,
+    getApiOptions,
+    getApiUrl,
+    IApiReturnObject,
+    IWalletPayOnShippingRequest,
+    keysToTestFromResponse,
+} from 'src';
+
+/** walletPayOnShipping
+ *
+ * handles the on shipping change event for wallet pay
+ *
+ * @param {@link IWalletPayOnShippingRequest} requestBody - on shipping data from the wallet payment
+ * @param {number} [numOfRetries=0] - Number of retries for some HTTP errors - Number from 0 to 5
+ *
+ * @returns {Promise<IApiReturnObject>} response
+ */
+export async function walletPayOnShipping(requestBody: IWalletPayOnShippingRequest, numOfRetries= 0): Promise<IApiReturnObject> {
+    const {walletPayOnShipping} = apiTypeKeys;
+    const options = getApiOptions(walletPayOnShipping, requestBody);
+    const url = getApiUrl(walletPayOnShipping);
+    const fetchRes = await fetchAPI(url, options, numOfRetries);
+    return checkApiResponse(fetchRes, [keysToTestFromResponse.data, keysToTestFromResponse.applicationState]);
+}

src/walletPay/walletPayOnShipping.ts

@@ -1,10 +1,10 @@
 import {
     apiTypeKeys,
     baseReturnObject,
-    createPaymentGatewayOrder,
     methods,
-    ICreatePaymentGatewayOrderRequest,
-    ICreatePaymentGatewayOrderResponse
+    IWalletPayCreateOrderRequest,
+    IWalletPayCreateOrderResponse,
+    walletPayCreateOrder
 } from 'src';
 import * as fetchAPI from 'src/utils/fetchAPI';
 import * as getApiOptions from 'src/utils/getApiOptions';
@@ -14,22 +14,22 @@ import * as apiResponse from 'src/utils/apiResponse';
 
 describe('testing create payment gateway order ', () => {
     const returnObject = {...baseReturnObject};
-    const apiUrlMock = 'https://api.com/checkout/storefront/123/123/payment_gateway_order';
+    const apiUrlMock = 'https://api.com/checkout/storefront/123/123/wallet-pay/create-order';
     let optionsMock: RequestInit;
     let getApiOptionsSpy: jest.SpyInstance;
     let getApiUrlSpy: jest.SpyInstance;
     let fetchApiSpy: jest.SpyInstance;
     let checkApiResponseSpy: jest.SpyInstance;
 
-    const initPaymentPayload: ICreatePaymentGatewayOrderRequest = {
+    const initPaymentPayload: IWalletPayCreateOrderRequest = {
         payment_data: {
             payment_type: 'paypal',
             locale: 'en-US',
         },
         gateway_type: 'paypal'
     };
 
-    const response: ICreatePaymentGatewayOrderResponse = {
+    const response: IWalletPayCreateOrderResponse = {
         payment_data: {id: '1234'},
         application_state: applicationStateMock
     };
@@ -50,13 +50,13 @@ describe('testing create payment gateway order ', () => {
     });
 
     test('calling init Payment', async () => {
-        const res = await createPaymentGatewayOrder(initPaymentPayload);
+        const res = await walletPayCreateOrder(initPaymentPayload);
 
         expect(getApiOptionsSpy).toHaveBeenCalledTimes(1);
         expect(getApiUrlSpy).toHaveBeenCalledTimes(1);
         expect(fetchApiSpy).toHaveBeenCalledTimes(1);
-        expect(getApiOptionsSpy).toHaveBeenCalledWith(apiTypeKeys.createPaymentGatewayOrder, initPaymentPayload);
-        expect(getApiUrlSpy).toHaveBeenCalledWith(apiTypeKeys.createPaymentGatewayOrder);
+        expect(getApiOptionsSpy).toHaveBeenCalledWith(apiTypeKeys.walletPayCreateOrder, initPaymentPayload);
+        expect(getApiUrlSpy).toHaveBeenCalledWith(apiTypeKeys.walletPayCreateOrder);
         expect(fetchApiSpy).toHaveBeenCalledWith(apiUrlMock, optionsMock, 0);
         expect(res).toStrictEqual(returnObject);
     });
@@ -66,13 +66,13 @@ describe('testing create payment gateway order ', () => {
         checkApiResponseSpy.mockReturnValueOnce(tempReturnObject);
         fetchApiSpy.mockReturnValueOnce(Promise.resolve(tempReturnObject));
 
-        const res = await createPaymentGatewayOrder(initPaymentPayload, 1);
+        const res = await walletPayCreateOrder(initPaymentPayload, 1);
 
         expect(getApiOptionsSpy).toHaveBeenCalledTimes(1);
         expect(getApiUrlSpy).toHaveBeenCalledTimes(1);
         expect(fetchApiSpy).toHaveBeenCalledTimes(1);
-        expect(getApiOptionsSpy).toHaveBeenCalledWith(apiTypeKeys.createPaymentGatewayOrder, initPaymentPayload);
-        expect(getApiUrlSpy).toHaveBeenCalledWith(apiTypeKeys.createPaymentGatewayOrder);
+        expect(getApiOptionsSpy).toHaveBeenCalledWith(apiTypeKeys.walletPayCreateOrder, initPaymentPayload);
+        expect(getApiUrlSpy).toHaveBeenCalledWith(apiTypeKeys.walletPayCreateOrder);
         expect(fetchApiSpy).toHaveBeenCalledWith(apiUrlMock, optionsMock, 1);
         expect(res).toStrictEqual(tempReturnObject);
     });