gohl
Version:
Go Highlevel Node Js ease of use library implementation to their API
61 lines (60 loc) • 2.37 kB
TypeScript
import { AuthData } from "../interfaces/auth/authdata";
import { IOpportunityResponse, ICreateOpportunity, IUpdateOpportunity, IUpdateOpportunityStatus, IUpsertOpportunity } from "../interfaces/opportunity";
import { OpportunitiesSearch } from "./opportunities.search";
import { OpportunitiesPipelines } from "./opportunities.pipelines";
import { OpportunitiesFollowers } from "./opportunities.followers";
export declare class Opportunities {
private authData?;
search: OpportunitiesSearch;
pipelines: OpportunitiesPipelines;
followers: OpportunitiesFollowers;
/**
* Endpoints For Opportunities
* https://highlevel.stoplight.io/docs/integrations/31798edaafcba-get-opportunity
*/
constructor(authData?: AuthData);
/**
* Get Opportunity
* Documentation - https://highlevel.stoplight.io/docs/integrations/31798edaafcba-get-opportunity
* @param opportunityId
* @returns
*/
get(opportunityId: string): Promise<IOpportunityResponse>;
/**
* Create Opportunity
* Documentation - https://highlevel.stoplight.io/docs/integrations/802093aa63900-create-opportunity
* @param data
* @returns
*/
create(data: ICreateOpportunity): Promise<IOpportunityResponse>;
/**
* Update Opportunity
* Documentation - https://highlevel.stoplight.io/docs/integrations/ca75b3ab9e828-update-opportunity
* @param opportunityId
* @param data
* @returns
*/
update(opportunityId: string, data: IUpdateOpportunity): Promise<IOpportunityResponse>;
/**
* Update Opportunity Status
* Documentation - https://highlevel.stoplight.io/docs/integrations/d595e6fa2b666-update-opportunity-status
* @param opportunityId
* @param data
* @returns
*/
updateStatus(opportunityId: string, data: IUpdateOpportunityStatus): Promise<IOpportunityResponse>;
/**
* Upsert Opportunity
* Documentation - https://highlevel.stoplight.io/docs/integrations/9df1c12e5da99-upsert-opportunity
* @param data
* @returns
*/
upsert(data: IUpsertOpportunity): Promise<IOpportunityResponse>;
/**
* Delete Opportunity
* Documentation - https://highlevel.stoplight.io/docs/integrations/11568af679dff-delete-opportunity
* @param opportunityId
* @returns
*/
remove(opportunityId: string): Promise<any>;
}