box-node-sdk/lib/managers/automateWorkflows.d.ts

Official SDK for Box Platform APIs

import { AutomateWorkflowsV2026R0 } from '../schemas/v2026R0/automateWorkflowsV2026R0.js';
import { BoxVersionHeaderV2026R0 } from '../parameters/v2026R0/boxVersionHeaderV2026R0.js';
import { AutomateWorkflowStartRequestV2026R0 } from '../schemas/v2026R0/automateWorkflowStartRequestV2026R0.js';
import { Authentication } from '../networking/auth.js';
import { NetworkSession } from '../networking/network.js';
import { CancellationToken } from '../internal/utils.js';
export declare class GetAutomateWorkflowsV2026R0Optionals {
    readonly headers: GetAutomateWorkflowsV2026R0Headers;
    readonly cancellationToken?: CancellationToken;
    constructor(fields: Omit<GetAutomateWorkflowsV2026R0Optionals, 'headers' | 'cancellationToken'> & Partial<Pick<GetAutomateWorkflowsV2026R0Optionals, 'headers' | 'cancellationToken'>>);
}
export interface GetAutomateWorkflowsV2026R0OptionalsInput {
    readonly headers?: GetAutomateWorkflowsV2026R0Headers;
    readonly cancellationToken?: CancellationToken;
}
export declare class CreateAutomateWorkflowStartV2026R0Optionals {
    readonly headers: CreateAutomateWorkflowStartV2026R0Headers;
    readonly cancellationToken?: CancellationToken;
    constructor(fields: Omit<CreateAutomateWorkflowStartV2026R0Optionals, 'headers' | 'cancellationToken'> & Partial<Pick<CreateAutomateWorkflowStartV2026R0Optionals, 'headers' | 'cancellationToken'>>);
}
export interface CreateAutomateWorkflowStartV2026R0OptionalsInput {
    readonly headers?: CreateAutomateWorkflowStartV2026R0Headers;
    readonly cancellationToken?: CancellationToken;
}
export interface GetAutomateWorkflowsV2026R0QueryParams {
    /**
     * The unique identifier that represent a folder.
     *
     * The ID for any folder can be determined
     * by visiting this folder in the web application
     * and copying the ID from the URL. For example,
     * for the URL `https://*.app.box.com/folder/123`
     * the `folder_id` is `123`.
     *
     * The root folder of a Box account is
     * always represented by the ID `0`. */
    readonly folderId: string;
    /**
     * The maximum number of items to return per page. */
    readonly limit?: number;
    /**
     * Defines the position marker at which to begin returning results. This is
     * used when paginating using marker-based pagination. */
    readonly marker?: string;
}
export declare class GetAutomateWorkflowsV2026R0Headers {
    /**
     * Version header. */
    readonly boxVersion: BoxVersionHeaderV2026R0;
    /**
     * Extra headers that will be included in the HTTP request. */
    readonly extraHeaders?: {
        readonly [key: string]: undefined | string;
    };
    constructor(fields: Omit<GetAutomateWorkflowsV2026R0Headers, 'boxVersion' | 'extraHeaders'> & Partial<Pick<GetAutomateWorkflowsV2026R0Headers, 'boxVersion' | 'extraHeaders'>>);
}
export interface GetAutomateWorkflowsV2026R0HeadersInput {
    /**
     * Version header. */
    readonly boxVersion?: BoxVersionHeaderV2026R0;
    /**
     * Extra headers that will be included in the HTTP request. */
    readonly extraHeaders?: {
        readonly [key: string]: undefined | string;
    };
}
export declare class CreateAutomateWorkflowStartV2026R0Headers {
    /**
     * Version header. */
    readonly boxVersion: BoxVersionHeaderV2026R0;
    /**
     * Extra headers that will be included in the HTTP request. */
    readonly extraHeaders?: {
        readonly [key: string]: undefined | string;
    };
    constructor(fields: Omit<CreateAutomateWorkflowStartV2026R0Headers, 'boxVersion' | 'extraHeaders'> & Partial<Pick<CreateAutomateWorkflowStartV2026R0Headers, 'boxVersion' | 'extraHeaders'>>);
}
export interface CreateAutomateWorkflowStartV2026R0HeadersInput {
    /**
     * Version header. */
    readonly boxVersion?: BoxVersionHeaderV2026R0;
    /**
     * Extra headers that will be included in the HTTP request. */
    readonly extraHeaders?: {
        readonly [key: string]: undefined | string;
    };
}
export declare class AutomateWorkflowsManager {
    readonly auth?: Authentication;
    readonly networkSession: NetworkSession;
    constructor(fields: Omit<AutomateWorkflowsManager, 'networkSession' | 'getAutomateWorkflowsV2026R0' | 'createAutomateWorkflowStartV2026R0'> & Partial<Pick<AutomateWorkflowsManager, 'networkSession'>>);
    /**
     * Returns workflow actions from Automate for a folder, using the
     * `WORKFLOW` action category.
     * @param {GetAutomateWorkflowsV2026R0QueryParams} queryParams Query parameters of getAutomateWorkflowsV2026R0 method
     * @param {GetAutomateWorkflowsV2026R0OptionalsInput} optionalsInput
     * @returns {Promise<AutomateWorkflowsV2026R0>}
     */
    getAutomateWorkflowsV2026R0(queryParams: GetAutomateWorkflowsV2026R0QueryParams, optionalsInput?: GetAutomateWorkflowsV2026R0OptionalsInput): Promise<AutomateWorkflowsV2026R0>;
    /**
       * Starts an Automate workflow manually by using a workflow action ID and file IDs.
       * @param {string} workflowId The ID of the workflow.
      Example: "12345"
       * @param {AutomateWorkflowStartRequestV2026R0} requestBody Request body of createAutomateWorkflowStartV2026R0 method
       * @param {CreateAutomateWorkflowStartV2026R0OptionalsInput} optionalsInput
       * @returns {Promise<undefined>}
       */
    createAutomateWorkflowStartV2026R0(workflowId: string, requestBody: AutomateWorkflowStartRequestV2026R0, optionalsInput?: CreateAutomateWorkflowStartV2026R0OptionalsInput): Promise<undefined>;
}
export interface AutomateWorkflowsManagerInput {
    readonly auth?: Authentication;
    readonly networkSession?: NetworkSession;
}
//# sourceMappingURL=automateWorkflows.d.ts.map