Class BasicApi

Constructors

constructor

new BasicApi(configuration, requestFactory?, responseProcessor?): BasicApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: BasicApiRequestFactory
- OptionalresponseProcessor: BasicApiResponseProcessor
Returns BasicApi
- Defined in codegen/marketing/events/types/PromiseAPI.ts:99

Methods

archiveWithHttpInfo

archiveWithHttpInfo(externalEventId, externalAccountId, _options?): Promise<HttpInfo<void>>
Deletes an existing Marketing Event with the specified id, if one exists. Delete a marketing event
Parameters
- externalEventId: string
  The id of the marketing event to delete
- externalAccountId: string
  The account id associated with the marketing event
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:113

batchArchive

batchArchive(batchInputMarketingEventExternalUniqueIdentifier, _options?): Promise<void>
Bulk delete a number of marketing events in HubSpot Delete multiple marketing events
Parameters
- batchInputMarketingEventExternalUniqueIdentifier: BatchInputMarketingEventExternalUniqueIdentifier
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:144

batchArchiveWithHttpInfo

batchArchiveWithHttpInfo(batchInputMarketingEventExternalUniqueIdentifier, _options?): Promise<HttpInfo<void>>
Bulk delete a number of marketing events in HubSpot Delete multiple marketing events
Parameters
- batchInputMarketingEventExternalUniqueIdentifier: BatchInputMarketingEventExternalUniqueIdentifier
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:134

batchUpsert

batchUpsert(batchInputMarketingEventCreateRequestParams, _options?): Promise<BatchResponseMarketingEventPublicDefaultResponse>
Upsert multiple marketing events. If there is an existing Marketing event with the specified ID, it will be updated; otherwise a new event will be created. Create or update multiple marketing events
Parameters
- batchInputMarketingEventCreateRequestParams: BatchInputMarketingEventCreateRequestParams
- Optional_options: Configuration
Returns Promise<BatchResponseMarketingEventPublicDefaultResponse>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:164

batchUpsertWithHttpInfo

batchUpsertWithHttpInfo(batchInputMarketingEventCreateRequestParams, _options?): Promise<HttpInfo<BatchResponseMarketingEventPublicDefaultResponse>>
Upsert multiple marketing events. If there is an existing Marketing event with the specified ID, it will be updated; otherwise a new event will be created. Create or update multiple marketing events
Parameters
- batchInputMarketingEventCreateRequestParams: BatchInputMarketingEventCreateRequestParams
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseMarketingEventPublicDefaultResponse>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:154

cancel

cancel(externalEventId, externalAccountId, _options?): Promise<MarketingEventDefaultResponse>
Mark a marketing event as cancelled. Mark a marketing event as cancelled
Parameters
- externalEventId: string
  The id of the marketing event to mark as cancelled
- externalAccountId: string
  The account id associated with the marketing event
- Optional_options: Configuration
Returns Promise<MarketingEventDefaultResponse>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:186

cancelWithHttpInfo

cancelWithHttpInfo(externalEventId, externalAccountId, _options?): Promise<HttpInfo<MarketingEventDefaultResponse>>
Mark a marketing event as cancelled. Mark a marketing event as cancelled
Parameters
- externalEventId: string
  The id of the marketing event to mark as cancelled
- externalAccountId: string
  The account id associated with the marketing event
- Optional_options: Configuration
Returns Promise<HttpInfo<MarketingEventDefaultResponse>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:175

complete

complete(externalEventId, externalAccountId, marketingEventCompleteRequestParams, _options?): Promise<MarketingEventDefaultResponse>
Mark a marketing event as completed Mark a marketing event as completed
Parameters
- externalEventId: string
  The id of the marketing event in the external event application.
- externalAccountId: string
  The accountId that is associated with this marketing event in the external event application.
- marketingEventCompleteRequestParams: MarketingEventCompleteRequestParams
- Optional_options: Configuration
Returns Promise<MarketingEventDefaultResponse>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:210

completeWithHttpInfo

completeWithHttpInfo(externalEventId, externalAccountId, marketingEventCompleteRequestParams, _options?): Promise<HttpInfo<MarketingEventDefaultResponse>>
Mark a marketing event as completed Mark a marketing event as completed
Parameters
- externalEventId: string
  The id of the marketing event in the external event application.
- externalAccountId: string
  The accountId that is associated with this marketing event in the external event application.
- marketingEventCompleteRequestParams: MarketingEventCompleteRequestParams
- Optional_options: Configuration
Returns Promise<HttpInfo<MarketingEventDefaultResponse>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:198

create

create(marketingEventCreateRequestParams, _options?): Promise<MarketingEventDefaultResponse>
Creates a new marketing event in HubSpot Create a marketing event
Parameters
- marketingEventCreateRequestParams: MarketingEventCreateRequestParams
- Optional_options: Configuration
Returns Promise<MarketingEventDefaultResponse>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:230

createWithHttpInfo

createWithHttpInfo(marketingEventCreateRequestParams, _options?): Promise<HttpInfo<MarketingEventDefaultResponse>>
Creates a new marketing event in HubSpot Create a marketing event
Parameters
- marketingEventCreateRequestParams: MarketingEventCreateRequestParams
- Optional_options: Configuration
Returns Promise<HttpInfo<MarketingEventDefaultResponse>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:220

doSearch

doSearch(q, _options?): Promise<CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging>
Search for marketing events that have an event id that starts with the query string Search for marketing events
Parameters
- q: string
  The id of the marketing event in the external event application
- Optional_options: Configuration
Returns Promise<CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:250

doSearchWithHttpInfo

doSearchWithHttpInfo(q, _options?): Promise<HttpInfo<CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging>>
Search for marketing events that have an event id that starts with the query string Search for marketing events
Parameters
- q: string
  The id of the marketing event in the external event application
- Optional_options: Configuration
Returns Promise<HttpInfo<CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:240

getDetails

getDetails(externalEventId, externalAccountId, _options?): Promise<MarketingEventPublicReadResponse>
Returns the details of the Marketing Event with the specified id, if one exists. Get a marketing event
Parameters
- externalEventId: string
  The id of the marketing event to return
- externalAccountId: string
  The account id associated with the marketing event
- Optional_options: Configuration
Returns Promise<MarketingEventPublicReadResponse>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:272

getDetailsWithHttpInfo

getDetailsWithHttpInfo(externalEventId, externalAccountId, _options?): Promise<HttpInfo<MarketingEventPublicReadResponse>>
Returns the details of the Marketing Event with the specified id, if one exists. Get a marketing event
Parameters
- externalEventId: string
  The id of the marketing event to return
- externalAccountId: string
  The account id associated with the marketing event
- Optional_options: Configuration
Returns Promise<HttpInfo<MarketingEventPublicReadResponse>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:261

update

update(externalEventId, externalAccountId, marketingEventUpdateRequestParams, _options?): Promise<MarketingEventPublicDefaultResponse>
Updates an existing Marketing Event with the specified id, if one exists. Update a marketing event
Parameters
- externalEventId: string
  The id of the marketing event to update
- externalAccountId: string
  The account id associated with the marketing event
- marketingEventUpdateRequestParams: MarketingEventUpdateRequestParams
- Optional_options: Configuration
Returns Promise<MarketingEventPublicDefaultResponse>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:296

updateWithHttpInfo

updateWithHttpInfo(externalEventId, externalAccountId, marketingEventUpdateRequestParams, _options?): Promise<HttpInfo<MarketingEventPublicDefaultResponse>>
Updates an existing Marketing Event with the specified id, if one exists. Update a marketing event
Parameters
- externalEventId: string
  The id of the marketing event to update
- externalAccountId: string
  The account id associated with the marketing event
- marketingEventUpdateRequestParams: MarketingEventUpdateRequestParams
- Optional_options: Configuration
Returns Promise<HttpInfo<MarketingEventPublicDefaultResponse>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:284

upsert

upsert(externalEventId, marketingEventCreateRequestParams, _options?): Promise<MarketingEventPublicDefaultResponse>
Upserts a marketing event If there is an existing marketing event with the specified ID, it will be updated; otherwise a new event will be created. Create or update a marketing event
Parameters
- externalEventId: string
  The ID of the marketing event to upsert
- marketingEventCreateRequestParams: MarketingEventCreateRequestParams
- Optional_options: Configuration
Returns Promise<MarketingEventPublicDefaultResponse>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:318

upsertWithHttpInfo

upsertWithHttpInfo(externalEventId, marketingEventCreateRequestParams, _options?): Promise<HttpInfo<MarketingEventPublicDefaultResponse>>
Upserts a marketing event If there is an existing marketing event with the specified ID, it will be updated; otherwise a new event will be created. Create or update a marketing event
Parameters
- externalEventId: string
  The ID of the marketing event to upsert
- marketingEventCreateRequestParams: MarketingEventCreateRequestParams
- Optional_options: Configuration
Returns Promise<HttpInfo<MarketingEventPublicDefaultResponse>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:307

Class BasicApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BasicApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

batchArchive

Parameters

Returns Promise<void>

batchArchiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

batchUpsert

Parameters

Returns Promise<BatchResponseMarketingEventPublicDefaultResponse>

batchUpsertWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseMarketingEventPublicDefaultResponse>>

cancel

Parameters

Returns Promise<MarketingEventDefaultResponse>

cancelWithHttpInfo

Parameters

Returns Promise<HttpInfo<MarketingEventDefaultResponse>>

complete

Parameters

Returns Promise<MarketingEventDefaultResponse>

completeWithHttpInfo

Parameters

Returns Promise<HttpInfo<MarketingEventDefaultResponse>>

create

Parameters

Returns Promise<MarketingEventDefaultResponse>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<MarketingEventDefaultResponse>>

doSearch

Parameters

Returns Promise<CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging>

doSearchWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging>>

getDetails

Parameters

Returns Promise<MarketingEventPublicReadResponse>

getDetailsWithHttpInfo

Parameters

Returns Promise<HttpInfo<MarketingEventPublicReadResponse>>

update

Parameters

Returns Promise<MarketingEventPublicDefaultResponse>

updateWithHttpInfo

Parameters

Returns Promise<HttpInfo<MarketingEventPublicDefaultResponse>>

upsert

Parameters

Returns Promise<MarketingEventPublicDefaultResponse>

upsertWithHttpInfo

Parameters

Returns Promise<HttpInfo<MarketingEventPublicDefaultResponse>>

Settings

On This Page