Class ParticipantStateApi

Index

Constructors

Methods

getParticipationsBreakdownByContactId getParticipationsBreakdownByContactIdWithHttpInfo getParticipationsBreakdownByExternalEventId getParticipationsBreakdownByExternalEventIdWithHttpInfo getParticipationsBreakdownByMarketingEventId getParticipationsBreakdownByMarketingEventIdWithHttpInfo getParticipationsCountersByEventExternalId getParticipationsCountersByEventExternalIdWithHttpInfo getParticipationsCountersByMarketingEventId getParticipationsCountersByMarketingEventIdWithHttpInfo

Constructors

constructor

new ParticipantStateApi(configuration, requestFactory?, responseProcessor?): ParticipantStateApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: ParticipantStateApiRequestFactory
- OptionalresponseProcessor: ParticipantStateApiResponseProcessor
Returns ParticipantStateApi
- Defined in codegen/marketing/events/types/PromiseAPI.ts:334

Methods

getParticipationsBreakdownByContactId

getParticipationsBreakdownByContactId(contactIdentifier, state?, limit?, after?, _options?): Promise<CollectionResponseWithTotalParticipationBreakdownForwardPaging>
Read Contact's participations by identifier - email or internal id. Read participations breakdown by Contact identifier
Parameters
- contactIdentifier: string
  The identifier of the Contact. It may be email or internal id.
- Optionalstate: string
  The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW
- Optionallimit: number
  The limit for response size. The default value is 10, the max number is 100
- Optionalafter: string
  The cursor indicating the position of the last retrieved item.
- Optional_options: Configuration
Returns Promise<CollectionResponseWithTotalParticipationBreakdownForwardPaging>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:363

getParticipationsBreakdownByContactIdWithHttpInfo

getParticipationsBreakdownByContactIdWithHttpInfo(contactIdentifier, state?, limit?, after?, _options?): Promise<HttpInfo<CollectionResponseWithTotalParticipationBreakdownForwardPaging>>
Read Contact's participations by identifier - email or internal id. Read participations breakdown by Contact identifier
Parameters
- contactIdentifier: string
  The identifier of the Contact. It may be email or internal id.
- Optionalstate: string
  The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW
- Optionallimit: number
  The limit for response size. The default value is 10, the max number is 100
- Optionalafter: string
  The cursor indicating the position of the last retrieved item.
- Optional_options: Configuration
Returns Promise<HttpInfo<CollectionResponseWithTotalParticipationBreakdownForwardPaging>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:350

getParticipationsBreakdownByExternalEventId

getParticipationsBreakdownByExternalEventId(externalAccountId, externalEventId, contactIdentifier?, state?, limit?, after?, _options?): Promise<CollectionResponseWithTotalParticipationBreakdownForwardPaging>
Read Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair. Read participations breakdown by Marketing Event external identifier
Parameters
- externalAccountId: string
  The accountId that is associated with this marketing event in the external event application.
- externalEventId: string
  The id of the marketing event in the external event application.
- OptionalcontactIdentifier: string
  The identifier of the Contact. It may be email or internal id.
- Optionalstate: string
  The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW
- Optionallimit: number
  The limit for response size. The default value is 10, the max number is 100
- Optionalafter: string
  The cursor indicating the position of the last retrieved item.
- Optional_options: Configuration
Returns Promise<CollectionResponseWithTotalParticipationBreakdownForwardPaging>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:393

getParticipationsBreakdownByExternalEventIdWithHttpInfo

getParticipationsBreakdownByExternalEventIdWithHttpInfo(externalAccountId, externalEventId, contactIdentifier?, state?, limit?, after?, _options?): Promise<HttpInfo<CollectionResponseWithTotalParticipationBreakdownForwardPaging>>
Read Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair. Read participations breakdown by Marketing Event external identifier
Parameters
- externalAccountId: string
  The accountId that is associated with this marketing event in the external event application.
- externalEventId: string
  The id of the marketing event in the external event application.
- OptionalcontactIdentifier: string
  The identifier of the Contact. It may be email or internal id.
- Optionalstate: string
  The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW
- Optionallimit: number
  The limit for response size. The default value is 10, the max number is 100
- Optionalafter: string
  The cursor indicating the position of the last retrieved item.
- Optional_options: Configuration
Returns Promise<HttpInfo<CollectionResponseWithTotalParticipationBreakdownForwardPaging>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:378

getParticipationsBreakdownByMarketingEventId

getParticipationsBreakdownByMarketingEventId(marketingEventId, contactIdentifier?, state?, limit?, after?, _options?): Promise<CollectionResponseWithTotalParticipationBreakdownForwardPaging>
Read Marketing event's participations breakdown with optional filters by internal identifier marketingEventId. Read participations breakdown by Marketing Event internal identifier
Parameters
- marketingEventId: number
  The internal id of the marketing event in HubSpot.
- OptionalcontactIdentifier: string
  The identifier of the Contact. It may be email or internal id.
- Optionalstate: string
  The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW
- Optionallimit: number
  The limit for response size. The default value is 10, the max number is 100
- Optionalafter: string
  The cursor indicating the position of the last retrieved item.
- Optional_options: Configuration
Returns Promise<CollectionResponseWithTotalParticipationBreakdownForwardPaging>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:421

getParticipationsBreakdownByMarketingEventIdWithHttpInfo

getParticipationsBreakdownByMarketingEventIdWithHttpInfo(marketingEventId, contactIdentifier?, state?, limit?, after?, _options?): Promise<HttpInfo<CollectionResponseWithTotalParticipationBreakdownForwardPaging>>
Read Marketing event's participations breakdown with optional filters by internal identifier marketingEventId. Read participations breakdown by Marketing Event internal identifier
Parameters
- marketingEventId: number
  The internal id of the marketing event in HubSpot.
- OptionalcontactIdentifier: string
  The identifier of the Contact. It may be email or internal id.
- Optionalstate: string
  The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW
- Optionallimit: number
  The limit for response size. The default value is 10, the max number is 100
- Optionalafter: string
  The cursor indicating the position of the last retrieved item.
- Optional_options: Configuration
Returns Promise<HttpInfo<CollectionResponseWithTotalParticipationBreakdownForwardPaging>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:407

getParticipationsCountersByEventExternalId

getParticipationsCountersByEventExternalId(externalAccountId, externalEventId, _options?): Promise<AttendanceCounters>
Read Marketing event's participations counters by externalAccountId and externalEventId pair. Read participations counters by Marketing Event external identifier
Parameters
- externalAccountId: string
  The accountId that is associated with this marketing event in the external event application.
- externalEventId: string
  The id of the marketing event in the external event application.
- Optional_options: Configuration
Returns Promise<AttendanceCounters>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:443

getParticipationsCountersByEventExternalIdWithHttpInfo

getParticipationsCountersByEventExternalIdWithHttpInfo(externalAccountId, externalEventId, _options?): Promise<HttpInfo<AttendanceCounters>>
Read Marketing event's participations counters by externalAccountId and externalEventId pair. Read participations counters by Marketing Event external identifier
Parameters
- externalAccountId: string
  The accountId that is associated with this marketing event in the external event application.
- externalEventId: string
  The id of the marketing event in the external event application.
- Optional_options: Configuration
Returns Promise<HttpInfo<AttendanceCounters>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:432

getParticipationsCountersByMarketingEventId

getParticipationsCountersByMarketingEventId(marketingEventId, _options?): Promise<AttendanceCounters>
Read Marketing event's participations counters by internal identifier marketingEventId. Read participations counters by Marketing Event internal identifier
Parameters
- marketingEventId: number
  The internal id of the marketing event in HubSpot.
- Optional_options: Configuration
Returns Promise<AttendanceCounters>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:463

getParticipationsCountersByMarketingEventIdWithHttpInfo

getParticipationsCountersByMarketingEventIdWithHttpInfo(marketingEventId, _options?): Promise<HttpInfo<AttendanceCounters>>
Read Marketing event's participations counters by internal identifier marketingEventId. Read participations counters by Marketing Event internal identifier
Parameters
- marketingEventId: number
  The internal id of the marketing event in HubSpot.
- Optional_options: Configuration
Returns Promise<HttpInfo<AttendanceCounters>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:453

Class ParticipantStateApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ParticipantStateApi

Methods

getParticipationsBreakdownByContactId

Parameters

Returns Promise<CollectionResponseWithTotalParticipationBreakdownForwardPaging>

getParticipationsBreakdownByContactIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseWithTotalParticipationBreakdownForwardPaging>>

getParticipationsBreakdownByExternalEventId

Parameters

Returns Promise<CollectionResponseWithTotalParticipationBreakdownForwardPaging>

getParticipationsBreakdownByExternalEventIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseWithTotalParticipationBreakdownForwardPaging>>

getParticipationsBreakdownByMarketingEventId

Parameters

Returns Promise<CollectionResponseWithTotalParticipationBreakdownForwardPaging>

getParticipationsBreakdownByMarketingEventIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseWithTotalParticipationBreakdownForwardPaging>>

getParticipationsCountersByEventExternalId

Parameters

Returns Promise<AttendanceCounters>

getParticipationsCountersByEventExternalIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<AttendanceCounters>>

getParticipationsCountersByMarketingEventId

Parameters

Returns Promise<AttendanceCounters>

getParticipationsCountersByMarketingEventIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<AttendanceCounters>>

Settings

On This Page