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

public class | source

Event

Extends:

RequestHandler → Event

Ingresse Event's API

API to get, create and update events.

Example:

var sdk = require('ingresse-sdk');
var ingresse = new Sdk();

// You will have access to this API
// after instantiate the Sdk.
var event = ingresse.event;

Constructor Summary

Public Constructor
public	constructor(custom: object) Event Api

Member Summary

Public Members
public	settings: *

Method Summary

Public Methods
public	addAdmins(eventId: string \| number, data: object, query: object): Promise
public	create(data: object, query: object): Promise Create new Event
public	deleteAdmin(eventId: string \| number, userId: string \| number, query: object): Promise
public	deleteCategory(eventId: string \| number, categoryId: string \| number, query: object): Promise Remove Category from specific Event
public	deletePermission(eventId: string \| number, data: object, query: object): Promise Remove permission on the event of only unique user
public	deletePoster(id: string \| number, query: object): Promise Delete Event Poster
public	deleteSession(eventId: string \| number, sessionId: string \| number, query: object): Promise Remove an Event Session
public	getAttributes(id: number, query: object): Promise Get event attributes
public	getById(id: number, query: object): Promise Get event by ID
public	getCategories(query: object): Promise Get all Events Categories
public	getCategory(id: string \| number, query: object): Promise Get Event Category by ID
public	getPrivateCategories(query: object): Promise Get all Private Events Categories
public	searchByProducer(query: object): Promise Get events by producer, based on JWT
public	staffAdd(eventId: number, userId: number, role: string, data: object, query: object): Promise Add user to the event staff
public	staffRemove(eventId: number, userId: number, role: string, query: object): Promise Remove user of event staff
public	update(id: string \| number, data: object, query: object): Promise Update an Event
public	updateAttributes(id: string \| number, data: object, query: object): Promise Update Event Attributes
public	updatePermission(eventId: string \| number, data: object, query: object): Promise Update/Add users permission to the event
public	updatePoster(id: string \| number, data: object, query: object): Promise Update an Event Poster
public	validateSlug(term: string, query: object): Promise Validate if slug is available to use in an Event.

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 Constructors

public constructor(custom: object) source

Event Api

Override:

RequestHandler#constructor

Params:

Name	Type	Attribute	Description
custom	object	optional default: {}	Initialize Event Api settings.

Public Members

public settings: * source

Override:

RequestHandler#settings

Public Methods

public addAdmins(eventId: string | number, data: object, query: object): Promise source

Params:

Name	Type	Attribute	Description
eventId	string \| number		The Event ID.
data	object		Object with attribute `usersPermission` as Array with Users IDs to attribute Permission.
query	object	optional	Request parameters/filters.

Return:

Promise

Example:

...
var data = { admins: [ 321, 123, 654 ] };

ingresse.event.addAdmins(21232, data)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public create(data: object, query: object): Promise source

Create new Event

Params:

Name	Type	Attribute	Description
data	object		Data to create a new event.
query	object	optional	Optional request parameters.

Return:

Promise

Example:

...

ingresse.event.create({ name: 'My Event Name' })
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public deleteAdmin(eventId: string | number, userId: string | number, query: object): Promise source

Params:

Name	Type	Attribute	Description
eventId	string \| number		The Event ID.
userId	string \| number		The User ID.
query	object	optional	Request parameters/filters.

Return:

Promise

Example:

...

ingresse.event.deleteAdmin(21232, 654)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public deleteCategory(eventId: string | number, categoryId: string | number, query: object): Promise source

Remove Category from specific Event

Params:

Name	Type	Attribute	Description
eventId	string \| number		The Event ID to remove category.
categoryId	string \| number		The Category ID to remove.
query	object	optional	Optional request parameters.

Return:

Promise

Example:

...

ingresse.event.deleteCategory(123, 321)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public deletePermission(eventId: string | number, data: object, query: object): Promise source

Remove permission on the event of only unique user

Params:

Name	Type	Attribute	Description
eventId	string \| number		The Event ID.
data	object		Object with attribute `usersPermission` as Array with Users IDs to delete Permission.
query	object	optional	Request parameters/filters.

Return:

Promise

Example:

...
var data = { usersPermission: [ 321 ] };

ingresse.event.deletePermission(21232, data)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

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

Delete Event Poster

Params:

Name	Type	Attribute	Description
id	string \| number		The Event ID to delete poster.
query	object	optional	Optional request parameters.

Return:

Promise

Example:

...

ingresse.event.deletePoster(12)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public deleteSession(eventId: string | number, sessionId: string | number, query: object): Promise source

Remove an Event Session

Params:

Name	Type	Attribute	Description
eventId	string \| number		The Event ID to remove session.
sessionId	string \| number		The Session ID to remove.
query	object	optional	Optional request parameters.

Return:

Promise

Example:

...

ingresse.event.deleteSession(123, 321)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public getAttributes(id: number, query: object): Promise source

Get event attributes

Params:

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

Return:

Promise

Example:

...

ingresse.event.getAttributes(20866)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public getById(id: number, query: object): Promise source

Get event by ID

Params:

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

Return:

Promise

Example:

...

ingresse.event.getById(200)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public getCategories(query: object): Promise source

Get all Events Categories

This method will return a Promise so you can use .then and .catch methods.

Params:

Name	Type	Attribute	Description
query	object	optional	Optional request parameters.

Return:

Promise

Example:

...

ingresse.event.getCategories()
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

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

Get Event Category by ID

Params:

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

Return:

Promise

Example:

...

ingresse.event.getCategory(12)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public getPrivateCategories(query: object): Promise source

Get all Private Events Categories

This method will return a Promise so you can use .then and .catch methods.

Params:

Name	Type	Attribute	Description
query	object	optional	Optional request parameters.

Return:

Promise

Example:

...

ingresse.event.getPrivateCategories()
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public searchByProducer(query: object): Promise source

Get events by producer, based on JWT

Params:

Name	Type	Attribute	Description
query	object	optional	Request parameters/filters.

Return:

Promise

Example:

...

ingresse.event.searchByProducer({ from: 'now-1d' })
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public staffAdd(eventId: number, userId: number, role: string, data: object, query: object): Promise source

Add user to the event staff

Params:

Name	Type	Attribute	Description
eventId	number		The Event ID.
userId	number		User ID
role	string		Role in Event: 'admin' or 'producer'...
data	object	optional	Request body.
query	object	optional	Request parameters/filters.

Return:

Promise

Example:

...

ingresse.event.staffAdd(21232, 123, 'producer')
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public staffRemove(eventId: number, userId: number, role: string, query: object): Promise source

Remove user of event staff

Params:

Name	Type	Attribute	Description
eventId	number		The Event ID.
userId	number		User ID
role	string		Role in Event: 'admin' or 'producer'...
query	object	optional	Request parameters/filters.

Return:

Promise

Example:

...

ingresse.event.staffRemove(21232, 123, 'producer')
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

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

Update an Event

Params:

Name	Type	Attribute	Description
id	string \| number		The Event ID to update.
data	object		Data to update Event.
query	object	optional	Optional request parameters.

Return:

Promise

Example:

...

ingresse.event.update(200, { name: 'My Updated Event Name' })
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

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

Update Event Attributes

Params:

Name	Type	Attribute	Description
id	string \| number		The Event ID to update.
data	object		Data to update event attributes.
query	object	optional	Optional request parameters.

Return:

Promise

Example:

...

ingresse.event.updateAttributes(12, {
         attributes: [
             {
                 name : 'video_url',
                 value: 'https://www.youtube.com/watch?v=hRGnjgBOHIk',
             }
         ]
    })
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public updatePermission(eventId: string | number, data: object, query: object): Promise source

Update/Add users permission to the event

Params:

Name	Type	Attribute	Description
eventId	string \| number		The Event ID.
data	object		Object with attribute `usersPermission` as Array with Users IDs to attribute Permission.
query	object	optional	Request parameters/filters.

Return:

Promise

Example:

...
var data = { usersPermission: [ 321 ] };

ingresse.event.updatePermission(21232, data)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

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

Update an Event Poster

Params:

Name	Type	Attribute	Description
id	string \| number		The Event ID to update.
data	object		Data to update event poster.
query	object	optional	Optional request parameters.

Return:

Promise

Example:

...

ingresse.event.updatePoster(12, {
         poster: {
             format: 'base64',
             image : 'data:image/jpeg;base64 8aAVdagg87h87t8q...',
         }
    })
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public validateSlug(term: string, query: object): Promise source

Validate if slug is available to use in an Event.

This method will return a Promise so you can use .then and .catch methods.

Params:

Name	Type	Attribute	Description
term	string		The slug term to check.
query	object	optional	Optional request parameters.

Return:

Promise

Example:

...

ingresse.event.validateSlug('my-event-slug')
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });