GalaxyMobile Client API

SubscriptionEvents

The following routes are available for this service:
GET	/subscription/events	Get a list of subscription event types

<?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 ApiServiceRequest implements IServiceRequest, IHasApiKey, JsonSerializable
{
    public function __construct(
        /** @description The API Key required for authentication */
        // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
        /** @var string */
        public string $ApiKey=''
    ) {
    }

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

class ApiServiceResponse implements IServiceResponse, JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $Heading=null,
        /** @var bool|null */
        public ?bool $WasSuccessful=null,
        /** @var Object|null */
        public ?Object $ModelState=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Heading'])) $this->Heading = $o['Heading'];
        if (isset($o['WasSuccessful'])) $this->WasSuccessful = $o['WasSuccessful'];
        if (isset($o['ModelState'])) $this->ModelState = JsonConverters::from('Object', $o['ModelState']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Heading)) $o['Heading'] = $this->Heading;
        if (isset($this->WasSuccessful)) $o['WasSuccessful'] = $this->WasSuccessful;
        if (isset($this->ModelState)) $o['ModelState'] = JsonConverters::to('Object', $this->ModelState);
        return empty($o) ? new class(){} : $o;
    }
}

enum WebhookSubscriptionEventType : int
{
    case MessageReceived = 1;
}

class SubscriptionEventsDescription implements JsonSerializable
{
    public function __construct(
        /** @var WebhookSubscriptionEventType|null */
        public ?WebhookSubscriptionEventType $EventType=null,
        /** @var string|null */
        public ?string $EventName=null,
        /** @var string|null */
        public ?string $EventDescription=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['EventType'])) $this->EventType = JsonConverters::from('WebhookSubscriptionEventType', $o['EventType']);
        if (isset($o['EventName'])) $this->EventName = $o['EventName'];
        if (isset($o['EventDescription'])) $this->EventDescription = $o['EventDescription'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->EventType)) $o['EventType'] = JsonConverters::to('WebhookSubscriptionEventType', $this->EventType);
        if (isset($this->EventName)) $o['EventName'] = $this->EventName;
        if (isset($this->EventDescription)) $o['EventDescription'] = $this->EventDescription;
        return empty($o) ? new class(){} : $o;
    }
}

class SubscriptionEventsResponse extends ApiServiceResponse implements JsonSerializable
{
    /**
     * @param string|null $Description
     * @param string|null $Heading
     * @param bool|null $WasSuccessful
     * @param Object|null $ModelState
     */
    public function __construct(
        ?string $Description=null,
        ?string $Heading=null,
        ?bool $WasSuccessful=null,
        ?Object $ModelState=null,
        /** @var array<SubscriptionEventsDescription>|null */
        public ?array $SubscriptionEventsDescriptions=null
    ) {
        parent::__construct($Description,$Heading,$WasSuccessful,$ModelState);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['SubscriptionEventsDescriptions'])) $this->SubscriptionEventsDescriptions = JsonConverters::fromArray('SubscriptionEventsDescription', $o['SubscriptionEventsDescriptions']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->SubscriptionEventsDescriptions)) $o['SubscriptionEventsDescriptions'] = JsonConverters::toArray('SubscriptionEventsDescription', $this->SubscriptionEventsDescriptions);
        return empty($o) ? new class(){} : $o;
    }
}

class SubscriptionEvents extends ApiServiceRequest implements JsonSerializable
{
    /**
     * @param string $ApiKey
     */
    public function __construct(
        string $ApiKey=''
    ) {
        parent::__construct($ApiKey);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

PHP SubscriptionEvents 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.

GET /subscription/events HTTP/1.1 
Host: galaxymobile.api.client.prod.86degrees.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"SubscriptionEventsDescriptions":[{"EventType":1,"EventName":"String","EventDescription":"String"}],"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}