BokaMera.API.Host

CreateIncentiveAction

**Requires Authentication**
Requires the role:	superadmin

The following routes are available for this service:
POST	/superadmin/incentives/action	Add a new incentive action

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


# @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 CreateIncentiveAction:
    id: int = 0
    action_type: Optional[IncentiveActionType] = None
    description: Optional[str] = None
    page: Optional[str] = None
    segment: Optional[str] = None
    element: Optional[str] = None
    license_type_id: Optional[int] = None

Python CreateIncentiveAction DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /superadmin/incentives/action HTTP/1.1 
Host: api.bookmore.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Id":0,"ActionType":"Upgrade","Description":"String","Page":"String","Segment":"String","Element":"String","LicenseTypeId":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"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"}]}}