Class OpportunitiesClient

Hierarchy

GhlClient
- OpportunitiesClient

Index

Constructors

Methods

findById remove update updateStatus upsert create search findPipelines addFollowers removeFollowers

Constructors

constructor

new OpportunitiesClient(accessToken: string): OpportunitiesClient
Parameters
- accessToken: string
Returns OpportunitiesClient
Overrides GhlClient.constructor
- Defined in opportunities/opportunities.client.ts:19

Methods

findById

findById(opportunityId: string): Promise<OpportunityResponse>
Parameters
- opportunityId: string
Returns Promise<OpportunityResponse>
- Defined in opportunities/opportunities.client.ts:23

remove

remove(opportunityId: string): Promise<SuccededDeleteResponse>
Parameters
- opportunityId: string
Returns Promise<SuccededDeleteResponse>
- Defined in opportunities/opportunities.client.ts:27

update

update(
opportunityId: string,
dto: UpdateOpportunityDto,
): Promise<OpportunityResponse>
Parameters
- opportunityId: string
- dto: UpdateOpportunityDto
Returns Promise<OpportunityResponse>
- Defined in opportunities/opportunities.client.ts:33

updateStatus

updateStatus(
opportunityId: string,
status: OpportunityStatus,
): Promise<UpdateOpportunityStatusResponse>
Parameters
- opportunityId: string
- status: OpportunityStatus
Returns Promise<UpdateOpportunityStatusResponse>
- Defined in opportunities/opportunities.client.ts:40

upsert

upsert(dto: UpsertOpportunityDto): Promise<UpsertOpportunityResponse>
Parameters
- dto: UpsertOpportunityDto
Returns Promise<UpsertOpportunityResponse>
- Defined in opportunities/opportunities.client.ts:50

create

create(dto: CreateOpportunityDto): Promise<OpportunityResponse>
Parameters
- dto: CreateOpportunityDto
Returns Promise<OpportunityResponse>
- Defined in opportunities/opportunities.client.ts:56

search

search(params: OpportunitySearchParams): Promise<OpportunitiesSearchResponse>
Parameters
- params: OpportunitySearchParams
Returns Promise<OpportunitiesSearchResponse>
- Defined in opportunities/opportunities.client.ts:60

findPipelines

findPipelines(locationId: string): Promise<ListPipelinesResponse>
Parameters
- locationId: string
Returns Promise<ListPipelinesResponse>
- Defined in opportunities/opportunities.client.ts:68

addFollowers

addFollowers(
opportunityId: string,
followers: string[],
): Promise<AddOpportunityFollowersResponse>
Parameters
- opportunityId: string
- followers: string[]
Returns Promise<AddOpportunityFollowersResponse>
- Defined in opportunities/opportunities.client.ts:76

removeFollowers

removeFollowers(
opportunityId: string,
followers: string[],
): Promise<RemoveOpportunityFollowersResponse>
Parameters
- opportunityId: string
- followers: string[]
Returns Promise<RemoveOpportunityFollowersResponse>
- Defined in opportunities/opportunities.client.ts:86