@tuturuuu/internal-api 0.18.0 → 0.20.0

package/dist/inventory.d.ts

@@ -27,7 +27,7 @@ export type InventoryStorefrontThemePreset = 'boutique' | 'catalog' | 'editorial
 export type InventoryStorefrontLayoutStyle = 'feature' | 'grid' | 'list';
 export type InventoryStorefrontSurfaceStyle = 'glass' | 'soft' | 'solid';
 export type InventoryStorefrontCornerStyle = 'compact' | 'rounded' | 'soft';
-export type InventoryStorefrontCheckoutMode = 'disabled' | 'polar' | 'square_terminal' | 'simulated';
+export type InventoryStorefrontCheckoutMode = 'disabled' | 'polar' | 'square_pos' | 'square_terminal' | 'simulated';
 export type InventoryStorefrontSectionType = 'cover' | 'featured_banners' | 'featured_listings' | 'product_grid' | 'promo' | 'text';
 export type InventoryStorefrontSectionStatus = 'draft' | 'hidden' | 'published';
 export type InventoryStorefrontAnalyticsEventType = 'add_to_cart' | 'banner_click' | 'checkout_completed' | 'checkout_created' | 'checkout_failed' | 'checkout_started' | 'product_view' | 'remove_from_cart' | 'view';
@@ -302,6 +302,7 @@ export type InventoryCheckoutSession = {
     squareOrderId: string | null;
     squareTerminalCheckoutId: string | null;
     squarePaymentId: string | null;
+    squarePosClientTransactionId?: string | null;
     squareReceiptUrl: string | null;
     squareStatus: InventorySquareTerminalCheckoutStatus | null;
     squareFailureReason: string | null;
@@ -345,7 +346,7 @@ export type InventorySquareEnvironment = 'production' | 'sandbox';
 export type InventorySquareAuthMethod = 'manual' | 'oauth';
 export type InventorySquareConnectionStatus = 'error' | 'pending' | 'ready' | 'revoked';
 export type InventorySquareTerminalCheckoutStatus = 'cancel_requested' | 'canceled' | 'cancelled' | 'checkout_created' | 'completed' | 'expired' | 'failed' | 'in_progress' | 'paid' | 'pending';
-export type InventorySquareReadinessIssue = 'app_credentials_missing' | 'connection_missing' | 'device_missing' | 'location_missing' | 'scopes_missing' | 'webhook_signature_missing';
+export type InventorySquareReadinessIssue = 'app_credentials_missing' | 'connection_missing' | 'device_missing' | 'location_missing' | 'production_required' | 'scopes_missing' | 'webhook_signature_missing';
 export type InventorySquareConnection = {
     environment: InventorySquareEnvironment;
     authMethod: InventorySquareAuthMethod;
@@ -382,6 +383,10 @@ export type InventorySquareSettings = {
         ready: boolean;
         issues: InventorySquareReadinessIssue[];
     };
+    posReadiness: {
+        ready: boolean;
+        issues: InventorySquareReadinessIssue[];
+    };
     appCredentials: InventorySquareAppCredential[];
     connections: InventorySquareConnection[];
 };
@@ -434,6 +439,7 @@ export type InventorySquareTerminalCheckoutPayload = {
 };
 export type InventorySquareCatalogSyncDirection = 'bidirectional' | 'from_square' | 'to_square';
 export type InventorySquareCatalogSyncSummary = {
+    centLevelPricesReady: boolean | null;
     conflicts: number;
     direction: InventorySquareCatalogSyncDirection;
     environment: InventorySquareEnvironment;
@@ -447,6 +453,21 @@ export type InventorySquareCatalogSyncSummary = {
     variationsPulled: number;
     variationsPushed: number;
 };
+export type InventorySquareCatalogLink = {
+    lastError: string | null;
+    lastSyncedAt: string | null;
+    productId: string;
+    productName: string;
+    squareItemId: string;
+    squareItemName: string | null;
+    squareSku: string | null;
+    squareVariationId: string;
+    squareVariationName: string | null;
+    status: 'active' | 'conflict' | 'error' | 'remote_deleted';
+    syncOrigin: 'square' | 'tuturuuu';
+    unitId: string;
+    warehouseId: string;
+};
 export type InventorySquareCatalogSyncState = {
     environment: InventorySquareEnvironment;
     lastCatalogCursorAt: string | null;
@@ -455,6 +476,7 @@ export type InventorySquareCatalogSyncState = {
     lastInventorySyncAt: string | null;
     lastStatus: 'error' | 'idle' | 'partial' | 'running' | 'success';
     lastSummary: InventorySquareCatalogSyncSummary | null;
+    links: InventorySquareCatalogLink[];
     updatedAt: string | null;
 };
 export type InventoryPolarSyncStatusCounts = {
@@ -472,9 +494,120 @@ export type InventoryStorefrontAnalytics = {
     }>;
     conversionRate: number;
 };
+export type InventoryAnalyticsSummary = {
+    revenue: number;
+    sales: number;
+    units: number;
+    averageOrderValue: number;
+    estimatedGrossProfit?: number;
+    estimatedGrossMarginPercentage?: number;
+    sellThroughPercentage?: number;
+    inventoryValue?: number;
+    finiteStockUnits?: number;
+    activeProducts?: number;
+    stockedProducts?: number;
+    lowStockRows?: number;
+    outOfStockRows?: number;
+    unlimitedStockRows?: number;
+};
+export type InventoryAnalyticsMetric = {
+    label: string;
+    revenue: number;
+    sales: number;
+    units?: number;
+};
+export type InventoryAnalyticsResponse = {
+    currency: string;
+    generatedAt: string;
+    observability?: {
+        dataPoints: number;
+        queryDurationMs: number;
+    };
+    range: {
+        days: number;
+        from: string;
+        to: string;
+        previousFrom: string;
+        previousTo: string;
+    };
+    summary: InventoryAnalyticsSummary;
+    previousSummary: InventoryAnalyticsSummary;
+    trend: Array<{
+        date: string;
+        previousDate: string;
+        revenue: number;
+        sales: number;
+        units: number;
+        previousRevenue: number;
+        previousSales: number;
+        previousUnits: number;
+    }>;
+    categoryMix: InventoryAnalyticsMetric[];
+    ownerMix: InventoryAnalyticsMetric[];
+    channels: InventoryAnalyticsMetric[];
+    weekdays: Array<{
+        day: number;
+        revenue: number;
+        sales: number;
+    }>;
+    products: Array<{
+        productId: string | null;
+        label: string;
+        imageUrl: string | null;
+        revenue: number;
+        units: number;
+        sales: number;
+        finiteStock: number;
+        unlimitedStockRows: number;
+    }>;
+    warehouses: Array<{
+        id: string;
+        label: string;
+        products: number;
+        stockRows: number;
+        unlimitedStockRows: number;
+        finiteStockUnits: number;
+        inventoryValue: number;
+        lowStockRows: number;
+        outOfStockRows: number;
+    }>;
+    periods: Array<{
+        periodId: string | null;
+        label: string;
+        revenue: number;
+        sales: number;
+    }>;
+    storefrontFunnel: {
+        views: number;
+        addToCart: number;
+        checkoutStarted: number;
+        checkoutCreated: number;
+        completed: number;
+        conversionRate: number;
+    };
+    quality: {
+        productsWithoutImages: number;
+        productsWithoutStock: number;
+        productsWithUnlimitedStock: number;
+        stockCoveragePercentage: number;
+    };
+};
+export type InventoryStorefrontBulkImportResult = {
+    created: number;
+    eligible: number;
+    skippedExisting: number;
+    skippedWithoutStock: number;
+};
 export type InventoryPolarProductSyncSummary = {
     listings: InventoryPolarSyncStatusCounts;
     bundles: InventoryPolarSyncStatusCounts;
+    items: Array<{
+        kind: 'listing' | 'bundle';
+        name: string;
+        polarProductId: string | null;
+        status: 'synced' | 'pending' | 'error' | 'disabled';
+        syncedAt: string | null;
+    }>;
     errors: Array<{
         kind: 'listing' | 'bundle';
         name: string;
@@ -732,6 +865,30 @@ export type InventoryBatchPayload = {
     total_diff?: number;
 };
 export type InventorySaleSource = 'checkout_session' | 'finance_invoice';
+export type InventorySalesPeriodStatus = 'active' | 'archived';
+export type InventorySalesPeriodProductScope = 'all' | 'allowlist' | 'blocklist';
+export type InventorySalesPeriod = {
+    created_at: string;
+    description: string | null;
+    ends_at: string | null;
+    id: string;
+    name: string;
+    product_ids: string[];
+    product_scope: InventorySalesPeriodProductScope;
+    sale_count: number;
+    starts_at: string | null;
+    status: InventorySalesPeriodStatus;
+    updated_at: string;
+    ws_id: string;
+};
+export type InventorySalesPeriodPayload = {
+    description?: string | null;
+    ends_at?: string | null;
+    name: string;
+    product_ids?: string[];
+    product_scope?: InventorySalesPeriodProductScope;
+    starts_at?: string | null;
+};
 export type InventorySaleSummary = {
     category_name?: string | null;
     completed_at: string | null;
@@ -745,6 +902,7 @@ export type InventorySaleSummary = {
     notice?: string | null;
     owners?: string[];
     paid_amount: number;
+    period?: InventorySalesPeriod | null;
     polar_order_id?: string | null;
     public_token?: string | null;
     square_order_id?: string | null;
@@ -753,6 +911,7 @@ export type InventorySaleSummary = {
     wallet_name?: string | null;
 };
 export type InventorySaleLine = {
+    product_image_url?: string | null;
     product_id: string;
     product_name: string;
     owner_id: string | null;
@@ -816,6 +975,33 @@ export type InventorySaleUpdatePayload = {
         price: number;
     }>;
 };
+export type InventorySaleCreatePayload = {
+    category_id: string;
+    content: string;
+    notes?: string;
+    period_id?: string | null;
+    products: Array<{
+        category_id: string;
+        price: number;
+        product_id: string;
+        quantity: number;
+        unit_id: string;
+        warehouse_id: string;
+    }>;
+    wallet_id: string;
+};
+export type InventorySaleCreateResponse = {
+    data?: {
+        category_id?: string | null;
+        id?: string;
+        products_count?: number;
+        subtotal?: number;
+        total?: number;
+    };
+    invoice_id: string;
+    message: string;
+    period_assignment_warning?: string;
+};
 export type InventoryAuditLogSummary = {
     auditRecordId: string;
     eventKind: string;
@@ -893,6 +1079,10 @@ export type InventoryOffsetListQuery = {
     limit?: number;
     offset?: number;
 };
+export type InventorySalesListQuery = InventoryOffsetListQuery & {
+    period_id?: string;
+    unassigned?: boolean;
+};
 export type InventoryOrderHistoryQuery = InventoryOffsetListQuery & {
     storeSlug?: string;
 };
@@ -1164,14 +1354,40 @@ export type InventoryListResponse<T> = {
     data: T[];
     count: number;
 };
+export type InventorySalesListResponse = InventoryListResponse<InventorySaleSummary> & {
+    realtime_enabled?: boolean;
+    workspace_currency: string;
+};
+export type InventoryCommerceSummary = {
+    currency: string;
+    estimatedGrossMarginPercentage: number;
+    estimatedGrossProfit: number;
+    excludedCurrencyCount: number;
+    revenue: number;
+    salesCount: number;
+    unitsSold: number;
+};
 export type InventoryProductFormOptionsResponse = {
     categories: ProductCategory[];
+    defaultFinanceCategoryId?: string | null;
+    defaultRevenueWalletId?: string | null;
+    defaultSalesPeriodId?: string | null;
+    defaultWalletId?: string | null;
     financeCategories: TransactionCategory[];
     manufacturers: InventoryManufacturer[];
     owners: InventoryOwner[];
     units: ProductUnit[];
+    wallets?: Array<{
+        id: string;
+        name: string;
+    }>;
     warehouses: ProductWarehouse[];
 };
+export type InventorySalesDefaultsPayload = {
+    defaultFinanceCategoryId: string | null;
+    defaultRevenueWalletId: string | null;
+    defaultSalesPeriodId: string | null;
+};
 export type InventoryStatisticsResponse = {
     batches: number;
     categories: number;
@@ -1192,6 +1408,13 @@ export type InventoryCheckoutResponse = {
     checkoutUrl: string | null;
     checkoutMode?: InventoryStorefrontCheckoutMode;
     nextUrl?: string | null;
+    squarePos?: InventorySquarePosLaunch;
+};
+export type InventorySquarePosLaunch = {
+    androidUrl: string;
+    callbackUrl: string;
+    fallbackUrl: string;
+    iosUrl: string;
 };
 export type InventoryOrderHistoryItem = {
     checkout: InventoryCheckoutSession;
@@ -1247,6 +1470,9 @@ export declare function getInventoryStatistics(wsId: string, options?: InternalA
 export declare function getInventoryOverview(wsId: string, options?: InternalApiClientOptions): Promise<InventoryOverviewResponse>;
 export declare function getInventoryProduct(wsId: string, productId: string, options?: InternalApiClientOptions): Promise<Product>;
 export declare function getInventoryProductFormOptions(wsId: string, options?: InternalApiClientOptions): Promise<InventoryProductFormOptionsResponse>;
+export declare function updateInventorySalesDefaults(wsId: string, payload: InventorySalesDefaultsPayload, options?: InternalApiClientOptions): Promise<{
+    message: string;
+}>;
 export declare function listInventoryProducts(wsId: string, query?: InventoryCatalogListQuery, options?: InternalApiClientOptions): Promise<InventoryListResponse<InventoryProductSummary>>;
 export declare function createInventoryProduct(wsId: string, payload: InventoryProductPayload, options?: InternalApiClientOptions): Promise<{
     message: string;
@@ -1255,6 +1481,7 @@ export declare function updateInventoryProduct(wsId: string, productId: string,
     message: string;
 }>;
 export declare function deleteInventoryProduct(wsId: string, productId: string, options?: InternalApiClientOptions): Promise<{
+    disposition: 'archived' | 'deleted';
     message: string;
 }>;
 export declare function updateInventoryProductInventory(wsId: string, productId: string, payload: InventoryProductInventoryPayload, options?: InternalApiClientOptions): Promise<{
@@ -1344,7 +1571,40 @@ export declare function deleteInventoryOwner(wsId: string, ownerId: string, opti
 }>;
 export declare function listInventoryUnits(wsId: string, options?: InternalApiClientOptions): Promise<InventoryUnit[]>;
 export declare function listInventoryUnitsPage(wsId: string, query?: InventoryNamedListQuery, options?: InternalApiClientOptions): Promise<InventoryListResponse<ProductUnit>>;
-export declare function listInventorySales(wsId: string, query?: InventoryOffsetListQuery, options?: InternalApiClientOptions): Promise<InventoryListResponse<InventorySaleSummary>>;
+export declare function listInventorySales(wsId: string, query?: InventorySalesListQuery, options?: InternalApiClientOptions): Promise<InventorySalesListResponse>;
+export declare function getInventoryCommerceSummary(wsId: string, query?: Pick<InventorySalesListQuery, 'period_id' | 'unassigned'>, options?: InternalApiClientOptions): Promise<InventoryCommerceSummary>;
+export declare function listInventorySalesPeriods(wsId: string, query?: {
+    include_archived?: boolean;
+}, options?: InternalApiClientOptions): Promise<{
+    data: InventorySalesPeriod[];
+}>;
+export declare function createInventorySalesPeriod(wsId: string, payload: InventorySalesPeriodPayload, options?: InternalApiClientOptions): Promise<{
+    data: InventorySalesPeriod;
+}>;
+export declare function updateInventorySalesPeriod(wsId: string, periodId: string, payload: Partial<InventorySalesPeriodPayload & {
+    status: InventorySalesPeriodStatus;
+}>, options?: InternalApiClientOptions): Promise<{
+    data: InventorySalesPeriod;
+}>;
+export declare function deleteInventorySalesPeriod(wsId: string, periodId: string, options?: InternalApiClientOptions): Promise<{
+    ok: true;
+}>;
+export declare function setInventorySalePeriod(wsId: string, saleId: string, payload: {
+    period_id: string | null;
+    source: InventorySaleSource;
+}, options?: InternalApiClientOptions): Promise<{
+    data: InventorySalesPeriod | null;
+}>;
+export declare function setInventorySalesPeriodBulk(wsId: string, payload: {
+    period_id: string | null;
+    sales: Array<{
+        id: string;
+        source: InventorySaleSource;
+    }>;
+}, options?: InternalApiClientOptions): Promise<{
+    data: InventorySalesPeriod | null;
+    updated: number;
+}>;
 export type InventoryProductSalesRow = {
     productId: string;
     productName: string;
@@ -1357,6 +1617,7 @@ export declare function listInventorySalesByProduct(wsId: string, options?: Inte
 export declare function getInventorySale(wsId: string, saleId: string, options?: InternalApiClientOptions): Promise<{
     data: InventorySaleDetail;
 }>;
+export declare function createInventorySale(wsId: string, payload: InventorySaleCreatePayload, options?: InternalApiClientOptions): Promise<InventorySaleCreateResponse>;
 export declare function updateInventorySale(wsId: string, saleId: string, payload: InventorySaleUpdatePayload, options?: InternalApiClientOptions): Promise<{
     data: InventorySaleDetail;
 }>;
@@ -1399,6 +1660,9 @@ export declare function listInventoryStorefrontListings(wsId: string, storefront
 export declare function createInventoryStorefrontListing(wsId: string, storefrontId: string, payload: InventoryStorefrontListingPayload, options?: InternalApiClientOptions): Promise<{
     data: InventoryStorefrontListing;
 }>;
+export declare function bulkImportInventoryStorefrontListings(wsId: string, storefrontId: string, options?: InternalApiClientOptions): Promise<{
+    data: InventoryStorefrontBulkImportResult;
+}>;
 export declare function updateInventoryStorefrontListing(wsId: string, storefrontId: string, listingId: string, payload: Partial<InventoryStorefrontListingPayload>, options?: InternalApiClientOptions): Promise<{
     data: InventoryStorefrontListing;
 }>;
@@ -1460,6 +1724,9 @@ export declare function createInventorySquareDeviceCode(wsId: string, payload: {
 export declare function getInventoryStorefrontAnalytics(wsId: string, query?: {
     days?: number;
 }, options?: InternalApiClientOptions): Promise<InventoryStorefrontAnalytics>;
+export declare function getInventoryAnalytics(wsId: string, query?: {
+    days?: number;
+}, options?: InternalApiClientOptions): Promise<InventoryAnalyticsResponse>;
 export declare function getInventoryPolarSyncSummary(wsId: string, options?: InternalApiClientOptions): Promise<InventoryPolarProductSyncSummary>;
 export declare function syncInventoryPolarProducts(wsId: string, options?: InternalApiClientOptions): Promise<{
     ok: boolean;