import {RequestHandler} from 'ingresse-sdk/src/request/handler.js'

public class | source

RequestHandler

Direct Subclass:

ApiAuth, ApiEvents, ApiRecover, ApiTicketTransfer, ApiTransactions, ApiUser, Checkin, Coupon, Event, EventSearch, Ticket

Base request handler for all the API's with get, post, put and delete methods

Constructor Summary

Public Constructor
public	constructor(settings: object) Initialize request handler

Member Summary

Public Members
public	auth: *
public	settings: *

Method Summary

Public Methods
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(settings: object) source

Initialize request handler

Params:

Name	Type	Attribute	Description
settings	object		Settings

Public Members

public auth: * source

public settings: * source

Public Methods

public delete(path: string, query: object, data: object, headers: object): Promise source

Delete resource

Params:

Name	Type	Attribute	Description
path	string		Request delete to endpoint e.g. /api-path/1
query	object	optional	Optional request parameters.
data	object	optional	Data to be deleted.
headers	object	optional	Optional request headers.

Return:

Promise

public get(path: string, query: object, headers: object): Promise source

Get resource

Params:

Name	Type	Attribute	Description
path	string		Request get to endpoint e.g. /api-path/1
query	object	optional	Optional request parameters.
headers	object	optional	Optional request headers.

Return:

Promise

public post(path: string, data: object, query: object, headers: object): Promise source

Post resource

Params:

Name	Type	Attribute	Description
path	string		Request post to endpoint e.g. /api-path
data	object		Data to be posted.
query	object	optional	Optional request parameters.
headers	object	optional	Optional request headers.

Return:

Promise

public put(path: string, data: object, query: object, headers: object): Promise source

Put resource

Params:

Name	Type	Attribute	Description
path	string		Request put to end endpoint e.g. /api-path/1
data	object		Data to be updated.
query	object	optional	Optional request parameters.
headers	object	optional	Optional request headers.

Return:

Promise

public request(options: object): Promise source

Create new request promise

Params:

Name	Type	Attribute	Description
options	object		request options.

Return:

Promise

public setEnv(env: string) source

Set Environment

Params:

Name	Type	Attribute	Description
env	string		Environment Type: 'stg', 'hmla', 'hmlb', 'sandbox', 'integration';

Example:

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

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

// Can set an specific Environment to this API
api.setEnv('integration');

public setUrl(url: string) source

Set API url

Params:

Name	Type	Attribute	Description
url	string		Base URL, example: 'https://hml-api.ingresse.com'

Example:

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

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

// Can set an specific URL to this API
api.setUrl('https://hml-api.ingresse.com');

public upload(path: string, formData: object, query: object, headers: object): Promise source

Upload files

Params:

Name	Type	Attribute	Description
path	string		Request post to endpoint e.g. /api-path
formData	object		Data to be posted.
query	object	optional	Optional request parameters.
headers	object	optional	Optional request headers.

Return:

Promise