| GET | /subscriptions/activate/{ExternalRef} | ||
|---|---|---|---|
| POST | /subscriptions/activate | ||
| GET POST | /ActivateSubscription |
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class ActivateSubscription implements IPost, JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $externalRef=null,
/** @var string|null */
public ?string $userAuthId=null,
/** @var bool|null */
public ?bool $agreeTerms=null,
/** @var string|null */
public ?string $firstName=null,
/** @var string|null */
public ?string $lastName=null,
/** @var string|null */
public ?string $email=null,
/** @var string|null */
public ?string $password=null,
/** @var string|null */
public ?string $company=null,
/** @var string|null */
public ?string $phoneNumber=null,
/** @var string|null */
public ?string $addressLine1=null,
/** @var string|null */
public ?string $addressLine2=null,
/** @var string|null */
public ?string $addressCity=null,
/** @var string|null */
public ?string $addressZip=null,
/** @var string|null */
public ?string $addressState=null,
/** @var string|null */
public ?string $addressCountry=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['externalRef'])) $this->externalRef = $o['externalRef'];
if (isset($o['userAuthId'])) $this->userAuthId = $o['userAuthId'];
if (isset($o['agreeTerms'])) $this->agreeTerms = $o['agreeTerms'];
if (isset($o['firstName'])) $this->firstName = $o['firstName'];
if (isset($o['lastName'])) $this->lastName = $o['lastName'];
if (isset($o['email'])) $this->email = $o['email'];
if (isset($o['password'])) $this->password = $o['password'];
if (isset($o['company'])) $this->company = $o['company'];
if (isset($o['phoneNumber'])) $this->phoneNumber = $o['phoneNumber'];
if (isset($o['addressLine1'])) $this->addressLine1 = $o['addressLine1'];
if (isset($o['addressLine2'])) $this->addressLine2 = $o['addressLine2'];
if (isset($o['addressCity'])) $this->addressCity = $o['addressCity'];
if (isset($o['addressZip'])) $this->addressZip = $o['addressZip'];
if (isset($o['addressState'])) $this->addressState = $o['addressState'];
if (isset($o['addressCountry'])) $this->addressCountry = $o['addressCountry'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->externalRef)) $o['externalRef'] = $this->externalRef;
if (isset($this->userAuthId)) $o['userAuthId'] = $this->userAuthId;
if (isset($this->agreeTerms)) $o['agreeTerms'] = $this->agreeTerms;
if (isset($this->firstName)) $o['firstName'] = $this->firstName;
if (isset($this->lastName)) $o['lastName'] = $this->lastName;
if (isset($this->email)) $o['email'] = $this->email;
if (isset($this->password)) $o['password'] = $this->password;
if (isset($this->company)) $o['company'] = $this->company;
if (isset($this->phoneNumber)) $o['phoneNumber'] = $this->phoneNumber;
if (isset($this->addressLine1)) $o['addressLine1'] = $this->addressLine1;
if (isset($this->addressLine2)) $o['addressLine2'] = $this->addressLine2;
if (isset($this->addressCity)) $o['addressCity'] = $this->addressCity;
if (isset($this->addressZip)) $o['addressZip'] = $this->addressZip;
if (isset($this->addressState)) $o['addressState'] = $this->addressState;
if (isset($this->addressCountry)) $o['addressCountry'] = $this->addressCountry;
return empty($o) ? new class(){} : $o;
}
}
enum SkuType : string
{
case Product = 'Product';
case PerDev = 'PerDev';
case PerCore = 'PerCore';
case Site = 'Site';
case Support = 'Support';
case Training = 'Training';
case Register = 'Register';
case Payment = 'Payment';
}
enum LicenseType : string
{
case Free = 'Free';
case FreeIndividual = 'FreeIndividual';
case FreeOpenSource = 'FreeOpenSource';
case Indie = 'Indie';
case Business = 'Business';
case Enterprise = 'Enterprise';
case TextIndie = 'TextIndie';
case TextBusiness = 'TextBusiness';
case OrmLiteIndie = 'OrmLiteIndie';
case OrmLiteBusiness = 'OrmLiteBusiness';
case RedisIndie = 'RedisIndie';
case RedisBusiness = 'RedisBusiness';
case AwsIndie = 'AwsIndie';
case AwsBusiness = 'AwsBusiness';
case Trial = 'Trial';
case Site = 'Site';
case TextSite = 'TextSite';
case RedisSite = 'RedisSite';
case OrmLiteSite = 'OrmLiteSite';
}
class LicenseKey implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $ref=null,
/** @var string|null */
public ?string $name=null,
/** @var LicenseType|null */
public ?LicenseType $type=null,
/** @var int */
public int $meta=0,
/** @var string|null */
public ?string $hash=null,
/** @var string|null */
public ?string $halg=null,
/** @var DateTime */
public DateTime $expiry=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ref'])) $this->ref = $o['ref'];
if (isset($o['name'])) $this->name = $o['name'];
if (isset($o['type'])) $this->type = JsonConverters::from('LicenseType', $o['type']);
if (isset($o['meta'])) $this->meta = $o['meta'];
if (isset($o['hash'])) $this->hash = $o['hash'];
if (isset($o['halg'])) $this->halg = $o['halg'];
if (isset($o['expiry'])) $this->expiry = JsonConverters::from('DateTime', $o['expiry']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ref)) $o['ref'] = $this->ref;
if (isset($this->name)) $o['name'] = $this->name;
if (isset($this->type)) $o['type'] = JsonConverters::to('LicenseType', $this->type);
if (isset($this->meta)) $o['meta'] = $this->meta;
if (isset($this->hash)) $o['hash'] = $this->hash;
if (isset($this->halg)) $o['halg'] = $this->halg;
if (isset($this->expiry)) $o['expiry'] = JsonConverters::to('DateTime', $this->expiry);
return empty($o) ? new class(){} : $o;
}
}
class Subscription implements JsonSerializable
{
public function __construct(
/** @var int */
public int $id=0,
/** @var int */
public int $customerId=0,
/** @var string|null */
public ?string $email=null,
/** @var int */
public int $skuId=0,
/** @var string|null */
public ?string $skuName=null,
/** @var SkuType|null */
public ?SkuType $skuType=null,
/** @var string|null */
public ?string $code=null,
/** @var int */
public int $quantity=0,
/** @var int */
public int $supportQuantity=0,
/** @var int */
public int $total=0,
/** @var bool|null */
public ?bool $isPlan=null,
/** @var bool|null */
public ?bool $isRenewal=null,
/** @var int */
public int $subscriptionDurationDays=0,
/** @var DateTime|null */
public ?DateTime $renewalDate=null,
/** @var string|null */
public ?string $licenseRef=null,
/** @var string|null */
public ?string $licenseName=null,
/** @var string|null */
public ?string $licenseAddress=null,
/** @var LicenseType|null */
public ?LicenseType $licenseType=null,
/** @var DateTime */
public DateTime $expiryDate=new DateTime(),
/** @var LicenseKey|null */
public ?LicenseKey $licenseKey=null,
/** @var string|null */
public ?string $licenseKeyText=null,
/** @var DateTime */
public DateTime $createdDate=new DateTime(),
/** @var DateTime */
public DateTime $modifiedDate=new DateTime(),
/** @var DateTime|null */
public ?DateTime $cancelledDate=null,
/** @var string|null */
public ?string $stripeSubscriptionId=null,
/** @var int|null */
public ?int $emailId=null,
/** @var int|null */
public ?int $emailRenewalId=null,
/** @var int|null */
public ?int $emailExpiredId=null,
/** @var int|null */
public ?int $renewalSubscriptionId=null,
/** @var string|null */
public ?string $externalRef=null,
/** @var string|null */
public ?string $notes=null,
/** @var string|null */
public ?string $error=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['customerId'])) $this->customerId = $o['customerId'];
if (isset($o['email'])) $this->email = $o['email'];
if (isset($o['skuId'])) $this->skuId = $o['skuId'];
if (isset($o['skuName'])) $this->skuName = $o['skuName'];
if (isset($o['skuType'])) $this->skuType = JsonConverters::from('SkuType', $o['skuType']);
if (isset($o['code'])) $this->code = $o['code'];
if (isset($o['quantity'])) $this->quantity = $o['quantity'];
if (isset($o['supportQuantity'])) $this->supportQuantity = $o['supportQuantity'];
if (isset($o['total'])) $this->total = $o['total'];
if (isset($o['isPlan'])) $this->isPlan = $o['isPlan'];
if (isset($o['isRenewal'])) $this->isRenewal = $o['isRenewal'];
if (isset($o['subscriptionDurationDays'])) $this->subscriptionDurationDays = $o['subscriptionDurationDays'];
if (isset($o['renewalDate'])) $this->renewalDate = JsonConverters::from('DateTime', $o['renewalDate']);
if (isset($o['licenseRef'])) $this->licenseRef = $o['licenseRef'];
if (isset($o['licenseName'])) $this->licenseName = $o['licenseName'];
if (isset($o['licenseAddress'])) $this->licenseAddress = $o['licenseAddress'];
if (isset($o['licenseType'])) $this->licenseType = JsonConverters::from('LicenseType', $o['licenseType']);
if (isset($o['expiryDate'])) $this->expiryDate = JsonConverters::from('DateTime', $o['expiryDate']);
if (isset($o['licenseKey'])) $this->licenseKey = JsonConverters::from('LicenseKey', $o['licenseKey']);
if (isset($o['licenseKeyText'])) $this->licenseKeyText = $o['licenseKeyText'];
if (isset($o['createdDate'])) $this->createdDate = JsonConverters::from('DateTime', $o['createdDate']);
if (isset($o['modifiedDate'])) $this->modifiedDate = JsonConverters::from('DateTime', $o['modifiedDate']);
if (isset($o['cancelledDate'])) $this->cancelledDate = JsonConverters::from('DateTime', $o['cancelledDate']);
if (isset($o['stripeSubscriptionId'])) $this->stripeSubscriptionId = $o['stripeSubscriptionId'];
if (isset($o['emailId'])) $this->emailId = $o['emailId'];
if (isset($o['emailRenewalId'])) $this->emailRenewalId = $o['emailRenewalId'];
if (isset($o['emailExpiredId'])) $this->emailExpiredId = $o['emailExpiredId'];
if (isset($o['renewalSubscriptionId'])) $this->renewalSubscriptionId = $o['renewalSubscriptionId'];
if (isset($o['externalRef'])) $this->externalRef = $o['externalRef'];
if (isset($o['notes'])) $this->notes = $o['notes'];
if (isset($o['error'])) $this->error = $o['error'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->customerId)) $o['customerId'] = $this->customerId;
if (isset($this->email)) $o['email'] = $this->email;
if (isset($this->skuId)) $o['skuId'] = $this->skuId;
if (isset($this->skuName)) $o['skuName'] = $this->skuName;
if (isset($this->skuType)) $o['skuType'] = JsonConverters::to('SkuType', $this->skuType);
if (isset($this->code)) $o['code'] = $this->code;
if (isset($this->quantity)) $o['quantity'] = $this->quantity;
if (isset($this->supportQuantity)) $o['supportQuantity'] = $this->supportQuantity;
if (isset($this->total)) $o['total'] = $this->total;
if (isset($this->isPlan)) $o['isPlan'] = $this->isPlan;
if (isset($this->isRenewal)) $o['isRenewal'] = $this->isRenewal;
if (isset($this->subscriptionDurationDays)) $o['subscriptionDurationDays'] = $this->subscriptionDurationDays;
if (isset($this->renewalDate)) $o['renewalDate'] = JsonConverters::to('DateTime', $this->renewalDate);
if (isset($this->licenseRef)) $o['licenseRef'] = $this->licenseRef;
if (isset($this->licenseName)) $o['licenseName'] = $this->licenseName;
if (isset($this->licenseAddress)) $o['licenseAddress'] = $this->licenseAddress;
if (isset($this->licenseType)) $o['licenseType'] = JsonConverters::to('LicenseType', $this->licenseType);
if (isset($this->expiryDate)) $o['expiryDate'] = JsonConverters::to('DateTime', $this->expiryDate);
if (isset($this->licenseKey)) $o['licenseKey'] = JsonConverters::to('LicenseKey', $this->licenseKey);
if (isset($this->licenseKeyText)) $o['licenseKeyText'] = $this->licenseKeyText;
if (isset($this->createdDate)) $o['createdDate'] = JsonConverters::to('DateTime', $this->createdDate);
if (isset($this->modifiedDate)) $o['modifiedDate'] = JsonConverters::to('DateTime', $this->modifiedDate);
if (isset($this->cancelledDate)) $o['cancelledDate'] = JsonConverters::to('DateTime', $this->cancelledDate);
if (isset($this->stripeSubscriptionId)) $o['stripeSubscriptionId'] = $this->stripeSubscriptionId;
if (isset($this->emailId)) $o['emailId'] = $this->emailId;
if (isset($this->emailRenewalId)) $o['emailRenewalId'] = $this->emailRenewalId;
if (isset($this->emailExpiredId)) $o['emailExpiredId'] = $this->emailExpiredId;
if (isset($this->renewalSubscriptionId)) $o['renewalSubscriptionId'] = $this->renewalSubscriptionId;
if (isset($this->externalRef)) $o['externalRef'] = $this->externalRef;
if (isset($this->notes)) $o['notes'] = $this->notes;
if (isset($this->error)) $o['error'] = $this->error;
return empty($o) ? new class(){} : $o;
}
}
class ActivateSubscriptionResponse implements JsonSerializable
{
public function __construct(
/** @var Subscription|null */
public ?Subscription $subscription=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['subscription'])) $this->subscription = JsonConverters::from('Subscription', $o['subscription']);
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->subscription)) $o['subscription'] = JsonConverters::to('Subscription', $this->subscription);
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /subscriptions/activate HTTP/1.1
Host: account.servicestack.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
externalRef: String,
userAuthId: String,
agreeTerms: False,
firstName: String,
lastName: String,
email: String,
password: String,
company: String,
phoneNumber: String,
addressLine1: String,
addressLine2: String,
addressCity: String,
addressZip: String,
addressState: String,
addressCountry: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
subscription:
{
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
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}