node-billplz/index.d.ts at master · Akim95/node-billplz · GitHub

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
68
69
70
71
72
73
74
75
76
77
78
// Type definitions for billplz 1.0.2
// Project: https://github.com/suhz/node-billplz
// Definitions by: Akim <https://github.com/Akim95>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

declare namespace Billplz {
    // api options type
    interface BillplzOptions {
        key: string;
        endpoint?: string;
        sandbox?: boolean;
    }

    // collection type
    interface CollectionArguments {
        title: string;
    }

    // open collection type
    interface OpenCollectionArguments {
        title: string;
        description: string;
        amount: number;
        fixed_amount?: boolean;
        fixed_quantity?: boolean;
        payment_button?: string;
        reference_1_label?: string
        reference_2_label?: string;
        email_link?: string;
        tax?: number;
    }

    // bill type
    interface BillArguments {
        collection_id: string;
        email: string;
        mobile: number;
        name: string;
        amount: number;
        callback_url: string;
        description: string;
        due_at?: string;
        redirect_url?: string;
        deliver?: boolean;
        reference_1_label?: string;
        reference_1?: string;
        reference_2_label?: string;
        reference_2?: string;
    }
}

declare class Billplz {
    // constructor
    constructor(options: string | Billplz.BillplzOptions);

    // create_collection
    create_collection(title: Billplz.CollectionArguments, callback?: (res: any, err: any) => void): void;

    // create collectionOpen
    create_collectionOpen(args: Billplz.OpenCollectionArguments, callback?: (res: any, err: any) => void): void;

    // create bill
    create_bill(args: Billplz.BillArguments, callback?: (res: any, err: any) => void): void;

    // get bill
    get_bill(billId: string, callback?: (res: any, err: any) => void): void;

    // delete bill
    delete_bill(billId: string, callback?: (res: any, err: any) => void): void;

    // change_collection status
    change_collection_status(collectionId: string, status: string, callback?: (res: any, err: any) => void): void;

    // registration check
    registration_check(bankAccountNumber: string, callback?: (res: any, err: any) => void): void;
}

export = Billplz;