| Requires the role: | superadmin |
| PUT | /superadmin/incentive/{id} | Update 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 LicensePriceResponse:
license_type_id: int = 0
country_id: Optional[str] = None
price: int = 0
country: Optional[Country] = None
license_plan_id: int = 0
@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[LicensePriceResponse]] = 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
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
@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
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 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
@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
# @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 UpdateIncentive:
# @ApiMember(Description="The id of the incentive.", IsRequired=true, ParameterType="path")
id: int = 0
"""
The id of the incentive.
"""
# @ApiMember()
heading: Optional[str] = None
# @ApiMember()
storage_url: Optional[str] = None
# @ApiMember()
success_button_text: Optional[str] = None
# @ApiMember()
action_id: Optional[int] = None
# @ApiMember()
frequency: Optional[IncentiveRecurrenceFrequency] = None
# @ApiMember()
recurrence_interval: int = 0
# @ApiMember()
initial_delay_in_seconds: int = 0
# @ApiMember()
max_display_count: Optional[int] = None
# @ApiMember()
valid_from: datetime.datetime = datetime.datetime(1, 1, 1)
# @ApiMember()
valid_to: datetime.datetime = datetime.datetime(1, 1, 1)
# @ApiMember()
company_ids: Optional[List[str]] = None
# @ApiMember()
criteria: Optional[List[IncentiveCriteriaDto]] = None
# @ApiMember()
payload: Optional[str] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /superadmin/incentive/{id} HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateIncentive xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<ActionId>0</ActionId>
<CompanyIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</CompanyIds>
<Criteria>
<IncentiveCriteriaDto>
<CriteriaType>LicenseAvailability</CriteriaType>
<InvertCondition>false</InvertCondition>
<Value>String</Value>
</IncentiveCriteriaDto>
</Criteria>
<Frequency>OneTime</Frequency>
<Heading>String</Heading>
<Id>0</Id>
<InitialDelayInSeconds>0</InitialDelayInSeconds>
<MaxDisplayCount>0</MaxDisplayCount>
<Payload>String</Payload>
<RecurrenceInterval>0</RecurrenceInterval>
<StorageUrl>String</StorageUrl>
<SuccessButtonText>String</SuccessButtonText>
<ValidFrom xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</ValidFrom>
<ValidTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</ValidTo>
</UpdateIncentive>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AdminIncentiveQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Action>
<ActionType>Upgrade</ActionType>
<Element>String</Element>
<Id>0</Id>
<LicenseTypeId>0</LicenseTypeId>
<Page>String</Page>
<Segment>String</Segment>
<SuggestedLicenseToUpgrade>
<Description>String</Description>
<Id>0</Id>
<IsExtraLicenseOption>false</IsExtraLicenseOption>
<Items>
<LicenseItemsResponse>
<AllowedItems>0</AllowedItems>
<Id>0</Id>
<Name>String</Name>
</LicenseItemsResponse>
</Items>
<Name>String</Name>
<PeriodOfNoticeDays>0</PeriodOfNoticeDays>
<Prices>
<LicensePriceResponse>
<Country xmlns:d6p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
<d6p1:Culture>String</d6p1:Culture>
<d6p1:CurrencyId>String</d6p1:CurrencyId>
<d6p1:CurrencyInfo>
<d6p1:Active>false</d6p1:Active>
<d6p1:CurrencySign>String</d6p1:CurrencySign>
<d6p1:Id>String</d6p1:Id>
<d6p1:ModifiedDate xmlns:d8p1="http://schemas.datacontract.org/2004/07/System">
<d8p1:DateTime>0001-01-01T00:00:00Z</d8p1:DateTime>
<d8p1:OffsetMinutes>0</d8p1:OffsetMinutes>
</d6p1:ModifiedDate>
<d6p1:Name>String</d6p1:Name>
</d6p1:CurrencyInfo>
<d6p1:Id>String</d6p1:Id>
<d6p1:ModifiedDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/System">
<d7p1:DateTime>0001-01-01T00:00:00Z</d7p1:DateTime>
<d7p1:OffsetMinutes>0</d7p1:OffsetMinutes>
</d6p1:ModifiedDate>
<d6p1:Name>String</d6p1:Name>
<d6p1:TimeZone>String</d6p1:TimeZone>
</Country>
<CountryId>String</CountryId>
<LicensePlanId>0</LicensePlanId>
<LicenseTypeId>0</LicenseTypeId>
<Price>0</Price>
</LicensePriceResponse>
</Prices>
</SuggestedLicenseToUpgrade>
</Action>
<ActionId>0</ActionId>
<Heading>String</Heading>
<Id>0</Id>
<InitialDelayInSeconds>0</InitialDelayInSeconds>
<MaxDisplayCount>0</MaxDisplayCount>
<Payload>String</Payload>
<StorageUrl>String</StorageUrl>
<SuccessButtonText>String</SuccessButtonText>
<ValidFrom xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</ValidFrom>
<ValidTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</ValidTo>
<ApplyToAllCompanies>false</ApplyToAllCompanies>
<CompanyIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</CompanyIds>
<CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</CreatedDate>
<Criteria xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db.Incentive">
<d2p1:IncentiveCriteria>
<d2p1:CreatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
</d2p1:CreatedDate>
<d2p1:CriteriaType>LicenseAvailability</d2p1:CriteriaType>
<d2p1:Id>0</d2p1:Id>
<d2p1:IncentiveId>0</d2p1:IncentiveId>
<d2p1:InvertCondition>false</d2p1:InvertCondition>
<d2p1:Value>String</d2p1:Value>
</d2p1:IncentiveCriteria>
</Criteria>
<Frequency>OneTime</Frequency>
<ModifiedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</ModifiedDate>
<RecurrenceInterval>0</RecurrenceInterval>
</AdminIncentiveQueryResponse>