box-node-sdk/lib-esm/schemas/collaboratorVariable.d.ts

Official SDK for Box Platform APIs

import { SerializedData } from '../serialization/json';
export type CollaboratorVariableTypeField = 'variable';
export type CollaboratorVariableVariableTypeField = 'user_list' | string;
export type CollaboratorVariableVariableValueTypeField = 'user';
export declare class CollaboratorVariableVariableValueField {
    /**
     * The object type. */
    readonly type: CollaboratorVariableVariableValueTypeField;
    /**
     * User's ID. */
    readonly id: string;
    readonly rawData?: SerializedData;
    constructor(fields: Omit<CollaboratorVariableVariableValueField, 'type'> & Partial<Pick<CollaboratorVariableVariableValueField, 'type'>>);
}
export interface CollaboratorVariableVariableValueFieldInput {
    /**
     * The object type. */
    readonly type?: CollaboratorVariableVariableValueTypeField;
    /**
     * User's ID. */
    readonly id: string;
    readonly rawData?: SerializedData;
}
export declare class CollaboratorVariable {
    /**
     * Collaborator
     * object type. */
    readonly type: CollaboratorVariableTypeField;
    /**
     * Variable type
     * for the Collaborator
     * object. */
    readonly variableType: CollaboratorVariableVariableTypeField;
    /**
     * A list of user IDs. */
    readonly variableValue: readonly CollaboratorVariableVariableValueField[];
    readonly rawData?: SerializedData;
    constructor(fields: Omit<CollaboratorVariable, 'type' | 'variableType'> & Partial<Pick<CollaboratorVariable, 'type' | 'variableType'>>);
}
export interface CollaboratorVariableInput {
    /**
     * Collaborator
     * object type. */
    readonly type?: CollaboratorVariableTypeField;
    /**
     * Variable type
     * for the Collaborator
     * object. */
    readonly variableType?: CollaboratorVariableVariableTypeField;
    /**
     * A list of user IDs. */
    readonly variableValue: readonly CollaboratorVariableVariableValueField[];
    readonly rawData?: SerializedData;
}
export declare function serializeCollaboratorVariableTypeField(val: CollaboratorVariableTypeField): SerializedData;
export declare function deserializeCollaboratorVariableTypeField(val: SerializedData): CollaboratorVariableTypeField;
export declare function serializeCollaboratorVariableVariableTypeField(val: CollaboratorVariableVariableTypeField): SerializedData;
export declare function deserializeCollaboratorVariableVariableTypeField(val: SerializedData): CollaboratorVariableVariableTypeField;
export declare function serializeCollaboratorVariableVariableValueTypeField(val: CollaboratorVariableVariableValueTypeField): SerializedData;
export declare function deserializeCollaboratorVariableVariableValueTypeField(val: SerializedData): CollaboratorVariableVariableValueTypeField;
export declare function serializeCollaboratorVariableVariableValueField(val: CollaboratorVariableVariableValueField): SerializedData;
export declare function deserializeCollaboratorVariableVariableValueField(val: SerializedData): CollaboratorVariableVariableValueField;
export declare function serializeCollaboratorVariableVariableValueFieldInput(val: CollaboratorVariableVariableValueFieldInput): SerializedData;
export declare function deserializeCollaboratorVariableVariableValueFieldInput(val: SerializedData): CollaboratorVariableVariableValueFieldInput;
export declare function serializeCollaboratorVariable(val: CollaboratorVariable): SerializedData;
export declare function deserializeCollaboratorVariable(val: SerializedData): CollaboratorVariable;
export declare function serializeCollaboratorVariableInput(val: CollaboratorVariableInput): SerializedData;
export declare function deserializeCollaboratorVariableInput(val: SerializedData): CollaboratorVariableInput;