@hts-fintech-ancillaries/air-cfar-sdk v0.0.2

MOCK CFAR SDK

This is a mock CFAR(Cancel For Any Reason) SDK. All the calls are mocked and the responses are hardcoded.

Installation

npm install @hts-fintech-ancillaries/air-cfar-sdk

Usage

To use the CFAR SDK, you need to create an instance of the Cfar class with your clientId and clientSecret. Any arbitrary values can be passed in the Config object for this mock SDK.

You can then use the purchase method of the Cfar instance to purchase cfar:

import {
  Cfar,
  PurchaseRequest,
  TokenType,
  PurchaseSuccessResponse,
  PurchaseError,
} from "@hts-fintech-ancillaries/air-cfar-sdk";

// Create a new instance of the Cfar class with your client ID and client secret.
const c = new Cfar({ clientId: "your-client-id", clientSecret: "your-client-secret" });

// Call the purchase method of the Cfar instance with the purchase request object.
// Can have any arbitrary values as long as they are of the correct type.
const request: PurchaseRequest = {
  sessionId: "sessionId",
  contractDetails: {
    purchaseQuoteId: "purchaseQuoteId",
    bookingId: "bookingId",
    bookingLocators: ["bookingLocators"],
    userDetails: {
      id: "id",
      email: "email@test.com",
    },
    paymentMethod: {
      token: "validToken",
      type: TokenType.Spreedly,
    },
  },
};

// To purchase CFAR, call the purchase method of the Cfar instance with the purchase request object
c.purchase(request)
  .then((response: PurchaseSuccessResponse) => {
    // Handle the successful purchase response
    console.log("Purchase successful:", response.contractId);
  })
  .catch((error: PurchaseError) => {
    // Handle the purchase error by checking the type of the error
    if (error instanceof PurchaseError.InvalidPaymentToken) {
      console.log("Purchase failed:", error.message);
    } else if (error instanceof PurchaseError.InvalidPurchaseQuoteId) {
      console.log("Purchase failed:", error.message);
    }
  });

The purchase method of the Cfar instance returns a Promise that resolves to a PurchaseSuccessResponse object if the purchase is successful. If the purchase fails, the promise is rejected with a PurchaseError object.

The PurchaseError class is a custom error class that is used to represent errors that occur during the purchase process in our application. For demonstrating how the errors will be communicated, it has two types of errors: InvalidPaymentToken and InvalidPurchaseQuoteId.

Note: The values passed in Config object and PurchaseRequest object are just for demonstration purposes. You can pass any arbitrary values in these objects as long as they are of the correct type.

Using provided example requests

The CFAR SDK provides example requests for testing purposes. You can use these requests by importing them from the @hts-fintech-ancillaries/air-cfar-sdk package:

import {
  Cfar,
  PurchaseError,
  PurchaseSuccessResponse,
  EXAMPLE_REQUESTS,
} from "@hts-fintech-ancillaries/air-cfar-sdk";

const c = new Cfar({ clientId: "test", clientSecret: "test" });

c.purchase(EXAMPLE_REQUESTS.INVALID_PAYMENT_TOKEN)
  .then((response: PurchaseSuccessResponse) => {
    console.log("Purchase successful:", response.contractId);
  })
  .catch((error: PurchaseError) => {
    // ...
  });

Example requests are provided for the following scenarios:

• SUCCESSFUL_PURCHASE: Purchase is successful
• INVALID_PAYMENT_TOKEN: Payment token is invalid
• INVALID_PURCHASE_QUOTE_ID: Purchase quote id is invalid

Types

The following types are used in the CFAR SDK:

PurchaseRequest

type PurchaseRequest {
  sessionId: string;
  contractDetails: {
    purchaseQuoteId: string;
    bookingId: string;
    bookingLocators: string[];
    userDetails: UserDetails;
    paymentMethod: PaymentMethod;
  };
}

UserDetails

type UserDetails {
  id: string;
  email: string;
}

PaymentMethod

type PaymentMethod {
  token: string;
  type: TokenType;
}

TokenType

enum TokenType {
  Spreedly = 'spreedly',
}

PurchaseSuccessResponse

type PurchaseSuccessResponse {
  contractId: string;
}