starkbank/types/merchantSession/merchantSession.d.ts

SDK to facilitate Node integrations with Stark Bank

declare module 'starkbank' {

    export class MerchantSession {
        allowedFundingTypes: string[]
        allowedInstallments: {totalAmount: number, count: number}[]
        expiration: number
        holderId?: string
        softDescriptor?: string
        
        readonly id : string
        readonly allowedIps: string[]
        readonly challengeMode: string
        readonly created: string
        readonly status: string
        readonly tags: string[]
        readonly updated: string
        readonly uuid: string

        constructor(params: {allowedFundingTypes: string[], allowedInstallments: {totalAmount: number, count: number}[], id : string, expiration: number, allowedIps: string, challengeMode: string, created: string, status: string, tags: string[], updated: string, uuid: string, holderId?: string, softDescriptor?: string})
    }

    export namespace merchantSession {

        function create(
            MerchantSession: MerchantSession,
            params?: { user: Project | Organization | null }
        ): Promise<MerchantSession>;

        function purchase(
            uuid: string,
            Purchase: MerchantSession.Purchase,
            params?: { user: Project | Organization | null }
        ): any;

        function get(id: string, params?:{ user?: Project | Organization | null}): Promise<MerchantSession>;

        function page(params?: { 
            cursor?: string | null, 
            limit?: number | null, 
            after?: string | null, 
            before?: string | null, 
            status?: string | null, 
            tags?: string[] | null, 
            ids?: string[] | null, 
            holderId?: string | null, 
            user?: Project | Organization | null
        }): Promise<[MerchantSession[], string | null]>;

        function query(params?: { 
            limit?: number | null, 
            after?: string | null, 
            before?: string | null, 
            status?: string | null, 
            tags?: string[] | null, 
            ids?: string[] | null, 
            holderId?: string | null, 
            user?: Project | Organization | null
        }): Promise<MerchantSession[]>;

        export class Purchase {
            amount : number
            cardExpiration : string
            cardNumber : string
            cardSecurityCode : string
            fundingType : string
            holderName : string
            billingCity : string
            billingCountryCode : string
            billingStateCode : string
            billingStreetLine1 : string
            billingStreetLine2 : string
            billingZipCode : string
            holderEmail : string 
            holderPhone : string 
            metadata : Record<string, any>
            installmentCount : number
            holderId : string
            softDescriptor : string

            constructor(params: {
                amount: number, cardExpiration: string, cardNumber: string, cardSecurityCode: string, fundingType: string, holderName: string,
                billingCity?: string | null, billingCountryCode?: string | null, billingStateCode?: string | null, billingStreetLine1?: string | null,
                billingStreetLine2?: string | null, billingZipCode?: string | null, holderEmail?: string | null, holderPhone?: string | null,
                metadata?: Record<string, any> | null, installmentCount?: number | null, holderId?: string, softDescriptor?: string,
            })
        }

        export class Log {
            readonly id : string
            readonly purchase : MerchantSession
            readonly errors: string[]
            readonly type : string
            readonly created : string

            constructor(id: string, purchase: Invoice, errors: string[], type: string, created: string)
        }

        namespace log {

            function get(id: string, params?:{ user?: Project | Organization | null}): Promise<merchantSession.Log>;

            function page(params?: { 
                cursor?: string | null, 
                limit?: number | null, 
                after?: string | null, 
                before?: string | null, 
                types?: string[] | null, 
                user?: Project | Organization | null
            }): Promise<[merchantSession.Log[], string | null]>;

            function query(params?: { 
                limit?: number | null, 
                after?: string | null, 
                before?: string | null, 
                types?: string[] | null, 
                user?: Project | Organization | null
            }): Promise<merchantSession.Log[]>;
        }
    }
}