@gnosticdev/highlevel-sdk
Version:
SDK for the HighLevel API
1,095 lines (1,093 loc) • 35.3 kB
text/typescript
type paths = {
'/opportunities/': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Opportunity
* @description Create Opportunity
*/
post: operations['create-opportunity'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/opportunities/{id}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Opportunity
* @description Get Opportunity
*/
get: operations['get-opportunity'];
/**
* Update Opportunity
* @description Update Opportunity
*/
put: operations['update-opportunity'];
post?: never;
/**
* Delete Opportunity
* @description Delete Opportunity
*/
delete: operations['delete-opportunity'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/opportunities/{id}/followers': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Add Followers
* @description Add Followers
*/
post: operations['add-followers-opportunity'];
/**
* Remove Followers
* @description Remove Followers
*/
delete: operations['remove-followers-opportunity'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/opportunities/{id}/status': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Update Opportunity Status
* @description Update Opportunity Status
*/
put: operations['update-opportunity-status'];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/opportunities/pipelines': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Pipelines
* @description Get Pipelines
*/
get: operations['get-pipelines'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/opportunities/search': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Search Opportunity
* @description Search Opportunity
*/
get: operations['search-opportunity'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/opportunities/upsert': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Upsert Opportunity
* @description Upsert Opportunity
*/
post: operations['Upsert-opportunity'];
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;
};
CreateAddFollowersSuccessfulResponseDto: {
/** @example [
* "sx6wyHhbFdRXh302Lunr",
* "sx6wyHhbFdRXh302LLss"
* ] */
followers?: string[];
/** @example [
* "Mx6wyHhbFdRXh302Luer",
* "Ka6wyHhbFdRXh302LLsAm"
* ] */
followersAdded?: string[];
};
CreateDto: {
/** @example 082goXVW3lIExEQPOnd3 */
assignedTo?: string;
/** @example mTkSCb1UBjb5tk4OvB69 */
contactId: string;
/** @description Add custom fields to opportunities. */
customFields?: (components['schemas']['customFieldsInputStringSchema'] | components['schemas']['customFieldsInputArraySchema'] | components['schemas']['customFieldsInputObjectSchema'])[];
/** @example ve9EPM428h8vShlRW1KT */
locationId: string;
/** @example 220 */
monetaryValue?: number;
/** @example First Opps */
name: string;
/**
* @description pipeline Id
* @example VDm7RPYC2GLUvdpKmBfC
*/
pipelineId: string;
/** @example 7915dedc-8f18-44d5-8bc3-77c04e994a10 */
pipelineStageId?: string;
/** @enum {string} */
status: 'open' | 'won' | 'lost' | 'abandoned' | 'all';
};
CustomFieldResponseSchema: {
/** @description The value of the custom field */
fieldValue: string | Record<string, never> | string[] | Record<string, never>[];
/** @example MgobCB14YMVKuE4Ka8p1 */
id: string;
};
customFieldsInputArraySchema: {
/** @example [
* "test",
* "test2"
* ] */
field_value?: string[];
/** @example 6dvNaf7VhkQ9snc5vnjJ */
id: string;
/** @example my_custom_field */
key?: string;
};
customFieldsInputObjectSchema: {
/** @example {} */
field_value?: Record<string, never>;
/** @example 6dvNaf7VhkQ9snc5vnjJ */
id: string;
/** @example my_custom_field */
key?: string;
};
customFieldsInputStringSchema: {
/** @example 9039160788 */
field_value?: string;
/**
* @description Pass either `id` or `key` of custom field
* @example 6dvNaf7VhkQ9snc5vnjJ
*/
id?: string;
/**
* @description Pass either `id` or `key` of custom field
* @example my_custom_field
*/
key?: string;
};
DeleteFollowersSuccessfulResponseDto: {
/** @example [
* "sx6wyHhbFdRXh302Lunr",
* "sx6wyHhbFdRXh302LLss"
* ] */
followers?: string[];
/** @example [
* "Mx6wyHhbFdRXh302Luer",
* "Ka6wyHhbFdRXh302LLsAm"
* ] */
followersRemoved?: string[];
};
DeleteUpdateOpportunitySuccessfulResponseDto: {
/** @example true */
succeded?: boolean;
};
FollowersDTO: {
/** @example [
* "sx6wyHhbFdRXh302Lunr",
* "sx6wyHhbFdRXh302Lunr"
* ] */
followers: string[];
};
GetPipelinesSuccessfulResponseDto: {
pipelines?: components['schemas']['PipelinesResponseSchema'][];
};
GetPostOpportunitySuccessfulResponseDto: {
opportunity?: components['schemas']['SearchOpportunitiesResponseSchema'];
};
PipelinesResponseSchema: {
/** @example aWdODOBVOlH1RUFKWQke */
id?: string;
/** @example dsjddjkndadqaja */
locationId?: string;
/** @example new pipeline */
name?: string;
/** @example false */
showInFunnel?: boolean;
/** @example true */
showInPieChart?: boolean;
stages?: unknown[][];
};
SearchMetaResponseSchema: {
/** @example 2 */
currentPage?: number;
/** @example 3 */
nextPage?: number;
/** @example http://localhost:5066/opportunities/search?q=&location_id=ve9EPM428h8vShlRW1KT&pipeline_id=&pipeline_stage_id=&status=&assigned_to+=&campaignId=&id=&order=&endDate=&startAfter=1625203104328&startAfterId=yWQobCRIhRguQtD2llvk&date=&limit=1&country=&page=1 */
nextPageUrl?: string;
/** @example 1 */
prevPage?: number;
/** @example 1625203104328 */
startAfter?: number;
/** @example yWQobCRIhRguQtD2llvk */
startAfterId?: string;
/** @example 1 */
total?: number;
};
SearchOpportunitiesContactResponseSchema: {
/** @example Tesla Inc */
companyName?: string;
/** @example john@deo.com */
email?: string;
/** @example byMEV0NQinDhq8ZfiOi2 */
id?: string;
/** @example John Deo */
name?: string;
/** @example +1202-555-0107 */
phone?: string;
tags?: string[];
};
SearchOpportunitiesResponseSchema: {
/** @example zT46WSCPbudrq4zhWMk6 */
assignedTo?: string;
calendarEvents?: string[];
contact?: components['schemas']['SearchOpportunitiesContactResponseSchema'];
/** @example zT46WSCPbudrq4zhWMk6 */
contactId?: string;
/** @example 2021-08-03T04:55:17.355Z */
createdAt?: string;
customFields?: components['schemas']['CustomFieldResponseSchema'][];
followers?: unknown[][];
/** @example yWQobCRIhRguQtD2llvk */
id?: string;
/** @example 1 */
indexVersion?: string;
/** @example 2021-08-03T04:55:17.355Z */
lastActionDate?: string;
/** @example 2021-08-03T04:55:17.355Z */
lastStageChangeAt?: string;
/** @example 2021-08-03T04:55:17.355Z */
lastStatusChangeAt?: string;
/** @example zT46WSCPbudrq4zhW */
locationId?: string;
/** @example 500 */
monetaryValue?: number;
/** @example testing */
name?: string;
notes?: string[];
/** @example VDm7RPYC2GLUvdpKmBfC */
pipelineId?: string;
/** @example e93ba61a-53b3-45e7-985a-c7732dbcdb69 */
pipelineStageId?: string;
/** @example */
source?: string;
/** @example open */
status?: string;
tasks?: string[];
/** @example 2021-08-03T04:55:17.355Z */
updatedAt?: string;
};
SearchSuccessfulResponseDto: {
aggregations?: Record<string, never>;
meta?: components['schemas']['SearchMetaResponseSchema'];
opportunities?: components['schemas']['SearchOpportunitiesResponseSchema'][];
};
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;
};
UpdateOpportunityDto: {
/** @example 082goXVW3lIExEQPOnd3 */
assignedTo?: string;
/** @description Update custom fields to opportunities. */
customFields?: (components['schemas']['customFieldsInputStringSchema'] | components['schemas']['customFieldsInputArraySchema'] | components['schemas']['customFieldsInputObjectSchema'])[];
/** @example 220 */
monetaryValue?: number;
/** @example First Opps */
name?: string;
/**
* @description pipeline Id
* @example bCkKGpDsyPP4peuKowkG
*/
pipelineId?: string;
/** @example 7915dedc-8f18-44d5-8bc3-77c04e994a10 */
pipelineStageId?: string;
/** @enum {string} */
status?: 'open' | 'won' | 'lost' | 'abandoned' | 'all';
};
UpdateStatusDto: {
/** @enum {string} */
status: 'open' | 'won' | 'lost' | 'abandoned' | 'all';
};
UpsertOpportunityDto: {
/** @example 082goXVW3lIExEQPOnd3 */
assignedTo?: string;
/**
* @description contactId
* @example LiKJ2vnRg5ETM8Z19K7
*/
contactId: string;
/**
* @description locationId
* @example CLu7BaljjqrEjBGKTNNe
*/
locationId: string;
/** @example 220 */
monetaryValue?: number;
/**
* @description name
* @example opportunity name
*/
name?: string;
/**
* @description pipeline Id
* @example bCkKGpDsyPP4peuKowkG
*/
pipelineId: string;
/** @example 7915dedc-8f18-44d5-8bc3-77c04e994a10 */
pipelineStageId?: string;
/** @enum {string} */
status?: 'open' | 'won' | 'lost' | 'abandoned' | 'all';
};
UpsertOpportunitySuccessfulResponseDto: {
/** @example true */
new: boolean;
/** @description Updated / New Opportunity */
opportunity: Record<string, never>;
};
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
};
type $defs = Record<string, never>;
interface operations {
'create-opportunity': {
parameters: {
query?: never;
header: {
/** @description Access Token */
Authorization: string;
/** @description API Version */
Version: '2021-07-28';
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
'application/json': components['schemas']['CreateDto'];
};
};
responses: {
/** @description Successful response */
201: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['GetPostOpportunitySuccessfulResponseDto'];
};
};
/** @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'];
};
};
};
};
'get-opportunity': {
parameters: {
query?: never;
header: {
/** @description Access Token */
Authorization: string;
/** @description API Version */
Version: '2021-07-28';
};
path: {
/**
* @description Opportunity Id
* @example yWQobCRIhRguQtD2llvk
*/
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful response */
200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['GetPostOpportunitySuccessfulResponseDto'];
};
};
/** @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'];
};
};
};
};
'update-opportunity': {
parameters: {
query?: never;
header: {
/** @description Access Token */
Authorization: string;
/** @description API Version */
Version: '2021-07-28';
};
path: {
/**
* @description Opportunity Id
* @example yWQobCRIhRguQtD2llvk
*/
id: string;
};
cookie?: never;
};
requestBody: {
content: {
'application/json': components['schemas']['UpdateOpportunityDto'];
};
};
responses: {
/** @description Successful response */
200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['GetPostOpportunitySuccessfulResponseDto'];
};
};
/** @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'];
};
};
};
};
'delete-opportunity': {
parameters: {
query?: never;
header: {
/** @description Access Token */
Authorization: string;
/** @description API Version */
Version: '2021-07-28';
};
path: {
/**
* @description Opportunity Id
* @example yWQobCRIhRguQtD2llvk
*/
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful response */
200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['DeleteUpdateOpportunitySuccessfulResponseDto'];
};
};
/** @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'];
};
};
};
};
'add-followers-opportunity': {
parameters: {
query?: never;
header: {
/** @description Access Token */
Authorization: string;
/** @description API Version */
Version: '2021-07-28';
};
path: {
/**
* @description Opportunity Id
* @example sx6wyHhbFdRXh302Lunr
*/
id: string;
};
cookie?: never;
};
requestBody: {
content: {
'application/json': components['schemas']['FollowersDTO'];
};
};
responses: {
/** @description Successful response */
201: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['CreateAddFollowersSuccessfulResponseDto'];
};
};
/** @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'];
};
};
};
};
'remove-followers-opportunity': {
parameters: {
query?: never;
header: {
/** @description Access Token */
Authorization: string;
/** @description API Version */
Version: '2021-07-28';
};
path: {
/**
* @description Opportunity Id
* @example sx6wyHhbFdRXh302Lunr
*/
id: string;
};
cookie?: never;
};
requestBody: {
content: {
'application/json': components['schemas']['FollowersDTO'];
};
};
responses: {
/** @description Successful response */
200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['DeleteFollowersSuccessfulResponseDto'];
};
};
/** @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'];
};
};
};
};
'update-opportunity-status': {
parameters: {
query?: never;
header: {
/** @description Access Token */
Authorization: string;
/** @description API Version */
Version: '2021-07-28';
};
path: {
/**
* @description Opportunity Id
* @example yWQobCRIhRguQtD2llvk
*/
id: string;
};
cookie?: never;
};
requestBody: {
content: {
'application/json': components['schemas']['UpdateStatusDto'];
};
};
responses: {
/** @description Successful response */
200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['DeleteUpdateOpportunitySuccessfulResponseDto'];
};
};
/** @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'];
};
};
};
};
'get-pipelines': {
parameters: {
query: {
/** @example ve9EPM428h8vShlRW1KT */
locationId: 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']['GetPipelinesSuccessfulResponseDto'];
};
};
/** @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'];
};
};
};
};
'search-opportunity': {
parameters: {
query: {
/** @example 082goXVW3lIExEQPOnd3 */
assigned_to?: string;
/**
* @description Campaign Id
* @example Y2I9XM7aO1hncuSOlc9L
*/
campaignId?: string;
/**
* @description Contact Id
* @example WFwVrSSjZ2CNHbZThQX2
*/
contact_id?: string;
/** @example US */
country?: string;
/**
* @description Start date
* @example mm-dd-yyyy
*/
date?: string;
/**
* @description End date
* @example mm-dd-yyyy
*/
endDate?: string;
/**
* @description get Calender event in contact
* @example false
*/
getCalendarEvents?: boolean;
/**
* @description get Notes in contact
* @example false
*/
getNotes?: boolean;
/**
* @description get Tasks in contact
* @example false
*/
getTasks?: boolean;
/**
* @description Opportunity Id
* @example 123akv4LFn6C9frZoy3e
*/
id?: string;
/** @description Limit Per Page records count. will allow maximum up to 100 and default will be 20 */
limit?: number;
/**
* @description Location Id
* @example i2SpAtBVHSVea1sL6oah
*/
location_id: string;
/** @example added_asc */
order?: string;
page?: number;
/**
* @description Pipeline Id
* @example bCkKGpDsyPP4peuKowkG
*/
pipeline_id?: string;
/**
* @description stage Id
* @example 7915dedc-8f18-44d5-8bc3-77c04e994a10
*/
pipeline_stage_id?: string;
/** @example john@deo.com */
q?: string;
/**
* @description Start After
* @example 1628008053263
*/
startAfter?: string;
/**
* @description Start After Id
* @example UIaE1WjAwWKdlyD7osQI
*/
startAfterId?: string;
status?: 'open' | 'won' | 'lost' | 'abandoned' | 'all';
};
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']['SearchSuccessfulResponseDto'];
};
};
/** @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'];
};
};
};
};
'Upsert-opportunity': {
parameters: {
query?: never;
header: {
/** @description Access Token */
Authorization: string;
/** @description API Version */
Version: '2021-07-28';
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
'application/json': components['schemas']['UpsertOpportunityDto'];
};
};
responses: {
/** @description Successful response */
200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['UpsertOpportunitySuccessfulResponseDto'];
};
};
/** @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 };