@gnosticdev/highlevel-sdk/dist/types/campaigns.d.cts

SDK for the HighLevel API

type paths = {
    '/campaigns/': {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /**
         * Get Campaigns
         * @description Get Campaigns
         */
        get: operations['get-campaigns'];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
};
type webhooks = Record<string, never>;
type components = {
    schemas: {
        BadRequestDTO: {
            /** @example Bad Request */
            message?: string;
            /** @example 400 */
            statusCode?: number;
        };
        campaignsSchema: {
            /** @example mIVALPYuTD7YjUHnFEx4 */
            id?: string;
            /** @example ve9EPM428h8vShlRW1KT */
            locationId?: string;
            /** @example test */
            name?: string;
            /** @example published */
            status?: string;
        };
        CampaignsSuccessfulResponseDto: {
            campaigns?: components['schemas']['campaignsSchema'][];
        };
        UnauthorizedDTO: {
            /** @example Unauthorized */
            error?: string;
            /** @example Invalid token: access token is invalid */
            message?: string;
            /** @example 401 */
            statusCode?: number;
        };
        UnprocessableDTO: {
            /** @example Unprocessable Entity */
            error?: string;
            /** @example [
             *       "Unprocessable Entity"
             *     ] */
            message?: string[];
            /** @example 422 */
            statusCode?: number;
        };
    };
    responses: never;
    parameters: never;
    requestBodies: never;
    headers: never;
    pathItems: never;
};
type $defs = Record<string, never>;
interface operations {
    'get-campaigns': {
        parameters: {
            query: {
                /** @example ve9EPM428h8vShlRW1KT */
                locationId: string;
                /** @example draft */
                status?: string;
            };
            header: {
                /** @description Access Token */
                Authorization: string;
                /** @description API Version */
                Version: '2021-07-28';
            };
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description Successful response */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    'application/json': components['schemas']['CampaignsSuccessfulResponseDto'];
                };
            };
            /** @description Bad Request */
            400: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    'application/json': components['schemas']['BadRequestDTO'];
                };
            };
            /** @description Unauthorized */
            401: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    'application/json': components['schemas']['UnauthorizedDTO'];
                };
            };
            /** @description Unprocessable Entity */
            422: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    'application/json': components['schemas']['UnprocessableDTO'];
                };
            };
        };
    };
}

export type { $defs, components, operations, paths, webhooks };