@mitumba/sdk 1.27.1 → 1.28.0

package/dist/index.d.ts

@@ -404,6 +404,136 @@ interface OrderHistoryParams {
     page?: number;
 }
 
+type BaleGrade = 'Cream' | 'A' | 'B' | 'C';
+type BaleType = 'original' | 'sorted';
+interface WholesaleStore {
+    id: string;
+    name: string;
+    slug: string;
+    tagline: string | null;
+    description: string | null;
+    logo_url: string | null;
+    origins: string[];
+    verified: boolean;
+}
+interface WholesaleDepot {
+    id: string;
+    name: string;
+    address: string | null;
+    city_id: string | null;
+    is_primary: boolean;
+}
+interface Bale {
+    id: string;
+    store_id: string;
+    seller_id: string;
+    title: string;
+    category: string;
+    grade: BaleGrade;
+    bale_type: BaleType;
+    weight_kg: number;
+    origin: string | null;
+    est_pieces: number | null;
+    price_kes: number;
+    moq: number;
+    mix: string | null;
+    description: string | null;
+    city_id: string | null;
+    status: 'draft' | 'active' | 'sold_out';
+    created_at: string;
+}
+interface BaleDetail extends Bale {
+    images: string[];
+    store: {
+        name: string;
+        slug: string;
+        verified: boolean;
+        sti: number | null;
+    };
+}
+interface CreateBaleInput {
+    title: string;
+    category: string;
+    grade: BaleGrade;
+    bale_type?: BaleType;
+    weight_kg: number;
+    origin?: string;
+    est_pieces?: number;
+    price_kes: number;
+    moq?: number;
+    mix?: string;
+    description?: string;
+    city_id?: string;
+    status?: 'draft' | 'active' | 'sold_out';
+}
+interface WholesaleFeedParams {
+    q?: string;
+    category?: string;
+    grade?: BaleGrade;
+    origin?: string;
+    city_id?: string;
+    limit?: number;
+    offset?: number;
+}
+interface BaleFeedItem extends Bale {
+    image_url: string | null;
+    store: {
+        name: string;
+        slug: string;
+        verified: boolean;
+        sti: number | null;
+    };
+}
+interface SaveWholesaleStoreInput {
+    name: string;
+    tagline?: string;
+    description?: string;
+    logo_url?: string;
+    origins?: string[];
+}
+interface AddDepotInput {
+    name: string;
+    address?: string;
+    city_id?: string;
+    is_primary?: boolean;
+}
+declare const BALE_ORDER_STATUSES: readonly ["pending_payment", "paid", "confirmed", "in_transit", "delivered", "completed", "cancelled"];
+type BaleOrderStatus = typeof BALE_ORDER_STATUSES[number];
+type BaleFulfillment = 'pickup' | 'courier';
+interface BaleOrder {
+    id: string;
+    bale_id: string;
+    buyer_id: string;
+    seller_id: string;
+    store_id: string;
+    title: string;
+    grade: string;
+    origin: string | null;
+    image_url: string | null;
+    qty: number;
+    unit_kes: number;
+    total_kes: number;
+    fulfillment: BaleFulfillment;
+    freight_kes: number | null;
+    status: BaleOrderStatus;
+    city_id: string | null;
+    buyer_name: string | null;
+    store_name: string | null;
+    created_at: string;
+}
+interface BaleOrderEvent {
+    actor: string;
+    old_status: string | null;
+    new_status: string;
+    note: string | null;
+    created_at: string;
+}
+interface CreateBaleOrderInput {
+    bale_id: string;
+    qty?: number;
+    fulfillment: BaleFulfillment;
+}
+
 interface StkPushInput {
     order_id: string;
     phone: string;
@@ -429,6 +559,42 @@ interface PaymentStatusResponse {
     status: PaymentStatus;
     total: number;
 }
+type PaymentProvider = 'daraja' | 'intasend' | 'paystack' | 'airtel';
+type PaymentAttemptStatus = 'initiated' | 'funded' | 'failed' | 'refunded' | 'cancelled';
+type CheckoutStatus = 'pending' | 'paid' | 'failed' | 'cancelled' | 'refunded';
+type CheckoutOrder = {
+    type: 'retail';
+    status: OrderStatus;
+} | {
+    type: 'bale';
+    status: BaleOrderStatus;
+};
+interface CheckoutStatusResponse {
+    version: 1;
+    order_id: string;
+    order: CheckoutOrder;
+    checkout_status: CheckoutStatus;
+    terminal: boolean;
+    retryable: boolean;
+    amount: {
+        currency: 'KES';
+        minor_units: number;
+    };
+    latest_attempt: {
+        id: string;
+        sequence: number;
+        provider: PaymentProvider;
+        status: PaymentAttemptStatus;
+        terminal: boolean;
+        created_at: string;
+        updated_at: string;
+    } | null;
+    attempt_count: number;
+    order_updated_at: string;
+    status_updated_at: string;
+    server_time: string;
+    poll_after_ms: number;
+}
 
 interface VAZIOutfitItem {
     id: string;
@@ -1040,136 +1206,6 @@ interface DisputeListParams {
     page?: number;
 }
 
-type BaleGrade = 'Cream' | 'A' | 'B' | 'C';
-type BaleType = 'original' | 'sorted';
-interface WholesaleStore {
-    id: string;
-    name: string;
-    slug: string;
-    tagline: string | null;
-    description: string | null;
-    logo_url: string | null;
-    origins: string[];
-    verified: boolean;
-}
-interface WholesaleDepot {
-    id: string;
-    name: string;
-    address: string | null;
-    city_id: string | null;
-    is_primary: boolean;
-}
-interface Bale {
-    id: string;
-    store_id: string;
-    seller_id: string;
-    title: string;
-    category: string;
-    grade: BaleGrade;
-    bale_type: BaleType;
-    weight_kg: number;
-    origin: string | null;
-    est_pieces: number | null;
-    price_kes: number;
-    moq: number;
-    mix: string | null;
-    description: string | null;
-    city_id: string | null;
-    status: 'draft' | 'active' | 'sold_out';
-    created_at: string;
-}
-interface BaleDetail extends Bale {
-    images: string[];
-    store: {
-        name: string;
-        slug: string;
-        verified: boolean;
-        sti: number | null;
-    };
-}
-interface CreateBaleInput {
-    title: string;
-    category: string;
-    grade: BaleGrade;
-    bale_type?: BaleType;
-    weight_kg: number;
-    origin?: string;
-    est_pieces?: number;
-    price_kes: number;
-    moq?: number;
-    mix?: string;
-    description?: string;
-    city_id?: string;
-    status?: 'draft' | 'active' | 'sold_out';
-}
-interface WholesaleFeedParams {
-    q?: string;
-    category?: string;
-    grade?: BaleGrade;
-    origin?: string;
-    city_id?: string;
-    limit?: number;
-    offset?: number;
-}
-interface BaleFeedItem extends Bale {
-    image_url: string | null;
-    store: {
-        name: string;
-        slug: string;
-        verified: boolean;
-        sti: number | null;
-    };
-}
-interface SaveWholesaleStoreInput {
-    name: string;
-    tagline?: string;
-    description?: string;
-    logo_url?: string;
-    origins?: string[];
-}
-interface AddDepotInput {
-    name: string;
-    address?: string;
-    city_id?: string;
-    is_primary?: boolean;
-}
-declare const BALE_ORDER_STATUSES: readonly ["pending_payment", "paid", "confirmed", "in_transit", "delivered", "completed", "cancelled"];
-type BaleOrderStatus = typeof BALE_ORDER_STATUSES[number];
-type BaleFulfillment = 'pickup' | 'courier';
-interface BaleOrder {
-    id: string;
-    bale_id: string;
-    buyer_id: string;
-    seller_id: string;
-    store_id: string;
-    title: string;
-    grade: string;
-    origin: string | null;
-    image_url: string | null;
-    qty: number;
-    unit_kes: number;
-    total_kes: number;
-    fulfillment: BaleFulfillment;
-    freight_kes: number | null;
-    status: BaleOrderStatus;
-    city_id: string | null;
-    buyer_name: string | null;
-    store_name: string | null;
-    created_at: string;
-}
-interface BaleOrderEvent {
-    actor: string;
-    old_status: string | null;
-    new_status: string;
-    note: string | null;
-    created_at: string;
-}
-interface CreateBaleOrderInput {
-    bale_id: string;
-    qty?: number;
-    fulfillment: BaleFulfillment;
-}
-
 interface MitumbaClientConfig {
     baseUrl: string;
     debug?: boolean;
@@ -1604,8 +1640,15 @@ declare class PayModule {
     initPaystack(input: PaystackInput, options?: RequestOptions): Promise<PaystackInitResponse>;
     /**
      * Poll for the current status of a payment by its order ID.
+     *
+     * @deprecated Use {@link getCheckoutStatus} for the typed checkout lifecycle.
+     * This method retains its legacy route and response for compatibility.
      */
     getStatus(orderId: string, options?: RequestOptions): Promise<PaymentStatusResponse>;
+    /**
+     * Get the buyer-visible checkout lifecycle for a retail or bale order.
+     */
+    getCheckoutStatus(orderId: string, options?: RequestOptions): Promise<CheckoutStatusResponse>;
 }
 
 declare class VaziModule {
@@ -2399,4 +2442,4 @@ declare class MitumbaClient {
     isAuthenticated(): Promise<boolean>;
 }
 
-export { APIClient, APIError, type APIErrorResponse, type Add2FAMethodInput, type Add2FAMethodResult, type AddAddressInput, type AddDepotInput, 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 AuthenticationResponseJSON, BALE_ORDER_STATUSES, type Bale, type BaleDetail, type BaleFeedItem, type BaleFulfillment, type BaleGrade, type BaleOrder, type BaleOrderEvent, type BaleOrderStatus, type BaleType, type BecomeBaleSellerInput, type BecomeSellerInput, type BlockedIp, type Business, type BusinessType, BusinessesModule, CONDITIONS, type CartItem, CartModule, type Category, type ChangePasswordInput, type City, type CompleteOnboardingInput, type Condition, type Conversation, type CreateBaleInput, type CreateBaleOrderInput, 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 FollowedStore, type ForgotPasswordInput, IDBTokenStore, type InboxRealtimeEvent, 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 PublicKeyCredentialCreationOptionsJSON, type PublicKeyCredentialRequestOptionsJSON, type RaiseDisputeInput, type RegisterInput, type RegistrationResponseJSON, ReportsModule, type RequestOptions, type ResetPasswordInput, type ResolveDisputeInput, type RespondDisputeInput, type Review, type ReviewableOrder, ReviewsModule, type SaveSearchInput, type SaveWholesaleStoreInput, type SearchHistoryItem, SearchModule, type SearchParams, type SearchResult, type SellerProfile, type SellerStorefront, type SellerType, 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, TWO_FACTOR_METHOD_TYPES, type TokenStore, type TransitionOrderInput, type TrendingTerm, type TwoFactorMethod, type TwoFactorMethodType, 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 WholesaleDepot, type WholesaleFeedParams, WholesaleModule, type WholesaleStore, type WishlistListing, WishlistsModule, createTokenStore };
+export { APIClient, APIError, type APIErrorResponse, type Add2FAMethodInput, type Add2FAMethodResult, type AddAddressInput, type AddDepotInput, 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 AuthenticationResponseJSON, BALE_ORDER_STATUSES, type Bale, type BaleDetail, type BaleFeedItem, type BaleFulfillment, type BaleGrade, type BaleOrder, type BaleOrderEvent, type BaleOrderStatus, type BaleType, type BecomeBaleSellerInput, type BecomeSellerInput, type BlockedIp, type Business, type BusinessType, BusinessesModule, CONDITIONS, type CartItem, CartModule, type Category, type ChangePasswordInput, type CheckoutOrder, type CheckoutStatus, type CheckoutStatusResponse, type City, type CompleteOnboardingInput, type Condition, type Conversation, type CreateBaleInput, type CreateBaleOrderInput, 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 FollowedStore, type ForgotPasswordInput, IDBTokenStore, type InboxRealtimeEvent, 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 PaymentAttemptStatus, type PaymentMethod, type PaymentMethodType, type PaymentProvider, type PaymentStatus, type PaymentStatusResponse, type PaystackInitResponse, type PaystackInput, type PhoneLoginInput, type PhoneRegisterInput, type PresignImageResponse, type PublicKeyCredentialCreationOptionsJSON, type PublicKeyCredentialRequestOptionsJSON, type RaiseDisputeInput, type RegisterInput, type RegistrationResponseJSON, ReportsModule, type RequestOptions, type ResetPasswordInput, type ResolveDisputeInput, type RespondDisputeInput, type Review, type ReviewableOrder, ReviewsModule, type SaveSearchInput, type SaveWholesaleStoreInput, type SearchHistoryItem, SearchModule, type SearchParams, type SearchResult, type SellerProfile, type SellerStorefront, type SellerType, 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, TWO_FACTOR_METHOD_TYPES, type TokenStore, type TransitionOrderInput, type TrendingTerm, type TwoFactorMethod, type TwoFactorMethodType, 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 WholesaleDepot, type WholesaleFeedParams, WholesaleModule, type WholesaleStore, type WishlistListing, WishlistsModule, createTokenStore };

package/dist/index.js

@@ -727,10 +727,19 @@ var PayModule = class {
   }
   /**
    * Poll for the current status of a payment by its order ID.
+   *
+   * @deprecated Use {@link getCheckoutStatus} for the typed checkout lifecycle.
+   * This method retains its legacy route and response for compatibility.
    */
   async getStatus(orderId, options) {
     return this.client.get(`/pay/status/${orderId}`, void 0, options);
   }
+  /**
+   * Get the buyer-visible checkout lifecycle for a retail or bale order.
+   */
+  async getCheckoutStatus(orderId, options) {
+    return this.client.get(`/pay/checkout-status/${orderId}`, void 0, options);
+  }
 };
 
 // src/modules/vazi.ts