@thorprovider/medusa-extended 1.0.0 → 1.1.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { GetChannelCustomersOptions, GetChannelCustomersResponse, GetChannelApiKeysResponse, GetChannelCategoriesOptions, GetChannelCategoriesResponse, GetCategorySalesChannelsResponse, AssignCategoriesToChannelsBody, AssignCategoriesToChannelsResponse, UnassignCategoriesFromChannelsBody, UnassignCategoriesFromChannelsResponse, GetCollectionSalesChannelsResponse, AssignCollectionsToChannelsBody, AssignCollectionsToChannelsResponse, UnassignCollectionsFromChannelsBody, UnassignCollectionsFromChannelsResponse, GetAdminStorefrontConfigResponse, UpdateStorefrontConfigBody, UpdateStorefrontConfigResponse, GetAdminSiteConfigResponse, UpdateSiteConfigBody, UpdateSiteConfigResponse, GetAdminSiteConfigHistoryOptions, GetAdminSiteConfigHistoryResponse, RestoreSiteConfigResponse } from '@thorprovider/types';
+import { GetChannelCustomersOptions, GetChannelCustomersResponse, GetChannelApiKeysResponse, GetChannelCategoriesOptions, GetChannelCategoriesResponse, GetCategorySalesChannelsResponse, AssignCategoriesToChannelsBody, AssignCategoriesToChannelsResponse, UnassignCategoriesFromChannelsBody, UnassignCategoriesFromChannelsResponse, GetCollectionSalesChannelsResponse, AssignCollectionsToChannelsBody, AssignCollectionsToChannelsResponse, UnassignCollectionsFromChannelsBody, UnassignCollectionsFromChannelsResponse, GetAdminStorefrontConfigResponse, UpdateStorefrontConfigBody, UpdateStorefrontConfigResponse, GetAdminSiteConfigResponse, UpdateSiteConfigBody, UpdateSiteConfigResponse, GetAdminSiteConfigHistoryOptions, GetAdminSiteConfigHistoryResponse, RestoreSiteConfigResponse, OnboardDropshipperBody, OnboardDropshipperResponse, GetVariantCostsOptions, GetVariantCostsResponse, CreateVariantCostBody, CreateVariantCostResponse, BatchVariantCostsBody, BatchVariantCostsResponse, DeleteVariantCostResponse, GetDropshipperProductsOptions, GetDropshipperProductsResponse, UpdateDropshipperPricesBody, UpdateDropshipperPricesResponse, GetDropshipperOrdersOptions, GetDropshipperOrdersResponse, GetDropshipperOrderDetailResponse, CreateDropshipperOrderBody, CreateDropshipperOrderResponse, SetPaymentCollectorBody, SetPaymentCollectorResponse, CancelDropshipperOrderResponse, CreateOrderEditBody, CreateOrderEditResponse, AddOrderEditItemBody, AddOrderEditItemResponse, ConfirmOrderEditResponse, GetOrderNotesResponse, CreateOrderNoteBody, OrderNote, DeleteOrderNoteResponse, GetDropshipperCategoriesOptions, GetDropshipperCategoriesResponse, CreateDropshipperCategoryBody, DropshipperCategory, UpdateDropshipperCategoryBody, DeleteDropshipperCategoryResponse, CreateCategoryMappingBody, CreateCategoryMappingResponse, DeleteCategoryMappingResponse, GetDropshipperCustomersOptions, GetDropshipperCustomersResponse, GetDropshipperCustomerDetailResponse, CreateDropshipperCustomerBody, CreateDropshipperCustomerResponse, GetDropshipperAddressesResponse, DropshipperAddressBody, DropshipperAddressResponse, GetDropshipperAccountResponse, GetDropshipperPayableResponse, GetDropshipperReceivableResponse, GetSettlementsOptions, GetSettlementsResponse, GetSettlementDetailResponse, CreateSettlementBody, CreateSettlementResponse, ConfirmSettlementBody, UpdateSettlementStatusResponse, CancelSettlementBody, GetAdminDropshipperAccountsResponse, GetAdminAccountBalanceResponse, GetAdminPriceListsResponse, GetUserChannelResponse, GetDropshipperPromotionsOptions, GetDropshipperPromotionsResponse, CreateDropshipperPromotionBody, DropshipperPromotion, UpdateDropshipperPromotionBody, DeleteDropshipperPromotionResponse, GetDashboardStatsOptions, GetDashboardStatsResponse, GetStorefrontDropshipperCategoriesResponse } from '@thorprovider/types';
 
 /**
  * @fileoverview Medusa Multi-Tenant Admin Client
@@ -147,4 +147,371 @@ declare class MedusaAdminClient {
     restoreSiteConfig(salesChannelId: string, version: string): Promise<RestoreSiteConfigResponse>;
 }
 
-export { MedusaAdminClient, type MedusaAdminClientConfig };
+/**
+ * @fileoverview Dropshipper Client — Thor Commerce Extended
+ * @module @thorprovider/medusa-extended/dropshipper
+ *
+ * HTTP client for all `/admin/thor/dropshipper/` endpoints.
+ *
+ * Used by both:
+ *   - X (ThorProvider admin) — authenticated via admin JWT, role "Admin"
+ *   - Y (Dropshipper panel) — authenticated via dropshipper JWT, role "Dropshipper"
+ *
+ * Access control is enforced server-side via `withDropshipperScope` middleware.
+ * This client always sends `Authorization: Bearer <token>`.
+ *
+ * Endpoint reference: `dropshipping-api-contract.md`
+ */
+
+/**
+ * Configuration required to instantiate the dropshipper client.
+ */
+interface DropshipperClientConfig {
+    /** Medusa backend base URL */
+    baseUrl: string;
+    /**
+     * JWT token obtained from `POST /auth/user/emailpass`.
+     * Used as `Authorization: Bearer <token>`.
+     */
+    token: string;
+    /** Enable debug logging */
+    debug?: boolean;
+}
+/**
+ * HTTP client for Thor Commerce dropshipping endpoints (`/admin/thor/dropshipper/`).
+ *
+ * All methods throw `ProviderAPIError` on non-2xx responses.
+ *
+ * @example
+ * ```typescript
+ * const client = new DropshipperClient({
+ *   baseUrl: process.env.MEDUSA_BACKEND_URL!,
+ *   token: jwtFromLogin,
+ * });
+ *
+ * // Y: list own products
+ * const { products } = await client.getProducts();
+ *
+ * // X: onboard a new dropshipper
+ * const { dropshipper } = await client.onboardDropshipper({ ... });
+ * ```
+ */
+declare class DropshipperClient {
+    private baseUrl;
+    private token;
+    private logger;
+    constructor(config: DropshipperClientConfig);
+    private request;
+    /**
+     * Create a new dropshipper account (sales channel + user + price list).
+     *
+     * `POST /admin/thor/dropshipper/onboard`
+     */
+    onboardDropshipper(body: OnboardDropshipperBody): Promise<OnboardDropshipperResponse>;
+    /**
+     * List variant cost records, optionally filtered by account/variant/currency.
+     *
+     * `GET /admin/thor/dropshipper/variant-costs`
+     */
+    getVariantCosts(options?: GetVariantCostsOptions): Promise<GetVariantCostsResponse>;
+    /**
+     * Upsert a single variant cost record.
+     *
+     * `POST /admin/thor/dropshipper/variant-costs`
+     */
+    createVariantCost(body: CreateVariantCostBody): Promise<CreateVariantCostResponse>;
+    /**
+     * Batch-upsert variant costs for a given account and currency.
+     *
+     * `POST /admin/thor/dropshipper/variant-costs/batch`
+     */
+    batchVariantCosts(body: BatchVariantCostsBody): Promise<BatchVariantCostsResponse>;
+    /**
+     * Delete a variant cost record by ID.
+     *
+     * `DELETE /admin/thor/dropshipper/variant-costs/:id`
+     */
+    deleteVariantCost(id: string): Promise<DeleteVariantCostResponse>;
+    /**
+     * List products available in Y's channel with cost/margin data.
+     *
+     * `GET /admin/thor/dropshipper/products`
+     */
+    getProducts(options?: GetDropshipperProductsOptions): Promise<GetDropshipperProductsResponse>;
+    /**
+     * Bulk-update sale prices on Y's channel price list.
+     *
+     * `PUT /admin/thor/dropshipper/prices`
+     */
+    updatePrices(body: UpdateDropshipperPricesBody): Promise<UpdateDropshipperPricesResponse>;
+    /**
+     * Paginated list of orders in Y's channel.
+     *
+     * `GET /admin/thor/dropshipper/orders`
+     */
+    getOrders(options?: GetDropshipperOrdersOptions): Promise<GetDropshipperOrdersResponse>;
+    /**
+     * Full detail for a single order with profit breakdown.
+     *
+     * `GET /admin/thor/dropshipper/orders/:id`
+     */
+    getOrder(orderId: string): Promise<GetDropshipperOrderDetailResponse>;
+    /**
+     * Manually create an order on behalf of a customer.
+     *
+     * `POST /admin/thor/dropshipper/orders`
+     */
+    createOrder(body: CreateDropshipperOrderBody): Promise<CreateDropshipperOrderResponse>;
+    /**
+     * Set who collects payment for an order (Solo X).
+     *
+     * `POST /admin/thor/dropshipper/orders/:id/set-payment-collector`
+     */
+    setPaymentCollector(orderId: string, body: SetPaymentCollectorBody): Promise<SetPaymentCollectorResponse>;
+    /**
+     * Cancel a dropshipper order.
+     *
+     * `POST /admin/thor/dropshipper/orders/:id/cancel`
+     */
+    cancelOrder(orderId: string): Promise<CancelDropshipperOrderResponse>;
+    /**
+     * Create an order edit for a dropshipper order.
+     *
+     * `POST /admin/thor/dropshipper/orders/:id/edit`
+     */
+    createOrderEdit(orderId: string, body?: CreateOrderEditBody): Promise<CreateOrderEditResponse>;
+    /**
+     * Add an item to the active order edit.
+     *
+     * `POST /admin/thor/dropshipper/orders/:id/edit/items`
+     */
+    addOrderEditItem(orderId: string, body: AddOrderEditItemBody): Promise<AddOrderEditItemResponse>;
+    /**
+     * Confirm the active order edit, applying changes to the order.
+     *
+     * `POST /admin/thor/dropshipper/orders/:id/edit/confirm`
+     */
+    confirmOrderEdit(orderId: string): Promise<ConfirmOrderEditResponse>;
+    /**
+      * Get all notes for an order.
+   *
+   * `GET /admin/thor/dropshipper/orders/:id/notes`
+   */
+    getOrderNotes(orderId: string): Promise<GetOrderNotesResponse>;
+    /**
+     * Create a new note for an order.
+     *
+     * `POST /admin/thor/dropshipper/orders/:id/notes`
+     */
+    createOrderNote(orderId: string, body: CreateOrderNoteBody): Promise<OrderNote>;
+    /**
+     * Delete a note from an order.
+     *
+     * `DELETE /admin/thor/dropshipper/orders/:id/notes/:noteId`
+     */
+    deleteOrderNote(orderId: string, noteId: string): Promise<DeleteOrderNoteResponse>;
+    /**
+     * List Y's custom product categories.
+     *
+     * `GET /admin/thor/dropshipper/categories`
+     */
+    getCategories(options?: GetDropshipperCategoriesOptions): Promise<GetDropshipperCategoriesResponse>;
+    /**
+     * Create a custom category in Y's channel.
+     *
+     * `POST /admin/thor/dropshipper/categories`
+     */
+    createCategory(body: CreateDropshipperCategoryBody): Promise<DropshipperCategory>;
+    /**
+     * Update a custom category.
+     *
+     * `PUT /admin/thor/dropshipper/categories/:id`
+     */
+    updateCategory(categoryId: string, body: UpdateDropshipperCategoryBody): Promise<DropshipperCategory>;
+    /**
+     * Delete a custom category.
+     *
+     * `DELETE /admin/thor/dropshipper/categories/:id`
+     */
+    deleteCategory(categoryId: string): Promise<DeleteDropshipperCategoryResponse>;
+    /**
+     * Map a product to a custom category.
+     *
+     * `POST /admin/thor/dropshipper/category-mappings`
+     */
+    createCategoryMapping(body: CreateCategoryMappingBody): Promise<CreateCategoryMappingResponse>;
+    /**
+     * Remove a product-to-category mapping.
+     *
+     * `DELETE /admin/thor/dropshipper/category-mappings/:id`
+     */
+    deleteCategoryMapping(mappingId: string): Promise<DeleteCategoryMappingResponse>;
+    /**
+     * Paginated list of customers in Y's channel.
+     *
+     * `GET /admin/thor/dropshipper/customers`
+     */
+    getCustomers(options?: GetDropshipperCustomersOptions): Promise<GetDropshipperCustomersResponse>;
+    /**
+     * Full detail for a single customer.
+     *
+     * `GET /admin/thor/dropshipper/customers/:id`
+     */
+    getCustomer(customerId: string): Promise<GetDropshipperCustomerDetailResponse>;
+    /**
+     * Create a customer scoped to Y's channel.
+     *
+     * `POST /admin/thor/dropshipper/customers`
+     */
+    createCustomer(body: CreateDropshipperCustomerBody): Promise<CreateDropshipperCustomerResponse>;
+    /**
+     * List addresses for a customer in Y's channel.
+     *
+     * `GET /admin/thor/dropshipper/customers/:id/addresses`
+     */
+    getCustomerAddresses(customerId: string): Promise<GetDropshipperAddressesResponse>;
+    /**
+     * Create a new address for a customer.
+     *
+     * `POST /admin/thor/dropshipper/customers/:id/addresses`
+     */
+    createCustomerAddress(customerId: string, body: DropshipperAddressBody): Promise<DropshipperAddressResponse>;
+    /**
+     * Update an existing customer address.
+     *
+     * `PUT /admin/thor/dropshipper/customers/:id/addresses/:addressId`
+     */
+    updateCustomerAddress(customerId: string, addressId: string, body: Partial<DropshipperAddressBody>): Promise<DropshipperAddressResponse>;
+    /**
+     * Delete a customer address.
+     *
+     * `DELETE /admin/thor/dropshipper/customers/:id/addresses/:addressId`
+     */
+    deleteCustomerAddress(customerId: string, addressId: string): Promise<{
+        deleted: true;
+        id: string;
+    }>;
+    /**
+     * Y's account info with current balance.
+     *
+     * `GET /admin/thor/dropshipper/account`
+     */
+    getAccount(): Promise<GetDropshipperAccountResponse>;
+    /**
+     * Orders where Y owes money to X (Y collected payment, needs to pay costs).
+     *
+     * `GET /admin/thor/dropshipper/account/payable`
+     */
+    getPayable(): Promise<GetDropshipperPayableResponse>;
+    /**
+     * Orders where X owes money to Y (X collected COD, needs to transfer profit).
+     *
+     * `GET /admin/thor/dropshipper/account/receivable`
+     */
+    getReceivable(): Promise<GetDropshipperReceivableResponse>;
+    /**
+     * List settlements (Y sees own; X can filter by account_id).
+     *
+     * `GET /admin/thor/dropshipper/settlements`
+     */
+    getSettlements(options?: GetSettlementsOptions): Promise<GetSettlementsResponse>;
+    /**
+     * Full detail for a single settlement record.
+     *
+     * `GET /admin/thor/dropshipper/settlements/:id`
+     */
+    getSettlement(settlementId: string): Promise<GetSettlementDetailResponse>;
+    /**
+     * Create a settlement record for a dropshipper account.
+     *
+     * `POST /admin/thor/dropshipper/admin/settlements`
+     */
+    createSettlement(body: CreateSettlementBody): Promise<CreateSettlementResponse>;
+    /**
+     * Confirm a pending settlement (marks it as paid/received).
+     *
+     * `POST /admin/thor/dropshipper/admin/settlements/:id/confirm`
+     */
+    confirmSettlement(settlementId: string, body?: ConfirmSettlementBody): Promise<UpdateSettlementStatusResponse>;
+    /**
+     * Cancel a pending settlement.
+     *
+     * `POST /admin/thor/dropshipper/admin/settlements/:id/cancel`
+     */
+    cancelSettlement(settlementId: string, body?: CancelSettlementBody): Promise<UpdateSettlementStatusResponse>;
+    /**
+     * X views all settlement records across all dropshipper accounts.
+     *
+     * `GET /admin/thor/dropshipper/admin/settlements`
+     */
+    getAdminSettlements(options?: GetSettlementsOptions): Promise<GetSettlementsResponse>;
+    /**
+     * List all dropshipper accounts.
+     *
+     * `GET /admin/thor/dropshipper/admin/accounts`
+     */
+    getAdminAccounts(): Promise<GetAdminDropshipperAccountsResponse>;
+    /**
+     * Full balance detail for a specific dropshipper account.
+     *
+     * `GET /admin/thor/dropshipper/admin/accounts/:id/balance`
+     */
+    getAdminAccountBalance(accountId: string): Promise<GetAdminAccountBalanceResponse>;
+    /**
+     * List all dropshipper price lists.
+     *
+     * `GET /admin/thor/dropshipper/admin/price-lists`
+     */
+    getAdminPriceLists(): Promise<GetAdminPriceListsResponse>;
+    /**
+     * Utility: look up which sales channel a user belongs to.
+     *
+     * `GET /admin/thor/dropshipper/admin/user-channel`
+     */
+    getUserChannel(): Promise<GetUserChannelResponse>;
+    /**
+     * List Y's promotions (discount codes).
+     *
+     * `GET /admin/thor/dropshipper/promotions`
+     */
+    getPromotions(options?: GetDropshipperPromotionsOptions): Promise<GetDropshipperPromotionsResponse>;
+    /**
+     * Create a promotion for Y's channel.
+     *
+     * `POST /admin/thor/dropshipper/promotions`
+     */
+    createPromotion(body: CreateDropshipperPromotionBody): Promise<DropshipperPromotion>;
+    /**
+     * Get a single promotion by ID.
+     *
+     * `GET /admin/thor/dropshipper/promotions/:id`
+     */
+    getPromotion(promotionId: string): Promise<DropshipperPromotion>;
+    /**
+     * Update an existing promotion.
+     *
+     * `PUT /admin/thor/dropshipper/promotions/:id`
+     */
+    updatePromotion(promotionId: string, body: UpdateDropshipperPromotionBody): Promise<DropshipperPromotion>;
+    /**
+     * Delete a promotion.
+     *
+     * `DELETE /admin/thor/dropshipper/promotions/:id`
+     */
+    deletePromotion(promotionId: string): Promise<DeleteDropshipperPromotionResponse>;
+    /**
+     * Aggregate stats for Y's dashboard (revenue, profit, top products).
+     *
+     * `GET /admin/thor/dropshipper/dashboard/stats`
+     */
+    getDashboardStats(options?: GetDashboardStatsOptions): Promise<GetDashboardStatsResponse>;
+    /**
+     * Public endpoint: dropshipper-scoped categories for the storefront.
+     * Typically called with a publishable API key rather than a JWT.
+     *
+     * `GET /store/thor/dropshipper-categories`
+     */
+    getStorefrontCategories(): Promise<GetStorefrontDropshipperCategoriesResponse>;
+}
+
+export { DropshipperClient, type DropshipperClientConfig, MedusaAdminClient, type MedusaAdminClientConfig };