Home Reference Source Repository 
import {Ticket} from 'ingresse-sdk/src/apis/ticket.js'
public class | source

Ticket

Extends:

RequestHandler → Ticket

Ingresse Ticket's API

API to get, create, update or remove tickets.

Example:

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

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

Constructor Summary

Public Constructor
public

constructor(custom: object)

Ticket Api

Member Summary

Public Members
public

Method Summary

Public Methods
public

Associate a passkey to items
public

batchPasskeys(eventId: number, data: object, query: Object): Promise

Create many passkeys and associate it for many tickets.
public

Create a new passkey
public

deleteExternal(eventId: number, query: object): Promise

Delete External Item
public

deleteExternalCode(itemId: number, codeId: number | string, query: object): Promise

Delete External Item Code
public

deletePasskey(id: number, data: object, query: Object): Promise

Delete a passkey
public

Get External Item Codes
public

getItem(id: string | number, query: object): Promise

Get item by ID
public

Get a list of ticket items This method will return a Promise so you can use .then and .catch methdos.
public

Get the ticket passkeys by id.
public

Get the ticket passkeys list.
public

getTax(query: Object): Promise

Get the tax calculated
public

Get a list of triggers This method will return a Promise so you can use .then and .catch methods.
public

Get a list of ticket types This method will return a Promise so you can use .then and .catch methods.
public

newAttribute(id: number, attribute: object, query: object): *

Create new ticket attribute
public

newItem(data: object, query: object): Promise

Create new Ticket item
public

newSalePeriod(id: number, salePeriod: object, query: object): *

Create new sale period to ticket
public

newValues(id: number, values: object, query: object): *

Create new values to ticket
public

Remove a ticket item
public

updateAttribute(id: number, attribute: object, query: object): *

Updated ticket attribute
public

updateItem(id: string | number, data: object, query: object): Promise

Update a ticket item
public

updatePasskey(id: string | number, data: object, query: Object): Promise

Update a passkey
public

updateSalePeriod(id: number, salePeriod: object, query: object): *

Updated ticket sale period
public

updateValues(id: number, values: object, query: object): *

Updated ticket values
public

uploadExternals(eventId: number, formData: object, query: object): Promise

Upload External Codes via CSV file

Inherited Summary

From class RequestHandler
public

auth: *

public
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

Ticket Api

Override:

RequestHandler#constructor

Params:

NameTypeAttributeDescription
custom object
  • optional
  • default: {}

Initialize Ticket Api settings.

Public Members

public settings: * source

Override:

RequestHandler#settings

Public Methods

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

Associate a passkey to items

Params:

NameTypeAttributeDescription
id string | number

The passkey id to update.
data object

Data to be updated.
data.itemIds array

An array with tickets id.
query Object
  • optional

The request parameters.

Return:

Promise

Example:

...

ingresse.ticket.associatePasskey(820, { itemIds: [ 1, 2, 3] })
.then(function (response) {
   console.log(response);
})
.catch(function (error) {
  console.log(error);
});

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

Create many passkeys and associate it for many tickets.

Params:

NameTypeAttributeDescription
eventId number

The event id.
data object

Data with passkeys details.
data.codes array[string]

Array with passkeys strings.
data.itemIds array[integer]
  • optional

Array with tickets id.
data.start date
  • optional

The date that this passkey will works (can not be lower than current day).
data.finish date
  • optional

The data that this passkey will stop works.
data.limit integer
  • optional

The usage limit.
query Object
  • optional

The request parameters.

Return:

Promise

Example:

...

ingresse.ticket.batchPasskeys(200, {
   "codes"  : ["passkey1", "passkey2", "passkey3"],
   "itemIds": [1,2,3],
   "limit"  : 100,
   "start"  : "2018-10-31 12:00:00",
   "finish" : "2019-11-10 20:20:00"
})
.then(function (response) {
   console.log(response);
})
.catch(function (error) {
  console.log(error);
});

public createPasskey(data: object, query: Object): Promise source

Create a new passkey

Params:

NameTypeAttributeDescription
data object

Data to create a new passkey.
data.eventId number

The event id.
data.passkey string

The passkey.
data.start date
  • optional

The date that this passkey will works.
data.finish date
  • optional

The data that this passkey will stop works.
query Object
  • optional

The request parameters.

Return:

Promise

Example:

...

ingresse.ticket.createPasskey({
   "eventId": 26899,
   "passkey": "passkey",
   "start"  : "2018-10-31 12:00:00",
   "finish" : "2019-11-10 20:20:00"
})
.then(function (response) {
   console.log(response);
})
.catch(function (error) {
   console.log(error);
});

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

Delete External Item

Params:

NameTypeAttributeDescription
eventId number
query object
  • optional

Return:

Promise

Example:

....

ingresse.ticket.deleteExternal(21232, { name: 'My Ticket Name' })
.then(function (response) {
    console.log(response);
})
.catch(function (error) {
   console.log(error);
});

public deleteExternalCode(itemId: number, codeId: number | string, query: object): Promise source

Delete External Item Code

Params:

NameTypeAttributeDescription
itemId number
codeId number | string
query object
  • optional

Return:

Promise

Example:

....

ingresse.ticket.deleteExternalCode(123456, 987654321)
.then(function (response) {
    console.log(response);
})
.catch(function (error) {
   console.log(error);
});

public deletePasskey(id: number, data: object, query: Object): Promise source

Delete a passkey

Params:

NameTypeAttributeDescription
id number

The passkey id.
data object
  • optional

Data to delete passkey.
query Object
  • optional

The request parameters.

Return:

Promise

Example:

...

ingresse.ticket.deletePasskey(123)
.then(function (response) {
   console.log(response);
})
.catch(function (error) {
   console.log(error);
});

public getExternalCodes(itemId: number, query: object): Promise source

Get External Item Codes

Params:

NameTypeAttributeDescription
itemId number
query object
  • optional

Return:

Promise

Example:

....

ingresse.ticket.getExternalCodes(456789)
.then(function (response) {
    console.log(response);
})
.catch(function (error) {
   console.log(error);
});

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

Get item by ID

Params:

NameTypeAttributeDescription
id string | number

The item ID to get.
query object
  • optional

Optional request parameters.

Return:

Promise

Example:

...

ingresse.ticket.getItem(200)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public getItems(query: object): Promise source

Get a list of ticket items This method will return a Promise so you can use .then and .catch methdos.

Params:

NameTypeAttributeDescription
query object
  • optional

Optional request parameters.

Return:

Promise

Example:

...

ingresse.ticket.getItems()
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public getPasskeyById(id: number, query: Object): Promise source

Get the ticket passkeys by id.

Params:

NameTypeAttributeDescription
id number

The passkey id.
query Object
  • optional

The request parameters.

Return:

Promise

Example:

...

ingresse.ticket.getPasskeyById(id, query)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public getPasskeys(query: Object): Promise source

Get the ticket passkeys list.

Params:

NameTypeAttributeDescription
query Object

The request parameters.
query.eventId Number

The event id.

Return:

Promise

Example:

...

var query = {
 eventId: 123, // must be informed one eventId.
};

ingresse.ticket.getPasskeys(query)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public getTax(query: Object): Promise source

Get the tax calculated

Params:

NameTypeAttributeDescription
query Object

The request parameters.
query.producerId Number
  • optional

The producer id.
query.eventId Number
  • optional

The event id.
query.price Number
  • optional

The ticket's price in cents.
query.taxDistribution Number
  • optional

The tax payed by customer (in percent).
query.tax Number
  • optional

The custom tax in cents.

Return:

Promise

Example:

...

var query = {
 eventId: 123, // must be informed one eventId or producerId.
 taxDistribution: 50
};

ingresse.ticket.getTax(query)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

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

Get a list of triggers This method will return a Promise so you can use .then and .catch methods.

Params:

NameTypeAttributeDescription
id number

The item ID to get the triggers.
query object
  • optional

Optional request parameters.

Return:

Promise

Example:

...

ingresse.ticket.getTriggers(10000040)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public getTypes(query: object): Promise source

Get a list of ticket types This method will return a Promise so you can use .then and .catch methods.

Params:

NameTypeAttributeDescription
query object
  • optional

Optional request parameters.

Return:

Promise

Example:

...

ingresse.ticket.getTypes()
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public newAttribute(id: number, attribute: object, query: object): * source

Create new ticket attribute

Params:

NameTypeAttributeDescription
id number

The item ID to create attribute.
attribute object

The attribute data.
query object
  • optional

Optional request parameters.

Return:

*

Promise

Example:

...

ingresse.ticket.newAttribute(200, { key: 'min', value: '1', type: 'integer' })
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

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

Create new Ticket item

Params:

NameTypeAttributeDescription
data object

Data to create a new ticket item.
query object
  • optional

Optional request parameters.

Return:

Promise

Example:

...

ingresse.ticket.newItem({ name: 'My Ticket Name' })
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public newSalePeriod(id: number, salePeriod: object, query: object): * source

Create new sale period to ticket

Params:

NameTypeAttributeDescription
id number

The item ID to create sale period.
salePeriod object

The sale period data.
query object
  • optional

Optional request parameters.

Return:

*

Promise

Example:

...

ingresse.ticket.newSalePeriod({
         appCategoryId: 1,
         start: '2016-10-10 20:20:00',
         finish: '2016-11-10 20:20:00',
         available: 1
     })
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public newValues(id: number, values: object, query: object): * source

Create new values to ticket

Params:

NameTypeAttributeDescription
id number

The item ID to create values.
values object

The values data.
query object
  • optional

Optional request parameters.

Return:

*

Promise

Example:

...

ingresse.ticket.newValues({
         price: 10000,
         feeSale: 500,
         feeProducer: 500
     })
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

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

Remove a ticket item

Params:

NameTypeAttributeDescription
id string | number

The item ID to remove.
query object
  • optional

Optional request parameters.

Return:

Promise

Example:

...

ingresse.ticket.removeItem(200)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public updateAttribute(id: number, attribute: object, query: object): * source

Updated ticket attribute

Params:

NameTypeAttributeDescription
id number

The item ID to update attribute.
attribute object

The attribute data.
query object
  • optional

Optional request parameters.

Return:

*

Promise

Example:

...

ingresse.ticket.updateAttribute(200, { key: 'minimum', value: 5, type: 'integer' })
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

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

Update a ticket item

Params:

NameTypeAttributeDescription
id string | number

The item ID to update.
data object

Data to update item.
query object
  • optional

Optional request parameters.

Return:

Promise

Example:

...

ingresse.ticket.updateItem(200, { name: 'My Updated Ticket Name' })
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

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

Update a passkey

Params:

NameTypeAttributeDescription
id string | number

The passkey id to update.
data object

Data to update a passkey.
data.eventId number

The event id.
data.passkey string

The passkey.
data.start date
  • optional

The date that this passkey will works (can not be lower than current day).
data.finish date
  • optional

The data that this passkey will stop works.
query Object
  • optional

The request parameters.

Return:

Promise

Example:

...

ingresse.ticket.updatePasskey(200, {
   "eventId": 26899,
   "passkey": "passkey",
   "start"  : "2018-10-31 12:00:00",
   "finish" : "2019-11-10 20:20:00"
})
.then(function (response) {
   console.log(response);
})
.catch(function (error) {
  console.log(error);
});

public updateSalePeriod(id: number, salePeriod: object, query: object): * source

Updated ticket sale period

Params:

NameTypeAttributeDescription
id number

The item ID to update the sale period.
salePeriod object

The salePeriod data.
query object
  • optional

Optional request parameters.

Return:

*

Promise

Example:

...

ingresse.ticket.updateSalePeriod(200, {
         appCategoryId: 1,
         start: '2016-11-20 10:10:00',
         finish: '2016-12-20 10:10:00',
         available: 1
     })
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public updateValues(id: number, values: object, query: object): * source

Updated ticket values

Params:

NameTypeAttributeDescription
id number

The item ID to update values.
values object

The values data.
query object
  • optional

Optional request parameters.

Return:

*

Promise

Example:

...

ingresse.ticket.updateValues(200, {
         price: 20000,
         feeSale: 1000,
         feeProducer: 1000
     })
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

public uploadExternals(eventId: number, formData: object, query: object): Promise source

Upload External Codes via CSV file

Params:

NameTypeAttributeDescription
eventId number
formData object
formData.file file
query object
  • optional

Return:

Promise

Example:

....

var uploadData = new FormData();

uploadData.append('file', document.getElementById('input-file-id').value);

ingresse.ticket.uploadExternals(21232, uploadData)
.then(function (response) {
    console.log(response);
})
.catch(function (error) {
   console.log(error);
});