ServiceStack Home (Live)

<back to all web services

Support

Requires Authentication
The following routes are available for this service:
All Verbs/account/support
All Verbs/Support
import 'package:servicestack/servicestack.dart';

class Support implements IConvertible
{
    String? section;

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

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

    Map<String, dynamic> toJson() => {
        'section': section
    };

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

enum SkuType
{
    Product,
    PerDev,
    PerCore,
    Site,
    Support,
    Training,
    Register,
    Payment,
}

enum LicenseType
{
    Free,
    FreeIndividual,
    FreeOpenSource,
    Indie,
    Business,
    Enterprise,
    TextIndie,
    TextBusiness,
    OrmLiteIndie,
    OrmLiteBusiness,
    RedisIndie,
    RedisBusiness,
    AwsIndie,
    AwsBusiness,
    Trial,
    Site,
    TextSite,
    RedisSite,
    OrmLiteSite,
}

class LicenseKey implements IConvertible
{
    String? ref;
    String? name;
    LicenseType? type;
    int? meta;
    String? hash;
    String? halg;
    DateTime? expiry;

    LicenseKey({this.ref,this.name,this.type,this.meta,this.hash,this.halg,this.expiry});
    LicenseKey.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ref = json['ref'];
        name = json['name'];
        type = JsonConverters.fromJson(json['type'],'LicenseType',context!);
        meta = json['meta'];
        hash = json['hash'];
        halg = json['halg'];
        expiry = JsonConverters.fromJson(json['expiry'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ref': ref,
        'name': name,
        'type': JsonConverters.toJson(type,'LicenseType',context!),
        'meta': meta,
        'hash': hash,
        'halg': halg,
        'expiry': JsonConverters.toJson(expiry,'DateTime',context!)
    };

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

class Subscription implements IConvertible
{
    int? id;
    int? customerId;
    String? email;
    int? skuId;
    String? skuName;
    SkuType? skuType;
    String? code;
    int? quantity;
    int? supportQuantity;
    int? total;
    bool? isPlan;
    bool? isRenewal;
    int? subscriptionDurationDays;
    DateTime? renewalDate;
    String? licenseRef;
    String? licenseName;
    String? licenseAddress;
    LicenseType? licenseType;
    DateTime? expiryDate;
    LicenseKey? licenseKey;
    String? licenseKeyText;
    DateTime? createdDate;
    DateTime? modifiedDate;
    DateTime? cancelledDate;
    String? stripeSubscriptionId;
    int? emailId;
    int? emailRenewalId;
    int? emailExpiredId;
    int? renewalSubscriptionId;
    String? externalRef;
    String? notes;
    String? error;

    Subscription({this.id,this.customerId,this.email,this.skuId,this.skuName,this.skuType,this.code,this.quantity,this.supportQuantity,this.total,this.isPlan,this.isRenewal,this.subscriptionDurationDays,this.renewalDate,this.licenseRef,this.licenseName,this.licenseAddress,this.licenseType,this.expiryDate,this.licenseKey,this.licenseKeyText,this.createdDate,this.modifiedDate,this.cancelledDate,this.stripeSubscriptionId,this.emailId,this.emailRenewalId,this.emailExpiredId,this.renewalSubscriptionId,this.externalRef,this.notes,this.error});
    Subscription.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        customerId = json['customerId'];
        email = json['email'];
        skuId = json['skuId'];
        skuName = json['skuName'];
        skuType = JsonConverters.fromJson(json['skuType'],'SkuType',context!);
        code = json['code'];
        quantity = json['quantity'];
        supportQuantity = json['supportQuantity'];
        total = json['total'];
        isPlan = json['isPlan'];
        isRenewal = json['isRenewal'];
        subscriptionDurationDays = json['subscriptionDurationDays'];
        renewalDate = JsonConverters.fromJson(json['renewalDate'],'DateTime',context!);
        licenseRef = json['licenseRef'];
        licenseName = json['licenseName'];
        licenseAddress = json['licenseAddress'];
        licenseType = JsonConverters.fromJson(json['licenseType'],'LicenseType',context!);
        expiryDate = JsonConverters.fromJson(json['expiryDate'],'DateTime',context!);
        licenseKey = JsonConverters.fromJson(json['licenseKey'],'LicenseKey',context!);
        licenseKeyText = json['licenseKeyText'];
        createdDate = JsonConverters.fromJson(json['createdDate'],'DateTime',context!);
        modifiedDate = JsonConverters.fromJson(json['modifiedDate'],'DateTime',context!);
        cancelledDate = JsonConverters.fromJson(json['cancelledDate'],'DateTime',context!);
        stripeSubscriptionId = json['stripeSubscriptionId'];
        emailId = json['emailId'];
        emailRenewalId = json['emailRenewalId'];
        emailExpiredId = json['emailExpiredId'];
        renewalSubscriptionId = json['renewalSubscriptionId'];
        externalRef = json['externalRef'];
        notes = json['notes'];
        error = json['error'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'customerId': customerId,
        'email': email,
        'skuId': skuId,
        'skuName': skuName,
        'skuType': JsonConverters.toJson(skuType,'SkuType',context!),
        'code': code,
        'quantity': quantity,
        'supportQuantity': supportQuantity,
        'total': total,
        'isPlan': isPlan,
        'isRenewal': isRenewal,
        'subscriptionDurationDays': subscriptionDurationDays,
        'renewalDate': JsonConverters.toJson(renewalDate,'DateTime',context!),
        'licenseRef': licenseRef,
        'licenseName': licenseName,
        'licenseAddress': licenseAddress,
        'licenseType': JsonConverters.toJson(licenseType,'LicenseType',context!),
        'expiryDate': JsonConverters.toJson(expiryDate,'DateTime',context!),
        'licenseKey': JsonConverters.toJson(licenseKey,'LicenseKey',context!),
        'licenseKeyText': licenseKeyText,
        'createdDate': JsonConverters.toJson(createdDate,'DateTime',context!),
        'modifiedDate': JsonConverters.toJson(modifiedDate,'DateTime',context!),
        'cancelledDate': JsonConverters.toJson(cancelledDate,'DateTime',context!),
        'stripeSubscriptionId': stripeSubscriptionId,
        'emailId': emailId,
        'emailRenewalId': emailRenewalId,
        'emailExpiredId': emailExpiredId,
        'renewalSubscriptionId': renewalSubscriptionId,
        'externalRef': externalRef,
        'notes': notes,
        'error': error
    };

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

class SupportContact implements IConvertible
{
    int? id;
    int? customerId;
    String? name;
    String? email;
    String? gitHub;

    SupportContact({this.id,this.customerId,this.name,this.email,this.gitHub});
    SupportContact.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        customerId = json['customerId'];
        name = json['name'];
        email = json['email'];
        gitHub = json['gitHub'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'customerId': customerId,
        'name': name,
        'email': email,
        'gitHub': gitHub
    };

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

class SupportResponse implements IConvertible
{
    Subscription? activeSubscription;
    String? section;
    int? maxQuantity;
    int? supportQuantity;
    String? skuType;
    List<SupportContact>? supportContacts;
    ResponseStatus? responseStatus;

    SupportResponse({this.activeSubscription,this.section,this.maxQuantity,this.supportQuantity,this.skuType,this.supportContacts,this.responseStatus});
    SupportResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        activeSubscription = JsonConverters.fromJson(json['activeSubscription'],'Subscription',context!);
        section = json['section'];
        maxQuantity = json['maxQuantity'];
        supportQuantity = json['supportQuantity'];
        skuType = json['skuType'];
        supportContacts = JsonConverters.fromJson(json['supportContacts'],'List<SupportContact>',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'activeSubscription': JsonConverters.toJson(activeSubscription,'Subscription',context!),
        'section': section,
        'maxQuantity': maxQuantity,
        'supportQuantity': supportQuantity,
        'skuType': skuType,
        'supportContacts': JsonConverters.toJson(supportContacts,'List<SupportContact>',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

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

TypeContext _ctx = TypeContext(library: 'account.servicestack.net', types: <String, TypeInfo> {
    'Support': TypeInfo(TypeOf.Class, create:() => Support()),
    'SkuType': TypeInfo(TypeOf.Enum, enumValues:SkuType.values),
    'LicenseType': TypeInfo(TypeOf.Enum, enumValues:LicenseType.values),
    'LicenseKey': TypeInfo(TypeOf.Class, create:() => LicenseKey()),
    'Subscription': TypeInfo(TypeOf.Class, create:() => Subscription()),
    'SupportContact': TypeInfo(TypeOf.Class, create:() => SupportContact()),
    'SupportResponse': TypeInfo(TypeOf.Class, create:() => SupportResponse()),
    'List<SupportContact>': TypeInfo(TypeOf.Class, create:() => <SupportContact>[]),
});

Dart Support 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.

POST /account/support HTTP/1.1 
Host: account.servicestack.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	section: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	activeSubscription: 
	{
		id: 0,
		customerId: 0,
		email: String,
		skuId: 0,
		skuName: String,
		skuType: Product,
		code: String,
		quantity: 0,
		supportQuantity: 0,
		total: 0,
		isPlan: False,
		isRenewal: False,
		subscriptionDurationDays: 0,
		renewalDate: 0001-01-01,
		licenseRef: String,
		licenseName: String,
		licenseAddress: String,
		licenseType: Free,
		expiryDate: 0001-01-01,
		licenseKey: 
		{
			ref: String,
			name: String,
			type: Free,
			meta: 0,
			hash: String,
			halg: String,
			expiry: 0001-01-01
		},
		licenseKeyText: String,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		cancelledDate: 0001-01-01,
		stripeSubscriptionId: String,
		emailId: 0,
		emailRenewalId: 0,
		emailExpiredId: 0,
		renewalSubscriptionId: 0,
		externalRef: String,
		notes: String,
		error: String
	},
	section: String,
	maxQuantity: 0,
	supportQuantity: 0,
	skuType: String,
	supportContacts: 
	[
		{
			id: 0,
			customerId: 0,
			name: String,
			email: String,
			gitHub: String
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}