@gnosticdev/highlevel-sdk
Version:
SDK for the HighLevel API
499 lines • 14.1 kB
TypeScript
//#region src/v2/types/funnels.d.ts
interface paths {
'/funnels/funnel/list': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Fetch List of Funnels
* @description Retrieves a list of all funnels based on the given query parameters.
*/
get: operations['getFunnels'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/funnels/lookup/redirect': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Redirect
* @description 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.
*/
post: operations['create-redirect'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/funnels/lookup/redirect/{id}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Redirect By Id
* @description 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.
*/
delete: operations['delete-redirect-by-id'];
options?: never;
head?: never;
/**
* Update Redirect By Id
* @description 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.
*/
patch: operations['update-redirect-by-id'];
trace?: never;
};
'/funnels/lookup/redirect/list': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Fetch List of Redirects
* @description Retrieves a list of all URL redirects based on the given query parameters.
*/
get: operations['fetch-redirects-list'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/funnels/page': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Fetch list of funnel pages
* @description Retrieves a list of all funnel pages based on the given query parameters.
*/
get: operations['getPagesByFunnelId'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/funnels/page/count': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Fetch count of funnel pages
* @description Retrieves count of all funnel pages based on the given query parameters.
*/
get: operations['getPagesCountByFunnelId'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
type webhooks = Record<string, never>;
interface components {
schemas: {
CreateRedirectParams: {
/**
* @example URL
* @enum {string}
*/
action: 'funnel' | 'website' | 'url' | 'all'; /** @example example.com */
domain: string; /** @example 6p2RxpgtMKQwO3E6IUaT */
locationId: string; /** @example /Hello */
path: string; /** @example https://www.google.com */
target: string;
};
CreateRedirectResponseDTO: {
/** @description Data containing details of the created redirect */data: components['schemas']['RedirectResponseDTO'];
};
DeleteRedirectResponseDTO: {
/**
* @description Status of the delete operation
* @example {
* "status": "ok"
* }
*/
data: Record<string, never>;
};
FunnelListResponseDTO: {
/** @example 24 */count: number;
/**
* @example {
* "_id": "SkIDfu0S4m3NYQyvWHC6",
* "dateAdded": "2024-04-29T15:00:05.681Z",
* "dateUpdated": "2024-04-29T15:00:28.465Z",
* "deleted": false,
* "domainId": "",
* "locationId": "ojQjykmwNIU88vfsfzvH",
* "name": "Chaitanya Copy",
* "orderFormVersion": 2,
* "originId": "hAmyh7jrJH5FfEEKAJ9z",
* "steps": [
* {
* "id": "f5d178c0-8bbb-4cd4-927c-691c68a62c59",
* "name": "Step 1",
* "originId": "80b2f227-5bc8-4ca5-980d-817745ea4e8b",
* "pages": [
* "2IhBmBcQRx9JXV1JZsRt"
* ],
* "products": [],
* "sequence": 1,
* "type": "optin_funnel_page",
* "url": "/newtestifypath"
* }
* ],
* "type": "funnel",
* "updatedAt": "2024-04-29T15:00:34.233Z",
* "faviconUrl": "",
* "globalSectionVersion": 1,
* "globalSectionsPath": "funnel/SkIDfu0S4m3NYQyvWHC6/global-sections-1",
* "globalSectionsUrl": "https://firebasestorage.googleapis.com/v0/b/highlevel-staging.appspot.com/o/funnel%2FSkIDfu0S4m3NYQyvWHC6%2Fglobal-sections-1?alt=media&token=9cc5c211-093b-4751-aeba-19282ac92955",
* "isStoreActive": false,
* "trackingCodeBody": "",
* "trackingCodeHead": "",
* "url": "/chaitanya"
* }
*/
funnels: Record<string, never>; /** @example 03774d31-a57e-4b4f-95c7-315ce61969f1 */
traceId: string;
};
FunnelPageCountResponseDTO: {
/** @example 20 */count: number;
};
FunnelPageResponseDTO: {
/** @example 0yJbP3q7t7pLmeTWRAE2 */_id: string; /** @example false */
deleted: string; /** @example iucJ6TdFZiddhq9f6znh */
funnelId: string; /** @example ojQjykmwNIU88vfsfzvH */
locationId: string; /** @example Home */
name: string; /** @example 343bf634-3aa6-4ade-b963-2d3cd0bf2ede */
stepId: string; /** @example 2024-04-18T12:25:23.029Z */
updatedAt: string;
};
RedirectListResponseDTO: {
/**
* @description Object containing the count of redirects and an array of redirect data
* @example {
* "count": 42,
* "data": []
* }
*/
data: Record<string, never>;
};
RedirectResponseDTO: {
/**
* @description Action performed by the redirect
* @example url
*/
action: string;
/**
* @description Domain where the redirect occurs
* @example www.example.com
*/
domain: string;
/**
* @description Unique identifier of the redirect
* @example 6p2RxpgtMKQwO3E6IUaT
*/
id: string;
/**
* @description Identifier of the location associated with the redirect
* @example 6p2RxpgtMKQwO3E6IUaT
*/
locationId: string;
/**
* @description Original path that will be redirected
* @example /old-path
*/
path: string;
/**
* @description Lowercase version of the original path
* @example /old-path
*/
pathLowercase: string;
/**
* @description Target URL to which the original path will be redirected
* @example https://www.example.com/new-path
*/
target: string;
/**
* @description Type of redirect (e.g., Permanent, Temporary)
* @example Permanent
*/
type: string;
};
UnprocessableDTO: {
/** @example Unprocessable Entity */error?: string;
/**
* @example [
* "Unprocessable Entity"
* ]
*/
message?: string[]; /** @example 422 */
statusCode?: number;
};
UpdateRedirectParams: {
/**
* @example URL
* @enum {string}
*/
action: 'funnel' | 'website' | 'url' | 'all'; /** @example 6p2RxpgtMKQwO3E6IUaT */
locationId: string; /** @example https://www.google.com */
target: string;
};
UpdateRedirectResponseDTO: {
/** @description Data containing details of the updated redirect */data: components['schemas']['RedirectResponseDTO'];
};
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
}
type $defs = Record<string, never>;
interface operations {
getFunnels: {
parameters: {
query: {
category?: string;
limit?: string;
locationId: string;
name?: string;
offset?: string;
parentId?: string;
type?: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful response - List of funnels returned */200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['FunnelListResponseDTO'];
};
};
};
};
'create-redirect': {
parameters: {
query?: never;
header: {
/** @description API Version */Version: '2021-07-28';
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
'application/json': components['schemas']['CreateRedirectParams'];
};
};
responses: {
/** @description Successful response */200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['CreateRedirectResponseDTO'];
};
}; /** @description Unprocessable Entity */
422: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['UnprocessableDTO'];
};
};
};
};
'delete-redirect-by-id': {
parameters: {
query: {
/** @example 6p2RxpgtMKQwO3E6IUaT */locationId: string;
};
header: {
/** @description API Version */Version: '2021-07-28';
};
path: {
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful response - URL redirect deleted successfully */200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['DeleteRedirectResponseDTO'];
};
}; /** @description Unprocessable Entity - The provided data is invalid or incomplete */
422: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
'update-redirect-by-id': {
parameters: {
query?: never;
header: {
/** @description API Version */Version: '2021-07-28';
};
path: {
id: string;
};
cookie?: never;
};
requestBody: {
content: {
'application/json': components['schemas']['UpdateRedirectParams'];
};
};
responses: {
/** @description Successful response */200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['UpdateRedirectResponseDTO'];
};
}; /** @description Unprocessable Entity */
422: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['UnprocessableDTO'];
};
};
};
};
'fetch-redirects-list': {
parameters: {
query: {
/** @example 20 */limit: number; /** @example 6p2RxpgtMKQwO3E6IUaT */
locationId: string; /** @example 10 */
offset: number; /** @example example.com/test */
search?: string;
};
header: {
/** @description API Version */Version: '2021-07-28';
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful response - List of URL redirects returned */200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['RedirectListResponseDTO'];
};
}; /** @description Unprocessable Entity - The provided data is invalid or incomplete */
422: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
getPagesByFunnelId: {
parameters: {
query: {
funnelId: string;
limit: number;
locationId: string;
name?: string;
offset: number;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful response - List of funnel pages returned */200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['FunnelPageResponseDTO'];
};
};
};
};
getPagesCountByFunnelId: {
parameters: {
query: {
funnelId: string;
locationId: string;
name?: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful response - Count of funnel pages returned */200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['FunnelPageCountResponseDTO'];
};
};
};
};
}
//#endregion
export { webhooks as a, paths as i, components as n, operations as r, $defs as t };