ServiceStack Home (Live)

<back to all web services

CreateOpenSourceLicense

The following routes are available for this service:
POST/freelicense/opensource
POST/CreateOpenSourceLicense
<?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};


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 FreeLicenseResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $licenseName=null,
        /** @var string|null */
        public ?string $licenseRef=null,
        /** @var string|null */
        public ?string $licenseKey=null,
        /** @var LicenseType|null */
        public ?LicenseType $licenseType=null,
        /** @var DateTime|null */
        public ?DateTime $createdDate=null,
        /** @var DateTime|null */
        public ?DateTime $expiryDate=null,
        /** @var string|null */
        public ?string $externalRef=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['licenseName'])) $this->licenseName = $o['licenseName'];
        if (isset($o['licenseRef'])) $this->licenseRef = $o['licenseRef'];
        if (isset($o['licenseKey'])) $this->licenseKey = $o['licenseKey'];
        if (isset($o['licenseType'])) $this->licenseType = JsonConverters::from('LicenseType', $o['licenseType']);
        if (isset($o['createdDate'])) $this->createdDate = JsonConverters::from('DateTime', $o['createdDate']);
        if (isset($o['expiryDate'])) $this->expiryDate = JsonConverters::from('DateTime', $o['expiryDate']);
        if (isset($o['externalRef'])) $this->externalRef = $o['externalRef'];
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->licenseName)) $o['licenseName'] = $this->licenseName;
        if (isset($this->licenseRef)) $o['licenseRef'] = $this->licenseRef;
        if (isset($this->licenseKey)) $o['licenseKey'] = $this->licenseKey;
        if (isset($this->licenseType)) $o['licenseType'] = JsonConverters::to('LicenseType', $this->licenseType);
        if (isset($this->createdDate)) $o['createdDate'] = JsonConverters::to('DateTime', $this->createdDate);
        if (isset($this->expiryDate)) $o['expiryDate'] = JsonConverters::to('DateTime', $this->expiryDate);
        if (isset($this->externalRef)) $o['externalRef'] = $this->externalRef;
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class CreateOpenSourceLicense implements IPost, JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $licenseName=null,
        /** @var string|null */
        public ?string $projectUrl=null,
        /** @var string|null */
        public ?string $licenseSpdx=null,
        /** @var bool|null */
        public ?bool $agreeTerms=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['licenseName'])) $this->licenseName = $o['licenseName'];
        if (isset($o['projectUrl'])) $this->projectUrl = $o['projectUrl'];
        if (isset($o['licenseSpdx'])) $this->licenseSpdx = $o['licenseSpdx'];
        if (isset($o['agreeTerms'])) $this->agreeTerms = $o['agreeTerms'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->licenseName)) $o['licenseName'] = $this->licenseName;
        if (isset($this->projectUrl)) $o['projectUrl'] = $this->projectUrl;
        if (isset($this->licenseSpdx)) $o['licenseSpdx'] = $this->licenseSpdx;
        if (isset($this->agreeTerms)) $o['agreeTerms'] = $this->agreeTerms;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CreateOpenSourceLicense DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /freelicense/opensource HTTP/1.1 
Host: account.servicestack.net 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"licenseName":"String","projectUrl":"String","licenseSpdx":"String","agreeTerms":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"licenseName":"String","licenseRef":"String","licenseKey":"String","licenseType":"Free","createdDate":"\/Date(-62135596800000-0000)\/","expiryDate":"\/Date(-62135596800000-0000)\/","externalRef":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}