All files / src/models C2BUrlResponse.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                                                1x   2x 2x 2x 2x                 2x                         2x                      
/**
 * Represents the response from the Register URL API.
 */
export type RegisterUrlResponseType = {
    responseCode: string;
    responseMessage: string;
    customerMessage: string;
    timestamp: string;
};
 
/**
 * Represents the payload required for the Register URL request.
 */
export type RegisterUrlPayloadType = {
    ShortCode: number;
    ResponseType: 'Canceled' | 'Completed';
    CommandID: 'RegisterURL';
    ValidationURL: string;
    ConfirmationURL: string;
};
 
/**
 * Represents the response object from the Register URL API.
 */
export class RegisterUrlResponse {
    constructor(
        public responseCode: string,
        public responseMessage: string,
        public customerMessage: string,
        public timestamp: string
    ) { }
 
    /**
     * Factory method to create an instance from API response data.
     * @param data - The raw response data from the API.
     * @returns An instance of RegisterUrlResponse.
     */
    static fromApiResponse(data: RegisterUrlResponseType): RegisterUrlResponse {
        return new RegisterUrlResponse(
            data.responseCode,
            data.responseMessage,
            data.customerMessage,
            data.timestamp
        );
    }
 
    /**
     * Determines if the response indicates success.
     * @returns True if the response was successful, false otherwise.
     */
    isSuccess(): boolean {
        return this.responseCode === '200';
    }
 
    /**
     * Returns a formatted string summarizing the response.
     * @returns A formatted string.
     */
    toString(): string {
        return `Register URL Response: ${this.responseMessage} (Code: ${this.responseCode})`;
    }
}