BokaMera.API.Host

CreatePresetBehaviour

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/voss/presetBehaviour	create preset behaviour in voss

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 ChangeTypeEnum(str, Enum):
    SUBSCRIPTION = 'Subscription'
    PRODUCT_GROUP = 'ProductGroup'
    LICENSE = 'License'


class ChangeOperationEnum(str, Enum):
    CREATE = 'Create'
    TERMINATE = 'Terminate'
    UPGRADE = 'Upgrade'
    SIDEGRADE = 'Sidegrade'
    DOWNGRADE = 'Downgrade'
    MIGRATION = 'Migration'


class SubscriptionTimingEnum(str, Enum):
    AT_SUBSCRIPTION_BILLING_PERIOD_END = 'AtSubscriptionBillingPeriodEnd'
    AT_BINDING_PERIOD_END = 'AtBindingPeriodEnd'
    IMMEDIATELY = 'Immediately'


class PeriodAnchorEnum(str, Enum):
    LATEST_PERIOD = 'LatestPeriod'
    CURRENT_PERIOD = 'CurrentPeriod'


class RenewalTimingEnum(str, Enum):
    USE_CURRENT_PLAN_RENEWAL_DATE = 'UseCurrentPlanRenewalDate'
    USE_SCHEDULED_PLAN_RENEWAL_DATE = 'UseScheduledPlanRenewalDate'


class SubscriptionBehaviourEnum(str, Enum):
    PRORATE = 'Prorate'
    FULL = 'Full'
    NONE = 'None'


class CreditKindEnum(str, Enum):
    NORMAL = 'Normal'
    INTERNAL = 'Internal'


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreatePresetBehaviour:
    # @ApiMember(Description="Company ids to create invoice. If none added invoice for all will be created")
    change_type: Optional[ChangeTypeEnum] = None
    """
    Company ids to create invoice. If none added invoice for all will be created
    """


    change_operation: Optional[ChangeOperationEnum] = None
    timing: Optional[SubscriptionTimingEnum] = None
    period_anchor: Optional[PeriodAnchorEnum] = None
    renewal_timing: Optional[RenewalTimingEnum] = None
    debit_behaviour: Optional[SubscriptionBehaviourEnum] = None
    credit_behaviour: Optional[SubscriptionBehaviourEnum] = None
    credit_kind: Optional[CreditKindEnum] = None
    period_iteration_count: Optional[int] = None

Python CreatePresetBehaviour DTOs

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

HTTP + XML

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

POST /voss/presetBehaviour HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreatePresetBehaviour xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ChangeOperation>Create</ChangeOperation>
  <ChangeType>Subscription</ChangeType>
  <CreditBehaviour>Prorate</CreditBehaviour>
  <CreditKind>Normal</CreditKind>
  <DebitBehaviour>Prorate</DebitBehaviour>
  <PeriodAnchor>LatestPeriod</PeriodAnchor>
  <PeriodIterationCount>0</PeriodIterationCount>
  <RenewalTiming>UseCurrentPlanRenewalDate</RenewalTiming>
  <Timing>AtSubscriptionBillingPeriodEnd</Timing>
</CreatePresetBehaviour>

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

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />