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

ApiTicketTransfer

Extends:

RequestHandler → ApiTicketTransfer

Ingresse Tickets Transfer API

Method Summary

Public Methods
public

Creates a ticket transfer.

public

Get the ticket transfer history.

public

updateTicketTransfer(id: number, transferId: number, data: object, query: object): Promise

Update a ticket transfer.

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 Methods

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

Creates a ticket transfer.

Params:

NameTypeAttributeDescription
id number

The ticket ID to get.

data object
  • optional

The form with transfer data for post.

query object
  • optional

Optional request parameters.

Return:

Promise

Example:

...

var ticketId = 123;
var data = {
     user: 456 //The user that will get the ticket
};

ingresse.apiTickets.createTicketTransfer(ticketId, data)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

...
 // To return the ticket for the last owner

var ticketId = 123;
var data = {
     isReturn: true //With this option, the ticket will return to last owner.
};

ingresse.apiTickets.createTicketTransfer(ticketId, data)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });

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

Get the ticket transfer history.

Params:

NameTypeAttributeDescription
id string | number

The ticket ID to get.

query object
  • optional

Optional request parameters.

Return:

Promise

public updateTicketTransfer(id: number, transferId: number, data: object, query: object): Promise source

Update a ticket transfer.

Params:

NameTypeAttributeDescription
id number

The ticket ID to get.

transferId number

The transfer ID to get.

data object
  • optional

The form with transfer data to post.

query object
  • optional

Optional request parameters.

Return:

Promise

Example:

...

var ticketId = 123;
var transferId = 456;
var data = {
     action: 'accept' // can be [accept, cancel, refuse]
};

ingresse.apiTickets.updateTicketTransfer(ticketId, transferId, data)
    .then(function (response) {
        console.log(response);
    })
    .catch(function (error) {
        console.log(error);
    });