Class TrackingEvents

Index

Methods

As Create Delete Get List Patch Save

Methods

As

As(): this
Returns this
Description
enables impersonation by calling the subsequent method with the stored impersonation token
Example
```
TrackingEvents.As().List() // lists TrackingEvents using the impersonated users' token
```
- Defined in api/TrackingEvents.ts:168

Create

Create<TTrackingEvent extends TrackingEvent>(
trackingEvent: TrackingEvent,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TTrackingEvent>>
Create a tracking event Check out the docs for more info
Type Parameters
- TTrackingEvent extends TrackingEvent
Parameters
- trackingEvent: TrackingEvent
  Required fields: EventType, ClientID, Name, DeliveryConfigID
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TTrackingEvent>>
- Defined in api/TrackingEvents.ts:63

Delete

Delete(eventID: string, requestOptions?: RequestOptions): Promise<void>
Delete a tracking event Check out the docs for more info
Parameters
- eventID: string
  ID of the event.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<void>
- Defined in api/TrackingEvents.ts:127

Get

Get<TTrackingEvent extends TrackingEvent>(
eventID: string,
requestOptions?: RequestOptions,
): Promise<RequiredDeep<TTrackingEvent>>
Retrieve a tracking event Check out the docs for more info
Type Parameters
- TTrackingEvent extends TrackingEvent
Parameters
- eventID: string
  ID of the event.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TTrackingEvent>>
- Defined in api/TrackingEvents.ts:84

List

List<TTrackingEvent extends TrackingEvent>(
    listOptions?: {
        filters?: Filters;
        page?: number;
        pageSize?: number;
        search?: string;
        searchOn?: ("ID" | "EventType")[];
        sortBy?: ("ID" | "EventType" | "!ID" | "!EventType")[];
    },
    requestOptions?: RequestOptions,
): Promise<RequiredObjectDeep<ListPage<TTrackingEvent>>>
List tracking events Check out the docs for more info
Type Parameters
- TTrackingEvent extends TrackingEvent
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "EventType")[];
      sortBy?: ("ID" | "EventType" | "!ID" | "!EventType")[];
  } = {}
  - Optionalfilters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optionalpage?: number
    
    Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - OptionalpageSize?: number
    
    Number of results to return per page.
  - Optionalsearch?: string
    
    Word or phrase to search for.
  - OptionalsearchOn?: ("ID" | "EventType")[]
    
    Comma-delimited list of fields to search on.
  - OptionalsortBy?: ("ID" | "EventType" | "!ID" | "!EventType")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredObjectDeep<ListPage<TTrackingEvent>>>
- Defined in api/TrackingEvents.ts:42

Patch

Patch<TTrackingEvent extends TrackingEvent>(
    eventID: string,
    trackingEvent: PartialDeep<TrackingEvent>,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TTrackingEvent>>
Partially update a tracking event Check out the docs for more info
Type Parameters
- TTrackingEvent extends TrackingEvent
Parameters
- eventID: string
  ID of the event.
- trackingEvent: PartialDeep<TrackingEvent>
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TTrackingEvent>>
- Defined in api/TrackingEvents.ts:149

Save

Save<TTrackingEvent extends TrackingEvent>(
    eventID: string,
    trackingEvent: TrackingEvent,
    requestOptions?: RequestOptions,
): Promise<RequiredDeep<TTrackingEvent>>
Create or update a tracking event If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TTrackingEvent extends TrackingEvent
Parameters
- eventID: string
  ID of the event.
- trackingEvent: TrackingEvent
  Required fields: EventType, ClientID, Name, DeliveryConfigID
- requestOptions: RequestOptions = {}
  - OptionalaccessToken?: string
    
    Alternative token to the one stored in the sdk instance (useful for impersonation).
  - OptionalcancelToken?: CancelToken
    
    Axios cancelToken that can be used to cancel the request.
  - OptionalrequestType?: string
    
    Identify the type of request. Useful for error logs.
Returns Promise<RequiredDeep<TTrackingEvent>>
- Defined in api/TrackingEvents.ts:106

Class TrackingEvents

Index

Methods

Methods

As

Returns this

Description

Example

Create

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TTrackingEvent>>

Delete

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<void>

Get

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TTrackingEvent>>

List

Type Parameters

Parameters

Optionalfilters?: Filters

Optionalpage?: number

OptionalpageSize?: number

Optionalsearch?: string

OptionalsearchOn?: ("ID" | "EventType")[]

OptionalsortBy?: ("ID" | "EventType" | "!ID" | "!EventType")[]

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredObjectDeep<ListPage<TTrackingEvent>>>

Patch

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TTrackingEvent>>

Save

Type Parameters

Parameters

OptionalaccessToken?: string

OptionalcancelToken?: CancelToken

OptionalrequestType?: string

Returns Promise<RequiredDeep<TTrackingEvent>>

Settings

On This Page

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`filters?: Filters

`Optional`page?: number

`Optional`pageSize?: number

`Optional`search?: string

`Optional`searchOn?: ("ID" | "EventType")[]

`Optional`sortBy?: ("ID" | "EventType" | "!ID" | "!EventType")[]

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string

`Optional`accessToken?: string

`Optional`cancelToken?: CancelToken

`Optional`requestType?: string