Required role: | Admin |
POST | /CreateCustomer |
---|
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
class SkuType(str, Enum):
PRODUCT = 'Product'
PER_DEV = 'PerDev'
PER_CORE = 'PerCore'
SITE = 'Site'
SUPPORT = 'Support'
TRAINING = 'Training'
REGISTER = 'Register'
PAYMENT = 'Payment'
@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
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 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
# @ValidateRequest(Validator="IsAdmin")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateCustomer(IPost):
first_name: Optional[str] = None
last_name: Optional[str] = None
email: Optional[str] = None
password: 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
created_date: Optional[datetime.datetime] = None
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 /CreateCustomer HTTP/1.1
Host: account.servicestack.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
<AddressCity>String</AddressCity>
<AddressCountry>String</AddressCountry>
<AddressLine1>String</AddressLine1>
<AddressLine2>String</AddressLine2>
<AddressState>String</AddressState>
<AddressZip>String</AddressZip>
<Company>String</Company>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<Email>String</Email>
<FirstName>String</FirstName>
<LastName>String</LastName>
<Password>String</Password>
<PhoneNumber>String</PhoneNumber>
</CreateCustomer>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <Customer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel"> <AddressCity>String</AddressCity> <AddressCountry>String</AddressCountry> <AddressLine1>String</AddressLine1> <AddressLine2>String</AddressLine2> <AddressState>String</AddressState> <AddressZip>String</AddressZip> <Company>String</Company> <CreatedDate>0001-01-01T00:00:00</CreatedDate> <DisplayName>String</DisplayName> <Email>String</Email> <FirstName>String</FirstName> <Id>0</Id> <IsReferrer>false</IsReferrer> <LastName>String</LastName> <Orders> <Order> <AddressCity>String</AddressCity> <AddressCountry>String</AddressCountry> <AddressLine1>String</AddressLine1> <AddressLine2>String</AddressLine2> <AddressState>String</AddressState> <AddressZip>String</AddressZip> <AgreeTerms>false</AgreeTerms> <AuthorizedQuantity>0</AuthorizedQuantity> <CancelledDate>0001-01-01T00:00:00</CancelledDate> <CancelledReason>String</CancelledReason> <Company>String</Company> <CouponId>String</CouponId> <CreatedDate>0001-01-01T00:00:00</CreatedDate> <CustomerId>0</CustomerId> <Discount>0</Discount> <Email>String</Email> <EmailId>0</EmailId> <FirstName>String</FirstName> <Id>0</Id> <IpAddress>String</IpAddress> <ItemQuantity>0</ItemQuantity> <Last4>String</Last4> <LastName>String</LastName> <LicenseRef>String</LicenseRef> <ModifiedBy>String</ModifiedBy> <ModifiedDate>0001-01-01T00:00:00</ModifiedDate> <Notes>String</Notes> <OrderDetails> <OrderDetail> <Description>String</Description> <Id>0</Id> <OrderId>0</OrderId> <Price>0</Price> <Quantity>0</Quantity> <SkuId>0</SkuId> <SkuType>Product</SkuType> <Total>0</Total> </OrderDetail> </OrderDetails> <Paid>false</Paid> <PaymentId>0</PaymentId> <PhoneNumber>String</PhoneNumber> <ProductName>String</ProductName> <SubTotal>0</SubTotal> <SubscriptionId>0</SubscriptionId> <Tax>0</Tax> <Total>0</Total> </Order> </Orders> <PhoneNumber>String</PhoneNumber> <Plan>String</Plan> <StripeCouponId>String</StripeCouponId> <StripeCustomerId>String</StripeCustomerId> <Subscriptions> <Subscription> <CancelledDate>0001-01-01T00:00:00</CancelledDate> <Code>String</Code> <CreatedDate>0001-01-01T00:00:00</CreatedDate> <CustomerId>0</CustomerId> <Email>String</Email> <EmailExpiredId>0</EmailExpiredId> <EmailId>0</EmailId> <EmailRenewalId>0</EmailRenewalId> <Error>String</Error> <ExpiryDate>0001-01-01T00:00:00</ExpiryDate> <ExternalRef>String</ExternalRef> <Id>0</Id> <IsPlan>false</IsPlan> <IsRenewal>false</IsRenewal> <LicenseAddress>String</LicenseAddress> <LicenseKey xmlns:d4p1="http://schemas.datacontract.org/2004/07/ServiceStack"> <d4p1:Expiry>0001-01-01T00:00:00</d4p1:Expiry> <d4p1:Halg>String</d4p1:Halg> <d4p1:Hash>String</d4p1:Hash> <d4p1:Meta>0</d4p1:Meta> <d4p1:Name>String</d4p1:Name> <d4p1:Ref>String</d4p1:Ref> <d4p1:Type>Free</d4p1:Type> </LicenseKey> <LicenseKeyText>String</LicenseKeyText> <LicenseName>String</LicenseName> <LicenseRef>String</LicenseRef> <LicenseType>Free</LicenseType> <ModifiedDate>0001-01-01T00:00:00</ModifiedDate> <Notes>String</Notes> <Quantity>0</Quantity> <RenewalDate>0001-01-01T00:00:00</RenewalDate> <RenewalSubscriptionId>0</RenewalSubscriptionId> <SkuId>0</SkuId> <SkuName>String</SkuName> <SkuType>Product</SkuType> <StripeSubscriptionId>String</StripeSubscriptionId> <SubscriptionDurationDays>0</SubscriptionDurationDays> <SupportQuantity>0</SupportQuantity> <Total>0</Total> </Subscription> </Subscriptions> </Customer>