brinkcommerce-dev-mcp 0.1.0-beta.1

package/dist/clients/order-management-client.d.ts

@@ -0,0 +1,690 @@
+import type { Order } from "../generated/order-management/src/models/Order.js";
+import type { CancellationRequest } from "../generated/order-management/src/models/CancellationRequest.js";
+import type { CancellationDetails } from "../generated/order-management/src/models/CancellationDetails.js";
+import type { Cancellation } from "../generated/order-management/src/models/Cancellation.js";
+import type { RefundRequest } from "../generated/order-management/src/models/RefundRequest.js";
+import type { RefundDetails } from "../generated/order-management/src/models/RefundDetails.js";
+import type { Refund } from "../generated/order-management/src/models/Refund.js";
+import type { ImportOrderRequest } from "../generated/order-management/src/models/ImportOrderRequest.js";
+import type { ImportOrderResponse } from "../generated/order-management/src/models/ImportOrderResponse.js";
+import type { DeliveryRequest } from "../generated/order-management/src/models/DeliveryRequest.js";
+import type { DeliveryDetails } from "../generated/order-management/src/models/DeliveryDetails.js";
+import type { Delivery } from "../generated/order-management/src/models/Delivery.js";
+import type { ReleaseRequest } from "../generated/order-management/src/models/ReleaseRequest.js";
+import type { ReleaseDetails } from "../generated/order-management/src/models/ReleaseDetails.js";
+import type { Release } from "../generated/order-management/src/models/Release.js";
+import type { CompensationRequest } from "../generated/order-management/src/models/CompensationRequest.js";
+import type { CompensationDetails } from "../generated/order-management/src/models/CompensationDetails.js";
+import type { Compensation } from "../generated/order-management/src/models/Compensation.js";
+import type { OrderCompensations } from "../generated/order-management/src/models/OrderCompensations.js";
+import type { StartCompensationRequest } from "../generated/order-management/src/models/StartCompensationRequest.js";
+import type { OrderLinesModificationRequest } from "../generated/order-management/src/models/OrderLinesModificationRequest.js";
+import type { OrderLinesModificationDetails } from "../generated/order-management/src/models/OrderLinesModificationDetails.js";
+import type { OrderLinesModification } from "../generated/order-management/src/models/OrderLinesModification.js";
+import type { ShippingFeesModificationRequest } from "../generated/order-management/src/models/ShippingFeesModificationRequest.js";
+import type { ShippingFeesModificationDetails } from "../generated/order-management/src/models/ShippingFeesModificationDetails.js";
+import type { ShippingFeesModification } from "../generated/order-management/src/models/ShippingFeesModification.js";
+import type { OrderAddressesModificationRequest } from "../generated/order-management/src/models/OrderAddressesModificationRequest.js";
+import type { OrderAddressesModificationDetails } from "../generated/order-management/src/models/OrderAddressesModificationDetails.js";
+import type { OrderAddressesModification } from "../generated/order-management/src/models/OrderAddressesModification.js";
+import type { OrderModifications } from "../generated/order-management/src/models/OrderModifications.js";
+import type { StartOrderLinesModificationRequest } from "../generated/order-management/src/models/StartOrderLinesModificationRequest.js";
+import type { StartShippingFeesModificationRequest } from "../generated/order-management/src/models/StartShippingFeesModificationRequest.js";
+import type { CustomState } from "../generated/order-management/src/models/CustomState.js";
+import type { CustomStates } from "../generated/order-management/src/models/CustomStates.js";
+import type { CustomReasonCode } from "../generated/order-management/src/models/CustomReasonCode.js";
+import type { CustomReasonCodes } from "../generated/order-management/src/models/CustomReasonCodes.js";
+import type { OrderSummaries } from "../generated/order-management/src/models/OrderSummaries.js";
+import type { OrderHistory } from "../generated/order-management/src/models/OrderHistory.js";
+import type { OrderStockReservation } from "../generated/order-management/src/models/OrderStockReservation.js";
+import type { OrderDeliveries } from "../generated/order-management/src/models/OrderDeliveries.js";
+import type { OrderCancellations } from "../generated/order-management/src/models/OrderCancellations.js";
+import type { OrderRefunds } from "../generated/order-management/src/models/OrderRefunds.js";
+import type { OrderReleases } from "../generated/order-management/src/models/OrderReleases.js";
+import type { Comment } from "../generated/order-management/src/models/Comment.js";
+import type { OrderComment } from "../generated/order-management/src/models/OrderComment.js";
+import { BrinkApiClientConfig, ApiResult } from "./types.js";
+/**
+ * Options for starting a delivery
+ */
+export interface StartDeliveryOptions {
+    /** Reason code for the delivery */
+    reasonCode?: string;
+    /** Human-readable cause for the delivery */
+    reasonCause?: string;
+    /** Payment action: AUTO, MANUAL, or SKIP */
+    paymentAction?: "AUTO" | "MANUAL" | "SKIP";
+    /** Capture reference (required when paymentAction is MANUAL) */
+    captureReference?: string;
+    /** Shipping action: AUTO, MANUAL, or SKIP */
+    shippingAction?: "AUTO" | "MANUAL" | "SKIP";
+    /** Tracking reference (required when shippingAction is MANUAL) */
+    trackingReference?: string;
+    /** Tracking URL (required when shippingAction is MANUAL) */
+    trackingUrl?: string;
+    /** Shipping method (required when shippingAction is MANUAL) */
+    shippingMethod?: string;
+    /** Shipping company (optional when shippingAction is MANUAL) */
+    shippingCompany?: string;
+    /** Gift card action: AUTO, MANUAL, or SKIP */
+    giftCardAction?: "AUTO" | "MANUAL" | "SKIP";
+    /** Bonus action: AUTO, MANUAL, or SKIP */
+    bonusAction?: "AUTO" | "MANUAL" | "SKIP";
+    /** Bonus transaction ID (required when bonusAction is MANUAL) */
+    bonusTransactionId?: string;
+}
+/**
+ * Options for starting a cancellation
+ */
+export interface StartCancellationOptions {
+    /** Payment action: AUTO, MANUAL, or SKIP */
+    paymentAction?: "AUTO" | "MANUAL" | "SKIP";
+    /** Gift card action: AUTO, MANUAL, or SKIP */
+    giftCardAction?: "AUTO" | "MANUAL" | "SKIP";
+    /** Gift card product action: AUTO, MANUAL, or SKIP */
+    giftCardProductAction?: "AUTO" | "MANUAL" | "SKIP";
+    /** Bonus action: AUTO, MANUAL, or SKIP */
+    bonusAction?: "AUTO" | "MANUAL" | "SKIP";
+}
+/**
+ * Options for starting a refund
+ */
+export interface StartRefundOptions {
+    /** Payment action: AUTO, MANUAL, or SKIP */
+    paymentAction?: "AUTO" | "MANUAL" | "SKIP";
+    /** Gift card action: AUTO, MANUAL, or SKIP */
+    giftCardAction?: "AUTO" | "MANUAL" | "SKIP";
+    /** Gift card product action: AUTO, MANUAL, or SKIP */
+    giftCardProductAction?: "AUTO" | "MANUAL" | "SKIP";
+    /** Bonus action: AUTO, MANUAL, or SKIP */
+    bonusAction?: "AUTO" | "MANUAL" | "SKIP";
+}
+/**
+ * Options for starting a release
+ */
+export interface StartReleaseOptions {
+    /** Payment action: AUTO, MANUAL, or SKIP */
+    paymentAction?: "AUTO" | "MANUAL" | "SKIP";
+    /** Gift card action: AUTO, MANUAL, or SKIP */
+    giftCardAction?: "AUTO" | "MANUAL" | "SKIP";
+    /** Gift card product action: AUTO, MANUAL, or SKIP */
+    giftCardProductAction?: "AUTO" | "MANUAL" | "SKIP";
+    /** Bonus action: AUTO, MANUAL, or SKIP */
+    bonusAction?: "AUTO" | "MANUAL" | "SKIP";
+}
+/**
+ * BrinkCommerce Order Management API Client
+ * Wraps the generated client with authentication and error handling
+ */
+export declare class BrinkOrderManagementClient {
+    private ordersApi;
+    private cancellationsApi;
+    private refundsApi;
+    private importsApi;
+    private deliveriesApi;
+    private releasesApi;
+    private compensationsApi;
+    private modificationsApi;
+    private customApi;
+    private apiKey;
+    private region;
+    private customerName;
+    constructor(config?: BrinkApiClientConfig);
+    /**
+     * Get an order by ID
+     *
+     * @param orderId - The order ID to retrieve
+     * @returns Result with order data or error
+     */
+    getOrder(orderId: string): Promise<ApiResult<Order>>;
+    /**
+     * Get an order by reference
+     *
+     * @param reference - The order reference
+     * @returns Result with order data or error
+     */
+    getOrderByReference(reference: string): Promise<ApiResult<Order>>;
+    /**
+     * Cancel an order
+     *
+     * @param orderId - The order ID to cancel
+     * @param request - Cancellation request data
+     * @returns Result with cancellation details or error
+     */
+    cancelOrder(orderId: string, request: CancellationRequest): Promise<ApiResult<CancellationDetails>>;
+    /**
+     * Create a refund for an order
+     *
+     * @param orderId - The order ID to refund
+     * @param request - Refund request data
+     * @returns Result with refund details or error
+     */
+    refundOrder(orderId: string, request: RefundRequest): Promise<ApiResult<RefundDetails>>;
+    /**
+     * Import an external order into BrinkCommerce
+     *
+     * @param importId - The external import ID for this order
+     * @param request - Import order request data
+     * @returns Result with import response or error
+     */
+    importOrder(importId: string, request: ImportOrderRequest): Promise<ApiResult<ImportOrderResponse>>;
+    /**
+     * Get an imported order by import ID
+     *
+     * @param importId - The import ID to retrieve
+     * @returns Result with order data or error
+     */
+    getImportedOrder(importId: string): Promise<ApiResult<Order>>;
+    /**
+     * Create a delivery for an order
+     *
+     * @param orderId - The order ID to create delivery for
+     * @param request - Delivery request data
+     * @returns Result with delivery details or error
+     */
+    createDelivery(orderId: string, request: DeliveryRequest): Promise<ApiResult<DeliveryDetails>>;
+    /**
+     * Get a delivery by ID
+     *
+     * @param deliveryId - The delivery ID to retrieve
+     * @returns Result with delivery data or error
+     */
+    getDelivery(deliveryId: string): Promise<ApiResult<Delivery>>;
+    /**
+     * Update a delivery
+     *
+     * @param deliveryId - The delivery ID to update
+     * @param request - Delivery request data
+     * @returns Result with delivery details or error
+     */
+    updateDelivery(deliveryId: string, request: DeliveryRequest): Promise<ApiResult<DeliveryDetails>>;
+    /**
+     * Delete a delivery
+     *
+     * @param deliveryId - The delivery ID to delete
+     * @returns Result with success or error
+     */
+    deleteDelivery(deliveryId: string): Promise<ApiResult<void>>;
+    /**
+     * Start a delivery
+     *
+     * @param deliveryId - The delivery ID to start
+     * @param options - Optional start delivery request options
+     * @returns Result with success or error
+     */
+    startDelivery(deliveryId: string, options?: StartDeliveryOptions): Promise<ApiResult<void>>;
+    /**
+     * Restart a delivery
+     *
+     * @param deliveryId - The delivery ID to restart
+     * @param options - Optional start delivery request options
+     * @returns Result with success or error
+     */
+    restartDelivery(deliveryId: string, options?: StartDeliveryOptions): Promise<ApiResult<void>>;
+    /**
+     * Get a cancellation by ID
+     *
+     * @param cancellationId - The cancellation ID to retrieve
+     * @returns Result with cancellation data or error
+     */
+    getCancellation(cancellationId: string): Promise<ApiResult<Cancellation>>;
+    /**
+     * Delete a cancellation
+     *
+     * @param cancellationId - The cancellation ID to delete
+     * @returns Result with success or error
+     */
+    deleteCancellation(cancellationId: string): Promise<ApiResult<void>>;
+    /**
+     * Start a cancellation
+     *
+     * @param cancellationId - The cancellation ID to start
+     * @param options - Optional start cancellation request options
+     * @returns Result with success or error
+     */
+    startCancellation(cancellationId: string, options?: StartCancellationOptions): Promise<ApiResult<void>>;
+    /**
+     * Restart a cancellation
+     *
+     * @param cancellationId - The cancellation ID to restart
+     * @param options - Optional start cancellation request options
+     * @returns Result with success or error
+     */
+    restartCancellation(cancellationId: string, options?: StartCancellationOptions): Promise<ApiResult<void>>;
+    /**
+     * Get a refund by ID
+     *
+     * @param refundId - The refund ID to retrieve
+     * @returns Result with refund data or error
+     */
+    getRefund(refundId: string): Promise<ApiResult<Refund>>;
+    /**
+     * Update a refund
+     *
+     * @param refundId - The refund ID to update
+     * @param request - Refund request data
+     * @returns Result with refund details or error
+     */
+    updateRefund(refundId: string, request: RefundRequest): Promise<ApiResult<RefundDetails>>;
+    /**
+     * Delete a refund
+     *
+     * @param refundId - The refund ID to delete
+     * @returns Result with success or error
+     */
+    deleteRefund(refundId: string): Promise<ApiResult<void>>;
+    /**
+     * Start a refund
+     *
+     * @param refundId - The refund ID to start
+     * @param options - Optional start refund request options
+     * @returns Result with success or error
+     */
+    startRefund(refundId: string, options?: StartRefundOptions): Promise<ApiResult<void>>;
+    /**
+     * Restart a refund
+     *
+     * @param refundId - The refund ID to restart
+     * @param options - Optional start refund request options
+     * @returns Result with success or error
+     */
+    restartRefund(refundId: string, options?: StartRefundOptions): Promise<ApiResult<void>>;
+    /**
+     * Create a release for an order
+     *
+     * @param orderId - The order ID to create release for
+     * @param request - Release request data
+     * @returns Result with release details or error
+     */
+    createRelease(orderId: string, request: ReleaseRequest): Promise<ApiResult<ReleaseDetails>>;
+    /**
+     * Get a release by ID
+     *
+     * @param releaseId - The release ID to retrieve
+     * @returns Result with release data or error
+     */
+    getRelease(releaseId: string): Promise<ApiResult<Release>>;
+    /**
+     * Delete a release
+     *
+     * @param releaseId - The release ID to delete
+     * @returns Result with success or error
+     */
+    deleteRelease(releaseId: string): Promise<ApiResult<void>>;
+    /**
+     * Start a release
+     *
+     * @param releaseId - The release ID to start
+     * @param options - Optional start release request options
+     * @returns Result with success or error
+     */
+    startRelease(releaseId: string, options?: StartReleaseOptions): Promise<ApiResult<void>>;
+    /**
+     * Restart a release
+     *
+     * @param releaseId - The release ID to restart
+     * @param options - Optional start release request options
+     * @returns Result with success or error
+     */
+    restartRelease(releaseId: string, options?: StartReleaseOptions): Promise<ApiResult<void>>;
+    /**
+     * Get orders by billing address email
+     *
+     * @param email - The email address to search for
+     * @param from - Optional start date filter (RFC3339)
+     * @param to - Optional end date filter (RFC3339)
+     * @returns Result with order summaries or error
+     */
+    getOrdersByEmail(email: string, from?: Date, to?: Date): Promise<ApiResult<OrderSummaries>>;
+    /**
+     * Get orders by merchant reference
+     *
+     * @param merchantRef1 - The merchant reference to search for
+     * @param from - Optional start date filter (RFC3339)
+     * @param to - Optional end date filter (RFC3339)
+     * @returns Result with order summaries or error
+     */
+    getOrdersByMerchantRef(merchantRef1: string, from?: Date, to?: Date): Promise<ApiResult<OrderSummaries>>;
+    /**
+     * Get order history (status changes)
+     *
+     * @param orderId - The order ID
+     * @returns Result with order history or error
+     */
+    getOrderHistory(orderId: string): Promise<ApiResult<OrderHistory>>;
+    /**
+     * Get order stock reservation
+     *
+     * @param orderId - The order ID
+     * @returns Result with stock reservation data or error
+     */
+    getOrderReservation(orderId: string): Promise<ApiResult<OrderStockReservation>>;
+    /**
+     * Delete an order (only orders older than 30 days)
+     *
+     * @param orderId - The order ID to delete
+     * @returns Result with success or error
+     */
+    deleteOrder(orderId: string): Promise<ApiResult<void>>;
+    /**
+     * Get all deliveries for an order
+     *
+     * @param orderId - The order ID
+     * @returns Result with order deliveries or error
+     */
+    getOrderDeliveries(orderId: string): Promise<ApiResult<OrderDeliveries>>;
+    /**
+     * Get all cancellations for an order
+     *
+     * @param orderId - The order ID
+     * @returns Result with order cancellations or error
+     */
+    getOrderCancellations(orderId: string): Promise<ApiResult<OrderCancellations>>;
+    /**
+     * Get all refunds for an order
+     *
+     * @param orderId - The order ID
+     * @returns Result with order refunds or error
+     */
+    getOrderRefunds(orderId: string): Promise<ApiResult<OrderRefunds>>;
+    /**
+     * Get all releases for an order
+     *
+     * @param orderId - The order ID
+     * @returns Result with order releases or error
+     */
+    getOrderReleases(orderId: string): Promise<ApiResult<OrderReleases>>;
+    /**
+     * Get all compensations for an order
+     *
+     * @param orderId - The order ID
+     * @returns Result with order compensations or error
+     */
+    getOrderCompensations(orderId: string): Promise<ApiResult<OrderCompensations>>;
+    /**
+     * Get all modifications for an order
+     *
+     * @param orderId - The order ID
+     * @returns Result with order modifications or error
+     */
+    getOrderModifications(orderId: string): Promise<ApiResult<OrderModifications>>;
+    /**
+     * Create a compensation for an order
+     *
+     * @param orderId - The order ID
+     * @param request - Compensation request data
+     * @returns Result with compensation details or error
+     */
+    createCompensation(orderId: string, request: CompensationRequest): Promise<ApiResult<CompensationDetails>>;
+    /**
+     * Get a compensation by ID
+     *
+     * @param compensationId - The compensation ID
+     * @returns Result with compensation data or error
+     */
+    getCompensation(compensationId: string): Promise<ApiResult<Compensation>>;
+    /**
+     * Update a compensation
+     *
+     * @param compensationId - The compensation ID
+     * @param request - Compensation request data
+     * @returns Result with compensation details or error
+     */
+    updateCompensation(compensationId: string, request: CompensationRequest): Promise<ApiResult<CompensationDetails>>;
+    /**
+     * Delete a compensation
+     *
+     * @param compensationId - The compensation ID
+     * @returns Result with success or error
+     */
+    deleteCompensation(compensationId: string): Promise<ApiResult<void>>;
+    /**
+     * Start a compensation
+     *
+     * @param compensationId - The compensation ID
+     * @param request - Optional start compensation request
+     * @returns Result with success or error
+     */
+    startCompensation(compensationId: string, request?: StartCompensationRequest): Promise<ApiResult<void>>;
+    /**
+     * Restart a compensation
+     *
+     * @param compensationId - The compensation ID
+     * @param request - Optional start compensation request
+     * @returns Result with success or error
+     */
+    restartCompensation(compensationId: string, request?: StartCompensationRequest): Promise<ApiResult<void>>;
+    /**
+     * Create an order lines modification
+     *
+     * @param orderId - The order ID
+     * @param request - Order lines modification request
+     * @returns Result with modification details or error
+     */
+    createOrderLinesModification(orderId: string, request: OrderLinesModificationRequest): Promise<ApiResult<OrderLinesModificationDetails>>;
+    /**
+     * Get an order lines modification by ID
+     *
+     * @param modificationId - The modification ID
+     * @returns Result with modification data or error
+     */
+    getOrderLinesModification(modificationId: string): Promise<ApiResult<OrderLinesModification>>;
+    /**
+     * Update an order lines modification
+     *
+     * @param modificationId - The modification ID
+     * @param request - Order lines modification request
+     * @returns Result with modification details or error
+     */
+    updateOrderLinesModification(modificationId: string, request: OrderLinesModificationRequest): Promise<ApiResult<OrderLinesModificationDetails>>;
+    /**
+     * Delete an order lines modification
+     *
+     * @param modificationId - The modification ID
+     * @returns Result with success or error
+     */
+    deleteOrderLinesModification(modificationId: string): Promise<ApiResult<void>>;
+    /**
+     * Start an order lines modification
+     *
+     * @param modificationId - The modification ID
+     * @param request - Optional start modification request
+     * @returns Result with success or error
+     */
+    startOrderLinesModification(modificationId: string, request?: StartOrderLinesModificationRequest): Promise<ApiResult<void>>;
+    /**
+     * Restart an order lines modification
+     *
+     * @param modificationId - The modification ID
+     * @param request - Optional start modification request
+     * @returns Result with success or error
+     */
+    restartOrderLinesModification(modificationId: string, request?: StartOrderLinesModificationRequest): Promise<ApiResult<void>>;
+    /**
+     * Create a shipping fees modification
+     *
+     * @param orderId - The order ID
+     * @param request - Shipping fees modification request
+     * @returns Result with modification details or error
+     */
+    createShippingFeesModification(orderId: string, request: ShippingFeesModificationRequest): Promise<ApiResult<ShippingFeesModificationDetails>>;
+    /**
+     * Get a shipping fees modification by ID
+     *
+     * @param modificationId - The modification ID
+     * @returns Result with modification data or error
+     */
+    getShippingFeesModification(modificationId: string): Promise<ApiResult<ShippingFeesModification>>;
+    /**
+     * Update a shipping fees modification
+     *
+     * @param modificationId - The modification ID
+     * @param request - Shipping fees modification request
+     * @returns Result with modification details or error
+     */
+    updateShippingFeesModification(modificationId: string, request: ShippingFeesModificationRequest): Promise<ApiResult<ShippingFeesModificationDetails>>;
+    /**
+     * Delete a shipping fees modification
+     *
+     * @param modificationId - The modification ID
+     * @returns Result with success or error
+     */
+    deleteShippingFeesModification(modificationId: string): Promise<ApiResult<void>>;
+    /**
+     * Start a shipping fees modification
+     *
+     * @param modificationId - The modification ID
+     * @param request - Optional start modification request
+     * @returns Result with success or error
+     */
+    startShippingFeesModification(modificationId: string, request?: StartShippingFeesModificationRequest): Promise<ApiResult<void>>;
+    /**
+     * Restart a shipping fees modification
+     *
+     * @param modificationId - The modification ID
+     * @param request - Optional start modification request
+     * @returns Result with success or error
+     */
+    restartShippingFeesModification(modificationId: string, request?: StartShippingFeesModificationRequest): Promise<ApiResult<void>>;
+    /**
+     * Create an order addresses modification
+     *
+     * @param orderId - The order ID
+     * @param request - Order addresses modification request
+     * @returns Result with modification details or error
+     */
+    createAddressesModification(orderId: string, request: OrderAddressesModificationRequest): Promise<ApiResult<OrderAddressesModificationDetails>>;
+    /**
+     * Get an order addresses modification by ID
+     *
+     * @param modificationId - The modification ID
+     * @returns Result with modification data or error
+     */
+    getAddressesModification(modificationId: string): Promise<ApiResult<OrderAddressesModification>>;
+    /**
+     * Update an order addresses modification
+     *
+     * @param modificationId - The modification ID
+     * @param request - Order addresses modification request
+     * @returns Result with modification details or error
+     */
+    updateAddressesModification(modificationId: string, request: OrderAddressesModificationRequest): Promise<ApiResult<OrderAddressesModificationDetails>>;
+    /**
+     * Delete an order addresses modification
+     *
+     * @param modificationId - The modification ID
+     * @returns Result with success or error
+     */
+    deleteAddressesModification(modificationId: string): Promise<ApiResult<void>>;
+    /**
+     * Start an order addresses modification
+     *
+     * @param modificationId - The modification ID
+     * @returns Result with success or error
+     */
+    startAddressesModification(modificationId: string): Promise<ApiResult<void>>;
+    /**
+     * List all custom states
+     *
+     * @returns Result with custom states or error
+     */
+    listCustomStates(): Promise<ApiResult<CustomStates>>;
+    /**
+     * Get a custom state by ID
+     *
+     * @param stateId - The custom state ID
+     * @returns Result with custom state or error
+     */
+    getCustomState(stateId: string): Promise<ApiResult<CustomState>>;
+    /**
+     * Create a custom state
+     *
+     * @param stateId - The custom state ID
+     * @param customState - Custom state data
+     * @returns Result with created custom state or error
+     */
+    createCustomState(stateId: string, customState: CustomState): Promise<ApiResult<CustomState>>;
+    /**
+     * Delete a custom state
+     *
+     * @param stateId - The custom state ID
+     * @returns Result with success or error
+     */
+    deleteCustomState(stateId: string): Promise<ApiResult<void>>;
+    /**
+     * Add a custom state to an order
+     *
+     * @param orderId - The order ID
+     * @param stateId - The custom state ID
+     * @returns Result with success or error
+     */
+    addOrderCustomState(orderId: string, stateId: string): Promise<ApiResult<void>>;
+    /**
+     * Remove a custom state from an order
+     *
+     * @param orderId - The order ID
+     * @param stateId - The custom state ID
+     * @returns Result with success or error
+     */
+    removeOrderCustomState(orderId: string, stateId: string): Promise<ApiResult<void>>;
+    /**
+     * List all custom reason codes
+     *
+     * @returns Result with custom reason codes or error
+     */
+    listCustomReasonCodes(): Promise<ApiResult<CustomReasonCodes>>;
+    /**
+     * Get a custom reason code
+     *
+     * @param code - The custom reason code
+     * @returns Result with custom reason code or error
+     */
+    getCustomReasonCode(code: string): Promise<ApiResult<CustomReasonCode>>;
+    /**
+     * Create a custom reason code
+     *
+     * @param code - The custom reason code
+     * @param customReasonCode - Custom reason code data
+     * @returns Result with created custom reason code or error
+     */
+    createCustomReasonCode(code: string, customReasonCode: Omit<CustomReasonCode, 'code' | 'created' | 'updated' | 'revision'>): Promise<ApiResult<CustomReasonCode>>;
+    /**
+     * Delete a custom reason code
+     *
+     * @param code - The custom reason code
+     * @returns Result with success or error
+     */
+    deleteCustomReasonCode(code: string): Promise<ApiResult<void>>;
+    /**
+     * Create a comment on an order
+     *
+     * @param orderId - The order ID
+     * @param comment - Comment data
+     * @returns Result with order comment or error
+     */
+    createOrderComment(orderId: string, comment: Comment): Promise<ApiResult<OrderComment>>;
+    /**
+     * Update a comment on an order
+     *
+     * @param orderId - The order ID
+     * @param commentId - The comment ID
+     * @param comment - Updated comment data
+     * @returns Result with order comment or error
+     */
+    updateOrderComment(orderId: string, commentId: string, comment: Comment): Promise<ApiResult<OrderComment>>;
+    /**
+     * Delete a comment from an order
+     *
+     * @param orderId - The order ID
+     * @param commentId - The comment ID
+     * @returns Result with success or error
+     */
+    deleteOrderComment(orderId: string, commentId: string): Promise<ApiResult<void>>;
+}
+/**
+ * Factory function to create a BrinkCommerce Order Management client
+ *
+ * @param config - Optional configuration overrides
+ * @returns Configured API client instance
+ */
+export declare function createOrderManagementClient(config?: BrinkApiClientConfig): BrinkOrderManagementClient;