Class Campaigns

Hierarchy

Campaigns

Index

Constructors

constructor

Properties

qualifications

Methods

Constructors

constructor

new Campaigns(client: RequestController): Campaigns

Parameters
- client: RequestController
Returns Campaigns

Properties

qualifications

qualifications: CampaignsQualifications

Methods

addCertainVoucher

addCertainVoucher(name: string, code: string, body?: CampaignsAddCertainVoucherParams): Promise<CampaignsAddVoucherResponse>

see

https://docs.voucherify.io/reference/add-voucher-with-certain-code-to-campaign

Parameters
- name: string
- code: string
- body: CampaignsAddCertainVoucherParams = {}
Returns Promise<CampaignsAddVoucherResponse>

addVoucher

addVoucher(name: string, body?: CampaignsAddVoucherBody, params?: CampaignsAddVoucherParams): Promise<{} | CampaignsAddVoucherResponse>

see

https://docs.voucherify.io/reference/add-voucher-to-campaign

Parameters
- name: string
- body: CampaignsAddVoucherBody = {}
- params: CampaignsAddVoucherParams = {}
Returns Promise<{} | CampaignsAddVoucherResponse>

create

create(campaign: CampaignsCreateCampaign): Promise<CampaignResponse>

see

https://docs.voucherify.io/reference/create-campaign

Parameters
- campaign: CampaignsCreateCampaign
Returns Promise<CampaignResponse>

delete

delete(name: string, params?: CampaignsDeleteParams): Promise<unknown>

see

https://docs.voucherify.io/reference/delete-campaign

Parameters
- name: string
- params: CampaignsDeleteParams = {}
Returns Promise<unknown>

disable

disable(campaignId: string): Promise<{}>

see

https://docs.voucherify.io/reference/disable-campaign

Parameters
- campaignId: string
Returns Promise<{}>

enable

enable(campaignId: string): Promise<{}>

see

https://docs.voucherify.io/reference/enable-campaign

Parameters
- campaignId: string
Returns Promise<{}>

get

get(name: string): Promise<CampaignResponse>

see

https://docs.voucherify.io/reference/get-campaign

Parameters
- name: string
Returns Promise<CampaignResponse>

importVouchers

importVouchers(campaignName: string, vouchers: CampaignsImportVouchers[]): Promise<CampaignsVouchersImportResponse>

see

https://docs.voucherify.io/reference/import-vouchers

Parameters
- campaignName: string
- vouchers: CampaignsImportVouchers[]
Returns Promise<CampaignsVouchersImportResponse>

importVouchersCSV

importVouchersCSV(campaignId: string, filePath: string): Promise<AsyncActionCreateResponse>

see

https://api.voucherify.io/v1/campaigns/{campaignId}/importCSV

Parameters
- campaignId: string
- filePath: string
Returns Promise<AsyncActionCreateResponse>

list

list(params?: CampaignsListParams): Promise<CampaignsListResponse>

see

https://docs.voucherify.io/reference/list-campaigns

Parameters
- params: CampaignsListParams = {}
Returns Promise<CampaignsListResponse>

update

update(nameOrId: string, campaign: CampaignsUpdateCampaign): Promise<CampaignResponse>

see

https://docs.voucherify.io/reference/update-campaign

Parameters
- nameOrId: string
- campaign: CampaignsUpdateCampaign
Returns Promise<CampaignResponse>