@commercelayer/react-components/lib/esm/utils/triggerAttributeHelper.d.ts

The Official Commerce Layer React Components

import type { CommerceLayerConfig } from '../context/CommerceLayerContext';
import type { Order, OrderSubscription } from '@commercelayer/sdk';
export type HelperRequestResource = 'orders' | 'order_subscriptions';
export type TriggerAttributeHelper = {
    /**
     * CommerceLayer config
     */
    config: CommerceLayerConfig;
    /**
     * The resource id
     */
    id: string;
} & ({
    /**
     * The resource name
     */
    resource: 'orders';
    /**
     * The attribute to trigger
     */
    attribute: '_place' | '_refresh' | '_create_subscriptions';
} | {
    resource: 'order_subscriptions';
    attribute: '_active' | '_deactivate' | '_cancel';
});
type TriggerAttributeHelperResponse = Promise<Order | OrderSubscription>;
/**
 * Helper to trigger an attribute on a resource
 */
export declare function triggerAttributeHelper({ config, id, attribute, resource }: TriggerAttributeHelper): TriggerAttributeHelperResponse;
export {};