@inkress/admin-sdk 1.0.0 → 1.1.0

package/dist/types.d.ts

@@ -1,12 +1,38 @@
+import type { FeeStructureKey, KindKey, StatusKey } from './utils/translators';
+/**
+ * IMPORTANT: Types have been updated to match the database schema:
+ *
+ * 1. Field naming: Uses `inserted_at` and `updated_at` (not `created_at`)
+ * 2. Filtering: All list operations support filtering on any database field
+ * 3. Immutable fields: `id`, `uid`, `inserted_at`, and `updated_at` are never included in Create/Update types
+ * 4. Status/Kind values: Use contextual string codes (e.g., 'confirmed' instead of 'order_confirmed')
+ * 5. Fee structures: Use string codes that are automatically translated to integers
+ * 6. Translation: All status, kind, and fee structure fields accept contextual strings and return contextual strings
+ */
+export type OrderStatus = 'pending' | 'error' | 'paid' | 'partial' | 'confirmed' | 'cancelled' | 'prepared' | 'shipped' | 'delivered' | 'completed' | 'returned' | 'refunded' | 'verifying' | 'stale' | 'archived';
+export type OrderKind = 'online' | 'payment_link' | 'cart' | 'subscription' | 'invoice' | 'offline';
+export type ProductStatus = 'draft' | 'published' | 'archived';
+export type ProductKind = 'draft' | 'published' | 'archived';
+export type AccountStatus = 'pending' | 'approved' | 'suspended' | 'rejected' | 'disabled';
+export type UserKind = 'address' | 'preset' | 'organisation' | 'store';
+export type SubscriptionStatus = 'pending' | 'active' | 'cancelled' | 'adhoc_charged';
+export type TransactionStatus = 'pending' | 'authorized' | 'hold' | 'captured' | 'voided' | 'refunded' | 'processed';
+export type BillingPlanKind = 'subscription' | 'payout';
+export type BillingStatus = 'active' | 'inactive';
+export type CategoryKind = ProductKind;
+export type KycKind = 'document_submission' | 'bank_info_update' | 'limit_increase';
+export type KycStatus = 'pending' | 'in_review' | 'approved' | 'rejected';
+export type { QueryParams, RangeQuery, StringQuery, DateQuery, JsonQueryParams } from './utils/query-transformer';
+export type { OrderQueryParams, ProductQueryParams, CategoryQueryParams, UserQueryParams, MerchantQueryParams, BillingPlanQueryParams, SubscriptionQueryParams, } from './types/resources';
 export interface InkressConfig {
-    /** Bearer token for authentication */
-    bearerToken: string;
-    /** API endpoint URL */
-    endpoint?: string;
+    /** Access token for authentication */
+    accessToken: string;
+    /** API mode - 'live' (https://api.inkress.com) or 'sandbox' (https://api-dev.inkress.com) */
+    mode?: 'live' | 'sandbox';
     /** API version */
     apiVersion?: string;
-    /** Client ID for request identification (format: m-{merchant.username}) */
-    clientId?: string;
+    /** Merchant username (will be prepended with 'm-' for client ID) */
+    username?: string;
     /** Request timeout in milliseconds */
     timeout?: number;
     /** Number of retry attempts */
@@ -17,8 +43,24 @@ export interface InkressConfig {
 export interface PaginationParams {
     page?: number;
     per_page?: number;
+    page_size?: number;
     sort?: string;
     order?: 'asc' | 'desc';
+    order_by?: string;
+    limit?: number;
+}
+export interface BaseFilterParams extends PaginationParams {
+    /** General search query - searches across multiple fields automatically */
+    q?: string;
+    /** Legacy search field - use 'q' instead for new implementations */
+    search?: string;
+    /** Exclude specific records */
+    exclude?: string | number;
+    /** Return distinct values */
+    distinct?: string;
+    /** Override page behavior */
+    override_page?: string | boolean;
+    [key: string]: any;
 }
 export interface PaginatedResponse<T> {
     data: T[];
@@ -31,12 +73,11 @@ export interface PaginatedResponse<T> {
 }
 export interface ApiResponse<T = any> {
     state: 'ok' | 'error';
-    data?: T;
     result?: T;
 }
 export interface ErrorResponse {
     state: 'error';
-    data: {
+    result: {
         result: string;
     } | {
         reason: string;
@@ -44,26 +85,90 @@ export interface ErrorResponse {
 }
 export interface ValidationError {
     state: 'error';
-    data: Record<string, string[]>;
+    result: Record<string, string[]>;
 }
 export interface Currency {
     id: number;
     code: string;
     symbol: string;
     name: string;
+    flag?: string;
+    is_float: boolean;
+    inserted_at?: string;
+    updated_at?: string;
+}
+export interface CreateCurrencyData {
+    code: string;
+    symbol: string;
+    name: string;
+    flag?: string;
+    is_float: boolean;
+}
+export interface UpdateCurrencyData {
+    code?: string;
+    symbol?: string;
+    name?: string;
+    flag?: string;
+    is_float?: boolean;
 }
 export interface Organisation {
     id: number;
+    uid: string;
     name: string;
-    description: string;
+    email?: string;
+    phone?: string;
+    about?: string;
+    logo?: string;
+    business_type?: string;
+    status: AccountStatus;
+    timezone?: string;
+    data?: Record<string, any>;
+    domain_id?: number;
+    owner_id?: number;
+    default_merchant_id?: number;
+    inserted_at: string;
+    updated_at: string;
 }
 export interface Address {
-    address: string;
-    address2?: string;
+    id?: number;
+    hash?: string;
+    kind: number;
+    kind_id: number;
+    lang?: number;
+    lat?: number;
+    street: string;
+    street_optional?: string;
     city: string;
-    state?: string;
-    postal_code: string;
+    state: string;
+    country: string;
+    region: string;
+    town: string;
+    inserted_at?: string;
+    updated_at?: string;
+}
+export interface CreateAddressData {
+    kind: number;
+    kind_id: number;
+    lang?: number;
+    lat?: number;
+    street: string;
+    street_optional?: string;
+    city: string;
+    state: string;
     country: string;
+    region: string;
+    town: string;
+}
+export interface UpdateAddressData {
+    lang?: number;
+    lat?: number;
+    street?: string;
+    street_optional?: string;
+    city?: string;
+    state?: string;
+    country?: string;
+    region?: string;
+    town?: string;
 }
 export interface Merchant {
     id: number;
@@ -73,64 +178,94 @@ export interface Merchant {
     about?: string;
     logo?: string;
     sector?: string;
-    status: number;
+    status: AccountStatus;
     phone?: string;
     business_type?: string;
     theme_colour?: string;
     uid: string;
-    is_pre_verified: boolean;
-    webhook_url?: string;
-    plan_id?: number;
-    payment_provider_plan_id?: number;
-    platform_fee_structure: 'customer_pay' | 'merchant_absorb';
-    provider_fee_structure: 'customer_pay' | 'merchant_absorb';
-    address?: {
-        street?: string;
-        street_optional?: string;
-        town?: string;
-        city?: string;
-        province?: string;
-        region?: string;
-    };
-    data?: {
-        pickup_locations?: Array<{
-            name: string;
-            address: string;
-        }>;
-        support_phone?: string;
-        support_email?: string;
-        business_setup?: string;
-        bank_info?: {
-            account_holder_name?: string;
-            account_holder_type?: 'Business' | 'Individual';
-            account_number?: string;
-            account_type?: 'Checking' | 'Savings';
-            bank_name?: string;
-            branch_name?: string;
-            branch_code?: string;
-            routing_number?: string;
-            swift_code?: string;
-        };
-        registration_webhook?: string;
-    };
-    organisation?: Organisation;
-    domain?: {
-        cname?: string;
-    };
-    created_at: string;
+    address_id?: number;
+    owner_id?: number;
+    domain_id?: number;
+    organisation_id?: number;
+    platform_fee_structure: FeeStructureKey;
+    provider_fee_structure: FeeStructureKey;
+    parent_merchant_id?: number;
+    data?: Record<string, any>;
+    inserted_at: string;
     updated_at: string;
+    address?: Address;
+    owner?: User;
+    organisation?: Organisation;
+    parent_merchant?: Merchant;
 }
 export interface CreateMerchantData {
     name: string;
     email: string;
     phone?: string;
     about?: string;
+    username?: string;
+    logo?: string;
+    sector?: string;
+    business_type?: string;
+    theme_colour?: string;
+    address_id?: number;
+    owner_id?: number;
+    domain_id?: number;
+    organisation_id?: number;
+    platform_fee_structure?: FeeStructureKey;
+    provider_fee_structure?: FeeStructureKey;
+    parent_merchant_id?: number;
+    data?: Record<string, any>;
 }
 export interface UpdateMerchantData {
     name?: string;
     email?: string;
     phone?: string;
     about?: string;
+    username?: string;
+    logo?: string;
+    sector?: string;
+    status?: AccountStatus;
+    business_type?: string;
+    theme_colour?: string;
+    address_id?: number;
+    owner_id?: number;
+    domain_id?: number;
+    organisation_id?: number;
+    platform_fee_structure?: FeeStructureKey;
+    provider_fee_structure?: FeeStructureKey;
+    parent_merchant_id?: number;
+    data?: Record<string, any>;
+}
+export interface MerchantBalance {
+    available: number;
+    pending: number;
+    currency: string;
+}
+export interface MerchantLimits {
+    transaction_limit: number;
+    daily_limit: number;
+    monthly_limit: number;
+    currency: string;
+}
+export interface MerchantSubscription {
+    plan_name: string;
+    status: string;
+    billing_cycle: string;
+    price: number;
+    currency: string;
+    features: string[];
+    next_billing_date?: string;
+}
+export interface MerchantInvoice {
+    id: string;
+    invoice_number: string;
+    amount: number;
+    currency: string;
+    status: string;
+    due_date: string;
+    issued_date: string;
+    paid_date?: string;
 }
 export interface PublicMerchant {
     id: number;
@@ -147,28 +282,26 @@ export interface Category {
     id: number;
     name: string;
     description?: string | null;
-    kind: number;
+    kind: CategoryKind;
     kind_id?: number | null;
     parent_id?: number | null;
-    parent?: {
-        id: number;
-        name: string;
-    } | null;
-    children?: {
-        id: number;
-        name: string;
-    }[];
-    created_at: string;
+    uid: string;
+    inserted_at: string;
     updated_at: string;
+    parent?: Category;
 }
 export interface CreateCategoryData {
     name: string;
     description?: string;
-    kind: number;
+    kind: CategoryKind;
     kind_id?: number;
     parent_id?: number;
 }
-export interface UpdateCategoryData extends Partial<Omit<CreateCategoryData, 'parent_id'>> {
+export interface UpdateCategoryData {
+    name?: string;
+    description?: string;
+    kind?: KindKey;
+    kind_id?: number;
 }
 export interface Product {
     id: number;
@@ -177,7 +310,7 @@ export interface Product {
     price: number;
     permalink: string;
     image?: string | null;
-    status: number;
+    status: ProductStatus;
     public: boolean;
     unlimited: boolean;
     units_remaining?: number | null;
@@ -187,12 +320,15 @@ export interface Product {
     tag_ids: number[];
     data?: Record<string, any>;
     meta?: Record<string, any>;
-    currency: Currency;
-    category?: Category;
-    merchant: Merchant;
-    organisation: Organisation;
-    created_at: string;
+    uid: string;
+    category_id?: number;
+    currency_id?: number;
+    user_id?: number;
+    inserted_at: string;
     updated_at: string;
+    category?: Category;
+    currency?: Currency;
+    user?: User;
 }
 export interface CreateProductData {
     title: string;
@@ -206,34 +342,54 @@ export interface CreateProductData {
     tag_ids?: number[];
     data?: Record<string, any>;
     meta?: Record<string, any>;
+    category_id?: number;
+    currency_id?: number;
+    user_id?: number;
 }
-export interface UpdateProductData extends Partial<CreateProductData> {
-    status?: number;
+export interface UpdateProductData {
+    title?: string;
+    teaser?: string;
+    price?: number;
+    permalink?: string;
+    image?: string;
+    status?: StatusKey;
+    public?: boolean;
+    unlimited?: boolean;
+    units_remaining?: number;
+    tag_ids?: number[];
+    data?: Record<string, any>;
+    meta?: Record<string, any>;
+    category_id?: number;
+    currency_id?: number;
+    user_id?: number;
 }
 export interface Order {
     id: number;
     reference_id?: string;
     total: number;
-    kind: number;
-    status: number;
+    kind: OrderKind;
+    status: OrderStatus;
     status_on: number;
     uid: string;
     cart_id?: number | null;
-    customer?: Customer;
-    currency: Currency;
-    billing_plan?: any | null;
-    order_detail?: Record<string, any>;
-    transactions?: any[];
-    payment_methods?: PaymentMethod[];
-    order_lines: OrderLine[];
-    merchant: Merchant;
-    organisation: Organisation;
-    payment_urls?: {
-        short_link: string;
-    };
+    currency_id?: number;
+    customer_id?: number;
+    payment_link_id?: number;
+    billing_plan_id?: number;
+    billing_subscription_id?: number;
     meta_data?: Record<string, any>;
-    created_at: string;
+    session_id?: string;
+    data?: Record<string, any>;
+    inserted_at: string;
     updated_at: string;
+    currency?: Currency;
+    customer?: Customer;
+    payment_link?: PaymentLink;
+    billing_plan?: BillingPlan;
+    billing_subscription?: Subscription;
+    order_lines?: OrderLine[];
+    merchant?: Merchant;
+    organisation?: Organisation;
 }
 export interface OrderLine {
     product_id: number;
@@ -243,13 +399,34 @@ export interface OrderLine {
 export interface CreateOrderData {
     reference_id?: string;
     total: number;
-    kind?: number;
-    order_lines: OrderLine[];
+    kind?: OrderKind | KindKey | number;
+    status?: OrderStatus | StatusKey | number;
+    status_on?: number;
+    cart_id?: number;
+    currency_id?: number;
+    customer_id?: number;
+    payment_link_id?: number;
+    billing_plan_id?: number;
+    billing_subscription_id?: number;
     meta_data?: Record<string, any>;
+    session_id?: string;
+    data?: Record<string, any>;
 }
 export interface UpdateOrderData {
-    status?: number;
+    reference_id?: string;
+    total?: number;
+    kind?: OrderKind | KindKey | number;
+    status?: OrderStatus | StatusKey | number;
+    status_on?: number;
+    cart_id?: number;
+    currency_id?: number;
+    customer_id?: number;
+    payment_link_id?: number;
+    billing_plan_id?: number;
+    billing_subscription_id?: number;
     meta_data?: Record<string, any>;
+    session_id?: string;
+    data?: Record<string, any>;
 }
 export interface OrderStats {
     [key: string]: any;
@@ -257,9 +434,26 @@ export interface OrderStats {
 export interface PaymentMethod {
     id: number;
     name: string;
-    code: string;
-    provider: string;
+    code?: string;
+    provider?: string;
     active: boolean;
+    payment_provider_id: number;
+    financial_account_id?: number;
+    inserted_at: string;
+    updated_at: string;
+    financial_account?: FinancialAccount;
+}
+export interface CreatePaymentMethodData {
+    name: string;
+    payment_provider_id: number;
+    financial_account_id?: number;
+    active?: boolean;
+}
+export interface UpdatePaymentMethodData {
+    name?: string;
+    payment_provider_id?: number;
+    financial_account_id?: number;
+    active?: boolean;
 }
 export interface Customer {
     id: number;
@@ -268,137 +462,526 @@ export interface Customer {
     last_name?: string;
     name?: string;
     phone?: string;
-    created_at: string;
-    metadata?: Record<string, any>;
+    uid?: string;
+    dob?: number;
+    sex?: number;
+    image?: string;
+    status?: number;
+    level?: number;
+    data?: Record<string, any>;
+    merchant_id?: number;
+    organisation_id?: number;
+    inserted_at: string;
+    updated_at: string;
+    merchant?: Merchant;
+    organisation?: Organisation;
 }
-export interface BillingPlan {
+export interface PaymentLink {
     id: number;
-    name: string;
+    uid: string;
+    title: string;
     description?: string;
-    flat_rate: number;
-    transaction_fee: number;
-    transaction_percentage: number;
-    transaction_percentage_additional: number;
-    transaction_minimum_fee: number;
-    minimum_fee: number;
-    duration: number;
-    status: number;
-    billing_cycle: number;
-    trial_period: number;
-    charge_strategy: number;
-    kind: number;
-    auto_charge: boolean;
-    currency: Currency;
-    features?: string[];
+    total: number;
+    usage_limit: number;
+    expires_at?: string;
+    status: StatusKey;
+    kind: KindKey;
+    data?: Record<string, any>;
+    customer_id?: number;
+    currency_id: number;
+    order_id?: number;
+    inserted_at: string;
+    updated_at: string;
+    customer?: Customer;
+    currency?: Currency;
+    order?: Order;
 }
-export interface CreateBillingPlanData {
-    name: string;
+export interface CreatePaymentLinkData {
+    title: string;
     description?: string;
-    flat_rate: number;
-    transaction_fee: number;
-    transaction_percentage: number;
-    transaction_percentage_additional?: number;
-    transaction_minimum_fee?: number;
-    minimum_fee?: number;
-    duration: number;
-    billing_cycle: number;
-    trial_period?: number;
-    charge_strategy?: number;
+    total?: number;
+    usage_limit?: number;
+    expires_at?: string;
+    status?: number;
     kind?: number;
-    auto_charge?: boolean;
+    data?: Record<string, any>;
+    customer_id?: number;
     currency_id: number;
-    features?: string[];
+    order_id?: number;
 }
-export interface UpdateBillingPlanData extends Partial<CreateBillingPlanData> {
+export interface UpdatePaymentLinkData {
+    title?: string;
+    description?: string;
+    total?: number;
+    usage_limit?: number;
+    expires_at?: string;
     status?: number;
+    kind?: number;
+    data?: Record<string, any>;
+    customer_id?: number;
+    currency_id?: number;
+    order_id?: number;
 }
-export interface Subscription {
+export interface FinancialAccount {
     id: number;
-    status: number;
-    kind: number;
-    current_period_start: string;
-    current_period_end: string;
-    trial_end?: string;
-    canceled_at?: string;
-    start_date: string;
-    end_date?: string;
+    name: string;
+    type: string;
+    provider: string;
+    is_external: boolean;
+    fingerprint?: string;
+    data?: Record<string, any>;
     record: string;
     record_id: number;
-    customer_id?: number;
-    uid: string;
-    token?: string;
-    billing_plan_id: number;
-    has_token: boolean;
-    billing_plan: BillingPlan;
-    subscription_periods?: SubscriptionPeriod[];
+    active: boolean;
+    code?: string;
+    adapter?: string;
+    logo?: string;
+    website?: string;
+    inserted_at: string;
+    updated_at: string;
 }
-export interface CreateSubscriptionData {
-    billing_plan_id: number;
+export interface CreateFinancialAccountData {
+    name: string;
+    type: string;
+    provider: string;
+    is_external?: boolean;
+    fingerprint?: string;
+    data?: Record<string, any>;
     record: string;
     record_id: number;
-    start_date: string;
-    end_date?: string;
-    status: number;
+    active?: boolean;
+    code?: string;
+    adapter?: string;
+    logo?: string;
+    website?: string;
 }
-export interface SubscriptionPeriod {
+export interface UpdateFinancialAccountData {
+    name?: string;
+    type?: string;
+    provider?: string;
+    is_external?: boolean;
+    fingerprint?: string;
+    data?: Record<string, any>;
+    active?: boolean;
+    code?: string;
+    adapter?: string;
+    logo?: string;
+    website?: string;
+}
+export interface FinancialRequest {
     id: number;
-    subscription_id: string;
-    start_date: string;
-    end_date: string;
-    amount: number;
-    currency: Currency;
-    status: 'pending' | 'paid' | 'failed' | 'cancelled';
-    charged_at?: string;
-    created_at: string;
-    metadata?: Record<string, any>;
+    total: number;
+    status: number;
+    type: number;
+    sub_type?: number;
+    fee_total: number;
+    reference_id?: string;
+    reviewed_at?: string;
+    due_at?: string;
+    balance_on_request: number;
+    data?: Record<string, any>;
+    source_id?: number;
+    destination_id?: number;
+    merchant_id: number;
+    requester_id: number;
+    reviewer_id?: number;
+    currency_id: number;
+    evidence_file_id?: number;
+    inserted_at: string;
+    updated_at: string;
+    source?: FinancialAccount;
+    destination?: FinancialAccount;
+    merchant?: Merchant;
+    requester?: User;
+    reviewer?: User;
+    currency?: Currency;
 }
-export interface SubscriptionLinkData {
-    uid: string;
-    token: string;
+export interface CreateFinancialRequestData {
+    total: number;
+    type: number;
+    sub_type?: number;
+    reference_id?: string;
+    due_at?: string;
+    data?: Record<string, any>;
+    source_id?: number;
+    destination_id?: number;
+    currency_id: number;
+    evidence_file_id?: number;
 }
-export interface SubscriptionChargeData {
-    amount?: number;
-    description?: string;
+export interface UpdateFinancialRequestData {
+    total?: number;
+    status?: number;
+    type?: number;
+    sub_type?: number;
+    fee_total?: number;
+    reference_id?: string;
+    reviewed_at?: string;
+    due_at?: string;
+    data?: Record<string, any>;
+    source_id?: number;
+    destination_id?: number;
+    reviewer_id?: number;
+    currency_id?: number;
+    evidence_file_id?: number;
 }
-export interface User {
+export interface WebhookUrl {
     id: number;
-    email: string;
-    phone?: string;
-    first_name?: string;
-    last_name?: string;
-    username?: string;
-    status: number;
-    level: number;
-    dob?: number | null;
-    sex?: number | null;
-    image?: string | null;
+    url: string;
+    event: string;
     uid: string;
-    role?: {
-        id: number;
-        name: string;
-    };
-    organisation?: Organisation;
-    merchant?: Merchant;
-    created_at: string;
+    merchant_id?: number;
+    org_id?: number;
+    inserted_at: string;
     updated_at: string;
+    merchant?: Merchant;
+    organisation?: Organisation;
 }
-export interface CreateUserData {
-    email: string;
-    phone?: string;
-    first_name?: string;
-    last_name?: string;
-    username?: string;
-    password: string;
-    role_id?: number;
+export interface CreateWebhookUrlData {
+    url: string;
+    event: string;
+    merchant_id?: number;
+    org_id?: number;
 }
-export interface UpdateUserData {
-    email?: string;
-    phone?: string;
-    first_name?: string;
+export interface UpdateWebhookUrlData {
+    url?: string;
+    event?: string;
+    merchant_id?: number;
+    org_id?: number;
+}
+export interface Token {
+    id: number;
+    public_key: string;
+    title?: string;
+    provider: string;
+    kind: number;
+    enabled: boolean;
+    expires?: number;
+    user_id: number;
+    role_id?: number;
+    inserted_at: string;
+    updated_at: string;
+    user?: User;
+}
+export interface CreateTokenData {
+    title?: string;
+    provider: string;
+    kind: number;
+    enabled?: boolean;
+    expires?: number;
+    user_id: number;
+    role_id?: number;
+}
+export interface UpdateTokenData {
+    title?: string;
+    enabled?: boolean;
+    expires?: number;
+    role_id?: number;
+}
+export interface ExchangeRate {
+    id: number;
+    source_id: number;
+    destination_id: number;
+    rate: number;
+    expires?: number;
+    source?: string;
+    user_id?: number;
+    inserted_at: string;
+    updated_at: string;
+    source_currency?: Currency;
+    destination_currency?: Currency;
+    user?: User;
+}
+export interface CreateExchangeRateData {
+    source_id: number;
+    destination_id: number;
+    rate: number;
+    expires?: number;
+    source?: string;
+    user_id?: number;
+}
+export interface UpdateExchangeRateData {
+    rate?: number;
+    expires?: number;
+    source?: string;
+}
+export interface Fee {
+    id: number;
+    title?: string;
+    total: number;
+    unit: number;
+    kind: number;
+    priority: number;
+    compound: boolean;
+    fee_payer: number;
+    currency_code?: string;
+    hash?: string;
+    fee_set_id?: number;
+    currency_id?: number;
+    user_id?: number;
+    inserted_at: string;
+    updated_at: string;
+    currency?: Currency;
+    user?: User;
+}
+export interface CreateFeeData {
+    title?: string;
+    total: number;
+    unit: number;
+    kind: number;
+    priority?: number;
+    compound?: boolean;
+    fee_payer?: number;
+    currency_code?: string;
+    fee_set_id?: number;
+    currency_id?: number;
+    user_id?: number;
+}
+export interface UpdateFeeData {
+    title?: string;
+    total?: number;
+    unit?: number;
+    kind?: number;
+    priority?: number;
+    compound?: boolean;
+    fee_payer?: number;
+    currency_code?: string;
+    fee_set_id?: number;
+    currency_id?: number;
+    user_id?: number;
+}
+export interface TransactionEntry {
+    id: number;
+    amount: number;
+    type: number;
+    transaction_id: number;
+    financial_account_id: number;
+    inserted_at: string;
+    updated_at: string;
+    financial_account?: FinancialAccount;
+}
+export interface CreateTransactionEntryData {
+    amount: number;
+    type: number;
+    transaction_id: number;
+    financial_account_id: number;
+}
+export interface UpdateTransactionEntryData {
+    amount?: number;
+    type?: number;
+    transaction_id?: number;
+    financial_account_id?: number;
+}
+export interface GenericResource {
+    id: number;
+    [key: string]: any;
+    inserted_at?: string;
+    updated_at?: string;
+}
+export interface BillingPlan {
+    id: number;
+    name: string;
+    description?: string;
+    flat_rate: number;
+    transaction_fee: number;
+    transaction_percentage: number;
+    transaction_percentage_additional: number;
+    transaction_minimum_fee: number;
+    minimum_fee: number;
+    duration: number;
+    status: StatusKey;
+    billing_cycle?: number;
+    trial_period: number;
+    charge_strategy: number;
+    kind: BillingPlanKind;
+    auto_charge: boolean;
+    public: boolean;
+    payout_period: number;
+    payout_value_limit: number;
+    payout_percentage_limit: number;
+    features?: Record<string, any>;
+    data?: Record<string, any>;
+    meta_data?: Record<string, any>;
+    uid: string;
+    currency_id: number;
+    payment_provider_id?: number;
+    inserted_at: string;
+    updated_at: string;
+    currency?: Currency;
+}
+export interface CreateBillingPlanData {
+    name: string;
+    description?: string;
+    flat_rate: number;
+    transaction_fee: number;
+    transaction_percentage: number;
+    transaction_percentage_additional?: number;
+    transaction_minimum_fee?: number;
+    minimum_fee?: number;
+    duration: number;
+    billing_cycle?: number;
+    trial_period?: number;
+    charge_strategy?: number;
+    kind?: BillingPlanKind | KindKey | number;
+    auto_charge?: boolean;
+    public?: boolean;
+    payout_period?: number;
+    payout_value_limit?: number;
+    payout_percentage_limit?: number;
+    features?: Record<string, any>;
+    data?: Record<string, any>;
+    meta_data?: Record<string, any>;
+    currency_id: number;
+    payment_provider_id?: number;
+}
+export interface UpdateBillingPlanData {
+    name?: string;
+    description?: string;
+    flat_rate?: number;
+    transaction_fee?: number;
+    transaction_percentage?: number;
+    transaction_percentage_additional?: number;
+    transaction_minimum_fee?: number;
+    minimum_fee?: number;
+    duration?: number;
+    status?: StatusKey;
+    billing_cycle?: number;
+    trial_period?: number;
+    charge_strategy?: number;
+    kind?: BillingPlanKind | KindKey | number;
+    auto_charge?: boolean;
+    public?: boolean;
+    payout_period?: number;
+    payout_value_limit?: number;
+    payout_percentage_limit?: number;
+    features?: Record<string, any>;
+    data?: Record<string, any>;
+    meta_data?: Record<string, any>;
+    currency_id?: number;
+    payment_provider_id?: number;
+}
+export interface Subscription {
+    id: number;
+    status: StatusKey;
+    kind: KindKey;
+    record_id: number;
+    record: string;
+    start_date: string;
+    end_date?: string;
+    current_period_start?: string;
+    current_period_end?: string;
+    trial_end?: string;
+    canceled_at?: string;
+    uid: string;
+    token?: string;
+    billing_plan_id: number;
+    customer_id?: number;
+    order_id?: number;
+    data?: Record<string, any>;
+    meta_data?: Record<string, any>;
+    inserted_at: string;
+    updated_at: string;
+    billing_plan?: BillingPlan;
+    customer?: Customer;
+    order?: Order;
+    subscription_periods?: SubscriptionPeriod[];
+}
+export interface CreateSubscriptionData {
+    billing_plan_id: number;
+    record: string;
+    record_id: number;
+    start_date: string;
+    end_date?: string;
+    status?: StatusKey;
+    kind?: KindKey;
+    current_period_start?: string;
+    current_period_end?: string;
+    trial_end?: string;
+    token?: string;
+    customer_id?: number;
+    order_id?: number;
+    data?: Record<string, any>;
+    meta_data?: Record<string, any>;
+}
+export interface SubscriptionPeriod {
+    id: number;
+    subscription_id: string;
+    start_date: string;
+    end_date: string;
+    status: string;
+    inserted_at: string;
+    updated_at: string;
+}
+export interface SubscriptionUsageResponse {
+    id: number;
+    subscription_id: string;
+    usage_amount: number;
+    recorded_at: string;
+    description?: string;
+}
+export interface SubscriptionCancelResponse {
+    id: number;
+    uid: string;
+    status: string;
+    canceled_at: string;
+    cancellation_reason?: string;
+}
+export interface SubscriptionLinkData {
+    uid: string;
+    token: string;
+}
+export interface SubscriptionChargeData {
+    amount?: number;
+    description?: string;
+}
+export interface User {
+    id: number;
+    email: string;
+    phone?: string;
+    first_name: string;
+    last_name: string;
+    username?: string;
+    status: AccountStatus;
+    level: number;
+    dob?: number | null;
+    sex?: number | null;
+    image?: string | null;
+    uid: string;
+    kind?: UserKind;
+    organisation_id?: number;
+    role_id?: number;
+    inserted_at: string;
+    updated_at: string;
+    organisation?: Organisation;
+}
+export interface CreateUserData {
+    email: string;
+    phone?: string;
+    first_name: string;
+    last_name: string;
+    username?: string;
+    password: string;
+    status?: AccountStatus | StatusKey | number;
+    level?: number;
+    dob?: number;
+    sex?: number;
+    image?: string;
+    kind?: UserKind | KindKey | number;
+    organisation_id?: number;
+    role_id?: number;
+}
+export interface UpdateUserData {
+    email?: string;
+    phone?: string;
+    first_name?: string;
     last_name?: string;
     username?: string;
-    status?: number;
+    status?: AccountStatus | StatusKey | number;
     level?: number;
+    dob?: number;
+    sex?: number;
+    image?: string;
+    kind?: UserKind | KindKey | number;
+    organisation_id?: number;
     role_id?: number;
 }
 export interface WebhookEvent {
@@ -442,4 +1025,293 @@ export interface PublicMerchantProducts {
     products: Product[];
     [key: string]: any;
 }
+export interface KycRequest {
+    id: number;
+    kind: KycKind | KindKey;
+    status: KycStatus | StatusKey;
+    user_id?: number;
+    subject_id?: number;
+    data?: Record<string, any>;
+    inserted_at: string;
+    updated_at: string;
+    user?: User;
+}
+export interface CreateKycRequestData {
+    kind: KycKind | KindKey;
+    status?: KycStatus | StatusKey;
+    user_id?: number;
+    subject_id?: number;
+    data?: Record<string, any>;
+}
+export interface UpdateKycRequestData {
+    kind?: KycKind | KindKey;
+    status?: KycStatus | StatusKey;
+    user_id?: number;
+    subject_id?: number;
+    data?: Record<string, any>;
+}
+export interface PayoutRequest {
+    id: number;
+    total: number;
+    status: StatusKey;
+    balance_on_request: number;
+    reference_id?: string;
+    evidence_file_id?: number;
+    merchant_id: number;
+    requester_id: number;
+    type: KindKey;
+    sub_type: KindKey;
+    reviewer_id?: number;
+    reviewed_at?: string;
+    due_at: string;
+    fee_total: number;
+    currency_id: number;
+    inserted_at: string;
+    updated_at: string;
+    merchant?: Merchant;
+    requester?: User;
+    reviewer?: User;
+    currency?: Currency;
+}
+export interface CreatePayoutRequestData {
+    total: number;
+    type?: KindKey;
+    sub_type?: KindKey;
+    reference_id?: string;
+    evidence_file_id?: number;
+    due_at?: string;
+    currency_id?: number;
+}
+export interface UpdatePayoutRequestData {
+    total?: number;
+    status?: StatusKey;
+    type?: KindKey;
+    sub_type?: KindKey;
+    reference_id?: string;
+    evidence_file_id?: number;
+    reviewer_id?: number;
+    reviewed_at?: string;
+    due_at?: string;
+    fee_total?: number;
+    currency_id?: number;
+}
+export interface InternalMerchant {
+    id: number;
+    name: string;
+    email: string;
+    username: string;
+    about?: string;
+    logo?: string;
+    sector?: string;
+    status: number;
+    phone?: string;
+    business_type?: string;
+    theme_colour?: string;
+    uid: string;
+    address_id?: number;
+    owner_id?: number;
+    domain_id?: number;
+    organisation_id?: number;
+    platform_fee_structure: number;
+    provider_fee_structure: number;
+    parent_merchant_id?: number;
+    data?: Record<string, any>;
+    inserted_at: string;
+    updated_at: string;
+}
+export interface InternalCreateMerchantData {
+    name: string;
+    email: string;
+    phone?: string;
+    about?: string;
+    status?: number;
+    platform_fee_structure?: number;
+    provider_fee_structure?: number;
+}
+export interface InternalUpdateMerchantData {
+    name?: string;
+    email?: string;
+    phone?: string;
+    about?: string;
+    status?: number;
+    platform_fee_structure?: number;
+    provider_fee_structure?: number;
+}
+export interface InternalCategory {
+    id: number;
+    name: string;
+    description?: string | null;
+    kind: number;
+    kind_id?: number | null;
+    parent_id?: number | null;
+    uid: string;
+    inserted_at: string;
+    updated_at: string;
+}
+export interface InternalProduct {
+    id: number;
+    title: string;
+    teaser?: string;
+    price: number;
+    permalink: string;
+    image?: string | null;
+    status: number;
+    public: boolean;
+    unlimited: boolean;
+    units_remaining?: number | null;
+    units_sold?: number | null;
+    rating_sum?: number | null;
+    rating_count?: number | null;
+    tag_ids: number[];
+    data?: Record<string, any>;
+    meta?: Record<string, any>;
+    uid: string;
+    category_id?: number;
+    currency_id?: number;
+    user_id?: number;
+    inserted_at: string;
+    updated_at: string;
+}
+export interface InternalOrder {
+    id: number;
+    reference_id?: string;
+    total: number;
+    kind: number;
+    status: number;
+    status_on: number;
+    uid: string;
+    cart_id?: number | null;
+    customer?: Customer;
+    currency: Currency;
+    billing_plan?: any | null;
+    billing_subscription_id?: number;
+    order_detail?: Record<string, any>;
+    transactions?: any[];
+    payment_methods?: PaymentMethod[];
+    order_lines: OrderLine[];
+    merchant: InternalMerchant;
+    organisation: Organisation;
+    payment_urls?: {
+        short_link: string;
+    };
+    meta_data?: Record<string, any>;
+    inserted_at: string;
+    updated_at: string;
+}
+export interface InternalUser {
+    id: number;
+    email: string;
+    phone?: string;
+    first_name: string;
+    last_name: string;
+    username?: string;
+    status: number;
+    kind: number;
+    level: number;
+    dob?: number | null;
+    sex?: number | null;
+    image?: string | null;
+    uid: string;
+    organisation_id?: number;
+    role_id?: number;
+    inserted_at: string;
+    updated_at: string;
+}
+export interface InternalPaymentLink {
+    id: number;
+    uid: string;
+    title: string;
+    description?: string;
+    total: number;
+    usage_limit: number;
+    expires_at?: string;
+    status: number;
+    kind: number;
+    data?: Record<string, any>;
+    customer_id?: number;
+    currency_id: number;
+    order_id?: number;
+    inserted_at: string;
+    updated_at: string;
+}
+export interface InternalBillingPlan {
+    id: number;
+    name: string;
+    description?: string;
+    flat_rate: number;
+    transaction_fee: number;
+    transaction_percentage: number;
+    transaction_percentage_additional: number;
+    transaction_minimum_fee: number;
+    minimum_fee: number;
+    duration: number;
+    status: number;
+    kind: number;
+    billing_cycle?: number;
+    trial_period: number;
+    charge_strategy: number;
+    auto_charge: boolean;
+    public: boolean;
+    payout_period: number;
+    payout_value_limit: number;
+    payout_percentage_limit: number;
+    features?: Record<string, any>;
+    data?: Record<string, any>;
+    meta_data?: Record<string, any>;
+    uid: string;
+    currency_id: number;
+    payment_provider_id?: number;
+    inserted_at: string;
+    updated_at: string;
+    currency?: Currency;
+}
+export interface InternalSubscription {
+    id: number;
+    status: number;
+    kind: number;
+    current_period_start: string;
+    current_period_end: string;
+    trial_end?: string;
+    canceled_at?: string;
+    start_date: string;
+    end_date?: string;
+    record: string;
+    record_id: number;
+    customer_id?: number;
+    order_id?: number;
+    uid: string;
+    token?: string;
+    billing_plan_id: number;
+    has_token: boolean;
+    billing_plan: InternalBillingPlan;
+    subscription_periods?: SubscriptionPeriod[];
+    data?: Record<string, any>;
+    meta_data?: Record<string, any>;
+    inserted_at: string;
+    updated_at: string;
+}
+export interface InternalKycRequest {
+    id: number;
+    kind: number;
+    status: number;
+    data?: Record<string, any>;
+    user_id: number;
+    merchant_id?: number;
+    uid: string;
+    inserted_at: string;
+    updated_at: string;
+}
+export interface InternalPayoutRequest {
+    id: number;
+    amount: number;
+    currency_code: string;
+    status: number;
+    type: number;
+    sub_type: number;
+    data?: Record<string, any>;
+    merchant_id: number;
+    uid: string;
+    inserted_at: string;
+    updated_at: string;
+}
 //# sourceMappingURL=types.d.ts.map