| Requires the role: | superadmin |
| POST | /superadmin/incentives | Add a new incentive |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
class IncentiveActionType(IntEnum):
UPGRADE = 1
ADD_ON = 2
INFORMATION = 3
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LicenseItemsResponse:
id: int = 0
name: Optional[str] = None
allowed_items: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseModel:
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Currency(BaseModel):
# @Required()
name: Optional[str] = None
# @Required()
currency_sign: Optional[str] = None
# @Required()
active: bool = False
modified_date: Optional[datetime.datetime] = None
# @Required()
id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Country(BaseModel):
# @References(typeof(Currency))
currency_id: Optional[str] = None
currency_info: Optional[Currency] = None
# @Required()
name: Optional[str] = None
culture: Optional[str] = None
time_zone: Optional[str] = None
modified_date: Optional[datetime.datetime] = None
# @Required()
id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LicensePrice(BaseModel):
# @Ignore()
country: Optional[Country] = None
# @Ignore()
monthly_payment: bool = False
# @Required()
license_type_id: int = 0
# @Required()
country_id: Optional[str] = None
# @Required()
price: int = 0
modified_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LicenseTypeQueryResponse:
# @ApiMember(Description="The license type id")
id: int = 0
"""
The license type id
"""
# @ApiMember(Description="The license type name")
name: Optional[str] = None
"""
The license type name
"""
# @ApiMember(Description="The license type description")
description: Optional[str] = None
"""
The license type description
"""
# @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.")
is_extra_license_option: bool = False
"""
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="The period of notice for the license in days.")
period_of_notice_days: int = 0
"""
The period of notice for the license in days.
"""
# @ApiMember(Description="The license items for the license type")
items: Optional[List[LicenseItemsResponse]] = None
"""
The license items for the license type
"""
# @ApiMember(Description="The license prices in each country for the license type")
prices: Optional[List[LicensePrice]] = None
"""
The license prices in each country for the license type
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IncentiveActionResponse:
id: int = 0
description: Optional[str] = None
action_type: Optional[IncentiveActionType] = None
page: Optional[str] = None
segment: Optional[str] = None
element: Optional[str] = None
license_type_id: Optional[int] = None
suggested_license_to_upgrade: Optional[LicenseTypeQueryResponse] = None
class IncentiveRecurrenceFrequency(IntEnum):
ONE_TIME = 1
WEEKLY = 2
MONTHLY = 3
class CriteriaType(str, Enum):
LICENSE_AVAILABILITY = 'LicenseAvailability'
SMS_ACTIVATION = 'SmsActivation'
E_ACCOUNTING_ACTIVATION = 'eAccountingActivation'
CODE_LOCK_ACTIVATION = 'CodeLockActivation'
SOCIAL_ACTIVATION = 'SocialActivation'
ONLINE_PAYMENT_ACTIVATION = 'OnlinePaymentActivation'
FOLLOW_UP_MESSAGE_ACTIVATION = 'FollowUpMessageActivation'
RATING_ACTIVATION = 'RatingActivation'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IncentiveCriteriaDto:
criteria_type: Optional[CriteriaType] = None
value: Optional[str] = None
invert_condition: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyIncentiveResponse:
id: int = 0
heading: Optional[str] = None
storage_url: Optional[str] = None
success_button_text: Optional[str] = None
action_id: int = 0
initial_delay_in_seconds: int = 0
max_display_count: Optional[int] = None
valid_from: datetime.datetime = datetime.datetime(1, 1, 1)
valid_to: datetime.datetime = datetime.datetime(1, 1, 1)
action: Optional[IncentiveActionResponse] = None
payload: Optional[str] = None
# @ApiMember()
body: Optional[str] = None
# @ApiMember(IsRequired=true)
frequency: Optional[IncentiveRecurrenceFrequency] = None
# @ApiMember(IsRequired=true)
initial_deferred_days: int = 0
# @ApiMember()
recurrence_interval: int = 0
# @ApiMember()
active: bool = False
company_ids: Optional[List[str]] = None
criteria: Optional[List[IncentiveCriteriaDto]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IncentiveCriteria(BaseModel):
id: int = 0
incentive_id: int = 0
criteria_type: Optional[CriteriaType] = None
value: Optional[str] = None
invert_condition: bool = False
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdminIncentiveQueryResponse(CompanyIncentiveResponse):
frequency: Optional[IncentiveRecurrenceFrequency] = None
recurrence_interval: int = 0
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
company_ids: Optional[List[str]] = None
criteria: Optional[List[IncentiveCriteria]] = None
apply_to_all_companies: bool = False
action: Optional[IncentiveActionResponse] = None
# @ValidateRequest(Validator="IsAuthenticated")
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateIncentive:
# @ApiMember(IsRequired=true)
heading: Optional[str] = None
# @ApiMember()
storage_url: Optional[str] = None
# @ApiMember()
body: Optional[str] = None
# @ApiMember(IsRequired=true)
success_button_text: Optional[str] = None
# @ApiMember(IsRequired=true)
action_id: int = 0
# @ApiMember(IsRequired=true)
frequency: Optional[IncentiveRecurrenceFrequency] = None
# @ApiMember()
recurrence_interval: int = 0
# @ApiMember(IsRequired=true)
initial_delay_in_seconds: int = 0
# @ApiMember(IsRequired=true)
max_display_count: Optional[int] = None
# @ApiMember(IsRequired=true)
valid_from: datetime.datetime = datetime.datetime(1, 1, 1)
# @ApiMember(IsRequired=true)
valid_to: datetime.datetime = datetime.datetime(1, 1, 1)
# @ApiMember()
active: bool = False
# @ApiMember()
payload: Optional[str] = None
company_ids: Optional[List[str]] = None
criteria: Optional[List[IncentiveCriteriaDto]] = None
# @ApiMember(Description="Number of days to wait after first display attempt before displaying the incentive. Set to 0 to show immediately.", IsRequired=true)
initial_deferred_days: int = 0
"""
Number of days to wait after first display attempt before displaying the incentive. Set to 0 to show immediately.
"""
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: api.bookmore.com
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
}
],
InitialDeferredDays: 0
}
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,
Action:
{
Id: 0,
Description: String,
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:
[
{
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
},
MonthlyPayment: True,
LicenseTypeId: 0,
CountryId: String,
Price: 0,
ModifiedDate: 0001-01-01T00:00:00.0000000+00:00
}
]
}
},
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,
Payload: String,
Body: String,
InitialDeferredDays: 0,
Active: False,
Criteria:
[
{
CriteriaType: LicenseAvailability,
Value: String,
InvertCondition: False
}
]
}