CHK-8290: Implement endpoint hooks in lib for Checkout Payment Method Delete (#39)

Author: BoldBrandonM

src/index.ts

@@ -28,6 +28,7 @@ export * from './shipping';
 export * from './taxes';
 export * from './discounts';
 export * from './payment';
+export * from './paymentMethod';
 export * from './orderMetaData';
 export * from './order';
 export * from './externalPaymentGateway';

src/paymentMethod/deletePaymentMethod.ts

@@ -0,0 +1,28 @@
+import {
+    apiTypeKeys,
+    apiTypes,
+    checkApiResponse,
+    fetchAPI,
+    getApiOptions,
+    getApiUrl,
+    IApiReturnObject
+} from 'src';
+
+/**
+ * # deletePaymentMethod
+ *
+ * Remove saved payment method
+ *
+ * @param {@link string} paymentMethodID - Payment Method pyblic ID to delete.
+ * @param {number} [numOfRetries=0] - Number of retries for some HTTP errors - Number from 0 to 5
+ *
+ * @returns {Promise<IApiReturnObject>} response
+ */
+export async function deletePaymentMethod(paymentMethodID: string, numOfRetries = 0): Promise<IApiReturnObject> {
+    const {deletePaymentMethod} = apiTypeKeys;
+    const url = `${getApiUrl(deletePaymentMethod)}/${paymentMethodID}`;
+    const options = getApiOptions(deletePaymentMethod);
+    const fetchRes = await fetchAPI(url, options, numOfRetries);
+    const {keysToTest} = apiTypes.deletePaymentMethod;
+    return checkApiResponse(fetchRes, keysToTest);
+}

src/paymentMethod/index.ts

@@ -0,0 +1 @@
+export * from './deletePaymentMethod';

src/types/apiInterfaces.ts

@@ -272,6 +272,7 @@ export interface IApiTypes {
     updatePayment: IApiTypesDetail;
     deletePayment: IApiTypesDetail;
     deleteGiftCardPayment: IApiTypesDetail;
+    deletePaymentMethod: IApiTypesDetail;
     patchOrderMetaData: IApiTypesDetail;
     batchRequest: IApiTypesDetail;
     addLog: IApiTypesDetail;
@@ -313,6 +314,7 @@ export interface IApiTypeKeys {
     updatePayment: keyof  IApiTypes;
     deletePayment: keyof  IApiTypes;
     deleteGiftCardPayment: keyof  IApiTypes;
+    deletePaymentMethod: keyof IApiTypes;
     patchOrderMetaData: keyof IApiTypes;
     batchRequest: keyof IApiTypes;
     addLog: keyof IApiTypes;

src/variables/constants.ts

@@ -252,6 +252,12 @@ export const apiTypes: IApiTypes = {
         useJwt: true,
         keysToTest: [...appStateKeysToTest]
     },
+    deletePaymentMethod: {
+        path: '/payments/saved',
+        method: methods.DELETE,
+        useJwt: true,
+        keysToTest: [...appStateKeysToTest]
+    },
     patchOrderMetaData: {
         path: '/meta_data',
         method: methods.PATCH,
@@ -333,6 +339,7 @@ export const apiTypeKeys: IApiTypeKeys = {
     updatePayment: 'updatePayment',
     deletePayment: 'deletePayment',
     deleteGiftCardPayment: 'deleteGiftCardPayment',
+    deletePaymentMethod: 'deletePaymentMethod',
     patchOrderMetaData: 'patchOrderMetaData',
     batchRequest: 'batchRequest',
     addLog: 'addLog',

tests/paymentMethod/deletePaymentMethod.test.ts

@@ -0,0 +1,66 @@
+import {apiTypeKeys, baseReturnObject, keysToTestFromResponse, methods, deletePaymentMethod, FetchError} from 'src';
+import * as fetchAPI from 'src/utils/fetchAPI';
+import * as getApiOptions from 'src/utils/getApiOptions';
+import * as apiUrl from 'src/utils/apiUrl';
+import * as apiResponse from 'src/utils/apiResponse';
+import {applicationStateMock} from 'src/variables/mocks';
+
+describe('testing deletePaymentMethod', () => {
+    const returnObject = {...baseReturnObject};
+    const apiUrlMock = 'https://api.com/checkout/storefront/123/123/payments/saved';
+    const keysToTest = [keysToTestFromResponse.data, keysToTestFromResponse.applicationState];
+    let optionsMock: RequestInit;
+    let getApiOptionsSpy: jest.SpyInstance;
+    let getApiUrlSpy: jest.SpyInstance;
+    let fetchApiSpy: jest.SpyInstance;
+    let checkApiResponseSpy: jest.SpyInstance;
+
+    beforeEach(() => {
+        global.Headers = jest.fn().mockReturnValue({append: jest.fn()});
+        returnObject.response = { data: { application_state: applicationStateMock }};
+        returnObject.success = true;
+        optionsMock = {method: methods.DELETE, headers: new Headers(), body: JSON.stringify({})};
+        getApiOptionsSpy = jest.spyOn(getApiOptions, 'getApiOptions').mockReturnValue(optionsMock);
+        getApiUrlSpy = jest.spyOn(apiUrl, 'getApiUrl').mockReturnValue(apiUrlMock);
+        fetchApiSpy = jest.spyOn(fetchAPI, 'fetchAPI').mockReturnValue(Promise.resolve(returnObject));
+        checkApiResponseSpy = jest.spyOn(apiResponse, 'checkApiResponse').mockReturnValue(returnObject);
+    });
+
+    afterEach(() => {
+        jest.restoreAllMocks();
+    });
+
+    test('successful call (200)', async () => {
+        const res = await deletePaymentMethod('test');
+
+        expect(getApiOptionsSpy).toHaveBeenCalledTimes(1);
+        expect(getApiUrlSpy).toHaveBeenCalledTimes(1);
+        expect(fetchApiSpy).toHaveBeenCalledTimes(1);
+        expect(checkApiResponseSpy).toHaveBeenCalledTimes(1);
+        expect(getApiOptionsSpy).toHaveBeenCalledWith(apiTypeKeys.deletePaymentMethod);
+        expect(getApiUrlSpy).toHaveBeenCalledWith(apiTypeKeys.deletePaymentMethod);
+        expect(fetchApiSpy).toHaveBeenCalledWith(`${apiUrlMock}/test`, optionsMock, 0);
+        expect(checkApiResponseSpy).toHaveBeenCalledWith(returnObject, keysToTest);
+        expect(res).toStrictEqual(returnObject);
+    });
+
+    test('failed call (422)', async () => {
+        const tempReturnObject = {...baseReturnObject};
+        tempReturnObject.error = new FetchError(422, 'Unprocessable Entity');
+        checkApiResponseSpy = jest.spyOn(apiResponse, 'checkApiResponse').mockReturnValueOnce(tempReturnObject);
+
+        fetchApiSpy.mockReturnValueOnce(Promise.resolve(tempReturnObject));
+
+        const res = await deletePaymentMethod('test', 1);
+
+        expect(getApiOptionsSpy).toHaveBeenCalledTimes(1);
+        expect(getApiUrlSpy).toHaveBeenCalledTimes(1);
+        expect(fetchApiSpy).toHaveBeenCalledTimes(1);
+        expect(checkApiResponseSpy).toHaveBeenCalledTimes(1);
+        expect(getApiOptionsSpy).toHaveBeenCalledWith(apiTypeKeys.deletePaymentMethod);
+        expect(getApiUrlSpy).toHaveBeenCalledWith(apiTypeKeys.deletePaymentMethod);
+        expect(fetchApiSpy).toHaveBeenCalledWith(`${apiUrlMock}/test`, optionsMock, 1);
+        expect(checkApiResponseSpy).toHaveBeenCalledWith(tempReturnObject, keysToTest);
+        expect(res).toStrictEqual(tempReturnObject);
+    });
+});