import type {StandardRenderingExtensionApi} from '../standard/standard-rendering';
import type {ExtensionTarget as AnyExtensionTarget} from '../../extension-targets';

import {ApplyMetafieldsChange} from './metafields';
import {Data} from './data';

/**
 * The `OrderRoutingRuleApi` object provides methods for configuring order routing rules. Access the following properties on the `OrderRoutingRuleApi` object to manage rule settings and metafields.
 */
export interface OrderRoutingRuleApi<ExtensionTarget extends AnyExtensionTarget>
  extends StandardRenderingExtensionApi<ExtensionTarget> {
  /** Updates or removes [metafields](/docs/apps/build/metafields) that store order routing rule configuration. */
  applyMetafieldsChange: ApplyMetafieldsChange;
  /** The order routing rule being configured, including its metadata and associated [metafields](/docs/apps/build/metafields). */
  data: Data;
}