| Requires the role: | superadmin |
| POST | /superadmin/incentives | Add a new incentive |
|---|
import 'package:servicestack/servicestack.dart';
enum IncentiveActionType
{
Upgrade,
AddOn,
Information,
}
class LicenseItemsResponse implements IConvertible
{
int? Id;
String? Name;
int? AllowedItems;
LicenseItemsResponse({this.Id,this.Name,this.AllowedItems});
LicenseItemsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Name = json['Name'];
AllowedItems = json['AllowedItems'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Name': Name,
'AllowedItems': AllowedItems
};
getTypeName() => "LicenseItemsResponse";
TypeContext? context = _ctx;
}
class BaseModel implements IConvertible
{
BaseModel();
BaseModel.fromJson(Map<String, dynamic> json) : super();
fromMap(Map<String, dynamic> json) {
return this;
}
Map<String, dynamic> toJson() => {};
getTypeName() => "BaseModel";
TypeContext? context = _ctx;
}
class Currency extends BaseModel implements IConvertible
{
// @Required()
String? Name;
// @Required()
String? CurrencySign;
// @Required()
bool? Active;
DateTime? ModifiedDate;
// @Required()
String? Id;
Currency({this.Name,this.CurrencySign,this.Active,this.ModifiedDate,this.Id});
Currency.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Name = json['Name'];
CurrencySign = json['CurrencySign'];
Active = json['Active'];
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
Id = json['Id'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Name': Name,
'CurrencySign': CurrencySign,
'Active': Active,
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
'Id': Id
});
getTypeName() => "Currency";
TypeContext? context = _ctx;
}
class Country extends BaseModel implements IConvertible
{
// @References(typeof(Currency))
String? CurrencyId;
Currency? CurrencyInfo;
// @Required()
String? Name;
String? Culture;
String? TimeZone;
DateTime? ModifiedDate;
// @Required()
String? Id;
Country({this.CurrencyId,this.CurrencyInfo,this.Name,this.Culture,this.TimeZone,this.ModifiedDate,this.Id});
Country.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
CurrencyId = json['CurrencyId'];
CurrencyInfo = JsonConverters.fromJson(json['CurrencyInfo'],'Currency',context!);
Name = json['Name'];
Culture = json['Culture'];
TimeZone = json['TimeZone'];
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
Id = json['Id'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'CurrencyId': CurrencyId,
'CurrencyInfo': JsonConverters.toJson(CurrencyInfo,'Currency',context!),
'Name': Name,
'Culture': Culture,
'TimeZone': TimeZone,
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
'Id': Id
});
getTypeName() => "Country";
TypeContext? context = _ctx;
}
class LicensePriceResponse implements IConvertible
{
int? LicenseTypeId;
String? CountryId;
int? Price;
Country? Country;
int? LicensePlanId;
LicensePriceResponse({this.LicenseTypeId,this.CountryId,this.Price,this.Country,this.LicensePlanId});
LicensePriceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
LicenseTypeId = json['LicenseTypeId'];
CountryId = json['CountryId'];
Price = json['Price'];
Country = JsonConverters.fromJson(json['Country'],'Country',context!);
LicensePlanId = json['LicensePlanId'];
return this;
}
Map<String, dynamic> toJson() => {
'LicenseTypeId': LicenseTypeId,
'CountryId': CountryId,
'Price': Price,
'Country': JsonConverters.toJson(Country,'Country',context!),
'LicensePlanId': LicensePlanId
};
getTypeName() => "LicensePriceResponse";
TypeContext? context = _ctx;
}
class LicenseTypeQueryResponse implements IConvertible
{
/**
* The license type id
*/
// @ApiMember(Description="The license type id")
int? Id;
/**
* The license type name
*/
// @ApiMember(Description="The license type name")
String? Name;
/**
* The license type description
*/
// @ApiMember(Description="The license type description")
String? Description;
/**
* If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
*/
// @ApiMember(Description="If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.")
bool? IsExtraLicenseOption;
/**
* The period of notice for the license in days.
*/
// @ApiMember(Description="The period of notice for the license in days.")
int? PeriodOfNoticeDays;
/**
* The license items for the license type
*/
// @ApiMember(Description="The license items for the license type")
List<LicenseItemsResponse>? Items;
/**
* The license prices in each country for the license type
*/
// @ApiMember(Description="The license prices in each country for the license type")
List<LicensePriceResponse>? Prices;
LicenseTypeQueryResponse({this.Id,this.Name,this.Description,this.IsExtraLicenseOption,this.PeriodOfNoticeDays,this.Items,this.Prices});
LicenseTypeQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Name = json['Name'];
Description = json['Description'];
IsExtraLicenseOption = json['IsExtraLicenseOption'];
PeriodOfNoticeDays = json['PeriodOfNoticeDays'];
Items = JsonConverters.fromJson(json['Items'],'List<LicenseItemsResponse>',context!);
Prices = JsonConverters.fromJson(json['Prices'],'List<LicensePriceResponse>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Name': Name,
'Description': Description,
'IsExtraLicenseOption': IsExtraLicenseOption,
'PeriodOfNoticeDays': PeriodOfNoticeDays,
'Items': JsonConverters.toJson(Items,'List<LicenseItemsResponse>',context!),
'Prices': JsonConverters.toJson(Prices,'List<LicensePriceResponse>',context!)
};
getTypeName() => "LicenseTypeQueryResponse";
TypeContext? context = _ctx;
}
class IncentiveActionResponse implements IConvertible
{
int? Id;
IncentiveActionType? ActionType;
String? Page;
String? Segment;
String? Element;
int? LicenseTypeId;
LicenseTypeQueryResponse? SuggestedLicenseToUpgrade;
IncentiveActionResponse({this.Id,this.ActionType,this.Page,this.Segment,this.Element,this.LicenseTypeId,this.SuggestedLicenseToUpgrade});
IncentiveActionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
ActionType = JsonConverters.fromJson(json['ActionType'],'IncentiveActionType',context!);
Page = json['Page'];
Segment = json['Segment'];
Element = json['Element'];
LicenseTypeId = json['LicenseTypeId'];
SuggestedLicenseToUpgrade = JsonConverters.fromJson(json['SuggestedLicenseToUpgrade'],'LicenseTypeQueryResponse',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'ActionType': JsonConverters.toJson(ActionType,'IncentiveActionType',context!),
'Page': Page,
'Segment': Segment,
'Element': Element,
'LicenseTypeId': LicenseTypeId,
'SuggestedLicenseToUpgrade': JsonConverters.toJson(SuggestedLicenseToUpgrade,'LicenseTypeQueryResponse',context!)
};
getTypeName() => "IncentiveActionResponse";
TypeContext? context = _ctx;
}
class CompanyIncentiveResponse implements IConvertible
{
int? Id;
String? Heading;
String? StorageUrl;
String? SuccessButtonText;
int? ActionId;
int? InitialDelayInSeconds;
int? MaxDisplayCount;
DateTime? ValidFrom;
DateTime? ValidTo;
IncentiveActionResponse? Action;
String? Payload;
CompanyIncentiveResponse({this.Id,this.Heading,this.StorageUrl,this.SuccessButtonText,this.ActionId,this.InitialDelayInSeconds,this.MaxDisplayCount,this.ValidFrom,this.ValidTo,this.Action,this.Payload});
CompanyIncentiveResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Heading = json['Heading'];
StorageUrl = json['StorageUrl'];
SuccessButtonText = json['SuccessButtonText'];
ActionId = json['ActionId'];
InitialDelayInSeconds = json['InitialDelayInSeconds'];
MaxDisplayCount = json['MaxDisplayCount'];
ValidFrom = JsonConverters.fromJson(json['ValidFrom'],'DateTime',context!);
ValidTo = JsonConverters.fromJson(json['ValidTo'],'DateTime',context!);
Action = JsonConverters.fromJson(json['Action'],'IncentiveActionResponse',context!);
Payload = json['Payload'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Heading': Heading,
'StorageUrl': StorageUrl,
'SuccessButtonText': SuccessButtonText,
'ActionId': ActionId,
'InitialDelayInSeconds': InitialDelayInSeconds,
'MaxDisplayCount': MaxDisplayCount,
'ValidFrom': JsonConverters.toJson(ValidFrom,'DateTime',context!),
'ValidTo': JsonConverters.toJson(ValidTo,'DateTime',context!),
'Action': JsonConverters.toJson(Action,'IncentiveActionResponse',context!),
'Payload': Payload
};
getTypeName() => "CompanyIncentiveResponse";
TypeContext? context = _ctx;
}
enum IncentiveRecurrenceFrequency
{
OneTime,
Weekly,
Monthly,
}
enum CriteriaType
{
LicenseAvailability,
SmsActivation,
eAccountingActivation,
CodeLockActivation,
SocialActivation,
OnlinePaymentActivation,
FollowUpMessageActivation,
RatingActivation,
}
class IncentiveCriteria extends BaseModel implements IConvertible
{
int? Id;
int? IncentiveId;
CriteriaType? CriteriaType;
String? Value;
bool? InvertCondition;
DateTime? CreatedDate;
IncentiveCriteria({this.Id,this.IncentiveId,this.CriteriaType,this.Value,this.InvertCondition,this.CreatedDate});
IncentiveCriteria.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Id = json['Id'];
IncentiveId = json['IncentiveId'];
CriteriaType = JsonConverters.fromJson(json['CriteriaType'],'CriteriaType',context!);
Value = json['Value'];
InvertCondition = json['InvertCondition'];
CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Id': Id,
'IncentiveId': IncentiveId,
'CriteriaType': JsonConverters.toJson(CriteriaType,'CriteriaType',context!),
'Value': Value,
'InvertCondition': InvertCondition,
'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!)
});
getTypeName() => "IncentiveCriteria";
TypeContext? context = _ctx;
}
class AdminIncentiveQueryResponse extends CompanyIncentiveResponse implements IConvertible
{
IncentiveRecurrenceFrequency? Frequency;
int? RecurrenceInterval;
DateTime? CreatedDate;
DateTime? ModifiedDate;
List<String>? CompanyIds;
List<IncentiveCriteria>? Criteria;
bool? ApplyToAllCompanies;
AdminIncentiveQueryResponse({this.Frequency,this.RecurrenceInterval,this.CreatedDate,this.ModifiedDate,this.CompanyIds,this.Criteria,this.ApplyToAllCompanies});
AdminIncentiveQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Frequency = JsonConverters.fromJson(json['Frequency'],'IncentiveRecurrenceFrequency',context!);
RecurrenceInterval = json['RecurrenceInterval'];
CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
CompanyIds = JsonConverters.fromJson(json['CompanyIds'],'List<String>',context!);
Criteria = JsonConverters.fromJson(json['Criteria'],'List<IncentiveCriteria>',context!);
ApplyToAllCompanies = json['ApplyToAllCompanies'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Frequency': JsonConverters.toJson(Frequency,'IncentiveRecurrenceFrequency',context!),
'RecurrenceInterval': RecurrenceInterval,
'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
'CompanyIds': JsonConverters.toJson(CompanyIds,'List<String>',context!),
'Criteria': JsonConverters.toJson(Criteria,'List<IncentiveCriteria>',context!),
'ApplyToAllCompanies': ApplyToAllCompanies
});
getTypeName() => "AdminIncentiveQueryResponse";
TypeContext? context = _ctx;
}
class IncentiveCriteriaDto implements IConvertible
{
CriteriaType? CriteriaType;
String? Value;
bool? InvertCondition;
IncentiveCriteriaDto({this.CriteriaType,this.Value,this.InvertCondition});
IncentiveCriteriaDto.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CriteriaType = JsonConverters.fromJson(json['CriteriaType'],'CriteriaType',context!);
Value = json['Value'];
InvertCondition = json['InvertCondition'];
return this;
}
Map<String, dynamic> toJson() => {
'CriteriaType': JsonConverters.toJson(CriteriaType,'CriteriaType',context!),
'Value': Value,
'InvertCondition': InvertCondition
};
getTypeName() => "IncentiveCriteriaDto";
TypeContext? context = _ctx;
}
// @ValidateRequest(Validator="IsAuthenticated")
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class CreateIncentive implements IConvertible
{
// @ApiMember(IsRequired=true)
String? Heading;
// @ApiMember()
String? StorageUrl;
// @ApiMember()
String? Body;
// @ApiMember(IsRequired=true)
String? SuccessButtonText;
// @ApiMember(IsRequired=true)
int? ActionId;
// @ApiMember(IsRequired=true)
IncentiveRecurrenceFrequency? Frequency;
// @ApiMember()
int? RecurrenceInterval;
// @ApiMember(IsRequired=true)
int? InitialDelayInSeconds;
// @ApiMember(IsRequired=true)
int? MaxDisplayCount;
// @ApiMember(IsRequired=true)
DateTime? ValidFrom;
// @ApiMember(IsRequired=true)
DateTime? ValidTo;
// @ApiMember()
bool? Active;
// @ApiMember()
String? Payload;
List<String>? CompanyIds;
List<IncentiveCriteriaDto>? Criteria;
CreateIncentive({this.Heading,this.StorageUrl,this.Body,this.SuccessButtonText,this.ActionId,this.Frequency,this.RecurrenceInterval,this.InitialDelayInSeconds,this.MaxDisplayCount,this.ValidFrom,this.ValidTo,this.Active,this.Payload,this.CompanyIds,this.Criteria});
CreateIncentive.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Heading = json['Heading'];
StorageUrl = json['StorageUrl'];
Body = json['Body'];
SuccessButtonText = json['SuccessButtonText'];
ActionId = json['ActionId'];
Frequency = JsonConverters.fromJson(json['Frequency'],'IncentiveRecurrenceFrequency',context!);
RecurrenceInterval = json['RecurrenceInterval'];
InitialDelayInSeconds = json['InitialDelayInSeconds'];
MaxDisplayCount = json['MaxDisplayCount'];
ValidFrom = JsonConverters.fromJson(json['ValidFrom'],'DateTime',context!);
ValidTo = JsonConverters.fromJson(json['ValidTo'],'DateTime',context!);
Active = json['Active'];
Payload = json['Payload'];
CompanyIds = JsonConverters.fromJson(json['CompanyIds'],'List<String>',context!);
Criteria = JsonConverters.fromJson(json['Criteria'],'List<IncentiveCriteriaDto>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Heading': Heading,
'StorageUrl': StorageUrl,
'Body': Body,
'SuccessButtonText': SuccessButtonText,
'ActionId': ActionId,
'Frequency': JsonConverters.toJson(Frequency,'IncentiveRecurrenceFrequency',context!),
'RecurrenceInterval': RecurrenceInterval,
'InitialDelayInSeconds': InitialDelayInSeconds,
'MaxDisplayCount': MaxDisplayCount,
'ValidFrom': JsonConverters.toJson(ValidFrom,'DateTime',context!),
'ValidTo': JsonConverters.toJson(ValidTo,'DateTime',context!),
'Active': Active,
'Payload': Payload,
'CompanyIds': JsonConverters.toJson(CompanyIds,'List<String>',context!),
'Criteria': JsonConverters.toJson(Criteria,'List<IncentiveCriteriaDto>',context!)
};
getTypeName() => "CreateIncentive";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
'IncentiveActionType': TypeInfo(TypeOf.Enum, enumValues:IncentiveActionType.values),
'LicenseItemsResponse': TypeInfo(TypeOf.Class, create:() => LicenseItemsResponse()),
'BaseModel': TypeInfo(TypeOf.Class, create:() => BaseModel()),
'Currency': TypeInfo(TypeOf.Class, create:() => Currency()),
'Country': TypeInfo(TypeOf.Class, create:() => Country()),
'LicensePriceResponse': TypeInfo(TypeOf.Class, create:() => LicensePriceResponse()),
'LicenseTypeQueryResponse': TypeInfo(TypeOf.Class, create:() => LicenseTypeQueryResponse()),
'List<LicenseItemsResponse>': TypeInfo(TypeOf.Class, create:() => <LicenseItemsResponse>[]),
'List<LicensePriceResponse>': TypeInfo(TypeOf.Class, create:() => <LicensePriceResponse>[]),
'IncentiveActionResponse': TypeInfo(TypeOf.Class, create:() => IncentiveActionResponse()),
'CompanyIncentiveResponse': TypeInfo(TypeOf.Class, create:() => CompanyIncentiveResponse()),
'IncentiveRecurrenceFrequency': TypeInfo(TypeOf.Enum, enumValues:IncentiveRecurrenceFrequency.values),
'CriteriaType': TypeInfo(TypeOf.Enum, enumValues:CriteriaType.values),
'IncentiveCriteria': TypeInfo(TypeOf.Class, create:() => IncentiveCriteria()),
'AdminIncentiveQueryResponse': TypeInfo(TypeOf.Class, create:() => AdminIncentiveQueryResponse()),
'List<IncentiveCriteria>': TypeInfo(TypeOf.Class, create:() => <IncentiveCriteria>[]),
'IncentiveCriteriaDto': TypeInfo(TypeOf.Class, create:() => IncentiveCriteriaDto()),
'CreateIncentive': TypeInfo(TypeOf.Class, create:() => CreateIncentive()),
'List<IncentiveCriteriaDto>': TypeInfo(TypeOf.Class, create:() => <IncentiveCriteriaDto>[]),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
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/jsonl
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"}