box-node-sdk/lib-esm/managers/externalUsers.d.ts

Official SDK for Box Platform APIs

import { ExternalUsersSubmitDeleteJobResponseV2025R0 } from '../schemas/v2025R0/externalUsersSubmitDeleteJobResponseV2025R0';
import { BoxVersionHeaderV2025R0 } from '../parameters/v2025R0/boxVersionHeaderV2025R0';
import { ExternalUsersSubmitDeleteJobRequestV2025R0 } from '../schemas/v2025R0/externalUsersSubmitDeleteJobRequestV2025R0';
import { Authentication } from '../networking/auth';
import { NetworkSession } from '../networking/network';
import { CancellationToken } from '../internal/utils';
export declare class SubmitJobToDeleteExternalUsersV2025R0Optionals {
    readonly headers: SubmitJobToDeleteExternalUsersV2025R0Headers;
    readonly cancellationToken?: CancellationToken;
    constructor(fields: Omit<SubmitJobToDeleteExternalUsersV2025R0Optionals, 'headers' | 'cancellationToken'> & Partial<Pick<SubmitJobToDeleteExternalUsersV2025R0Optionals, 'headers' | 'cancellationToken'>>);
}
export interface SubmitJobToDeleteExternalUsersV2025R0OptionalsInput {
    readonly headers?: SubmitJobToDeleteExternalUsersV2025R0Headers;
    readonly cancellationToken?: CancellationToken;
}
export declare class SubmitJobToDeleteExternalUsersV2025R0Headers {
    /**
     * Version header. */
    readonly boxVersion: BoxVersionHeaderV2025R0;
    /**
     * Extra headers that will be included in the HTTP request. */
    readonly extraHeaders?: {
        readonly [key: string]: undefined | string;
    };
    constructor(fields: Omit<SubmitJobToDeleteExternalUsersV2025R0Headers, 'boxVersion' | 'extraHeaders'> & Partial<Pick<SubmitJobToDeleteExternalUsersV2025R0Headers, 'boxVersion' | 'extraHeaders'>>);
}
export interface SubmitJobToDeleteExternalUsersV2025R0HeadersInput {
    /**
     * Version header. */
    readonly boxVersion?: BoxVersionHeaderV2025R0;
    /**
     * Extra headers that will be included in the HTTP request. */
    readonly extraHeaders?: {
        readonly [key: string]: undefined | string;
    };
}
export declare class ExternalUsersManager {
    readonly auth?: Authentication;
    readonly networkSession: NetworkSession;
    constructor(fields: Omit<ExternalUsersManager, 'networkSession' | 'submitJobToDeleteExternalUsersV2025R0'> & Partial<Pick<ExternalUsersManager, 'networkSession'>>);
    /**
     * Delete external users from current user enterprise. This will remove each
     * external user from all invited collaborations within the current enterprise.
     * @param {ExternalUsersSubmitDeleteJobRequestV2025R0} requestBody Request body of submitJobToDeleteExternalUsersV2025R0 method
     * @param {SubmitJobToDeleteExternalUsersV2025R0OptionalsInput} optionalsInput
     * @returns {Promise<ExternalUsersSubmitDeleteJobResponseV2025R0>}
     */
    submitJobToDeleteExternalUsersV2025R0(requestBody: ExternalUsersSubmitDeleteJobRequestV2025R0, optionalsInput?: SubmitJobToDeleteExternalUsersV2025R0OptionalsInput): Promise<ExternalUsersSubmitDeleteJobResponseV2025R0>;
}
export interface ExternalUsersManagerInput {
    readonly auth?: Authentication;
    readonly networkSession?: NetworkSession;
}