import {ApiEvents} from 'ingresse-sdk/src/apis/api.event.js'

public class | source

ApiEvents

Extends:

RequestHandler → ApiEvents

Ingresse Event API

Method Summary

Public Methods
public	getBorderoReport(eventId: number, query: object): Promise Get Event Bordero Report
public	getEntryReport(eventId: number, sessionId: number, query: object): Promise Get Event Entry Report
public	getEvent(id: string \| number, query: object): Promise Get event
public	getEventAttributes(id: string \| number, query: object): Promise Get event attributes
public	getEventCategories(category: string, query: object): Promise Get the search event categorie.
public	getEventCrew(id: string \| number, query: object): Promise Get event crew
public	getEventSessionTickets(id: string \| number, sessionId: string \| number, query: object): Promise Get event session tickets
public	getEventTickets(id: string \| number, query: object): Promise Get event tickets
public	getEventTypes(query: {}): * Deprecated
public	getFeatured(query: object): Promise Featured events
public	getHomeCover(query: object): Promise Home Cover
public	getHomeSections(query: object): Promise Get Home Sections
public	identifyEvent(link: string, fields: string, queryOpt: object): Promise Identify event
public	requestExportList(eventId: number, data: object, query: object): Promise Request export list processment.
public	requestPasskeysReport(eventId: number, data: object, query: object): Promise Request the passkeys report processment.

Inherited Summary

From class RequestHandler
public	auth: *
public	settings: *
public	delete(path: string, query: object, data: object, headers: object): Promise Delete resource
public	get(path: string, query: object, headers: object): Promise Get resource
public	post(path: string, data: object, query: object, headers: object): Promise Post resource
public	put(path: string, data: object, query: object, headers: object): Promise Put resource
public	request(options: object): Promise Create new request promise
public	setEnv(env: string) Set Environment
public	setUrl(url: string) Set API url
public	upload(path: string, formData: object, query: object, headers: object): Promise Upload files

Public Methods

public getBorderoReport(eventId: number, query: object): Promise source

Get Event Bordero Report

Params:

Name	Type	Attribute	Description
eventId	number		The event ID.
query	object	optional	Optional request parameters.

Return:

Promise

public getEntryReport(eventId: number, sessionId: number, query: object): Promise source

Get Event Entry Report

Params:

Name	Type	Attribute	Description
eventId	number		The event ID.
sessionId	number	optional	The event session ID to get.
query	object	optional	Optional request parameters.

Return:

Promise

public getEvent(id: string | number, query: object): Promise source

Get event

Params:

Name	Type	Attribute	Description
id	string \| number		The event ID to get.
query	object	optional	Optional request parameters.

Return:

Promise

public getEventAttributes(id: string | number, query: object): Promise source

Get event attributes

Params:

Name	Type	Attribute	Description
id	string \| number		The event ID to get.
query	object	optional	Optional request parameters.

Return:

Promise

public getEventCategories(category: string, query: object): Promise source

Get the search event categorie.

Params:

Name	Type	Attribute	Description
category	string		The search category to get.
query	object	optional	Optional request parameters.

Return:

Promise

public getEventCrew(id: string | number, query: object): Promise source

Get event crew

Params:

Name	Type	Attribute	Description
id	string \| number		The event ID to get.
query	object	optional	Optional request parameters.

Return:

Promise

public getEventSessionTickets(id: string | number, sessionId: string | number, query: object): Promise source

Get event session tickets

Params:

Name	Type	Attribute	Description
id	string \| number		The event ID to get.
sessionId	string \| number		The event session ID to get.
query	object	optional	Optional request parameters.

Return:

Promise

public getEventTickets(id: string | number, query: object): Promise source

Get event tickets

Params:

Name	Type	Attribute	Description
id	string \| number		The event ID to get.
query	object	optional	Optional request parameters.

Return:

Promise

public getEventTypes(query: {}): * source

Deprecated

Params:

Name	Type	Attribute	Description
query	{}	optional default: {}

Return:

public getFeatured(query: object): Promise source

Featured events

Params:

Name	Type	Attribute	Description
query	object	optional	Optional request parameters.

Return:

Promise

Example:


ENDPOINT: '/featured'

...

ingresse.ApiEvents.getFeatured({ method: 'banner', state: 'sp' })
.then(function (response) {
    console.log(response);
})
.catch(function (error) {
    console.log(error);
});

public getHomeCover(query: object): Promise source

Home Cover

Params:

Name	Type	Attribute	Description
query	object	optional	Optional request parameters.

Return:

Promise

Example:


ENDPOINT: '/home/cover'

...

ingresse.ApiEvents.getHomeCover()
.then(function (response) {
    console.log(response);
})
.catch(function (error) {
    console.log(error);
});

public getHomeSections(query: object): Promise source

Get Home Sections

Params:

Name	Type	Attribute	Description
query	object	optional	Optional request parameters.

Return:

Promise

Example:


ENDPOINT: '/home/sections'

...

ingresse.ApiEvents.getHomeSections()
.then(function (response) {
    console.log(response);
})
.catch(function (error) {
    console.log(error);
});

public identifyEvent(link: string, fields: string, queryOpt: object): Promise source

Identify event

Params:

Name	Type	Attribute	Description
link	string		Link/Slug or id.
fields	string		Event fields to get.
queryOpt	object	optional	Optional request parameters.

Return:

Promise

public requestExportList(eventId: number, data: object, query: object): Promise source

Request export list processment.

Will request to API generate an List and API will send an email to the user when the list is available, with the link to download file.

Params:

Name	Type	Attribute	Description
eventId	number		The event ID.
data	object		Report requisition details.
query	object	optional	Optional request parameters.
query.filters	array	optional
query.format	string	optional	'csv' or 'xlsx'. Default: 'csv'.
query.type	string	optional	'guestlist', 'passkey' or 'transactions'. Default: 'transactions'

Return:

Promise

Example:

...
const ing = new Sdk();

ing.api.requestExportList(21232, {
    "type":  "guestlist",
    "format": "xlsx",
    "filters": [
         {
             "name" : "channel",
             "value": "offline",
         },
         {
             "name" : "term",
             "value": "udi",
         }
     ]
})
.then((response) => {
    console.log(response);
})
.catch((error) => {
    console.log(error);
});

public requestPasskeysReport(eventId: number, data: object, query: object): Promise source

Request the passkeys report processment.

Will request to API generate the Passkeys Report and API will send an email to the user when the report is available, with the link to download file.

Params:

Name	Type	Attribute	Description
eventId	number		The event ID.
data	object		Report requisition details.
query	object	optional	Optional request parameters.

Return:

Promise

Example:

...
const ing = new Sdk();

ing.api.requestPasskeysReport(21232, {
    "type":  "passkey",
    "format": "xlsx",
    "filters": [{
        "status": "approved"
    }]
})
.then((response) => {
    console.log(response);
})
.catch((error) => {
    console.log(error);
});