BokaMera.API.Host

<back to all web services

CreatePresetBehaviour

The following routes are available for this service:
POST/voss/presetBehaviourcreate preset behaviour in voss
"use strict";
/** @typedef {'Subscription'|'ProductGroup'|'License'} */
export var ChangeTypeEnum;
(function (ChangeTypeEnum) {
    ChangeTypeEnum["Subscription"] = "Subscription"
    ChangeTypeEnum["ProductGroup"] = "ProductGroup"
    ChangeTypeEnum["License"] = "License"
})(ChangeTypeEnum || (ChangeTypeEnum = {}));
/** @typedef {'Create'|'Terminate'|'Upgrade'|'Sidegrade'|'Downgrade'|'Migration'} */
export var ChangeOperationEnum;
(function (ChangeOperationEnum) {
    ChangeOperationEnum["Create"] = "Create"
    ChangeOperationEnum["Terminate"] = "Terminate"
    ChangeOperationEnum["Upgrade"] = "Upgrade"
    ChangeOperationEnum["Sidegrade"] = "Sidegrade"
    ChangeOperationEnum["Downgrade"] = "Downgrade"
    ChangeOperationEnum["Migration"] = "Migration"
})(ChangeOperationEnum || (ChangeOperationEnum = {}));
/** @typedef {'AtSubscriptionBillingPeriodEnd'|'AtBindingPeriodEnd'|'Immediately'} */
export var SubscriptionTimingEnum;
(function (SubscriptionTimingEnum) {
    SubscriptionTimingEnum["AtSubscriptionBillingPeriodEnd"] = "AtSubscriptionBillingPeriodEnd"
    SubscriptionTimingEnum["AtBindingPeriodEnd"] = "AtBindingPeriodEnd"
    SubscriptionTimingEnum["Immediately"] = "Immediately"
})(SubscriptionTimingEnum || (SubscriptionTimingEnum = {}));
/** @typedef {'LatestPeriod'|'CurrentPeriod'} */
export var PeriodAnchorEnum;
(function (PeriodAnchorEnum) {
    PeriodAnchorEnum["LatestPeriod"] = "LatestPeriod"
    PeriodAnchorEnum["CurrentPeriod"] = "CurrentPeriod"
})(PeriodAnchorEnum || (PeriodAnchorEnum = {}));
/** @typedef {'UseCurrentPlanRenewalDate'|'UseScheduledPlanRenewalDate'} */
export var RenewalTimingEnum;
(function (RenewalTimingEnum) {
    RenewalTimingEnum["UseCurrentPlanRenewalDate"] = "UseCurrentPlanRenewalDate"
    RenewalTimingEnum["UseScheduledPlanRenewalDate"] = "UseScheduledPlanRenewalDate"
})(RenewalTimingEnum || (RenewalTimingEnum = {}));
/** @typedef {'Prorate'|'Full'|'None'} */
export var SubscriptionBehaviourEnum;
(function (SubscriptionBehaviourEnum) {
    SubscriptionBehaviourEnum["Prorate"] = "Prorate"
    SubscriptionBehaviourEnum["Full"] = "Full"
    SubscriptionBehaviourEnum["None"] = "None"
})(SubscriptionBehaviourEnum || (SubscriptionBehaviourEnum = {}));
/** @typedef {'Normal'|'Internal'} */
export var CreditKindEnum;
(function (CreditKindEnum) {
    CreditKindEnum["Normal"] = "Normal"
    CreditKindEnum["Internal"] = "Internal"
})(CreditKindEnum || (CreditKindEnum = {}));
export class CreatePresetBehaviour {
    /** @param {{ChangeType?:ChangeTypeEnum,ChangeOperation?:ChangeOperationEnum,Timing?:SubscriptionTimingEnum,PeriodAnchor?:PeriodAnchorEnum,RenewalTiming?:RenewalTimingEnum,DebitBehaviour?:SubscriptionBehaviourEnum,CreditBehaviour?:SubscriptionBehaviourEnum,CreditKind?:CreditKindEnum,PeriodIterationCount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {ChangeTypeEnum}
     * @description Company ids to create invoice. If none added invoice for all will be created */
    ChangeType;
    /** @type {ChangeOperationEnum} */
    ChangeOperation;
    /** @type {SubscriptionTimingEnum} */
    Timing;
    /** @type {PeriodAnchorEnum} */
    PeriodAnchor;
    /** @type {RenewalTimingEnum} */
    RenewalTiming;
    /** @type {?SubscriptionBehaviourEnum} */
    DebitBehaviour;
    /** @type {?SubscriptionBehaviourEnum} */
    CreditBehaviour;
    /** @type {?CreditKindEnum} */
    CreditKind;
    /** @type {?number} */
    PeriodIterationCount;
}

JavaScript CreatePresetBehaviour DTOs

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

HTTP + CSV

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: 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

{}