liferay-headless-rest-client/dist/clients/dispatch-rest-v1.0/types.gen.d.ts

A collection of Headless Clients used in Liferay Portal

export type DispatchTrigger = {
    active?: boolean;
    companyId?: number;
    cronExpression?: string;
    dispatchTaskClusterMode?: number;
    dispatchTaskExecutorType?: string;
    dispatchTaskSettings?: {
        [key: string]: {
            [key: string]: unknown;
        };
    };
    readonly endDate?: string;
    externalReferenceCode?: string;
    id?: number;
    name?: string;
    overlapAllowed?: boolean;
    readonly startDate?: string;
    system?: boolean;
    timeZoneId?: string;
    userId?: number;
    readonly 'x-class-name'?: string;
};
export type Facet = {
    facetCriteria?: string;
    facetValues?: Array<FacetValue>;
};
export type FacetValue = {
    numberOfOccurrences?: number;
    term?: string;
};
export type PageDispatchTrigger = {
    items?: Array<DispatchTrigger>;
    lastPage?: number;
    totalCount?: number;
    actions?: {
        [key: string]: {
            [key: string]: string;
        };
    };
    page?: number;
    facets?: Array<Facet>;
    pageSize?: number;
};
export type GetDispatchTriggersPageData = {
    body?: never;
    path?: never;
    query?: {
        nestedFields?: string;
    };
    url: '/o/dispatch-rest/v1.0/dispatch-triggers';
};
export type GetDispatchTriggersPageResponses = {
    /**
     * default response
     */
    default: PageDispatchTrigger;
};
export type GetDispatchTriggersPageResponse = GetDispatchTriggersPageResponses[keyof GetDispatchTriggersPageResponses];
export type PostDispatchTriggerData = {
    body?: DispatchTrigger;
    path?: never;
    query?: never;
    url: '/o/dispatch-rest/v1.0/dispatch-triggers';
};
export type PostDispatchTriggerResponses = {
    /**
     * default response
     */
    default: DispatchTrigger;
};
export type PostDispatchTriggerResponse = PostDispatchTriggerResponses[keyof PostDispatchTriggerResponses];
export type PostDispatchTriggerBatchData = {
    body?: {
        [key: string]: unknown;
    };
    path?: never;
    query?: {
        callbackURL?: string;
    };
    url: '/o/dispatch-rest/v1.0/dispatch-triggers/batch';
};
export type PostDispatchTriggerBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type PostDispatchTriggerRunData = {
    body?: never;
    path: {
        dispatchTriggerId: string;
    };
    query?: never;
    url: '/o/dispatch-rest/v1.0/dispatch-triggers/{dispatchTriggerId}/run';
};
export type PostDispatchTriggerRunResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type PostDispatchTriggersPageExportBatchData = {
    body?: never;
    path?: never;
    query?: {
        callbackURL?: string;
        contentType?: string;
        fieldNames?: string;
    };
    url: '/o/dispatch-rest/v1.0/dispatch-triggers/export-batch';
};
export type PostDispatchTriggersPageExportBatchResponses = {
    /**
     * default response
     */
    default: unknown;
};
export type ClientOptions = {
    baseUrl: 'http://localhost:8080' | (string & {});
};