@gohighlevel/api-client
Version:
Official SDK for HighLevel Public APIs
75 lines • 3.05 kB
TypeScript
import { AxiosInstance, AxiosRequestConfig } from 'axios';
import * as Models from './models/funnels';
/**
* Funnels Service
* Documentation for funnels API
*/
export declare class Funnels {
private client;
constructor(httpClient: AxiosInstance);
/**
* Create Redirect
* The "Create Redirect" API Allows adding a new url redirect to the system. Use this endpoint to create a url redirect with the specified details. Ensure that the required information is provided in the request payload.
*/
createRedirect(requestBody: Models.CreateRedirectParams, options?: AxiosRequestConfig): Promise<Models.CreateRedirectResponseDTO>;
/**
* Update Redirect By Id
* The "Update Redirect By Id" API Allows updating an existing URL redirect in the system. Use this endpoint to modify a URL redirect with the specified ID using details provided in the request payload.
*/
updateRedirectById(params: {
id: string;
}, requestBody: Models.UpdateRedirectParams, options?: AxiosRequestConfig): Promise<Models.UpdateRedirectResponseDTO>;
/**
* Delete Redirect By Id
* The "Delete Redirect By Id" API Allows deletion of a URL redirect from the system using its unique identifier. Use this endpoint to delete a URL redirect with the specified ID using details provided in the request payload.
*/
deleteRedirectById(params: {
id: string;
locationId: string;
}, options?: AxiosRequestConfig): Promise<Models.DeleteRedirectResponseDTO>;
/**
* Fetch List of Redirects
* Retrieves a list of all URL redirects based on the given query parameters.
*/
fetchRedirectsList(params: {
locationId: string;
limit: number;
offset: number;
search?: string;
}, options?: AxiosRequestConfig): Promise<Models.RedirectListResponseDTO>;
/**
* Fetch List of Funnels
* Retrieves a list of all funnels based on the given query parameters.
*/
getFunnels(params: {
locationId: string;
type?: string;
category?: string;
offset?: string;
limit?: string;
parentId?: string;
name?: string;
}, options?: AxiosRequestConfig): Promise<Models.FunnelListResponseDTO>;
/**
* Fetch list of funnel pages
* Retrieves a list of all funnel pages based on the given query parameters.
*/
getPagesByFunnelId(params: {
locationId: string;
funnelId: string;
name?: string;
limit: number;
offset: number;
}, options?: AxiosRequestConfig): Promise<Models.FunnelPageResponseDTO>;
/**
* Fetch count of funnel pages
* Retrieves count of all funnel pages based on the given query parameters.
*/
getPagesCountByFunnelId(params: {
locationId: string;
funnelId: string;
name?: string;
}, options?: AxiosRequestConfig): Promise<Models.FunnelPageCountResponseDTO>;
}
export default Funnels;
//# sourceMappingURL=funnels.d.ts.map