| Requires the role: | superadmin |
| GET | /superadmin/incentives/ | Query incentives |
|---|
"use strict";
export class QueryBase {
/** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?number}
* @description Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code> */
Skip;
/**
* @type {?number}
* @description Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code> */
Take;
/**
* @type {string}
* @description Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code> */
OrderBy;
/**
* @type {string}
* @description Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code> */
OrderByDesc;
/**
* @type {string}
* @description Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code> */
Include;
/** @type {string} */
Fields;
/** @type {{ [index: string]: string; }} */
Meta;
}
/** @typedef From {any} */
/** @typedef Into {any} */
export class QueryDb extends QueryBase {
/** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class BaseModel {
constructor(init) { Object.assign(this, init) }
}
/** @typedef {number} */
export var IncentiveRecurrenceFrequency;
(function (IncentiveRecurrenceFrequency) {
IncentiveRecurrenceFrequency[IncentiveRecurrenceFrequency["OneTime"] = 1] = "OneTime"
IncentiveRecurrenceFrequency[IncentiveRecurrenceFrequency["Weekly"] = 2] = "Weekly"
IncentiveRecurrenceFrequency[IncentiveRecurrenceFrequency["Monthly"] = 3] = "Monthly"
})(IncentiveRecurrenceFrequency || (IncentiveRecurrenceFrequency = {}));
export class IncentiveCompanyRelation extends BaseModel {
/** @param {{Id?:number,CompanyId?:string,IncentiveId?:number,CreatedDate?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
CompanyId;
/** @type {number} */
IncentiveId;
/** @type {string} */
CreatedDate;
}
/** @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;
}
/** @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 IncentiveAction extends BaseModel {
/** @param {{Id?:number,ActionType?:IncentiveActionType,Page?:string,Segment?:string,Element?:string,LicenseTypeId?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {IncentiveActionType} */
ActionType;
/** @type {string} */
Page;
/** @type {string} */
Segment;
/** @type {string} */
Element;
/** @type {?number} */
LicenseTypeId;
}
export class Incentive extends BaseModel {
/** @param {{Id?:number,Heading?:string,StorageUrl?:string,SuccessButtonText?:string,Active?:boolean,ActionId?:number,Frequency?:IncentiveRecurrenceFrequency,RecurrenceInterval?:number,InitialDelayInSeconds?:number,MaxDisplayCount?:number,ValidFrom?:string,ValidTo?:string,CreatedDate?:string,ModifiedDate?:string,AppliesToAllCompanies?:boolean,Payload?:string,Companies?:IncentiveCompanyRelation[],Criteria?:IncentiveCriteria[],Action?:IncentiveAction}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Heading;
/** @type {string} */
StorageUrl;
/** @type {string} */
SuccessButtonText;
/** @type {boolean} */
Active;
/** @type {number} */
ActionId;
/** @type {IncentiveRecurrenceFrequency} */
Frequency;
/** @type {number} */
RecurrenceInterval;
/** @type {number} */
InitialDelayInSeconds;
/** @type {?number} */
MaxDisplayCount;
/** @type {string} */
ValidFrom;
/** @type {string} */
ValidTo;
/** @type {string} */
CreatedDate;
/** @type {?string} */
ModifiedDate;
/** @type {boolean} */
AppliesToAllCompanies;
/** @type {string} */
Payload;
/** @type {IncentiveCompanyRelation[]} */
Companies;
/** @type {IncentiveCriteria[]} */
Criteria;
/** @type {IncentiveAction} */
Action;
}
export class AdminIncentivesQuery extends QueryDb {
/** @param {{Id?:number,CompanyId?:string,ValidFrom?:Date,ValidTo?:Date,ActionId?:number,Active?:boolean,IncludeCriteria?:boolean,IncludeCompanies?:boolean,IncludeAction?:boolean,Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
Id;
/** @type {?string} */
CompanyId;
/** @type {?Date} */
ValidFrom;
/** @type {?Date} */
ValidTo;
/** @type {?number} */
ActionId;
/** @type {?boolean} */
Active;
/** @type {boolean} */
IncludeCriteria;
/** @type {boolean} */
IncludeCompanies;
/** @type {boolean} */
IncludeAction;
}
export class AccessKeyTypeResponse {
/** @param {{Id?:number,KeyType?:string,Description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
KeyType;
/** @type {string} */
Description;
}
/** @typedef T {any} */
export class QueryResponse {
/** @param {{Offset?:number,Total?:number,Results?:T[],Meta?:{ [index: string]: string; },ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Offset;
/** @type {number} */
Total;
/** @type {T[]} */
Results;
/** @type {{ [index: string]: string; }} */
Meta;
/** @type {ResponseStatus} */
ResponseStatus;
}
JavaScript AdminIncentivesQuery 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.
GET /superadmin/incentives/ HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Offset: 0,
Total: 0,
Results:
[
{
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
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}