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

Official SDK for Box Platform APIs

import { EnterpriseConfigurationV2025R0 } from '../schemas/v2025R0/enterpriseConfigurationV2025R0';
import { BoxVersionHeaderV2025R0 } from '../parameters/v2025R0/boxVersionHeaderV2025R0';
import { Authentication } from '../networking/auth';
import { NetworkSession } from '../networking/network';
import { CancellationToken } from '../internal/utils';
export declare class GetEnterpriseConfigurationByIdV2025R0Optionals {
    readonly headers: GetEnterpriseConfigurationByIdV2025R0Headers;
    readonly cancellationToken?: CancellationToken;
    constructor(fields: Omit<GetEnterpriseConfigurationByIdV2025R0Optionals, 'headers' | 'cancellationToken'> & Partial<Pick<GetEnterpriseConfigurationByIdV2025R0Optionals, 'headers' | 'cancellationToken'>>);
}
export interface GetEnterpriseConfigurationByIdV2025R0OptionalsInput {
    readonly headers?: GetEnterpriseConfigurationByIdV2025R0Headers;
    readonly cancellationToken?: CancellationToken;
}
export interface GetEnterpriseConfigurationByIdV2025R0QueryParams {
    /**
     * A comma-separated list of the enterprise configuration categories.
     * Allowed values: `security`, `content_and_sharing`, `user_settings`, `shield`. */
    readonly categories: readonly string[];
}
export declare class GetEnterpriseConfigurationByIdV2025R0Headers {
    /**
     * 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<GetEnterpriseConfigurationByIdV2025R0Headers, 'boxVersion' | 'extraHeaders'> & Partial<Pick<GetEnterpriseConfigurationByIdV2025R0Headers, 'boxVersion' | 'extraHeaders'>>);
}
export interface GetEnterpriseConfigurationByIdV2025R0HeadersInput {
    /**
     * 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 EnterpriseConfigurationsManager {
    readonly auth?: Authentication;
    readonly networkSession: NetworkSession;
    constructor(fields: Omit<EnterpriseConfigurationsManager, 'networkSession' | 'getEnterpriseConfigurationByIdV2025R0'> & Partial<Pick<EnterpriseConfigurationsManager, 'networkSession'>>);
    /**
       * Retrieves the configuration for an enterprise.
       * @param {string} enterpriseId The ID of the enterprise.
      Example: "3442311"
       * @param {GetEnterpriseConfigurationByIdV2025R0QueryParams} queryParams Query parameters of getEnterpriseConfigurationByIdV2025R0 method
       * @param {GetEnterpriseConfigurationByIdV2025R0OptionalsInput} optionalsInput
       * @returns {Promise<EnterpriseConfigurationV2025R0>}
       */
    getEnterpriseConfigurationByIdV2025R0(enterpriseId: string, queryParams: GetEnterpriseConfigurationByIdV2025R0QueryParams, optionalsInput?: GetEnterpriseConfigurationByIdV2025R0OptionalsInput): Promise<EnterpriseConfigurationV2025R0>;
}
export interface EnterpriseConfigurationsManagerInput {
    readonly auth?: Authentication;
    readonly networkSession?: NetworkSession;
}