@gnosticdev/highlevel-sdk
Version:
SDK for the HighLevel API
689 lines (686 loc) • 27 kB
TypeScript
import { i as paths, n as components, r as operations } from "./oauth-DxEw3I4f.js";
import { r as Scopes, t as AccessType } from "./scope-types-pFzsUio-.js";
import { i as paths$1 } from "./agencies-Bm8xtwQz.js";
import { i as paths$2 } from "./associations-DXNGaMuH.js";
import { i as paths$3 } from "./blogs-D0Px088h.js";
import { i as paths$4 } from "./businesses-fnrR-cND.js";
import { i as paths$5 } from "./calendars-DqOwzbyr.js";
import { i as paths$6 } from "./campaigns-Bsx9CN4c.js";
import { i as paths$7 } from "./companies-BRQ6SWoS.js";
import { i as paths$8 } from "./contacts-DjjikbXc.js";
import { i as paths$9 } from "./conversations-Mbmko3rc.js";
import { i as paths$10 } from "./courses-TJpUJJdC.js";
import { i as paths$11 } from "./custom-fields-qV6DE5II.js";
import { i as paths$12 } from "./custom-menus-D3tcvbji.js";
import { i as paths$13 } from "./email-isv-Cn2xwGkX.js";
import { i as paths$14 } from "./emails-quKomLUA.js";
import { i as paths$15 } from "./forms-vF3d2tbF.js";
import { i as paths$16 } from "./funnels-D3urx349.js";
import { i as paths$17 } from "./invoices-BUr2_9ci.js";
import { i as paths$18 } from "./links-CB-nm0dh.js";
import { i as paths$19 } from "./locations-D2W3aupW.js";
import { i as paths$20 } from "./marketplace-z_cnyC8r.js";
import { i as paths$21 } from "./medias-C8951YFQ.js";
import { i as paths$22 } from "./objects-8jHzrJKv.js";
import { i as paths$23 } from "./opportunities-g9VeKYV_.js";
import { i as paths$24 } from "./payments-DizoDh5L.js";
import { i as paths$25 } from "./phone-system-sPS8Vo1s.js";
import { i as paths$26 } from "./products-DJPQZrXk.js";
import { i as paths$27 } from "./proposals-DjOmdZpV.js";
import { i as paths$28 } from "./saas-api-BAUQuIe9.js";
import { i as paths$29 } from "./snapshots-_eqwCIKx.js";
import { i as paths$30 } from "./social-media-posting-j-sINF0-.js";
import { i as paths$31 } from "./store-BU6_Q5Yz.js";
import { i as paths$32 } from "./surveys-C42ptaYb.js";
import { i as paths$33 } from "./users-CEcAVTCv.js";
import { i as paths$34 } from "./voice-ai-sAWMNV0j.js";
import { i as paths$35 } from "./workflows-DmJLaS1q.js";
import createClient$1, { Client, ClientOptions } from "openapi-fetch";
//#region src/v2/oauth/types.d.ts
type AccessTokenRequest = operations['get-access-token']['requestBody']['content']['application/x-www-form-urlencoded'] & {
grant_type: 'authorization_code';
};
type RefreshTokenRequest = operations['get-access-token']['requestBody']['content']['application/x-www-form-urlencoded'];
/**
* Search Params appended to the auth url
* @see https://highlevel.stoplight.io/docs/integrations/a04191c0fabf9-authorization
*/
type AuthUrlParams = {
response_type: 'code';
redirect_uri: string;
client_id: string;
scope: string;
};
/**
* The params used to generate a new access token, or refresh an existing one
*/
type TokenParams = AuthCodeParams | RefreshTokenRequest;
/**
* The params used to generate a new access token
*/
type AuthCodeParams<TGrantType extends AccessTokenRequest['grant_type'] = 'authorization_code'> = { [K in keyof Pick<AccessTokenRequest, 'client_id' | 'client_secret' | 'refresh_token'>]: AccessTokenRequest[K] } & {
grant_type: TGrantType;
user_type: 'Company' | 'Location';
};
/**
* The params used to generate a new location access token
*/
type LocationTokenParams = components['schemas']['GetLocationAccessCodeBodyDto'];
/**
* The response from the server when generating a new location access token
*/
type LocationTokenResponse = components['schemas']['GetLocationAccessTokenSuccessfulResponseDto'];
/**
* The params used to search for installed locations
*/
type SearchInstalledLocationParams = {
query: operations['get-installed-location']['parameters']['query'];
};
type GetInstalledLocationResponse = components['schemas']['GetInstalledLocationsSuccessfulResponseDto'];
/**
* The response from the server when generating a new access token
*/
type AccessTokenResponse = Required<components['schemas']['GetAccessCodeSuccessfulResponseDto']>;
/**
* The data stored in the token response.
* **NOTE** `expiresAt` is a calculated value based on the `expires_in` value from the token response.
*/
type TokenData = AccessTokenResponse & {
expiresAt: number;
};
/**
* If providing your own auth provider, you can implement this interface and pass it into the `createHighLevelClient` function.
*/
interface OAuthClientInterface {
/**
* The time (in seconds) when the access token expires. Default expiry is 24 hours from the time it was generated.
*/
expiresAt: number | undefined;
/**
* Auto generates the authorization url for your app.
* @see https://highlevel.stoplight.io/docs/integrations/a04191c0fabf9-authorization
* @example
* ```ts
https://marketplace.gohighlevel.com/oauth/chooselocation?response_type=code&redirect_uri=https://myapp.com/oauth/callback/gohighlevel&client_id=CLIENT_ID&scope=conversations/message.readonly conversations/message.write
* ```
*/
getAuthorizationUrl(): string;
/**
* The token response from the server.
*/
tokenData: TokenData | undefined;
/**
* The scopes needed for your app. These must be added to your app in the marketplace.
*/
readonly scopes: string;
/**
* Gets the current access token, or generates a new one if needed.
* @param authCode - The authorization code received from the OAuth provider.
* @returns The access token.
*/
getAccessToken(authCode?: string): Promise<string | null>;
/**
* Get all locations under your agency that have installed your app
* @param query - search for installed locations using any of these properties
* @returns
* */
getInstalledLocations(query: SearchInstalledLocationParams['query']): Promise<GetInstalledLocationResponse>;
/**
* generate a location AccessToken from Agency AccessToken
* @param companyId - your agency id
* @param locationId - The locationId is the locationId of the location you want to get a token for
*/
generateLocationToken(params: LocationTokenParams): Promise<LocationTokenResponse>;
/**
* Exchange an authorization code for an access_token.
*
* To refresh a token use the `refreshAccessToken` method
* @param authCode - Parameters required to generate a new token.
* @returns The token response from the server.
* */
exchangeToken(authCode: string): Promise<AccessTokenResponse>;
/**
* Refreshes the current access token.
* @returns The token response from the server.
*/
refreshAccessToken(): Promise<AccessTokenResponse>;
}
//#endregion
//#region src/v2/client/types.d.ts
type HTTPMethod = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options' | 'trace';
type RemoveAuthHeaders<T> = T extends {
parameters: {
header: infer H;
};
} ? H extends {
Authorization: string;
Version: string;
} ? {
parameters: {
header?: Partial<Pick<H, 'Authorization' | 'Version'>> & Omit<H, 'Authorization' | 'Version'>;
} & Omit<T['parameters'], 'header'>;
} & Omit<T, 'parameters'> : T : never;
/**
* An `openapi-fetch` client with optional Authentication headers.
*
* @see {@link createClientWithAuth}
*/
type OptionalAuthParamsClient<T> = T extends Client<infer Paths> ? Client<{ [P in keyof Paths]: { [M in keyof Paths[P]]: M extends 'parameters' ? Paths[P][M] : M extends HTTPMethod ? RemoveAuthHeaders<Paths[P][M]> : Paths[P][M] } }> : never;
interface ClientWithAuth<TPaths extends {}> extends OptionalAuthParamsClient<Client<TPaths>> {}
/**
* Authentication headers for the HighLevel v2 API.
*/
type AUTH_HEADERS = {
/**
* The token to use for authentication.
*
* @example `Bearer 1234567890`
*/
Authorization: `Bearer ${string}`;
/**
* The version of the API to use.
*
* @default '2021-07-28'
*/
Version: '2021-07-28';
};
//#endregion
//#region src/v2/client/base.d.ts
/**
* Base implementation for HighLevel API client.
* Provides endpoint clients for each API domain.
*/
declare class BaseHighLevelClient<T extends AccessType, TOAuth extends DefaultOauthClient | OauthClientImpl<T>> implements HighLevelClientInterface<T, TOAuth> {
/**
* Exposed config object for convenience.
*/
_clientConfig: HighLevelClientConfig;
oauth: TOAuth;
agencies: Client<paths$1>;
associations: Client<paths$2>;
blogs: Client<paths$3>;
businesses: Client<paths$4>;
calendars: Client<paths$5>;
campaigns: Client<paths$6>;
companies: Client<paths$7>;
contacts: Client<paths$8>;
conversations: Client<paths$9>;
courses: Client<paths$10>;
customFields: Client<paths$11>;
customMenus: Client<paths$12>;
emailIsv: Client<paths$13>;
emails: Client<paths$14>;
forms: Client<paths$15>;
funnels: Client<paths$16>;
invoices: Client<paths$17>;
links: Client<paths$18>;
locations: Client<paths$19>;
marketplace: Client<paths$20>;
medias: Client<paths$21>;
objects: Client<paths$22>;
opportunities: Client<paths$23>;
payments: Client<paths$24>;
phoneSystem: Client<paths$25>;
products: Client<paths$26>;
proposals: Client<paths$27>;
saasApi: Client<paths$28>;
snapshots: Client<paths$29>;
socialMediaPosting: Client<paths$30>;
store: Client<paths$31>;
surveys: Client<paths$32>;
users: Client<paths$33>;
voiceAi: Client<paths$34>;
workflows: Client<paths$35>;
constructor(clientConfig?: HighLevelClientConfig, authHeaders?: AUTH_HEADERS);
}
//#endregion
//#region src/v2/client/with-oauth.d.ts
declare const DEFAULT_OAUTH_LOGIN_URL = "https://marketplace.leadconnectorhq.com/oauth/chooselocation";
/**
* Default memory storage function for token data.
* Stores token data in memory using the default memory store.
*
* @param tokenData - The token data to store
* @returns The stored token data
*/
declare function defaultMemoryStorageFunction(tokenData: TokenData): Promise<TokenData>;
/**
* HighLevelClient with built in OAuth methods.
*
* To create an instance, use the `createHighLevelClient` function from the main client.
*
* @see {@link createHighLevelClient}
* @example
* ```ts
* const client = createHighLevelClient({}, 'oauth', {
* clientId: 'your-client-id',
* clientSecret: 'your-client-secret',
* redirectUri: 'http://localhost:3000/callback',
* accessType: 'Sub-Account',
* scopes: ['contacts.readonly']
* })
* ```
* @internal
*/
declare class HighLevelClientWithOAuth<T extends AccessType> extends BaseHighLevelClient<T, OauthClientImpl<T>> {
oauth: OauthClientImpl<T>;
constructor(oauthConfig: HighLevelOauthConfig<T>, clientConfig?: HighLevelClientConfig);
}
/**
* The configuration for the HighLevel API client with OAuth.
*/
type HighLevelOauthConfig<T extends AccessType> = {
/**
* base url for each API endpoint. no need to change unless you are proxying requests.
* @default 'https://services.leadconnectorhq.com'
*/
baseUrl?: string;
/**
* client_id from app settings in marketplace.
*
* **Important:** Your client_id and client_secret must have been created after your scopes were added to your app.
* @default process.env.HIGHLEVEL_CLIENT_ID
* @see {@link https://marketplace.gohighlevel.com/apps}
*/
clientId: string;
/**
* client_secret from app settings in marketplace.
*
* **Important:** Your client_id and client_secret must have been created after your scopes were added to your app.
* @default process.env.HIGHLEVEL_CLIENT_SECRET
* @see {@link https://marketplace.gohighlevel.com/apps}
*/
clientSecret: string;
/**
* The access level of your app as defined in the ghl marketplace.
*
* - `Sub-Account` is same as **Location**.
* - `Company` is same as **Agency**
*/
accessType: T;
/**
* the url to redirect to after the user has authorized the app
* - use `client.getAuthorizationUrl()` to generate the the full auth url including your redirectUri, clientId, and scopes
*/
redirectUri: string;
/**
* Scopes needed to get the authorization code. These must be added to your app in the marketplace.
*
* Available scopes will change depending on your app type.
* @see {@link https://marketplace.gohighlevel.com/apps}
*/
scopes: (Scopes<T> | (string & {}))[];
/**
* base url used by the Oauth client to build the redirect uri. no need to change unless you are proxying requests.
* @default `https://marketplace.leadconnectorhq.com/oauth/chooselocation`
*/
baseAuthUrl?: string;
/**
* the auth code from the redirect uri
*
* use `client.getAuthCode()` to get the auth code from the query params
* @see https://highlevel.stoplight.io/docs/integrations/
*/
authCode?: string;
/**
* Store the token data in your database or cache
*/
storageFunction?: (tokenData: TokenData) => Promise<TokenData>;
};
//#endregion
//#region src/v2/oauth/impl.d.ts
/**
* Default `openapi-fetch` client for HighLevel OAuth 2.0 endpoints.
*/
type DefaultOauthClient = Client<paths>;
/**
* This client has built in methods for generating, refreshing, and storing tokens.
* You can extend this class to implement your own methods.
* @see https://highlevel.stoplight.io/docs/integrations/
*/
declare class OauthClientImpl<T extends AccessType> implements OAuthClientInterface {
#private;
private _accessToken;
private _refreshToken;
/**
* Type of user that is accessing the API.
*
* Only used for generating tokens, similar to `accessType` but uses `Location` (Sub-Account) or `Company` (Agency)
*/
private readonly userType;
/**
* Underlying oauth client created by `createClient` method from `openapi-fetch`
*
* Most likely do not need to use this unless special use case.
*/
_oauthClient: DefaultOauthClient;
expiresAt: number | undefined;
readonly scopes: string;
readonly config: HighLevelOauthConfig<T>;
private readonly baseUrl;
private readonly baseOauthUrl;
tokenData: TokenData | undefined;
storeTokenFn: (tokenData: TokenData) => Promise<TokenData>;
/**
* creates a new oauth client for use with the HighLevel API
* @constructor
* @param config - configuration for your app
*/
constructor(config: HighLevelOauthConfig<T>);
/**
* Update the stored token data with the provided token data.
* @param updatedTokenData - The token data to update.
*/
updateTokenData(updatedTokenData: Partial<TokenData>): void;
/**
* generates the authorization url for your app using the baseAuthUrl, clientId, redirectUri, and scopes.
* @see https://highlevel.stoplight.io/docs/integrations/a04191c0fabf9-authorization
* @example
* ```ts
https://marketplace.leadconnectorhq.com/oauth/chooselocation?response_type=code&redirect_uri=https://myapp.com/oauth/callback/gohighlevel&client_id=CLIENT_ID&scope=conversations/message.readonly conversations/message.write
* ```
*/
getAuthorizationUrl(): string;
/**
* Stores the token data using the `storageFunction` including the accessToken, refreshToken, locationID, and adds the expiresAt time (in ms).
* **NOTE**: You can add a `storageFunction` to the config to store the token data in your database or cache.
* @param tokenData - the token response from the server
* @returns the token data with the `expiresAt` time added
*/
storeTokenData(tokenData: TokenData): Promise<TokenData>;
/**
* Check if the token is expired or if we need to refresh it
* @returns true if the token is expired or if we need to refresh it
*/
private isTokenExpired;
/**
* Returns a valid access token by either refreshing the token or exchanging the auth code for a new token.
*
* Also stores the token via the `storeTokenData` if provided.
* @param authCode - The authorization code received from the OAuth provider.
* @throws {Error} - If no token response is received or if no auth code or refresh token is provided.
* @returns The access token.
*/
getAccessToken(authCode?: string): Promise<string | null>;
/**
* Generates a new access token using the provided authorization code. \
* **NOTE**: This method does not save the token data to the client.
* To store the token:
* - `storeTokenData` - saves the token data.
* - `getAccessToken` - fetches and stores the token data.
* @param authCode - Parameters required to generate a new token.
* @returns The token response from the server.
*/
exchangeToken(authCode: string): Promise<TokenData>;
/**
* Refreshes the current access token.
* **NOTE**: This method does not save the token data to the client.
* To store the token:
* - `storeTokenData` - saves the token data.
* - `getAccessToken` - fetches and stores the token data.
* @returns The token response from the server.
*/
refreshAccessToken(): Promise<TokenData>;
/**
* generate a location AccessToken from Agency AccessToken
* @param companyId - your agency id
* @param locationId - The locationId is the locationId of the location you want to get a token for
*/
generateLocationToken({
companyId,
locationId
}: LocationTokenParams): Promise<{
access_token?: string;
expires_in?: number;
locationId?: string;
planId?: string;
scope?: string;
token_type?: string;
userId: string;
}>;
/**
* Get all locations under your agency that have installed your app
* @param query - search for installed locations using any of these properties
* @param appId - the appId of your app
* @param companyId - the companyId of your agency
*/
getInstalledLocations(query: SearchInstalledLocationParams['query']): Promise<{
count?: number;
installToFutureLocations?: boolean;
locations?: components["schemas"]["InstalledLocationSchema"][];
}>;
}
//#endregion
//#region src/v2/client/default.d.ts
/**
* default base url for the HighLevel API.
* @default 'https://services.leadconnectorhq.com'
*/
declare const DEFAULT_V2_BASE_URL = "https://services.leadconnectorhq.com";
interface HighLevelClientConfig extends ClientOptions {
/**
* base url for each API endpoint. no need to change unless you are proxying requests.
* @default 'https://services.leadconnectorhq.com'
*/
baseUrl?: string;
}
/**
* Default client for HighLevel API endpoints.
*
* @remarks use the `createHighLevelClient` function to create an instance of this client without handling generic types.
*
* @see {@link createHighLevelClient}
*
* @example
* ```ts
* const client = new HighLevelClient({}, {Authorization: 'Bearer 1234567890', Version: '2021-07-28'})
* const locations = client.locations.GET('/locations/search', {query: {name: 'John Doe'}})
* ```
*/
declare class HighLevelClient<T extends AccessType> extends BaseHighLevelClient<T, DefaultOauthClient> {
oauth: DefaultOauthClient;
constructor(clientConfig?: HighLevelClientConfig);
}
//#endregion
//#region src/v2/client/with-integration.d.ts
type PrivateIntegrationConfig<T extends AccessType> = {
/**
* The access type for the integration. Decides what scopes are available.
*/
accessType: T;
/**
* The private integration token.
*
* @see https://help.leadconnectorhq.com/support/solutions/articles/155000002774-private-integrations-everything-you-need-to-know
*/
privateToken: string;
};
/**
* HighLevel API client using private integration token for authentication.
* To create an instance, use the `createHighLevelClient` function from the main client.
*
* @see {@link createHighLevelClient}
*
* @example
* ```ts
* const client = createHighLevelClient({}, 'integration', {
* privateToken: 'your-token',
* accessType: 'Sub-Account',
* scopes: ['contacts.readonly']
* })
* ```
* @internal
*/
declare class HighLevelIntegrationClient<T extends AccessType> extends BaseHighLevelClient<T, DefaultOauthClient> {
/**
* The private token for the integration
*
* @see https://help.leadconnectorhq.com/support/solutions/articles/155000002774-private-integrations-everything-you-need-to-know
*/
privateToken: string;
/**
* The scopes for the integration.
*
* _NOTE_: in a private integration, we never send off the scopes like we do in Oauth2, but leaving this here for potential future use.
*
* @example
* ```ts
* const scopes = new ScopesBuilder().all().build()
* ```
*/
scopes?: Scopes<T>[];
constructor(
/**
* The integration config uses your private token and scopes to add the appropriate headers to the client.
*/
integrationConfig: PrivateIntegrationConfig<T>,
/**
* The `openapi-fetch` client config.
*
* @default { baseUrl: `https://services.leadconnectorhq.com` }
*
* @see https://openapi-ts.dev/openapi-fetch
*/
clientConfig?: HighLevelClientConfig);
}
//#endregion
//#region src/v2/client/interface.d.ts
interface HighLevelClientInterface<T extends AccessType, TOAuth extends DefaultOauthClient | OauthClientImpl<T>> {
/**
* Exposed config object for convenience.
*/
_clientConfig: HighLevelClientConfig;
oauth: TOAuth;
objects: Client<paths$22> | ClientWithAuth<paths$22>;
invoices: Client<paths$17> | ClientWithAuth<paths$17>;
socialMediaPosting: Client<paths$30> | ClientWithAuth<paths$30>;
customMenus: Client<paths$12> | ClientWithAuth<paths$12>;
customFields: Client<paths$11> | ClientWithAuth<paths$11>;
opportunities: Client<paths$23> | ClientWithAuth<paths$23>;
campaigns: Client<paths$6> | ClientWithAuth<paths$6>;
businesses: Client<paths$4> | ClientWithAuth<paths$4>;
marketplace: Client<paths$20> | ClientWithAuth<paths$20>;
conversations: Client<paths$9> | ClientWithAuth<paths$9>;
voiceAi: Client<paths$34> | ClientWithAuth<paths$34>;
products: Client<paths$26> | ClientWithAuth<paths$26>;
courses: Client<paths$10> | ClientWithAuth<paths$10>;
surveys: Client<paths$32> | ClientWithAuth<paths$32>;
emails: Client<paths$14> | ClientWithAuth<paths$14>;
payments: Client<paths$24> | ClientWithAuth<paths$24>;
emailIsv: Client<paths$13> | ClientWithAuth<paths$13>;
phoneSystem: Client<paths$25> | ClientWithAuth<paths$25>;
workflows: Client<paths$35> | ClientWithAuth<paths$35>;
snapshots: Client<paths$29> | ClientWithAuth<paths$29>;
saasApi: Client<paths$28> | ClientWithAuth<paths$28>;
associations: Client<paths$2> | ClientWithAuth<paths$2>;
users: Client<paths$33> | ClientWithAuth<paths$33>;
funnels: Client<paths$16> | ClientWithAuth<paths$16>;
locations: Client<paths$19> | ClientWithAuth<paths$19>;
links: Client<paths$18> | ClientWithAuth<paths$18>;
blogs: Client<paths$3> | ClientWithAuth<paths$3>;
companies: Client<paths$7> | ClientWithAuth<paths$7>;
contacts: Client<paths$8> | ClientWithAuth<paths$8>;
store: Client<paths$31> | ClientWithAuth<paths$31>;
agencies: Client<paths$1> | ClientWithAuth<paths$1>;
forms: Client<paths$15> | ClientWithAuth<paths$15>;
proposals: Client<paths$27> | ClientWithAuth<paths$27>;
calendars: Client<paths$5> | ClientWithAuth<paths$5>;
medias: Client<paths$21> | ClientWithAuth<paths$21>;
}
//#endregion
//#region src/v2/index.d.ts
type AuthConfig<T extends AccessType, TAuthType extends 'oauth' | 'integration'> = TAuthType extends 'oauth' ? HighLevelOauthConfig<T> : PrivateIntegrationConfig<T>;
type AuthClient<T extends AccessType, TAuthType extends 'oauth' | 'integration' = never> = TAuthType extends never ? HighLevelClient<T> : TAuthType extends 'oauth' ? HighLevelClientWithOAuth<T> : HighLevelIntegrationClient<T>;
/**
* Creates a HighLevel client with typed endpoints.
*
* @param clientConfig - the client configuration that will be used on each request.
* @param authType - the type of authentication to use.
* @param authConfig - the authentication configuration for either OAuth or Private Integration.
*
* @example
* ```ts
* // basic client
* const client = createHighLevelClient()
* const contacts = client.contacts.GET('/contacts/', {
* params: {
* header: {
* Authorization: 'Bearer 1234567890',
* Version: '2021-07-28',
* },
* query: {
* locationId: '1234567890',
* query: 'John Doe',
* },
* },
* })
* ```
*/
declare function createHighLevelClient<T extends AccessType>(): HighLevelClient<T>;
/**
* Creates a default HighLevel client with typed endpoints.
*
* @example
* ```ts
* // pass in client config
* const client = createHighLevelClient({ baseUrl: 'https://custom-url.com' })
* ```
*/
declare function createHighLevelClient<T extends AccessType>(clientConfig?: HighLevelClientConfig): HighLevelClient<T>;
/**
* Creates a HighLevel client with support for OAuth.
*
* @example
* ```ts
* // client with OAuth
* const client = createHighLevelClient({}, 'oauth', {
* clientId: 'your-client-id',
* clientSecret: 'your-client-secret',
* redirectUri: 'http://localhost:3000/callback',
* accessType: 'Sub-Account',
* scopes: ['contacts.readonly'],
* storageFunction: async (tokenData) => {
* await db.set('tokenData', tokenData)
* return tokenData
* }
* })
* const authUrl = client.oauth.getAuthorizationUrl()
* // redirect to authUrl, get the code from your callback route.
* app.get('/auth/callback', async (c) => {
* const code = c.req.query('code')
* if (!code) {
* throw new Error('No code found in callback')
* }
* const token = await client.oauth.getAccessToken(code)
* const contacts = client.contacts.GET('/contacts/', {
* params: {
* query: {
* locationId: '1234567890',
* query: 'John Doe',
* },
* header: {
* Authorization: `Bearer ${token}`,
* Version: '2021-07-28',
* },
* },
* })
* return c.json(contacts)
* })
* ```
*/
declare function createHighLevelClient<T extends AccessType, TAuthType extends 'oauth' | 'integration' = 'oauth'>(clientConfig?: HighLevelClientConfig, authType?: TAuthType, authConfig?: AuthConfig<T, TAuthType>): AuthClient<T, TAuthType>;
/**
* Creates a HighLevel client with support for Private Integration.
*
* @example
* ```ts
* const client = createHighLevelClient({}, 'integration', {
* privateToken: 'your-token',
* accessType: 'Agency',
* scopes: ['saas/company.write']
* })
* ```
*/
declare function createHighLevelClient<T extends AccessType, TAuthType extends 'oauth' | 'integration' = 'integration'>(clientConfig?: HighLevelClientConfig, authType?: TAuthType, authConfig?: AuthConfig<T, TAuthType>): AuthClient<T, TAuthType>;
//#endregion
export { TokenParams as C, TokenData as S, GetInstalledLocationResponse as _, PrivateIntegrationConfig as a, OAuthClientInterface as b, DefaultOauthClient as c, HighLevelOauthConfig as d, AUTH_HEADERS as f, AuthUrlParams as g, AuthCodeParams as h, HighLevelIntegrationClient as i, OauthClientImpl as l, AccessTokenResponse as m, createHighLevelClient as n, HighLevelClient as o, ClientWithAuth as p, HighLevelClientInterface as r, HighLevelClientConfig as s, createClient$1 as t, HighLevelClientWithOAuth as u, LocationTokenParams as v, SearchInstalledLocationParams as x, LocationTokenResponse as y };