| Requires the role: | superadmin |
| POST | /superadmin/incentives | Add a new incentive |
|---|
"use strict";
/** @typedef {number} */
export var IncentiveActionType;
(function (IncentiveActionType) {
IncentiveActionType[IncentiveActionType["Upgrade"] = 1] = "Upgrade"
IncentiveActionType[IncentiveActionType["AddOn"] = 2] = "AddOn"
IncentiveActionType[IncentiveActionType["Information"] = 3] = "Information"
})(IncentiveActionType || (IncentiveActionType = {}));
export class LicenseItemsResponse {
/** @param {{Id?:number,Name?:string,AllowedItems?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Name;
/** @type {number} */
AllowedItems;
}
export class BaseModel {
constructor(init) { Object.assign(this, init) }
}
export class Currency extends BaseModel {
/** @param {{Name?:string,CurrencySign?:string,Active?:boolean,ModifiedDate?:string,Id?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
CurrencySign;
/** @type {boolean} */
Active;
/** @type {?string} */
ModifiedDate;
/** @type {string} */
Id;
}
export class Country extends BaseModel {
/** @param {{CurrencyId?:string,CurrencyInfo?:Currency,Name?:string,Culture?:string,TimeZone?:string,ModifiedDate?:string,Id?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
CurrencyId;
/** @type {Currency} */
CurrencyInfo;
/** @type {string} */
Name;
/** @type {string} */
Culture;
/** @type {string} */
TimeZone;
/** @type {?string} */
ModifiedDate;
/** @type {string} */
Id;
}
export class LicensePriceResponse {
/** @param {{LicenseTypeId?:number,CountryId?:string,Price?:number,Country?:Country,LicensePlanId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
LicenseTypeId;
/** @type {string} */
CountryId;
/** @type {number} */
Price;
/** @type {Country} */
Country;
/** @type {number} */
LicensePlanId;
}
export class LicenseTypeQueryResponse {
/** @param {{Id?:number,Name?:string,Description?:string,IsExtraLicenseOption?:boolean,PeriodOfNoticeDays?:number,Items?:LicenseItemsResponse[],Prices?:LicensePriceResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The license type id */
Id;
/**
* @type {string}
* @description The license type name */
Name;
/**
* @type {string}
* @description The license type description */
Description;
/**
* @type {boolean}
* @description If the license type is not a standard license but instead an extra license option. An example would be sending new letter license. */
IsExtraLicenseOption;
/**
* @type {number}
* @description The period of notice for the license in days. */
PeriodOfNoticeDays;
/**
* @type {LicenseItemsResponse[]}
* @description The license items for the license type */
Items;
/**
* @type {LicensePriceResponse[]}
* @description The license prices in each country for the license type */
Prices;
}
export class IncentiveActionResponse {
/** @param {{Id?:number,ActionType?:IncentiveActionType,Page?:string,Segment?:string,Element?:string,LicenseTypeId?:number,SuggestedLicenseToUpgrade?:LicenseTypeQueryResponse}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {IncentiveActionType} */
ActionType;
/** @type {string} */
Page;
/** @type {string} */
Segment;
/** @type {string} */
Element;
/** @type {?number} */
LicenseTypeId;
/** @type {LicenseTypeQueryResponse} */
SuggestedLicenseToUpgrade;
}
export class CompanyIncentiveResponse {
/** @param {{Id?:number,Heading?:string,StorageUrl?:string,SuccessButtonText?:string,ActionId?:number,InitialDelayInSeconds?:number,MaxDisplayCount?:number,ValidFrom?:string,ValidTo?:string,Action?:IncentiveActionResponse,Payload?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Heading;
/** @type {string} */
StorageUrl;
/** @type {string} */
SuccessButtonText;
/** @type {number} */
ActionId;
/** @type {number} */
InitialDelayInSeconds;
/** @type {?number} */
MaxDisplayCount;
/** @type {string} */
ValidFrom;
/** @type {string} */
ValidTo;
/** @type {IncentiveActionResponse} */
Action;
/** @type {string} */
Payload;
}
/** @typedef {number} */
export var IncentiveRecurrenceFrequency;
(function (IncentiveRecurrenceFrequency) {
IncentiveRecurrenceFrequency[IncentiveRecurrenceFrequency["OneTime"] = 1] = "OneTime"
IncentiveRecurrenceFrequency[IncentiveRecurrenceFrequency["Weekly"] = 2] = "Weekly"
IncentiveRecurrenceFrequency[IncentiveRecurrenceFrequency["Monthly"] = 3] = "Monthly"
})(IncentiveRecurrenceFrequency || (IncentiveRecurrenceFrequency = {}));
/** @typedef {'LicenseAvailability'|'SmsActivation'|'eAccountingActivation'|'CodeLockActivation'|'SocialActivation'|'OnlinePaymentActivation'|'FollowUpMessageActivation'|'RatingActivation'} */
export var CriteriaType;
(function (CriteriaType) {
CriteriaType["LicenseAvailability"] = "LicenseAvailability"
CriteriaType["SmsActivation"] = "SmsActivation"
CriteriaType["eAccountingActivation"] = "eAccountingActivation"
CriteriaType["CodeLockActivation"] = "CodeLockActivation"
CriteriaType["SocialActivation"] = "SocialActivation"
CriteriaType["OnlinePaymentActivation"] = "OnlinePaymentActivation"
CriteriaType["FollowUpMessageActivation"] = "FollowUpMessageActivation"
CriteriaType["RatingActivation"] = "RatingActivation"
})(CriteriaType || (CriteriaType = {}));
export class IncentiveCriteria extends BaseModel {
/** @param {{Id?:number,IncentiveId?:number,CriteriaType?:CriteriaType,Value?:string,InvertCondition?:boolean,CreatedDate?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {number} */
IncentiveId;
/** @type {CriteriaType} */
CriteriaType;
/** @type {string} */
Value;
/** @type {boolean} */
InvertCondition;
/** @type {string} */
CreatedDate;
}
export class AdminIncentiveQueryResponse extends CompanyIncentiveResponse {
/** @param {{Frequency?:IncentiveRecurrenceFrequency,RecurrenceInterval?:number,CreatedDate?:string,ModifiedDate?:string,CompanyIds?:string[],Criteria?:IncentiveCriteria[],ApplyToAllCompanies?:boolean,Id?:number,Heading?:string,StorageUrl?:string,SuccessButtonText?:string,ActionId?:number,InitialDelayInSeconds?:number,MaxDisplayCount?:number,ValidFrom?:string,ValidTo?:string,Action?:IncentiveActionResponse,Payload?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {IncentiveRecurrenceFrequency} */
Frequency;
/** @type {number} */
RecurrenceInterval;
/** @type {string} */
CreatedDate;
/** @type {string} */
ModifiedDate;
/** @type {string[]} */
CompanyIds;
/** @type {IncentiveCriteria[]} */
Criteria;
/** @type {boolean} */
ApplyToAllCompanies;
}
export class IncentiveCriteriaDto {
/** @param {{CriteriaType?:CriteriaType,Value?:string,InvertCondition?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CriteriaType} */
CriteriaType;
/** @type {string} */
Value;
/** @type {boolean} */
InvertCondition;
}
export class CreateIncentive {
/** @param {{Heading?:string,StorageUrl?:string,Body?:string,SuccessButtonText?:string,ActionId?:number,Frequency?:IncentiveRecurrenceFrequency,RecurrenceInterval?:number,InitialDelayInSeconds?:number,MaxDisplayCount?:number,ValidFrom?:string,ValidTo?:string,Active?:boolean,Payload?:string,CompanyIds?:string[],Criteria?:IncentiveCriteriaDto[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Heading;
/** @type {string} */
StorageUrl;
/** @type {string} */
Body;
/** @type {string} */
SuccessButtonText;
/** @type {number} */
ActionId;
/** @type {IncentiveRecurrenceFrequency} */
Frequency;
/** @type {number} */
RecurrenceInterval;
/** @type {number} */
InitialDelayInSeconds;
/** @type {number} */
MaxDisplayCount;
/** @type {string} */
ValidFrom;
/** @type {string} */
ValidTo;
/** @type {boolean} */
Active;
/** @type {string} */
Payload;
/** @type {string[]} */
CompanyIds;
/** @type {IncentiveCriteriaDto[]} */
Criteria;
}
JavaScript CreateIncentive DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /superadmin/incentives HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Heading: String,
StorageUrl: String,
Body: String,
SuccessButtonText: String,
ActionId: 0,
Frequency: OneTime,
RecurrenceInterval: 0,
InitialDelayInSeconds: 0,
MaxDisplayCount: 0,
ValidFrom: 0001-01-01T00:00:00.0000000+00:00,
ValidTo: 0001-01-01T00:00:00.0000000+00:00,
Active: False,
Payload: String,
CompanyIds:
[
00000000-0000-0000-0000-000000000000
],
Criteria:
[
{
CriteriaType: LicenseAvailability,
Value: String,
InvertCondition: False
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Frequency: OneTime,
RecurrenceInterval: 0,
CreatedDate: 0001-01-01T00:00:00.0000000+00:00,
ModifiedDate: 0001-01-01T00:00:00.0000000+00:00,
CompanyIds:
[
00000000-0000-0000-0000-000000000000
],
Criteria:
[
{
Id: 0,
IncentiveId: 0,
CriteriaType: LicenseAvailability,
Value: String,
InvertCondition: False,
CreatedDate: 0001-01-01T00:00:00.0000000+00:00
}
],
ApplyToAllCompanies: False,
Id: 0,
Heading: String,
StorageUrl: String,
SuccessButtonText: String,
ActionId: 0,
InitialDelayInSeconds: 0,
MaxDisplayCount: 0,
ValidFrom: 0001-01-01T00:00:00.0000000+00:00,
ValidTo: 0001-01-01T00:00:00.0000000+00:00,
Action:
{
Id: 0,
ActionType: Upgrade,
Page: String,
Segment: String,
Element: String,
LicenseTypeId: 0,
SuggestedLicenseToUpgrade:
{
Id: 0,
Name: String,
Description: String,
IsExtraLicenseOption: False,
PeriodOfNoticeDays: 0,
Items:
[
{
Id: 0,
Name: String,
AllowedItems: 0
}
],
Prices:
[
{
LicenseTypeId: 0,
CountryId: String,
Price: 0,
Country:
{
CurrencyId: String,
CurrencyInfo:
{
Name: String,
CurrencySign: String,
Active: False,
ModifiedDate: 0001-01-01T00:00:00.0000000+00:00,
Id: String
},
Name: String,
Culture: String,
TimeZone: String,
ModifiedDate: 0001-01-01T00:00:00.0000000+00:00,
Id: String
},
LicensePlanId: 0
}
]
}
},
Payload: String
}