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

public class | source

EventSearch

Extends:

RequestHandler → EventSearch

Ingresse Event's Search API

API to search for events.

Example:

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

// You will have access to this API
// after instantiate the SDK.
var search = ingresse.eventSearch;

Constructor Summary

Public Constructor
public	constructor(custom: object) Event Search

Member Summary

Public Members
public	settings: *

Method Summary

Public Methods
public	search(query: object, companyId: number): Promise Search Events in a Company
public	searchByTerm(term: string, query: object, companyId: number): Promise Search Events by Term

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 Search

Override:

RequestHandler#constructor

Params:

Name	Type	Attribute	Description
custom	object	optional	Initialize Event Search settings.

Public Members

public settings: * source

Override:

RequestHandler#settings

Public Methods

public search(query: object, companyId: number): Promise source

Search Events in a Company

Params:

Name	Type	Attribute	Description
query	object	optional	Optional request parameters.
companyId	number		The Company ID to search events.

Return:

Promise

Example:


ingresse.eventSearch.search({
    from    : 'now-6h',
    to      : 'now+1d',              // Only get events in a day range
    state   : 'rj',
    orderBy : 'sessions.dateTime',
    category: 'festas-e-baladas',
    offset  : 21,
})
.then(function (response) {
    console.log(response);
})
.catch(function (error) {
    console.log(error);
});

public searchByTerm(term: string, query: object, companyId: number): Promise source

Search Events by Term

Params:

Name	Type	Attribute	Description
term	string
query	object	optional	Optional request parameters.
companyId	number		The Company ID to search events.

Return:

Promise

Example:


ingresse.eventSearch.searchByTerm('Event Name', {
    size   : 20,
    from   : 'now-6h',
    orderBy: 'sessions.dateTime',
})
.then(function (response) {
    console.log(response);
})
.catch(function (error) {
    console.log(error);
});