CodeMirror/appwrite
1
0
Fork 0
mirror of synced 2024-07-20 05:45:46 +12:00
Code Issues Projects Releases Wiki Activity

Merge branch 'feat-add-messaging-response-models' into feat-messages-event-config

Browse source
This commit is contained in:
prateek banga 2023-08-18 23:33:59 +05:30
parent ab655e69e6 a174aca2c8
commit cc1311b723
6 changed files with 252 additions and 252 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

140
src/Appwrite/Utopia/Response/Model/Message.php
View file

@ -8,88 +8,88 @@ use Utopia\Database\DateTime;
class Message extends Model
{
/**
* @var bool
*/
/**
* @var bool
*/
protected bool $public = false;
public function __construct()
{
$this
->addRule('$id', [
'type' => self::TYPE_STRING,
'description' => 'Message ID.',
'default' => '',
'example' => '5e5ea5c16897e',
])
->addRule('providerId', [
'type' => self::TYPE_STRING,
'description' => 'Provider Id for the message.',
'default' => '',
'example' => '5e5ea5c16897e',
])
->addRule('data', [
'type' => self::TYPE_JSON,
'description' => 'Message Data.',
'default' => '',
'required' => false,
'example' => '',
])
->addRule('to', [
'type' => self::TYPE_STRING,
'description' => 'Recipient of message.',
'default' => '',
'example' => ['user-1'],
])
->addRule('deliveryTime', [
'type' => self::TYPE_DATETIME,
'description' => 'Recipient of message.',
'required' => false,
'default' => DateTime::now(),
'example' => DateTime::now(),
])
->addRule('deliveryError', [
'type' => self::TYPE_STRING,
'description' => 'Delivery error if any.',
'required' => false,
'default' => '',
'example' => 'Provider not valid.',
])
->addRule('deliveredTo', [
'type' => self::TYPE_INTEGER,
'description' => 'Number of recipients the message was delivered to.',
'default' => '',
'example' => 1,
])
->addRule('delivered', [
'type' => self::TYPE_BOOLEAN,
'description' => 'Status of delivery.',
'default' => '',
'example' => true,
])
->addRule('search', [
'type' => self::TYPE_STRING,
'description' => 'Field that can be used for searching message.',
'default' => '',
'example' => 'Hello everyone',
]);
->addRule('$id', [
'type' => self::TYPE_STRING,
'description' => 'Message ID.',
'default' => '',
'example' => '5e5ea5c16897e',
])
->addRule('providerId', [
'type' => self::TYPE_STRING,
'description' => 'Provider Id for the message.',
'default' => '',
'example' => '5e5ea5c16897e',
])
->addRule('data', [
'type' => self::TYPE_JSON,
'description' => 'Message Data.',
'default' => '',
'required' => false,
'example' => '',
])
->addRule('to', [
'type' => self::TYPE_STRING,
'description' => 'Recipient of message.',
'default' => '',
'example' => ['user-1'],
])
->addRule('deliveryTime', [
'type' => self::TYPE_DATETIME,
'description' => 'Recipient of message.',
'required' => false,
'default' => DateTime::now(),
'example' => DateTime::now(),
])
->addRule('deliveryError', [
'type' => self::TYPE_STRING,
'description' => 'Delivery error if any.',
'required' => false,
'default' => '',
'example' => 'Provider not valid.',
])
->addRule('deliveredTo', [
'type' => self::TYPE_INTEGER,
'description' => 'Number of recipients the message was delivered to.',
'default' => '',
'example' => 1,
])
->addRule('delivered', [
'type' => self::TYPE_BOOLEAN,
'description' => 'Status of delivery.',
'default' => '',
'example' => true,
])
->addRule('search', [
'type' => self::TYPE_STRING,
'description' => 'Field that can be used for searching message.',
'default' => '',
'example' => 'Hello everyone',
]);
}
/**
* Get Name
*
* @return string
*/
/**
* Get Name
*
* @return string
*/
public function getName(): string
{
return 'Message';
}
/**
* Get Type
*
* @return string
*/
/**
* Get Type
*
* @return string
*/
public function getType(): string
{
return Response::MODEL_MESSAGE;

74
src/Appwrite/Utopia/Response/Model/Provider.php
View file

@ -7,55 +7,55 @@ use Appwrite\Utopia\Response\Model;
class Provider extends Model
{
/**
* @var bool
*/
/**
* @var bool
*/
protected bool $public = false;
public function __construct()
{
$this
->addRule('$id', [
'type' => self::TYPE_STRING,
'description' => 'Provider ID.',
'default' => '',
'example' => '5e5ea5c16897e',
])
->addRule('name', [
'type' => self::TYPE_STRING,
'description' => 'The user-given name for the provider instance.',
'default' => '',
'example' => 'Mailgun',
])
->addRule('provider', [
'type' => self::TYPE_STRING,
'description' => 'Provider name setup in Utopia.',
'default' => '',
'example' => 'mailgun',
])
->addRule('type', [
'type' => self::TYPE_STRING,
'description' => 'Type of provider.',
'default' => '',
'example' => 'sms',
]);
->addRule('$id', [
'type' => self::TYPE_STRING,
'description' => 'Provider ID.',
'default' => '',
'example' => '5e5ea5c16897e',
])
->addRule('name', [
'type' => self::TYPE_STRING,
'description' => 'The user-given name for the provider instance.',
'default' => '',
'example' => 'Mailgun',
])
->addRule('provider', [
'type' => self::TYPE_STRING,
'description' => 'Provider name setup in Utopia.',
'default' => '',
'example' => 'mailgun',
])
->addRule('type', [
'type' => self::TYPE_STRING,
'description' => 'Type of provider.',
'default' => '',
'example' => 'sms',
]);
}
/**
* Get Name
*
* @return string
*/
/**
* Get Name
*
* @return string
*/
public function getName(): string
{
return 'Provider';
}
/**
* Get Type
*
* @return string
*/
/**
* Get Type
*
* @return string
*/
public function getType(): string
{
return Response::MODEL_PROVIDER;

63
src/Appwrite/Utopia/Response/Model/Subsciber.php
View file

@ -1,63 +0,0 @@
<?php
namespace Appwrite\Utopia\Response\Model;
use Appwrite\Utopia\Response;
use Appwrite\Utopia\Response\Model;
class Subscriber extends Model
{
/**
* @var bool
*/
protected bool $public = false;
public function __construct()
{
$this
->addRule('$id', [
'type' => self::TYPE_STRING,
'description' => 'Subscriber ID.',
'default' => '',
'example' => '259125845563242502',
])
->addRule('userId', [
'type' => self::TYPE_STRING,
'description' => 'User ID.',
'default' => '',
'example' => '259125845563242502',
])
->addRule('targetId', [
'type' => self::TYPE_STRING,
'description' => 'Target ID.',
'default' => '',
'example' => '259125845563242502',
])
->addRule('topicId', [
'type' => self::TYPE_STRING,
'description' => 'Topic ID.',
'default' => '',
'example' => '259125845563242502',
]);
}
/**
* Get Name
*
* @return string
*/
public function getName(): string
{
return 'Subscriber';
}
/**
* Get Type
*
* @return string
*/
public function getType(): string
{
return Response::MODEL_SUBSCRIBER;
}
}

63
src/Appwrite/Utopia/Response/Model/Subscriber.php Normal file
View file

@ -0,0 +1,63 @@
<?php
namespace Appwrite\Utopia\Response\Model;
use Appwrite\Utopia\Response;
use Appwrite\Utopia\Response\Model;
class Subscriber extends Model
{
/**
* @var bool
*/
protected bool $public = false;
public function __construct()
{
$this
->addRule('$id', [
'type' => self::TYPE_STRING,
'description' => 'Subscriber ID.',
'default' => '',
'example' => '259125845563242502',
])
->addRule('userId', [
'type' => self::TYPE_STRING,
'description' => 'User ID.',
'default' => '',
'example' => '259125845563242502',
])
->addRule('targetId', [
'type' => self::TYPE_STRING,
'description' => 'Target ID.',
'default' => '',
'example' => '259125845563242502',
])
->addRule('topicId', [
'type' => self::TYPE_STRING,
'description' => 'Topic ID.',
'default' => '',
'example' => '259125845563242502',
]);
}
/**
* Get Name
*
* @return string
*/
public function getName(): string
{
return 'Subscriber';
}
/**
* Get Type
*
* @return string
*/
public function getType(): string
{
return Response::MODEL_SUBSCRIBER;
}
}

88
src/Appwrite/Utopia/Response/Model/Target.php
View file

@ -7,62 +7,62 @@ use Appwrite\Utopia\Response\Model;
class Target extends Model
{
/**
* @var bool
*/
/**
* @var bool
*/
protected bool $public = false;
public function __construct()
{
$this
->addRule('$id', [
'type' => self::TYPE_STRING,
'description' => 'Target ID.',
'default' => '',
'example' => '259125845563242502',
])
->addRule('userId', [
'type' => self::TYPE_STRING,
'description' => 'User ID.',
'default' => '',
'example' => '259125845563242502',
])
->addRule('providerId', [
'type' => self::TYPE_STRING,
'description' => 'Provider ID.',
'required' => false,
'default' => '',
'example' => '259125845563242502',
])
->addRule('providerType', [
'type' => self::TYPE_STRING,
'description' => 'The type of provider supported by this target.',
'default' => '',
'example' => 'sms',
])
->addRule('identifier', [
'type' => self::TYPE_STRING,
'description' => 'The target identifier.',
'default' => '',
'example' => 'token',
]);
->addRule('$id', [
'type' => self::TYPE_STRING,
'description' => 'Target ID.',
'default' => '',
'example' => '259125845563242502',
])
->addRule('userId', [
'type' => self::TYPE_STRING,
'description' => 'User ID.',
'default' => '',
'example' => '259125845563242502',
])
->addRule('providerId', [
'type' => self::TYPE_STRING,
'description' => 'Provider ID.',
'required' => false,
'default' => '',
'example' => '259125845563242502',
])
->addRule('providerType', [
'type' => self::TYPE_STRING,
'description' => 'The type of provider supported by this target.',
'default' => '',
'example' => 'sms',
])
->addRule('identifier', [
'type' => self::TYPE_STRING,
'description' => 'The target identifier.',
'default' => '',
'example' => 'token',
]);
}
/**
* Get Name
*
* @return string
*/
/**
* Get Name
*
* @return string
*/
public function getName(): string
{
return 'Target';
}
/**
* Get Type
*
* @return string
*/
/**
* Get Type
*
* @return string
*/
public function getType(): string
{
return Response::MODEL_TARGET;

76
src/Appwrite/Utopia/Response/Model/Topic.php
View file

@ -7,56 +7,56 @@ use Appwrite\Utopia\Response\Model;
class Topic extends Model
{
/**
* @var bool
*/
/**
* @var bool
*/
protected bool $public = false;
public function __construct()
{
$this
->addRule('$id', [
'type' => self::TYPE_STRING,
'description' => 'Topic ID.',
'default' => '',
'example' => '259125845563242502',
])
->addRule('providerId', [
'type' => self::TYPE_STRING,
'description' => 'Provider ID.',
'default' => '',
'example' => '259125845563242502',
])
->addRule('name', [
'type' => self::TYPE_STRING,
'description' => 'The name of the topic.',
'default' => '',
'example' => 'events',
])
->addRule('description', [
'type' => self::TYPE_STRING,
'description' => 'Description of the topic.',
'default' => '',
'required' => false,
'example' => 'All events related messages will be sent to this topic.',
]);
->addRule('$id', [
'type' => self::TYPE_STRING,
'description' => 'Topic ID.',
'default' => '',
'example' => '259125845563242502',
])
->addRule('providerId', [
'type' => self::TYPE_STRING,
'description' => 'Provider ID.',
'default' => '',
'example' => '259125845563242502',
])
->addRule('name', [
'type' => self::TYPE_STRING,
'description' => 'The name of the topic.',
'default' => '',
'example' => 'events',
])
->addRule('description', [
'type' => self::TYPE_STRING,
'description' => 'Description of the topic.',
'default' => '',
'required' => false,
'example' => 'All events related messages will be sent to this topic.',
]);
}
/**
* Get Name
*
* @return string
*/
/**
* Get Name
*
* @return string
*/
public function getName(): string
{
return 'Topic';
}
/**
* Get Type
*
* @return string
*/
/**
* Get Type
*
* @return string
*/
public function getType(): string
{
return Response::MODEL_TOPIC;