All files / src/models B2CPaymentResponse.ts

87.5% Statements 7/8
100% Branches 0/0
75% Functions 3/4
87.5% Lines 7/8

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67                                                          1x   2x 2x 2x 2x                 2x                         2x                    
/**
 * Represents the response from the B2C Pay Out API.
 */
export type B2CResponseType = {
    ConversationID: string;
    OriginatorConversationID: string;
    ResponseCode: string;
    ResponseDescription: string;
};
 
/**
 * Represents the payload required for the B2C Pay Out request.
 */
export type B2CPayloadType = {
    InitiatorName: string;
    SecurityCredential: string;
    CommandID: 'BusinessPayment' | 'SalaryPayment' | 'PromotionPayment';
    Amount: number;
    PartyA: number;
    PartyB: string;
    Remarks: string;
    QueueTimeOutURL: string;
    ResultURL: string;
    Occassion: string;
};
 
/**
 * Represents the response object from the B2C Pay Out API.
 */
export class B2CResponse {
    constructor(
        public ConversationID: string,
        public OriginatorConversationID: string,
        public ResponseCode: string,
        public ResponseDescription: string
    ) { }
 
    /**
     * Factory method to create an instance from API response data.
     * @param data - The raw response data from the API.
     * @returns An instance of B2CResponse.
     */
    static fromApiResponse(data: B2CResponseType): B2CResponse {
        return new B2CResponse(
            data.ConversationID,
            data.OriginatorConversationID,
            data.ResponseCode,
            data.ResponseDescription
        );
    }
 
    /**
     * Determines if the response indicates success.
     * @returns True if the response was successful, false otherwise.
     */
    isSuccess(): boolean {
        return this.ResponseCode === '0';
    }
 
    /**
     * Returns a formatted string for logging or displaying the response.
     * @returns A formatted string summarizing the response.
     */
    toString(): string {
        return `B2C Response: ${this.ResponseDescription} (Code: ${this.ResponseCode})`;
    }
}