paystack-sdk/dist/customer/interface.d.ts

Paystack SDK written in Typescript

import { Authorization } from '../charge/interface';
import { Meta } from '../interface';
import { SubAccount } from '../subaccounts/subaccount';
import { Subscription } from '../subscription/interface';
import { Transaction } from '../transaction/interface';
export interface CreateCustomer {
    email: string;
    first_name: string;
    last_name: string;
    phone?: string;
    metadata?: Record<string, unknown>;
}
export interface Response {
    status: boolean;
    message: string;
}
export interface Customer {
    id: number;
    transactions: Transaction[];
    subscriptions: Subscription[];
    authorizations: Authorization[];
    first_name: string;
    last_name: string;
    email: string;
    phone?: string;
    metadata?: Record<string, unknown>;
    domain: string;
    customer_code: string;
    risk_action: string;
    international_format_phone?: string;
    integration: number;
    createdAt: Date;
    updatedAt: Date;
    identified: boolean;
    identifications: CustomerIdentification[];
    dedicated_account: DedicatedAccount[];
}
export interface CustomerCreated extends Response {
    data: Customer;
}
export interface FetchCustomerResponse extends Response {
    data: Customer;
}
export interface ListCustomersResponse extends Response {
    data: Customer[];
    meta: Meta;
}
export interface ListCustomerQueryParams {
    /**
     * Specify how many records you want to retrieve per page.
     * If not specify we use a default value of 50.
     */
    perPage?: number;
    /**
     * Specify exactly what page you want to retrieve.
     * If not specify we use a default value of 1.
     */
    page?: number;
    /**
     * Specify an ID for the customer whose transactions
     * you want to retrieve
     */
    customer?: number;
    /**
     * Filter transactions by status ('failed', 'success', 'abandoned')
     */
    status?: string;
    /**
     * A timestamp from which to start listing transaction
     * e.g `2021-10-25T00.00.05.000z`, `2021-12-25`
     */
    from?: Date;
    /**
     * A timestamp from which to stop listing transaction
     * e.g `2021-10-25T00.00.05.000z`, `2021-12-25`
     */
    to?: Date;
}
export interface SplitConfig {
    id: number;
    name: string;
    type: string;
    currency: string;
    integration: number;
    domain: string;
    split_code: string;
    active: boolean;
    bearer_type: string;
    bearer_subaccount: string | null;
    createdAt: Date;
    updatedAt: Date;
    is_dynamic: boolean;
    subaccounts: CustomerSubAccount[];
    total_subaccounts: number;
}
export interface CustomerSubAccount {
    subaccount: SubAccount;
    share: number;
}
export interface CustomerIdentification {
    country: string;
    type: string;
    value: string;
}
export interface DedicatedAccount {
    bank: {
        name: string;
        id: number;
        slug: string;
    };
    id: number;
    account_name: string;
    account_number: string;
    created_at: Date;
    updated_at: Date;
    currency: string;
    split_config: SplitConfig;
    active: boolean;
    assigned: boolean;
    assignment: {
        assignee_id: number;
        assignee_type: string;
        account_type: string;
        integration: number;
    };
}
export interface UpdateCustomer {
    first_name: string;
    last_name: string;
    email: string;
    phone?: string;
    metadata?: Record<string, unknown>;
}
export interface SetRiskAction {
    customer: string;
    risk_action: RiskAction;
}
export interface ValidateCustomer {
    first_name: string;
    last_name: string;
    type: ValidationType;
    value: string;
    country: string;
    bvn: string;
    bank_code: string;
    account_number: string;
}
declare enum RiskAction {
    default = 0,
    allow = 1,
    deny = 2
}
declare enum ValidationType {
    bvn = 0,
    bank_account = 1
}
export interface ICustomer {
    integration: number;
    first_name: string;
    last_name: string;
    email: string;
    phone: string | null;
    dedicated_account: DedicatedAccount | null;
    identified: boolean;
    identifications: CustomerIdentification[] | null;
    metadata: Record<string, unknown> | null;
    domain: string;
    customer_code: string;
    id: string;
    transactions: Transaction[];
    subscriptions: Subscription[];
    authorizations: Authorization[];
    createdAt: Date;
    updatedAt: Date;
}
export {};