Add refund function to insurance service (#440)

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Next Release
 
 - Fix payment method funding and deletion failures due to undetermined payment method type
+- Adds `refund` function in Insurance service for requesting a refund of standalone insurance.
 
 ## v7.2.0 (2024-01-22)
 

src/services/insurance_service.js

@@ -56,4 +56,17 @@ export default (easypostClient) =>
 
       return this._retrieve(url);
     }
+
+    /**
+     * Refund an {@link Insurance insurance} record by its ID.
+     * See {@link https://www.easypost.com/docs/api/node#refund-an-insurance EasyPost API Documentation} for more information.
+     * @param {string} id - The ID of the insurance to be refunded.
+     * @returns {Insurance} - The refunded insurance.
+     */
+    static async refund(id) {
+      const url = `insurances/${id}/refund`;
+      const response = await easypostClient._post(url);
+
+      return this._convertToEasyPostObject(response.body);
+    }
   };

test/services/insurance.test.js

@@ -75,4 +75,17 @@ describe('Insurance Service', function () {
       }
     }
   });
+
+  it('refunds a standalone insurance', async function () {
+    const insuranceData = Fixture.basicInsurance();
+    insuranceData.tracking_code = 'EZ1000000001';
+
+    const insurance = await this.client.Insurance.create(insuranceData);
+    const cancelledInsurance = await this.client.Insurance.refund(insurance.id);
+
+    expect(cancelledInsurance).to.be.an.instanceOf(Insurance);
+    expect(cancelledInsurance.id).to.match(/^ins_/);
+    expect(cancelledInsurance.status).to.equal('cancelled');
+    expect(cancelledInsurance.messages[0]).to.equal('Insurance was cancelled by the user.');
+  });
 });

types/Insurance/Insurance.d.ts

@@ -161,4 +161,14 @@ export declare class Insurance implements IInsurance {
     insurances: Object,
     pageSize?: number,
   ): Promise<{ insurances: Insurance[]; has_more: boolean }>;
+
+  /**
+   * Refund an Insurance by id.
+   *
+   * @see https://www.easypost.com/docs/api/node#refund-an-insurance
+   *
+   * @param insuranceId Unique, starts with "ins_"
+   * @returns {Promise<Insurance>} The refunded {@link Insurance}.
+   */
+  static refund(insuranceId: string): Promise<Insurance>;
 }