| Required role: | Admin |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBase:
skip: Optional[int] = None
take: Optional[int] = None
order_by: Optional[str] = None
order_by_desc: Optional[str] = None
include: Optional[str] = None
fields: Optional[str] = None
meta: Optional[Dict[str, str]] = None
T = TypeVar('T')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
@staticmethod
def response_type(): return QueryResponse[T]
class SkuType(str, Enum):
PRODUCT = 'Product'
PER_DEV = 'PerDev'
PER_CORE = 'PerCore'
SITE = 'Site'
SUPPORT = 'Support'
TRAINING = 'Training'
REGISTER = 'Register'
PAYMENT = 'Payment'
# @Flags()
class LicenseFeature(IntEnum):
NONE = 0
FREE = 0
PREMIUM = 1
TEXT = 2
CLIENT = 4
COMMON = 8
REDIS = 16
REDIS_SKU = 18
ORM_LITE = 32
ORM_LITE_SKU = 34
SERVICE_STACK = 64
SERVER = 128
RAZOR = 256
ADMIN = 512
AWS = 1024
AWS_SKU = 1026
ALL = 2047
class LicenseType(str, Enum):
FREE = 'Free'
FREE_INDIVIDUAL = 'FreeIndividual'
FREE_OPEN_SOURCE = 'FreeOpenSource'
INDIE = 'Indie'
BUSINESS = 'Business'
ENTERPRISE = 'Enterprise'
TEXT_INDIE = 'TextIndie'
TEXT_BUSINESS = 'TextBusiness'
ORM_LITE_INDIE = 'OrmLiteIndie'
ORM_LITE_BUSINESS = 'OrmLiteBusiness'
REDIS_INDIE = 'RedisIndie'
REDIS_BUSINESS = 'RedisBusiness'
AWS_INDIE = 'AwsIndie'
AWS_BUSINESS = 'AwsBusiness'
TRIAL = 'Trial'
SITE = 'Site'
TEXT_SITE = 'TextSite'
REDIS_SITE = 'RedisSite'
ORM_LITE_SITE = 'OrmLiteSite'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Sku:
id: int = 0
product_id: int = 0
type: Optional[SkuType] = None
feature: Optional[LicenseFeature] = None
code: Optional[str] = None
name: Optional[str] = None
notes: Optional[str] = None
# @Ignore()
min_qty: Optional[int] = None
max_qty: Optional[int] = None
price: int = 0
plan: Optional[str] = None
discount_off: int = 0
discount_label_off: Optional[str] = None
actual_price: int = 0
is_plan: bool = False
is_renewal: bool = False
subscription_duration_days: Optional[int] = None
expiry_duration_days: Optional[int] = None
trial_period_days: Optional[int] = None
support_qty: int = 0
cores_qty: Optional[int] = None
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
license_type: Optional[LicenseType] = None
active: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Product:
id: int = 0
name: Optional[str] = None
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
skus: Optional[List[Sku]] = None
active: bool = False
# @ValidateRequest(Validator="IsAdmin")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryProducts(QueryDb[Product]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderDetail:
id: int = 0
order_id: int = 0
sku_id: int = 0
sku_type: Optional[SkuType] = None
price: int = 0
description: Optional[str] = None
quantity: int = 0
total: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Order(IAddress):
id: int = 0
customer_id: int = 0
product_name: Optional[str] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
email: Optional[str] = None
company: Optional[str] = None
phone_number: Optional[str] = None
address_line1: Optional[str] = None
address_line2: Optional[str] = None
address_city: Optional[str] = None
address_zip: Optional[str] = None
address_state: Optional[str] = None
address_country: Optional[str] = None
agree_terms: bool = False
notes: Optional[str] = None
last4: Optional[str] = None
sub_total: int = 0
coupon_id: Optional[str] = None
discount: int = 0
tax: int = 0
total: int = 0
item_quantity: int = 0
authorized_quantity: Optional[int] = None
subscription_id: Optional[int] = None
license_ref: Optional[str] = None
payment_id: Optional[int] = None
email_id: Optional[int] = None
paid: bool = False
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
modified_by: Optional[str] = None
cancelled_date: Optional[datetime.datetime] = None
cancelled_reason: Optional[str] = None
ip_address: Optional[str] = None
order_details: Optional[List[OrderDetail]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LicenseKey:
ref: Optional[str] = None
name: Optional[str] = None
type: Optional[LicenseType] = None
meta: int = 0
hash: Optional[str] = None
halg: Optional[str] = None
expiry: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Subscription:
id: int = 0
customer_id: int = 0
email: Optional[str] = None
sku_id: int = 0
sku_name: Optional[str] = None
sku_type: Optional[SkuType] = None
code: Optional[str] = None
quantity: int = 0
support_quantity: int = 0
total: int = 0
is_plan: bool = False
is_renewal: bool = False
subscription_duration_days: int = 0
renewal_date: Optional[datetime.datetime] = None
license_ref: Optional[str] = None
license_name: Optional[str] = None
license_address: Optional[str] = None
license_type: Optional[LicenseType] = None
expiry_date: datetime.datetime = datetime.datetime(1, 1, 1)
license_key: Optional[LicenseKey] = None
license_key_text: Optional[str] = None
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
cancelled_date: Optional[datetime.datetime] = None
stripe_subscription_id: Optional[str] = None
email_id: Optional[int] = None
email_renewal_id: Optional[int] = None
email_expired_id: Optional[int] = None
renewal_subscription_id: Optional[int] = None
external_ref: Optional[str] = None
notes: Optional[str] = None
error: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Customer(IAddress):
id: int = 0
email: Optional[str] = None
display_name: Optional[str] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
company: Optional[str] = None
phone_number: Optional[str] = None
address_line1: Optional[str] = None
address_line2: Optional[str] = None
address_city: Optional[str] = None
address_zip: Optional[str] = None
address_state: Optional[str] = None
address_country: Optional[str] = None
stripe_customer_id: Optional[str] = None
stripe_coupon_id: Optional[str] = None
plan: Optional[str] = None
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
is_referrer: bool = False
orders: Optional[List[Order]] = None
subscriptions: Optional[List[Subscription]] = None
T = TypeVar('T')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
offset: int = 0
total: int = 0
results: List[Customer] = field(default_factory=list)
meta: Optional[Dict[str, str]] = None
response_status: Optional[ResponseStatus] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/QueryProducts HTTP/1.1
Host: account.servicestack.net
Accept: application/json
Content-Type: application/json
Content-Length: length
{"skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"offset":0,"total":0,"results":[{"id":0,"name":"String","createdDate":"\/Date(-62135596800000-0000)\/","modifiedDate":"\/Date(-62135596800000-0000)\/","skus":[{"id":0,"productId":0,"type":"Product","feature":0,"code":"String","name":"String","notes":"String","maxQty":0,"price":0,"plan":"String","discountOff":0,"discountLabelOff":"String","actualPrice":0,"isPlan":false,"isRenewal":false,"subscriptionDurationDays":0,"expiryDurationDays":0,"trialPeriodDays":0,"supportQty":0,"coresQty":0,"createdDate":"\/Date(-62135596800000-0000)\/","modifiedDate":"\/Date(-62135596800000-0000)\/","licenseType":"Free","active":false}],"active":false}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}