| Required role: | Admin |
"use strict";
export class QueryBase {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
skip;
/** @type {?number} */
take;
/** @type {?string} */
orderBy;
/** @type {?string} */
orderByDesc;
/** @type {?string} */
include;
/** @type {?string} */
fields;
/** @type {?{ [index:string]: string; }} */
meta;
}
/** @typedef T {any} */
export class QueryDb extends QueryBase {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef {'Product'|'PerDev'|'PerCore'|'Site'|'Support'|'Training'|'Register'|'Payment'} */
export var SkuType;
(function (SkuType) {
SkuType["Product"] = "Product"
SkuType["PerDev"] = "PerDev"
SkuType["PerCore"] = "PerCore"
SkuType["Site"] = "Site"
SkuType["Support"] = "Support"
SkuType["Training"] = "Training"
SkuType["Register"] = "Register"
SkuType["Payment"] = "Payment"
})(SkuType || (SkuType = {}));
/** @typedef {number} */
export var LicenseFeature;
(function (LicenseFeature) {
LicenseFeature[LicenseFeature["None"] = 0] = "None"
LicenseFeature[LicenseFeature["Free"] = 0] = "Free"
LicenseFeature[LicenseFeature["Premium"] = 1] = "Premium"
LicenseFeature[LicenseFeature["Text"] = 2] = "Text"
LicenseFeature[LicenseFeature["Client"] = 4] = "Client"
LicenseFeature[LicenseFeature["Common"] = 8] = "Common"
LicenseFeature[LicenseFeature["Redis"] = 16] = "Redis"
LicenseFeature[LicenseFeature["RedisSku"] = 18] = "RedisSku"
LicenseFeature[LicenseFeature["OrmLite"] = 32] = "OrmLite"
LicenseFeature[LicenseFeature["OrmLiteSku"] = 34] = "OrmLiteSku"
LicenseFeature[LicenseFeature["ServiceStack"] = 64] = "ServiceStack"
LicenseFeature[LicenseFeature["Server"] = 128] = "Server"
LicenseFeature[LicenseFeature["Razor"] = 256] = "Razor"
LicenseFeature[LicenseFeature["Admin"] = 512] = "Admin"
LicenseFeature[LicenseFeature["Aws"] = 1024] = "Aws"
LicenseFeature[LicenseFeature["AwsSku"] = 1026] = "AwsSku"
LicenseFeature[LicenseFeature["All"] = 2047] = "All"
})(LicenseFeature || (LicenseFeature = {}));
/** @typedef {'Free'|'FreeIndividual'|'FreeOpenSource'|'Indie'|'Business'|'Enterprise'|'TextIndie'|'TextBusiness'|'OrmLiteIndie'|'OrmLiteBusiness'|'RedisIndie'|'RedisBusiness'|'AwsIndie'|'AwsBusiness'|'Trial'|'Site'|'TextSite'|'RedisSite'|'OrmLiteSite'} */
export var LicenseType;
(function (LicenseType) {
LicenseType["Free"] = "Free"
LicenseType["FreeIndividual"] = "FreeIndividual"
LicenseType["FreeOpenSource"] = "FreeOpenSource"
LicenseType["Indie"] = "Indie"
LicenseType["Business"] = "Business"
LicenseType["Enterprise"] = "Enterprise"
LicenseType["TextIndie"] = "TextIndie"
LicenseType["TextBusiness"] = "TextBusiness"
LicenseType["OrmLiteIndie"] = "OrmLiteIndie"
LicenseType["OrmLiteBusiness"] = "OrmLiteBusiness"
LicenseType["RedisIndie"] = "RedisIndie"
LicenseType["RedisBusiness"] = "RedisBusiness"
LicenseType["AwsIndie"] = "AwsIndie"
LicenseType["AwsBusiness"] = "AwsBusiness"
LicenseType["Trial"] = "Trial"
LicenseType["Site"] = "Site"
LicenseType["TextSite"] = "TextSite"
LicenseType["RedisSite"] = "RedisSite"
LicenseType["OrmLiteSite"] = "OrmLiteSite"
})(LicenseType || (LicenseType = {}));
export class Sku {
/** @param {{id?:number,productId?:number,type?:SkuType,feature?:LicenseFeature,code?:string,name?:string,notes?:string,minQty?:number,maxQty?:number,price?:number,plan?:string,discountOff?:number,discountLabelOff?:string,actualPrice?:number,isPlan?:boolean,isRenewal?:boolean,subscriptionDurationDays?:number,expiryDurationDays?:number,trialPeriodDays?:number,supportQty?:number,coresQty?:number,createdDate?:string,modifiedDate?:string,licenseType?:LicenseType,active?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
productId;
/** @type {SkuType} */
type;
/** @type {LicenseFeature} */
feature;
/** @type {string} */
code;
/** @type {string} */
name;
/** @type {string} */
notes;
/** @type {?number} */
minQty;
/** @type {?number} */
maxQty;
/** @type {number} */
price;
/** @type {string} */
plan;
/** @type {number} */
discountOff;
/** @type {string} */
discountLabelOff;
/** @type {number} */
actualPrice;
/** @type {boolean} */
isPlan;
/** @type {boolean} */
isRenewal;
/** @type {?number} */
subscriptionDurationDays;
/** @type {?number} */
expiryDurationDays;
/** @type {?number} */
trialPeriodDays;
/** @type {number} */
supportQty;
/** @type {?number} */
coresQty;
/** @type {string} */
createdDate;
/** @type {string} */
modifiedDate;
/** @type {LicenseType} */
licenseType;
/** @type {boolean} */
active;
}
export class Product {
/** @param {{id?:number,name?:string,createdDate?:string,modifiedDate?:string,skus?:Sku[],active?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
name;
/** @type {string} */
createdDate;
/** @type {string} */
modifiedDate;
/** @type {Sku[]} */
skus;
/** @type {boolean} */
active;
}
export class QueryProducts extends QueryDb {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class OrderDetail {
/** @param {{id?:number,orderId?:number,skuId?:number,skuType?:SkuType,price?:number,description?:string,quantity?:number,total?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
orderId;
/** @type {number} */
skuId;
/** @type {SkuType} */
skuType;
/** @type {number} */
price;
/** @type {string} */
description;
/** @type {number} */
quantity;
/** @type {number} */
total;
}
export class Order {
/** @param {{id?:number,customerId?:number,productName?:string,firstName?:string,lastName?:string,email?:string,company?:string,phoneNumber?:string,addressLine1?:string,addressLine2?:string,addressCity?:string,addressZip?:string,addressState?:string,addressCountry?:string,agreeTerms?:boolean,notes?:string,last4?:string,subTotal?:number,couponId?:string,discount?:number,tax?:number,total?:number,itemQuantity?:number,authorizedQuantity?:number,subscriptionId?:number,licenseRef?:string,paymentId?:number,emailId?:number,paid?:boolean,createdDate?:string,modifiedDate?:string,modifiedBy?:string,cancelledDate?:string,cancelledReason?:string,ipAddress?:string,orderDetails?:OrderDetail[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
customerId;
/** @type {string} */
productName;
/** @type {string} */
firstName;
/** @type {string} */
lastName;
/** @type {string} */
email;
/** @type {string} */
company;
/** @type {string} */
phoneNumber;
/** @type {string} */
addressLine1;
/** @type {string} */
addressLine2;
/** @type {string} */
addressCity;
/** @type {string} */
addressZip;
/** @type {string} */
addressState;
/** @type {string} */
addressCountry;
/** @type {boolean} */
agreeTerms;
/** @type {string} */
notes;
/** @type {string} */
last4;
/** @type {number} */
subTotal;
/** @type {string} */
couponId;
/** @type {number} */
discount;
/** @type {number} */
tax;
/** @type {number} */
total;
/** @type {number} */
itemQuantity;
/** @type {?number} */
authorizedQuantity;
/** @type {?number} */
subscriptionId;
/** @type {string} */
licenseRef;
/** @type {?number} */
paymentId;
/** @type {?number} */
emailId;
/** @type {boolean} */
paid;
/** @type {string} */
createdDate;
/** @type {string} */
modifiedDate;
/** @type {string} */
modifiedBy;
/** @type {?string} */
cancelledDate;
/** @type {string} */
cancelledReason;
/** @type {string} */
ipAddress;
/** @type {OrderDetail[]} */
orderDetails;
}
export class LicenseKey {
/** @param {{ref?:string,name?:string,type?:LicenseType,meta?:number,hash?:string,halg?:string,expiry?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ref;
/** @type {string} */
name;
/** @type {LicenseType} */
type;
/** @type {number} */
meta;
/** @type {string} */
hash;
/** @type {string} */
halg;
/** @type {string} */
expiry;
}
export class Subscription {
/** @param {{id?:number,customerId?:number,email?:string,skuId?:number,skuName?:string,skuType?:SkuType,code?:string,quantity?:number,supportQuantity?:number,total?:number,isPlan?:boolean,isRenewal?:boolean,subscriptionDurationDays?:number,renewalDate?:string,licenseRef?:string,licenseName?:string,licenseAddress?:string,licenseType?:LicenseType,expiryDate?:string,licenseKey?:LicenseKey,licenseKeyText?:string,createdDate?:string,modifiedDate?:string,cancelledDate?:string,stripeSubscriptionId?:string,emailId?:number,emailRenewalId?:number,emailExpiredId?:number,renewalSubscriptionId?:number,externalRef?:string,notes?:string,error?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {number} */
customerId;
/** @type {string} */
email;
/** @type {number} */
skuId;
/** @type {string} */
skuName;
/** @type {SkuType} */
skuType;
/** @type {string} */
code;
/** @type {number} */
quantity;
/** @type {number} */
supportQuantity;
/** @type {number} */
total;
/** @type {boolean} */
isPlan;
/** @type {boolean} */
isRenewal;
/** @type {number} */
subscriptionDurationDays;
/** @type {?string} */
renewalDate;
/** @type {string} */
licenseRef;
/** @type {string} */
licenseName;
/** @type {string} */
licenseAddress;
/** @type {LicenseType} */
licenseType;
/** @type {string} */
expiryDate;
/** @type {LicenseKey} */
licenseKey;
/** @type {string} */
licenseKeyText;
/** @type {string} */
createdDate;
/** @type {string} */
modifiedDate;
/** @type {?string} */
cancelledDate;
/** @type {string} */
stripeSubscriptionId;
/** @type {?number} */
emailId;
/** @type {?number} */
emailRenewalId;
/** @type {?number} */
emailExpiredId;
/** @type {?number} */
renewalSubscriptionId;
/** @type {string} */
externalRef;
/** @type {string} */
notes;
/** @type {string} */
error;
}
export class Customer {
/** @param {{id?:number,email?:string,displayName?:string,firstName?:string,lastName?:string,company?:string,phoneNumber?:string,addressLine1?:string,addressLine2?:string,addressCity?:string,addressZip?:string,addressState?:string,addressCountry?:string,stripeCustomerId?:string,stripeCouponId?:string,plan?:string,createdDate?:string,isReferrer?:boolean,orders?:Order[],subscriptions?:Subscription[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
email;
/** @type {string} */
displayName;
/** @type {string} */
firstName;
/** @type {string} */
lastName;
/** @type {string} */
company;
/** @type {string} */
phoneNumber;
/** @type {string} */
addressLine1;
/** @type {string} */
addressLine2;
/** @type {string} */
addressCity;
/** @type {string} */
addressZip;
/** @type {string} */
addressState;
/** @type {string} */
addressCountry;
/** @type {string} */
stripeCustomerId;
/** @type {string} */
stripeCouponId;
/** @type {string} */
plan;
/** @type {string} */
createdDate;
/** @type {boolean} */
isReferrer;
/** @type {Order[]} */
orders;
/** @type {Subscription[]} */
subscriptions;
}
/** @typedef T {any} */
export class QueryResponse {
/** @param {{offset?:number,total?:number,results?:T[],meta?:{ [index:string]: string; },responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
offset;
/** @type {number} */
total;
/** @type {T[]} */
results = [];
/** @type {?{ [index:string]: string; }} */
meta;
/** @type {?ResponseStatus} */
responseStatus;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/QueryProducts HTTP/1.1
Host: account.servicestack.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<QueryProducts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceInterface">
<Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
<Take xmlns="http://schemas.servicestack.net/types">0</Take>
<OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
<OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
<Include xmlns="http://schemas.servicestack.net/types">String</Include>
<Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
</QueryProducts>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfProducttlJ4_P31p xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
<d2p1:Product>
<d2p1:Active>false</d2p1:Active>
<d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
<d2p1:Id>0</d2p1:Id>
<d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
<d2p1:Name>String</d2p1:Name>
<d2p1:Skus>
<d2p1:Sku>
<d2p1:Active>false</d2p1:Active>
<d2p1:Code>String</d2p1:Code>
<d2p1:CoresQty>0</d2p1:CoresQty>
<d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
<d2p1:DiscountLabelOff>String</d2p1:DiscountLabelOff>
<d2p1:DiscountOff>0</d2p1:DiscountOff>
<d2p1:ExpiryDurationDays>0</d2p1:ExpiryDurationDays>
<d2p1:Feature>None</d2p1:Feature>
<d2p1:Id>0</d2p1:Id>
<d2p1:IsPlan>false</d2p1:IsPlan>
<d2p1:IsRenewal>false</d2p1:IsRenewal>
<d2p1:LicenseType>Free</d2p1:LicenseType>
<d2p1:MaxQty>0</d2p1:MaxQty>
<d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
<d2p1:Name>String</d2p1:Name>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:Plan>String</d2p1:Plan>
<d2p1:Price>0</d2p1:Price>
<d2p1:ProductId>0</d2p1:ProductId>
<d2p1:SubscriptionDurationDays>0</d2p1:SubscriptionDurationDays>
<d2p1:SupportQty>0</d2p1:SupportQty>
<d2p1:TrialPeriodDays>0</d2p1:TrialPeriodDays>
<d2p1:Type>Product</d2p1:Type>
</d2p1:Sku>
</d2p1:Skus>
</d2p1:Product>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</QueryResponseOfProducttlJ4_P31p>