@mitumba/sdk 1.15.0 → 1.17.0

package/dist/index.d.mts

@@ -145,6 +145,7 @@ interface Listing {
     seller_type: 'individual' | 'bale';
     images?: ListingImage[];
     image_url?: string | null;
+    media?: string[];
 }
 interface ListingsFeedParams {
     city_id?: string;
@@ -545,6 +546,7 @@ interface WishlistListing {
     condition: string;
     size: string | null;
     image_url: string | null;
+    media?: string[];
 }
 
 interface CartItem {
@@ -667,6 +669,167 @@ interface SystemStats {
     total_revenue: number;
     active_today: number;
 }
+interface AdminUserListItem {
+    id: string;
+    display_name: string | null;
+    email: string | null;
+    phone: string | null;
+    is_active: boolean;
+    roles: string[];
+    created_at: string;
+}
+interface AdminUserDetail {
+    id: string;
+    email: string | null;
+    phone: string | null;
+    display_name: string | null;
+    county: string | null;
+    city_id: string | null;
+    is_active: boolean;
+    suspended_at: string | null;
+    suspension_reason: string | null;
+    onboarding_completed: number;
+    email_verified: number;
+    created_at: string;
+    roles: string[];
+    order_count: number;
+    seller: {
+        sti_score: number;
+        seller_type: string;
+        verification_status: string;
+    } | null;
+}
+interface AdminStoreListItem {
+    id: string;
+    name: string;
+    slug: string;
+    seller_id: string;
+    is_verified: boolean;
+    subscription_tier: 'free' | 'pro';
+    sti_score: number | null;
+    created_at: string;
+}
+interface AdminStoreDetail {
+    id: string;
+    seller_id: string;
+    name: string;
+    slug: string;
+    tagline: string | null;
+    description: string | null;
+    category: string | null;
+    logo_url: string | null;
+    banner_url: string | null;
+    city_id: string | null;
+    subscription_tier: 'free' | 'pro';
+    is_verified: boolean;
+    created_at: string;
+    updated_at: string;
+    owner_name: string | null;
+    owner_email: string | null;
+    sti_score: number | null;
+    seller_type: string | null;
+    verification_status: string | null;
+    listing_count: number;
+    order_count: number;
+}
+interface AdminVerificationItem {
+    user_id: string;
+    seller_type: string;
+    verification_status: 'unverified' | 'pending' | 'verified' | 'rejected';
+    updated_at: string;
+    display_name: string | null;
+    email: string | null;
+    phone: string | null;
+    id_document_url: string | null;
+    kra_pin: string | null;
+}
+interface StiEvent {
+    trigger_type: string;
+    trigger_order_id: string | null;
+    score_before: number;
+    score_after: number;
+    delta: number;
+    reason: string;
+    created_at: string;
+}
+interface AdminListingItem {
+    id: string;
+    title: string;
+    price: number;
+    status: 'draft' | 'active' | 'sold' | 'removed';
+    photo_verified: boolean;
+    seller_id: string;
+    store_id: string | null;
+    created_at: string;
+    image_url: string | null;
+}
+interface AdminOrderListItem {
+    id: string;
+    buyer_id: string;
+    seller_id: string;
+    store_id: string | null;
+    total: number;
+    status: string;
+    created_at: string;
+    listing_title: string | null;
+}
+interface AdminOrderDetail {
+    id: string;
+    buyer_id: string;
+    seller_id: string;
+    store_id: string | null;
+    listing_id: string;
+    amount: number;
+    delivery_fee: number;
+    total: number;
+    status: string;
+    city_id: string;
+    created_at: string;
+    updated_at: string;
+    events: unknown[];
+    payment: unknown | null;
+    payout: unknown | null;
+    dispute: unknown | null;
+}
+interface AdminPayoutItem {
+    id: string;
+    order_id: string;
+    seller_id: string;
+    amount: number;
+    provider: string;
+    status: 'pending' | 'sent' | 'failed';
+    on_hold: boolean;
+    created_at: string;
+}
+interface AdminReport {
+    id: string;
+    reporter_id: string;
+    target_type: 'listing' | 'review' | 'store' | 'user';
+    target_id: string;
+    reason: string;
+    detail: string | null;
+    status: 'open' | 'reviewed' | 'dismissed' | 'actioned';
+    created_at: string;
+}
+interface AdminVaziOutfit {
+    id: string;
+    name: string;
+    seed_listing_id: string;
+    render_status: string;
+    removed: boolean;
+    item_count: number;
+    total_price: number;
+    engagement_impressions: number;
+    engagement_clicks: number;
+    engagement_purchases: number;
+    assembled_at: string;
+}
+interface CreateReportInput {
+    target_type: 'listing' | 'review' | 'store' | 'user';
+    target_id: string;
+    reason: 'counterfeit' | 'offensive' | 'spam' | 'scam' | 'other';
+    detail?: string;
+}
 
 declare const DISPUTE_REASONS: readonly ["not_received", "not_as_described", "damaged", "counterfeit", "wrong_item"];
 type DisputeReason = typeof DISPUTE_REASONS[number];
@@ -1446,39 +1609,202 @@ declare class BusinessesModule {
 declare class AdminModule {
     private readonly client;
     constructor(client: APIClient);
-    /** Block an IP address. Default duration: 24 hours. */
     blockIp(ip: string, durationHours?: number, options?: RequestOptions): Promise<{
         ok: true;
         blocked: string;
         hours: number;
     }>;
-    /** Unblock an IP address. */
     unblockIp(ip: string, options?: RequestOptions): Promise<{
         ok: true;
         unblocked: string;
     }>;
-    /** List currently blocked IPs. */
     getBlockedIps(options?: RequestOptions): Promise<{
         data: BlockedIp[];
     }>;
-    /** Get platform-wide statistics. */
     getSystemStats(options?: RequestOptions): Promise<SystemStats>;
-    /** Suspend a user account. */
+    getStatsTimeseries(params?: {
+        metric?: 'orders' | 'gmv' | 'users';
+        days?: number;
+    }, options?: RequestOptions): Promise<{
+        metric: string;
+        days: number;
+        data: {
+            day: string;
+            value: number;
+        }[];
+    }>;
+    getStatsByCity(options?: RequestOptions): Promise<{
+        data: {
+            city: string;
+            orders: number;
+            gmv: number;
+        }[];
+    }>;
+    listUsers(params?: {
+        q?: string;
+        page?: number;
+    }, options?: RequestOptions): Promise<{
+        data: AdminUserListItem[];
+        page: number;
+        page_size: number;
+    }>;
+    getUser(userId: string, options?: RequestOptions): Promise<AdminUserDetail>;
     suspendUser(userId: string, reason: string, options?: RequestOptions): Promise<{
         ok: true;
     }>;
-    /** Unsuspend a user account. */
     unsuspendUser(userId: string, options?: RequestOptions): Promise<{
         ok: true;
     }>;
-    /** Grant verified badge to a store. */
+    setUserRole(userId: string, role: string, action: 'grant' | 'revoke', options?: RequestOptions): Promise<{
+        ok: true;
+        roles: string[];
+    }>;
+    revokeUserSessions(userId: string, options?: RequestOptions): Promise<{
+        ok: true;
+    }>;
+    listStores(params?: {
+        q?: string;
+        verified?: 0 | 1;
+        tier?: 'free' | 'pro';
+        page?: number;
+    }, options?: RequestOptions): Promise<{
+        data: AdminStoreListItem[];
+        page: number;
+        page_size: number;
+    }>;
+    getStore(storeId: string, options?: RequestOptions): Promise<AdminStoreDetail>;
     verifyStore(storeId: string, options?: RequestOptions): Promise<{
         ok: true;
     }>;
-    /** Revoke verified badge from a store. */
     unverifyStore(storeId: string, options?: RequestOptions): Promise<{
         ok: true;
     }>;
+    listVerifications(params?: {
+        status?: 'pending' | 'verified' | 'rejected' | 'unverified';
+        page?: number;
+    }, options?: RequestOptions): Promise<{
+        data: AdminVerificationItem[];
+        page: number;
+        page_size: number;
+    }>;
+    approveVerification(userId: string, options?: RequestOptions): Promise<{
+        ok: true;
+        verification_status: 'verified';
+    }>;
+    rejectVerification(userId: string, reason?: string, options?: RequestOptions): Promise<{
+        ok: true;
+        verification_status: 'rejected';
+    }>;
+    adjustSti(userId: string, input: {
+        score?: number;
+        delta?: number;
+        reason: string;
+    }, options?: RequestOptions): Promise<{
+        ok: true;
+        score_before: number;
+        score_after: number;
+    }>;
+    getStiEvents(userId: string, params?: {
+        page?: number;
+    }, options?: RequestOptions): Promise<{
+        data: StiEvent[];
+        page: number;
+        page_size: number;
+    }>;
+    listListings(params?: {
+        status?: string;
+        photo_verified?: 0 | 1;
+        page?: number;
+    }, options?: RequestOptions): Promise<{
+        data: AdminListingItem[];
+        page: number;
+        page_size: number;
+    }>;
+    removeListing(listingId: string, reason?: string, options?: RequestOptions): Promise<{
+        ok: true;
+        status: 'removed';
+    }>;
+    reinstateListing(listingId: string, options?: RequestOptions): Promise<{
+        ok: true;
+        status: 'active';
+    }>;
+    listOrders(params?: {
+        status?: string;
+        q?: string;
+        page?: number;
+    }, options?: RequestOptions): Promise<{
+        data: AdminOrderListItem[];
+        page: number;
+        page_size: number;
+    }>;
+    getOrder(orderId: string, options?: RequestOptions): Promise<AdminOrderDetail>;
+    forceTransitionOrder(orderId: string, status: string, note?: string, options?: RequestOptions): Promise<{
+        ok: true;
+        status: string;
+    }>;
+    getPayoutSummary(options?: RequestOptions): Promise<{
+        owed: number;
+        held: number;
+        sent_today: number;
+    }>;
+    listPayouts(params?: {
+        status?: 'pending' | 'sent' | 'failed';
+        on_hold?: 0 | 1;
+        page?: number;
+    }, options?: RequestOptions): Promise<{
+        data: AdminPayoutItem[];
+        page: number;
+        page_size: number;
+    }>;
+    disbursePayout(payoutId: string, options?: RequestOptions): Promise<{
+        ok: true;
+        result: unknown;
+    }>;
+    listReports(params?: {
+        status?: 'open' | 'reviewed' | 'dismissed' | 'actioned';
+        type?: 'listing' | 'review' | 'store' | 'user';
+        page?: number;
+    }, options?: RequestOptions): Promise<{
+        data: AdminReport[];
+        page: number;
+        page_size: number;
+    }>;
+    resolveReport(reportId: string, status: 'reviewed' | 'dismissed' | 'actioned', note?: string, options?: RequestOptions): Promise<{
+        ok: true;
+        status: string;
+    }>;
+    removeReview(reviewId: string, reason?: string, options?: RequestOptions): Promise<{
+        ok: true;
+        hidden: true;
+    }>;
+    reinstateReview(reviewId: string, options?: RequestOptions): Promise<{
+        ok: true;
+        hidden: false;
+    }>;
+    listVaziOutfits(params?: {
+        page?: number;
+    }, options?: RequestOptions): Promise<{
+        data: AdminVaziOutfit[];
+        page: number;
+        page_size: number;
+    }>;
+    removeVaziOutfit(outfitId: string, reason?: string, options?: RequestOptions): Promise<{
+        ok: true;
+        removed: true;
+    }>;
+    reinstateVaziOutfit(outfitId: string, options?: RequestOptions): Promise<{
+        ok: true;
+        removed: false;
+    }>;
+    broadcast(input: {
+        title: string;
+        body: string;
+        segment?: 'all' | 'sellers' | 'buyers';
+    }, options?: RequestOptions): Promise<{
+        ok: true;
+        segment: string;
+        recipients: number;
+    }>;
 }
 
 declare class DisputesModule {
@@ -1539,6 +1865,16 @@ declare class UploadsModule {
     }>;
 }
 
+declare class ReportsModule {
+    private readonly client;
+    constructor(client: APIClient);
+    /** Report a listing, review, store, or user for admin review. */
+    create(input: CreateReportInput, options?: RequestOptions): Promise<{
+        ok: true;
+        already_reported?: boolean;
+    }>;
+}
+
 declare class MitumbaClient {
     readonly api: APIClient;
     readonly auth: AuthModule;
@@ -1559,6 +1895,7 @@ declare class MitumbaClient {
     readonly admin: AdminModule;
     readonly disputes: DisputesModule;
     readonly uploads: UploadsModule;
+    readonly reports: ReportsModule;
     constructor(config: MitumbaClientConfig);
     /**
      * Set the access token for authenticated requests.
@@ -1583,4 +1920,4 @@ declare class MitumbaClient {
     isAuthenticated(): Promise<boolean>;
 }
 
-export { APIClient, APIError, type APIErrorResponse, type AddAddressInput, type AddPaymentMethodInput, type Address, AdminModule, AuthModule, type AuthTokens, type BecomeSellerInput, type BlockedIp, type Business, BusinessesModule, CONDITIONS, type CartItem, CartModule, type Category, type ChangePasswordInput, type City, type CompleteOnboardingInput, type Condition, type Conversation, type CreateListingInput, type CreateOrderInput, type CreateReviewInput, type CreateStoreInput, DESIRED_RESOLUTIONS, DISPUTE_REASONS, DISPUTE_STATUSES, type DeliveryAddress, type DesiredResolution, type Dispute, type DisputeEvent, type DisputeEvidence, type DisputeListParams, type DisputeReason, type DisputeStatus, DisputesModule, type EmailLoginInput, type EmailRegisterInput, type ForgotPasswordInput, IDBTokenStore, LISTING_STATUSES, type LinkedAccount, type LinkedAccountProvider, type Listing, type ListingImage, type ListingStatus, type ListingsFeedParams, ListingsModule, type LoginInput, MailerModule, type MailerTemplate, MemoryTokenStore, type Message, type MessageResponse, MessagesModule, MitumbaClient, type MitumbaClientConfig, type MpesaInput, type Notification, type NotificationPref, type NotificationType, NotificationsModule, ORDER_STATUSES, type Order, type OrderEvent, type OrderHistoryParams, type OrderStatus, OrdersModule, PAYMENT_STATUSES, type PaginatedResponse, PayModule, type PaymentMethod, type PaymentMethodType, type PaymentStatus, type PaymentStatusResponse, type PaystackInitResponse, type PaystackInput, type PhoneLoginInput, type PhoneRegisterInput, type PresignImageResponse, type RaiseDisputeInput, type RegisterInput, type RequestOptions, type ResetPasswordInput, type ResolveDisputeInput, type RespondDisputeInput, type Review, type ReviewableOrder, ReviewsModule, type SaveSearchInput, type SearchHistoryItem, SearchModule, type SearchParams, type SearchResult, type SellerProfile, type SellerStorefront, type SendEmailInput, type SendMessageInput, type SendOtpInput, type Session, SettingsModule, type SimilarListing, type StkPushInput, type StkPushResponse, type Store, type StoreAnalytics, type StoreSettings, type StoreStats, StoresModule, type SubscriptionTier, type SystemStats, type TokenStore, type TransitionOrderInput, type TrendingTerm, type TwoFactorRequired, type UpdateBusinessInput, type UpdateListingInput, type UpdateProfileInput, type UpdateStoreInput, UploadsModule, type UserProfile, type VAZIOutfit, type VAZIOutfitDetail, type VAZIOutfitDetailItem, type VAZIOutfitItem, type VaziFeedParams, type VaziFeedResponse, VaziModule, type Verify2FAInput, type VerifyOtpInput, type WishlistListing, WishlistsModule, createTokenStore };
+export { APIClient, APIError, type APIErrorResponse, type AddAddressInput, type AddPaymentMethodInput, type Address, type AdminListingItem, AdminModule, type AdminOrderDetail, type AdminOrderListItem, type AdminPayoutItem, type AdminReport, type AdminStoreDetail, type AdminStoreListItem, type AdminUserDetail, type AdminUserListItem, type AdminVaziOutfit, type AdminVerificationItem, AuthModule, type AuthTokens, type BecomeSellerInput, type BlockedIp, type Business, BusinessesModule, CONDITIONS, type CartItem, CartModule, type Category, type ChangePasswordInput, type City, type CompleteOnboardingInput, type Condition, type Conversation, type CreateListingInput, type CreateOrderInput, type CreateReportInput, type CreateReviewInput, type CreateStoreInput, DESIRED_RESOLUTIONS, DISPUTE_REASONS, DISPUTE_STATUSES, type DeliveryAddress, type DesiredResolution, type Dispute, type DisputeEvent, type DisputeEvidence, type DisputeListParams, type DisputeReason, type DisputeStatus, DisputesModule, type EmailLoginInput, type EmailRegisterInput, type ForgotPasswordInput, IDBTokenStore, LISTING_STATUSES, type LinkedAccount, type LinkedAccountProvider, type Listing, type ListingImage, type ListingStatus, type ListingsFeedParams, ListingsModule, type LoginInput, MailerModule, type MailerTemplate, MemoryTokenStore, type Message, type MessageResponse, MessagesModule, MitumbaClient, type MitumbaClientConfig, type MpesaInput, type Notification, type NotificationPref, type NotificationType, NotificationsModule, ORDER_STATUSES, type Order, type OrderEvent, type OrderHistoryParams, type OrderStatus, OrdersModule, PAYMENT_STATUSES, type PaginatedResponse, PayModule, type PaymentMethod, type PaymentMethodType, type PaymentStatus, type PaymentStatusResponse, type PaystackInitResponse, type PaystackInput, type PhoneLoginInput, type PhoneRegisterInput, type PresignImageResponse, type RaiseDisputeInput, type RegisterInput, ReportsModule, type RequestOptions, type ResetPasswordInput, type ResolveDisputeInput, type RespondDisputeInput, type Review, type ReviewableOrder, ReviewsModule, type SaveSearchInput, type SearchHistoryItem, SearchModule, type SearchParams, type SearchResult, type SellerProfile, type SellerStorefront, type SendEmailInput, type SendMessageInput, type SendOtpInput, type Session, SettingsModule, type SimilarListing, type StiEvent, type StkPushInput, type StkPushResponse, type Store, type StoreAnalytics, type StoreSettings, type StoreStats, StoresModule, type SubscriptionTier, type SystemStats, type TokenStore, type TransitionOrderInput, type TrendingTerm, type TwoFactorRequired, type UpdateBusinessInput, type UpdateListingInput, type UpdateProfileInput, type UpdateStoreInput, UploadsModule, type UserProfile, type VAZIOutfit, type VAZIOutfitDetail, type VAZIOutfitDetailItem, type VAZIOutfitItem, type VaziFeedParams, type VaziFeedResponse, VaziModule, type Verify2FAInput, type VerifyOtpInput, type WishlistListing, WishlistsModule, createTokenStore };