Billhighway Cloud API

<back to all web services

CacheItemDeleteRq

The following routes are available for this service:
DELETE/devops/api/caches/{location}/regions/{region}/keys/{basekey}
import 'package:servicestack/servicestack.dart';

// @Flags()
class CacheResult
{
    static const CacheResult None = const CacheResult._(0);
    static const CacheResult Miss = const CacheResult._(1);
    static const CacheResult Hit = const CacheResult._(2);
    static const CacheResult Put = const CacheResult._(4);
    static const CacheResult Deleted = const CacheResult._(8);
    static const CacheResult Cleared = const CacheResult._(16);
    static const CacheResult Added = const CacheResult._(32);
    static const CacheResult Updated = const CacheResult._(64);
    static const CacheResult Unavailable = const CacheResult._(128);
    static const CacheResult Expired = const CacheResult._(256);

    final int _value;
    const CacheResult._(this._value);
    int get value => _value;
    static List<CacheResult> get values => const [None,Miss,Hit,Put,Deleted,Cleared,Added,Updated,Unavailable,Expired];
}

class CacheLocation
{
    static const CacheLocation None = const CacheLocation._(0);
    static const CacheLocation OutOfProcess = const CacheLocation._(1);
    static const CacheLocation InProcess = const CacheLocation._(2);
    static const CacheLocation InContext = const CacheLocation._(3);

    final int _value;
    const CacheLocation._(this._value);
    int get value => _value;
    static List<CacheLocation> get values => const [None,OutOfProcess,InProcess,InContext];
}

class CacheKey implements IConvertible
{
    String? Region;
    String? BaseKey;
    String? Key;
    int? ExpirationSeconds;

    CacheKey({this.Region,this.BaseKey,this.Key,this.ExpirationSeconds});
    CacheKey.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Region = json['Region'];
        BaseKey = json['BaseKey'];
        Key = json['Key'];
        ExpirationSeconds = json['ExpirationSeconds'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Region': Region,
        'BaseKey': BaseKey,
        'Key': Key,
        'ExpirationSeconds': ExpirationSeconds
    };

    getTypeName() => "CacheKey";
    TypeContext? context = _ctx;
}

abstract class CacheResultBase
{
    CacheResult? Result;
    CacheLocation? Location;
    CacheKey? Key;

    CacheResultBase({this.Result,this.Location,this.Key});
    CacheResultBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Result = JsonConverters.fromJson(json['Result'],'CacheResult',context!);
        Location = JsonConverters.fromJson(json['Location'],'CacheLocation',context!);
        Key = JsonConverters.fromJson(json['Key'],'CacheKey',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Result': JsonConverters.toJson(Result,'CacheResult',context!),
        'Location': JsonConverters.toJson(Location,'CacheLocation',context!),
        'Key': JsonConverters.toJson(Key,'CacheKey',context!)
    };

    getTypeName() => "CacheResultBase";
    TypeContext? context = _ctx;
}

class CacheDeleteResult extends CacheResultBase implements IConvertible
{
    bool? IsDeleted;

    CacheDeleteResult({this.IsDeleted});
    CacheDeleteResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        IsDeleted = json['IsDeleted'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'IsDeleted': IsDeleted
    });

    getTypeName() => "CacheDeleteResult";
    TypeContext? context = _ctx;
}

class CacheItemDeleteRs implements IConvertible
{
    CacheDeleteResult? Result;

    CacheItemDeleteRs({this.Result});
    CacheItemDeleteRs.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Result = JsonConverters.fromJson(json['Result'],'CacheDeleteResult',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Result': JsonConverters.toJson(Result,'CacheDeleteResult',context!)
    };

    getTypeName() => "CacheItemDeleteRs";
    TypeContext? context = _ctx;
}

class CacheItemDeleteRq implements IConvertible
{
    String? location;
    String? region;
    String? baseKey;

    CacheItemDeleteRq({this.location,this.region,this.baseKey});
    CacheItemDeleteRq.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        location = json['location'];
        region = json['region'];
        baseKey = json['baseKey'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'location': location,
        'region': region,
        'baseKey': baseKey
    };

    getTypeName() => "CacheItemDeleteRq";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'CacheResult': TypeInfo(TypeOf.Enum, enumValues:CacheResult.values),
    'CacheLocation': TypeInfo(TypeOf.Enum, enumValues:CacheLocation.values),
    'CacheKey': TypeInfo(TypeOf.Class, create:() => CacheKey()),
    'CacheResultBase': TypeInfo(TypeOf.AbstractClass),
    'CacheDeleteResult': TypeInfo(TypeOf.Class, create:() => CacheDeleteResult()),
    'CacheItemDeleteRs': TypeInfo(TypeOf.Class, create:() => CacheItemDeleteRs()),
    'CacheItemDeleteRq': TypeInfo(TypeOf.Class, create:() => CacheItemDeleteRq()),
});

Dart CacheItemDeleteRq DTOs

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

HTTP + JSV

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

DELETE /devops/api/caches/{location}/regions/{region}/keys/{basekey} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Result: 
	{
		IsDeleted: False,
		Result: 0,
		Location: 0
	}
}