Class FunnelsClient

Hierarchy

GhlClient
- FunnelsClient

Index

Constructors

Methods

findFunnels findPages countPages createRedirect updateRedirect removeRedirect findRedirects

Constructors

constructor

new FunnelsClient(accessToken: string): FunnelsClient
Parameters
- accessToken: string
Returns FunnelsClient
Overrides GhlClient.constructor
- Defined in funnels/funnels.client.ts:18

Methods

findFunnels

findFunnels(params: FunnelSearchParams): Promise<ListFunnelsResponse>
Parameters
- params: FunnelSearchParams
Returns Promise<ListFunnelsResponse>
- Defined in funnels/funnels.client.ts:22

findPages

findPages(params: FunnelPageSearchParams): Promise<FunnelPageResponse>
Parameters
- params: FunnelPageSearchParams
Returns Promise<FunnelPageResponse>
- Defined in funnels/funnels.client.ts:28

countPages

countPages(params: FunnelPageCountParams): Promise<FunnelPageCountResponse>
Parameters
- params: FunnelPageCountParams
Returns Promise<FunnelPageCountResponse>
- Defined in funnels/funnels.client.ts:34

createRedirect

createRedirect(dto: CreateFunnelRedirectDto): Promise<FunnelRedirectResponse>
Parameters
- dto: CreateFunnelRedirectDto
Returns Promise<FunnelRedirectResponse>
- Defined in funnels/funnels.client.ts:40

updateRedirect

updateRedirect(
redirectId: string,
dto: UpdateFunnelRedirectDto,
): Promise<FunnelRedirectResponse>
Parameters
- redirectId: string
- dto: UpdateFunnelRedirectDto
Returns Promise<FunnelRedirectResponse>
- Defined in funnels/funnels.client.ts:46

removeRedirect

removeRedirect(
redirectId: string,
locationId: string,
): Promise<DeleteFunnelRedirectResponse>
Parameters
- redirectId: string
- locationId: string
Returns Promise<DeleteFunnelRedirectResponse>
- Defined in funnels/funnels.client.ts:56

findRedirects

findRedirects(
params: FunnelRedirectSearchParams,
): Promise<ListFunnelRedirectsResponse>
Parameters
- params: FunnelRedirectSearchParams
Returns Promise<ListFunnelRedirectsResponse>
- Defined in funnels/funnels.client.ts:66