feat(api): add Simulate Return Payment endpoint (#197)

.stats.yml

@@ -1 +1 @@
-configured_endpoints: 87
+configured_endpoints: 88

api.md

@@ -315,13 +315,15 @@ Types:
 - <code><a href="./src/resources/payments.ts">Payment</a></code>
 - <code><a href="./src/resources/payments.ts">PaymentCreateResponse</a></code>
 - <code><a href="./src/resources/payments.ts">PaymentSimulateReleaseResponse</a></code>
+- <code><a href="./src/resources/payments.ts">PaymentSimulateReturnResponse</a></code>
 
 Methods:
 
 - <code title="post /payments">client.payments.<a href="./src/resources/payments.ts">create</a>({ ...params }) -> PaymentCreateResponse</code>
 - <code title="get /payments/{payment_token}">client.payments.<a href="./src/resources/payments.ts">retrieve</a>(paymentToken) -> Payment</code>
 - <code title="get /payments">client.payments.<a href="./src/resources/payments.ts">list</a>({ ...params }) -> PaymentsCursorPage</code>
 - <code title="post /simulate/payments/release">client.payments.<a href="./src/resources/payments.ts">simulateRelease</a>({ ...params }) -> PaymentSimulateReleaseResponse</code>
+- <code title="post /simulate/payments/return">client.payments.<a href="./src/resources/payments.ts">simulateReturn</a>({ ...params }) -> PaymentSimulateReturnResponse</code>
 
 # ThreeDS
 

src/index.ts

@@ -392,10 +392,12 @@ export namespace Lithic {
   export import Payment = API.Payment;
   export import PaymentCreateResponse = API.PaymentCreateResponse;
   export import PaymentSimulateReleaseResponse = API.PaymentSimulateReleaseResponse;
+  export import PaymentSimulateReturnResponse = API.PaymentSimulateReturnResponse;
   export import PaymentsCursorPage = API.PaymentsCursorPage;
   export import PaymentCreateParams = API.PaymentCreateParams;
   export import PaymentListParams = API.PaymentListParams;
   export import PaymentSimulateReleaseParams = API.PaymentSimulateReleaseParams;
+  export import PaymentSimulateReturnParams = API.PaymentSimulateReturnParams;
 
   export import ThreeDS = API.ThreeDS;
 

src/resources/index.ts

@@ -115,9 +115,11 @@ export {
   Payment,
   PaymentCreateResponse,
   PaymentSimulateReleaseResponse,
+  PaymentSimulateReturnResponse,
   PaymentCreateParams,
   PaymentListParams,
   PaymentSimulateReleaseParams,
+  PaymentSimulateReturnParams,
   PaymentsCursorPage,
   Payments,
 } from './payments';

src/resources/payments.ts

@@ -50,6 +50,16 @@ export class Payments extends APIResource {
   ): Core.APIPromise<PaymentSimulateReleaseResponse> {
     return this.post('/simulate/payments/release', { body, ...options });
   }
+
+  /**
+   * Simulates a return of a Payment.
+   */
+  simulateReturn(
+    body: PaymentSimulateReturnParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PaymentSimulateReturnResponse> {
+    return this.post('/simulate/payments/return', { body, ...options });
+  }
 }
 
 export class PaymentsCursorPage extends CursorPage<Payment> {}
@@ -91,6 +101,14 @@ export interface PaymentSimulateReleaseResponse {
   transaction_event_token?: string;
 }
 
+export interface PaymentSimulateReturnResponse {
+  debugging_request_id?: string;
+
+  result?: 'APPROVED' | 'DECLINED';
+
+  transaction_event_token?: string;
+}
+
 export interface PaymentCreateParams {
   amount: number;
 
@@ -129,12 +147,20 @@ export interface PaymentSimulateReleaseParams {
   payment_token: string;
 }
 
+export interface PaymentSimulateReturnParams {
+  payment_token: string;
+
+  return_reason_code?: string;
+}
+
 export namespace Payments {
   export import Payment = API.Payment;
   export import PaymentCreateResponse = API.PaymentCreateResponse;
   export import PaymentSimulateReleaseResponse = API.PaymentSimulateReleaseResponse;
+  export import PaymentSimulateReturnResponse = API.PaymentSimulateReturnResponse;
   export type PaymentsCursorPage = _PaymentsCursorPage;
   export import PaymentCreateParams = API.PaymentCreateParams;
   export import PaymentListParams = API.PaymentListParams;
   export import PaymentSimulateReleaseParams = API.PaymentSimulateReleaseParams;
+  export import PaymentSimulateReturnParams = API.PaymentSimulateReturnParams;
 }

tests/api-resources/payments.test.ts

@@ -109,4 +109,24 @@ describe('resource payments', () => {
       payment_token: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
     });
   });
+
+  test('simulateReturn: only required params', async () => {
+    const responsePromise = lithic.payments.simulateReturn({
+      payment_token: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+    });
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('simulateReturn: required and optional params', async () => {
+    const response = await lithic.payments.simulateReturn({
+      payment_token: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+      return_reason_code: 'string',
+    });
+  });
 });