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

Coupon

Extends:

RequestHandler → Coupon

Ingresse Coupon API

Constructor Summary

Public Constructor
public

constructor(custom: object)

Coupon

Member Summary

Public Members
public

Method Summary

Public Methods
public

createCoupon(body: object, query: object): Promise

Create the coupon

public

Delete the coupon

public

getCoupon(id: string, query: object): Promise

Get a coupon

public

Get a list of coupon

public

updateCoupon(id: string, body: object, query: object): Promise

Update the coupon

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

Coupon

Override:

RequestHandler#constructor

Params:

NameTypeAttributeDescription
custom object
  • optional

Initialize Coupon settings.

Public Members

public settings: * source

Override:

RequestHandler#settings

Public Methods

public createCoupon(body: object, query: object): Promise source

Create the coupon

Params:

NameTypeAttributeDescription
body object

Coupon data.

query object
  • optional

Optional request parameters.

Return:

Promise

public deleteCoupon(id: string, query: object): Promise source

Delete the coupon

Params:

NameTypeAttributeDescription
id string

Transaction ID.

query object
  • optional

Optional request parameters.

Return:

Promise

public getCoupon(id: string, query: object): Promise source

Get a coupon

Params:

NameTypeAttributeDescription
id string

Coupon ID.

query object
  • optional

Optional request parameters.

Return:

Promise

public getCoupons(query: object): Promise source

Get a list of coupon

Params:

NameTypeAttributeDescription
query object
  • optional

Optional request parameters.

Return:

Promise

public updateCoupon(id: string, body: object, query: object): Promise source

Update the coupon

Params:

NameTypeAttributeDescription
id string

Transaction ID.

body object

Coupon data.

query object
  • optional

Optional request parameters.

Return:

Promise