BokaMera.API.Host

CreatePresetBehaviour

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


export enum ChangeTypeEnum
{
    Subscription = 'Subscription',
    ProductGroup = 'ProductGroup',
    License = 'License',
}

export enum ChangeOperationEnum
{
    Create = 'Create',
    Terminate = 'Terminate',
    Upgrade = 'Upgrade',
    Sidegrade = 'Sidegrade',
    Downgrade = 'Downgrade',
    Migration = 'Migration',
}

export enum SubscriptionTimingEnum
{
    AtSubscriptionBillingPeriodEnd = 'AtSubscriptionBillingPeriodEnd',
    AtBindingPeriodEnd = 'AtBindingPeriodEnd',
    Immediately = 'Immediately',
}

export enum PeriodAnchorEnum
{
    LatestPeriod = 'LatestPeriod',
    CurrentPeriod = 'CurrentPeriod',
}

export enum RenewalTimingEnum
{
    UseCurrentPlanRenewalDate = 'UseCurrentPlanRenewalDate',
    UseScheduledPlanRenewalDate = 'UseScheduledPlanRenewalDate',
}

export enum SubscriptionBehaviourEnum
{
    Prorate = 'Prorate',
    Full = 'Full',
    None = 'None',
}

export enum CreditKindEnum
{
    Normal = 'Normal',
    Internal = 'Internal',
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class CreatePresetBehaviour
{
    /** @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")
    public ChangeType: ChangeTypeEnum;

    public ChangeOperation: ChangeOperationEnum;
    public Timing: SubscriptionTimingEnum;
    public PeriodAnchor: PeriodAnchorEnum;
    public RenewalTiming: RenewalTimingEnum;
    public DebitBehaviour?: SubscriptionBehaviourEnum;
    public CreditBehaviour?: SubscriptionBehaviourEnum;
    public CreditKind?: CreditKindEnum;
    public PeriodIterationCount?: number;

    public constructor(init?: Partial<CreatePresetBehaviour>) { (Object as any).assign(this, init); }
}

TypeScript 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

{}