BokaMera.API.Host

<back to all web services

CreatePresetBehaviour

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


enum ChangeTypeEnum : string
{
    case Subscription = 'Subscription';
    case ProductGroup = 'ProductGroup';
    case License = 'License';
}

enum ChangeOperationEnum : string
{
    case Create = 'Create';
    case Terminate = 'Terminate';
    case Upgrade = 'Upgrade';
    case Sidegrade = 'Sidegrade';
    case Downgrade = 'Downgrade';
    case Migration = 'Migration';
}

enum SubscriptionTimingEnum : string
{
    case AtSubscriptionBillingPeriodEnd = 'AtSubscriptionBillingPeriodEnd';
    case AtBindingPeriodEnd = 'AtBindingPeriodEnd';
    case Immediately = 'Immediately';
}

enum PeriodAnchorEnum : string
{
    case LatestPeriod = 'LatestPeriod';
    case CurrentPeriod = 'CurrentPeriod';
}

enum RenewalTimingEnum : string
{
    case UseCurrentPlanRenewalDate = 'UseCurrentPlanRenewalDate';
    case UseScheduledPlanRenewalDate = 'UseScheduledPlanRenewalDate';
}

enum SubscriptionBehaviourEnum : string
{
    case Prorate = 'Prorate';
    case Full = 'Full';
    case None = 'None';
}

enum CreditKindEnum : string
{
    case Normal = 'Normal';
    case Internal = 'Internal';
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class CreatePresetBehaviour implements JsonSerializable
{
    public function __construct(
        /** @description Company ids to create invoice. If none added invoice for all will be created */
        // @ApiMember(Description="Company ids to create invoice. If none added invoice for all will be created")
        /** @var ChangeTypeEnum|null */
        public ?ChangeTypeEnum $ChangeType=null,

        /** @var ChangeOperationEnum|null */
        public ?ChangeOperationEnum $ChangeOperation=null,
        /** @var SubscriptionTimingEnum|null */
        public ?SubscriptionTimingEnum $Timing=null,
        /** @var PeriodAnchorEnum|null */
        public ?PeriodAnchorEnum $PeriodAnchor=null,
        /** @var RenewalTimingEnum|null */
        public ?RenewalTimingEnum $RenewalTiming=null,
        /** @var SubscriptionBehaviourEnum|null */
        public ?SubscriptionBehaviourEnum $DebitBehaviour=null,
        /** @var SubscriptionBehaviourEnum|null */
        public ?SubscriptionBehaviourEnum $CreditBehaviour=null,
        /** @var CreditKindEnum|null */
        public ?CreditKindEnum $CreditKind=null,
        /** @var int|null */
        public ?int $PeriodIterationCount=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ChangeType'])) $this->ChangeType = JsonConverters::from('ChangeTypeEnum', $o['ChangeType']);
        if (isset($o['ChangeOperation'])) $this->ChangeOperation = JsonConverters::from('ChangeOperationEnum', $o['ChangeOperation']);
        if (isset($o['Timing'])) $this->Timing = JsonConverters::from('SubscriptionTimingEnum', $o['Timing']);
        if (isset($o['PeriodAnchor'])) $this->PeriodAnchor = JsonConverters::from('PeriodAnchorEnum', $o['PeriodAnchor']);
        if (isset($o['RenewalTiming'])) $this->RenewalTiming = JsonConverters::from('RenewalTimingEnum', $o['RenewalTiming']);
        if (isset($o['DebitBehaviour'])) $this->DebitBehaviour = JsonConverters::from('SubscriptionBehaviourEnum', $o['DebitBehaviour']);
        if (isset($o['CreditBehaviour'])) $this->CreditBehaviour = JsonConverters::from('SubscriptionBehaviourEnum', $o['CreditBehaviour']);
        if (isset($o['CreditKind'])) $this->CreditKind = JsonConverters::from('CreditKindEnum', $o['CreditKind']);
        if (isset($o['PeriodIterationCount'])) $this->PeriodIterationCount = $o['PeriodIterationCount'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ChangeType)) $o['ChangeType'] = JsonConverters::to('ChangeTypeEnum', $this->ChangeType);
        if (isset($this->ChangeOperation)) $o['ChangeOperation'] = JsonConverters::to('ChangeOperationEnum', $this->ChangeOperation);
        if (isset($this->Timing)) $o['Timing'] = JsonConverters::to('SubscriptionTimingEnum', $this->Timing);
        if (isset($this->PeriodAnchor)) $o['PeriodAnchor'] = JsonConverters::to('PeriodAnchorEnum', $this->PeriodAnchor);
        if (isset($this->RenewalTiming)) $o['RenewalTiming'] = JsonConverters::to('RenewalTimingEnum', $this->RenewalTiming);
        if (isset($this->DebitBehaviour)) $o['DebitBehaviour'] = JsonConverters::to('SubscriptionBehaviourEnum', $this->DebitBehaviour);
        if (isset($this->CreditBehaviour)) $o['CreditBehaviour'] = JsonConverters::to('SubscriptionBehaviourEnum', $this->CreditBehaviour);
        if (isset($this->CreditKind)) $o['CreditKind'] = JsonConverters::to('CreditKindEnum', $this->CreditKind);
        if (isset($this->PeriodIterationCount)) $o['PeriodIterationCount'] = $this->PeriodIterationCount;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CreatePresetBehaviour DTOs

POST /voss/presetBehaviour HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ChangeType":"Subscription","ChangeOperation":"Create","Timing":"AtSubscriptionBillingPeriodEnd","PeriodAnchor":"LatestPeriod","RenewalTiming":"UseCurrentPlanRenewalDate","DebitBehaviour":"Prorate","CreditBehaviour":"Prorate","CreditKind":"Normal","PeriodIterationCount":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{}