Promotions | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Promotions

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Promotions(options: PromotionsOptions, http: Client): Promotions

Overrides ThBaseHandler.constructor
- Defined in src/v0/promotions.ts:45
Parameters
- options: PromotionsOptions
- http: Client
Returns Promotions

Properties

endpoint

endpoint: string

http

http: Client

options

options: PromotionsOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/promotions'

Methods

create

create(promotion: Promotion): Promise<PromotionResponse>

- Defined in src/v0/promotions.ts:117
Parameters
- promotion: Promotion
Returns Promise<PromotionResponse>

delete

delete(promotionId: string): Promise<PromotionResponse>

- Defined in src/v0/promotions.ts:131
Parameters
- promotionId: string
Returns Promise<PromotionResponse>

get

get(promotionId: string): Promise<PromotionResponse>

- Defined in src/v0/promotions.ts:86
Parameters
- promotionId: string
Returns Promise<PromotionResponse>

getAll

getAll(queryOrOptions?: PromotionsQuery): Promise<PromotionsResponse>

- Defined in src/v0/promotions.ts:60
Parameters
- Optional queryOrOptions: PromotionsQuery
Returns Promise<PromotionsResponse>

put

put(promotionId: string, promotion: Promotion): Promise<PromotionResponse>

- Defined in src/v0/promotions.ts:103
Parameters
- promotionId: string
- promotion: Promotion
Returns Promise<PromotionResponse>

Generated using TypeDoc