ServiceStack Home (Live)

<back to all web services

Support

<?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 Support implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $section=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['section'])) $this->section = $o['section'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->section)) $o['section'] = $this->section;
        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 SupportContact implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0,
        /** @var int */
        public int $customerId=0,
        /** @var string|null */
        public ?string $name=null,
        /** @var string|null */
        public ?string $email=null,
        /** @var string|null */
        public ?string $gitHub=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['name'])) $this->name = $o['name'];
        if (isset($o['email'])) $this->email = $o['email'];
        if (isset($o['gitHub'])) $this->gitHub = $o['gitHub'];
    }
    
    /** @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->name)) $o['name'] = $this->name;
        if (isset($this->email)) $o['email'] = $this->email;
        if (isset($this->gitHub)) $o['gitHub'] = $this->gitHub;
        return empty($o) ? new class(){} : $o;
    }
}

class SupportResponse implements JsonSerializable
{
    public function __construct(
        /** @var Subscription|null */
        public ?Subscription $activeSubscription=null,
        /** @var string|null */
        public ?string $section=null,
        /** @var int */
        public int $maxQuantity=0,
        /** @var int */
        public int $supportQuantity=0,
        /** @var string|null */
        public ?string $skuType=null,
        /** @var array<SupportContact>|null */
        public ?array $supportContacts=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['activeSubscription'])) $this->activeSubscription = JsonConverters::from('Subscription', $o['activeSubscription']);
        if (isset($o['section'])) $this->section = $o['section'];
        if (isset($o['maxQuantity'])) $this->maxQuantity = $o['maxQuantity'];
        if (isset($o['supportQuantity'])) $this->supportQuantity = $o['supportQuantity'];
        if (isset($o['skuType'])) $this->skuType = $o['skuType'];
        if (isset($o['supportContacts'])) $this->supportContacts = JsonConverters::fromArray('SupportContact', $o['supportContacts']);
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->activeSubscription)) $o['activeSubscription'] = JsonConverters::to('Subscription', $this->activeSubscription);
        if (isset($this->section)) $o['section'] = $this->section;
        if (isset($this->maxQuantity)) $o['maxQuantity'] = $this->maxQuantity;
        if (isset($this->supportQuantity)) $o['supportQuantity'] = $this->supportQuantity;
        if (isset($this->skuType)) $o['skuType'] = $this->skuType;
        if (isset($this->supportContacts)) $o['supportContacts'] = JsonConverters::toArray('SupportContact', $this->supportContacts);
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

PHP Support DTOs

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

<Support xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <Section>String</Section>
</Support>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SupportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <ActiveSubscription>
    <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:d3p1="http://schemas.datacontract.org/2004/07/ServiceStack">
      <d3p1:Expiry>0001-01-01T00:00:00</d3p1:Expiry>
      <d3p1:Halg>String</d3p1:Halg>
      <d3p1:Hash>String</d3p1:Hash>
      <d3p1:Meta>0</d3p1:Meta>
      <d3p1:Name>String</d3p1:Name>
      <d3p1:Ref>String</d3p1:Ref>
      <d3p1:Type>Free</d3p1: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>
  </ActiveSubscription>
  <MaxQuantity>0</MaxQuantity>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </ResponseStatus>
  <Section>String</Section>
  <SkuType>String</SkuType>
  <SupportContacts>
    <SupportContact>
      <CustomerId>0</CustomerId>
      <Email>String</Email>
      <GitHub>String</GitHub>
      <Id>0</Id>
      <Name>String</Name>
    </SupportContact>
  </SupportContacts>
  <SupportQuantity>0</SupportQuantity>
</SupportResponse>