@infigo-official/types-for-megascript/v1/RunObject/Run.d.ts

Type definitions for Megascript Scripting

/**
 * Interface representing the run context with various properties and methods.
 */
interface Run {
   /**
    * The request associated with the run.
    */
   Request: Request;

   /**
    * The customers involved in the run.
    */
   Customers: Customers;

   /**
    * The response generated from the run.
    */
   Response: Response;

   /**
    * The trigger mode for the run.
    */
   TriggerMode: MegascriptInstanceFlag;

   /**
    * The MegaScript instance associated with the run.
    */
   MegaScriptInstance: MegascriptInstanceListObject;

   /**
    * Links related to the run.
    */
   Links: Links;

   /**
    * External API used in the run.
    */
   ExternalApi: ExternalApi;

   /**
    * Products involved in the run.
    */
   Products: Products;

   /**
    * Orders related to the run.
    */
   Orders: Orders;

   /**
    * Database operations within the run.
    */
   Database: Database;

   /**
    * Upload location used in the run.
    */
   UploadLocation: UploadLocation;

   /**
    * Cart management operations within the run.
    */
   CartManagement: CartManagement;

   /**
    * Message handler object used in the run.
    */
   MessageHandler: MessageHandlerObject;

   /**
    * Parse object associated with the run.
    */
   Parse: ParseObject;

   /**
    * Current context object within the run.
    */
   CurrentContext: CurrentContextObject;

   /**
    * File object used in the run.
    */
   File: FileObject;

   /**
    * Hot folder object related to the run.
    */
   HotFolder: HotFolderObject;

   /**
    * Departments involved in the run.
    */
   Departments: DepartmentObject;

   /**
    * Custom data categories associated with the run.
    */
   CustomDataCategory: CustomDataCategoryObjects;

   /**
    * The data associated with the run.
    */
   Data: {};

   /**
    * Order product variants associated with the run.
    */
   OrderProductVariants: OrderProductVariantsObject;

   /**
    * MisPlugins related to the run.
    */
   MisPlugins: MisPluginsObject;

   /**
    * Editable content associated with the run.
    */
   EditableContent: EditableContentObject;

   /**
    * Configurations used in the run.
    */
   Configurations: ConfigurationsObject;

   /**
    * PDF helper object used in the run.
    */
   PdfHelper: PdfGeneralObject;

   /**
    * Generates a MegaScript link with specified parameters.
    * @param parameters - Parameters for the MegaScript link.
    * @param additionalParameters - Additional parameters for the MegaScript link.
    * @returns The generated MegaScript link.
    */
   GenerateMegaScriptLink: (parameters: Object, additionalParameters: Object) => string;

   /**
    * The helper object.
    */
   Helper: HelperObject;

   /**
    * Checks if the request time matches the given time.
    * @param time - The time to compare against the request time.
    * @returns True if the request time matches, false otherwise.
    */
   RequestTime: (time: number) => boolean;

   /**
    * Indicates whether to add a run log entry.
    */
   AddRunLogEntry: boolean;

   /**
    * The current progress of the run, represented as an integer.
    */
   Progress: number;

   /**
    * The current message associated with the run.
    */
   CurrentMessage: string;

   /**
    * Terminates the execution of the run.
    * @returns True if the run was successfully terminated, false otherwise.
    */
   Die(): boolean;

   /**
    * Checks if the execution has been cancelled.
    * @returns True if the execution is cancelled, false otherwise.
    */
   IsExecutionCancelled(): boolean;

   /**
    * Executes a MegaScript asynchronously with specified options.
    * @param megascriptInstanceName - The name of the MegaScript instance to execute.
    * @param parameters - Parameters for the MegaScript execution.
    * @param jobName - Optional name of the job.
    * @param isHeavy - Optional flag indicating if the execution is heavy.
    * @param priority - Optional priority for the job execution.
    * @returns True if the execution was successfully initiated, false otherwise.
    */
   ExecuteMegaScriptAsync(
       megascriptInstanceName: string,
       parameters?: object,
       jobName?: string,
       isHeavy?: boolean,
       priority?: number
   ): boolean;

   /**
    * Starts the Symphony statistics timer.
    */
   SymphonyStatsStart(): void;

   /**
    * Stops the Symphony statistics timer and records the statistics.
    * @param count - The count of items to include in the statistics.
    */
   SymphonyStatsStop(count: number): void;

   /**
    * The saved quotes object.
    */
   SavedQuotes: SavedQuotes;
   
   /**
    * The reporting object.
    */
   Reporting: Reporting;
   
   /**
   * The price helper object.
   */
   DateTime: DateTime;
   
   /**
   * The price helper object.
   */
   PriceHelper: PriceHelper;

   /**
    * Provides access to country-related operations.
    */
   Countries: Countries;
}

/**
    * Represents a Run object.
 */
declare const Run: Run;

/**
 * Enum representing various flags for MegaScript instances.
 */
declare enum MegascriptInstanceFlag {
   /**
    * Indicates that the MegaScript should run in the background.
    */
   RunBackground = 'RunBackground',

   /**
    * Indicates that the MegaScript should be purged manually.
    */
   PurgeManually = 'PurgeManually',

   /**
    * Indicates that the MegaScript should be triggered via an API call.
    */
   TriggerViaApi = 'TriggerViaApi',

   /**
    * Indicates that the MegaScript is from a dynamic product.
    */
   FromDynamicProduct = 'FromDynamicProduct',

   /**
    * Indicates that the MegaScript is responsible for output creation.
    */
   OutputCreation = 'OutputCreation',

   /**
    * Indicates that the MegaScript should execute asynchronously.
    */
   AsyncExecution = 'AsyncExecution',

   /**
    * Indicates that the MegaScript is an event.
    */
   Event = 'Event',
}