Skip to content

Commit 2b0306e

Browse files
SecondeJKSecondeJK
authored
New Messages API Features (#465)
* New fields added * Last of the changes for messages
1 parent c412306 commit 2b0306e

File tree

11 files changed

+259
-22
lines changed

11 files changed

+259
-22
lines changed

‎src/Messages/Channel/BaseMessage.php‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ abstract class BaseMessage implements Message
99
protected string $from;
1010
protected string $channel;
1111
protected ?string $clientRef = null;
12+
protected ?string $webhookUrl = null;
13+
protected ?string $webhookVersion = null;
14+
15+
protected array $permittedVersions = [
16+
'v0.1',
17+
'v1'
18+
];
1219

1320
public const MESSAGES_SUBTYPE_TEXT = 'text';
1421
public const MESSAGES_SUBTYPE_IMAGE = 'image';
@@ -60,6 +67,30 @@ public function setTo(string $to): void
6067
$this->to = $to;
6168
}
6269

70+
public function setWebhookUrl(string $url): void
71+
{
72+
$this->webhookUrl = $url;
73+
}
74+
75+
public function getWebhookUrl(): ?string
76+
{
77+
return $this->webhookUrl;
78+
}
79+
80+
public function setWebhookVersion(string $version): void
81+
{
82+
if (! in_array($version, $this->permittedVersions, true)) {
83+
throw new \InvalidArgumentException($version . ' is not a valid webhook version');
84+
}
85+
86+
$this->webhookVersion = $version;
87+
}
88+
89+
public function getWebhookVersion(): ?string
90+
{
91+
return $this->webhookVersion;
92+
}
93+
6394
public function getBaseMessageUniversalOutputArray(): array
6495
{
6596
$returnArray = [
@@ -73,6 +104,14 @@ public function getBaseMessageUniversalOutputArray(): array
73104
$returnArray['client_ref'] = $this->getClientRef();
74105
}
75106

107+
if ($this->getWebhookUrl()) {
108+
$returnArray['webhook_url'] = $this->getWebhookUrl();
109+
}
110+
111+
if ($this->getWebhookVersion()) {
112+
$returnArray['webhook_version'] = $this->getWebhookVersion();
113+
}
114+
76115
return $returnArray;
77116
}
78117
}

‎src/Messages/Channel/Message.php‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ public function getClientRef(): ?string;
2222
public function getChannel(): string;
2323
public function getSubType(): string;
2424
public function setClientRef(string $clientRef): void;
25+
public function getWebhookUrl(): ?string;
26+
public function setWebhookUrl(string $url): void;
27+
public function getWebhookVersion(): ?string;
28+
public function setWebhookVersion(string $version): void;
2529

2630
/**
2731
* All message types have shared outputs required by the endpoint.

‎src/Messages/Channel/SMS/SMSText.php‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,18 @@ class SMSText extends BaseMessage
99
{
1010
use TextTrait;
1111

12+
protected array $permittedEncodingTypes = [
13+
'text',
14+
'unicode',
15+
'auto'
16+
];
17+
1218
protected string $subType = BaseMessage::MESSAGES_SUBTYPE_TEXT;
1319
protected string $channel = 'sms';
20+
protected ?int $ttl = null;
21+
protected ?string $encodingType = null;
22+
protected ?string $contentId = null;
23+
protected ?string $entityId = null;
1424

1525
public function __construct(
1626
string $to,
@@ -22,11 +32,71 @@ public function __construct(
2232
$this->text = $message;
2333
}
2434

35+
public function getEncodingType(): ?string
36+
{
37+
return $this->encodingType;
38+
}
39+
40+
public function setEncodingType(?string $encodingType): void
41+
{
42+
if (! in_array($encodingType, $this->permittedEncodingTypes, true)) {
43+
throw new \InvalidArgumentException($encodingType . ' is not a valid encoding type');
44+
}
45+
46+
$this->encodingType = $encodingType;
47+
}
48+
49+
public function getContentId(): ?string
50+
{
51+
return $this->contentId;
52+
}
53+
54+
public function setContentId(?string $contentId): void
55+
{
56+
$this->contentId = $contentId;
57+
}
58+
59+
public function getEntityId(): ?string
60+
{
61+
return $this->entityId;
62+
}
63+
64+
public function setEntityId(?string $entityId): void
65+
{
66+
$this->entityId = $entityId;
67+
}
68+
69+
public function getTtl(): ?int
70+
{
71+
return $this->ttl;
72+
}
73+
74+
public function setTtl(?int $ttl): void
75+
{
76+
$this->ttl = $ttl;
77+
}
78+
2579
public function toArray(): array
2680
{
2781
$returnArray = $this->getBaseMessageUniversalOutputArray();
2882
$returnArray['text'] = $this->getText();
2983

84+
if ($this->getEncodingType()) {
85+
$returnArray['sms']['encoding_type'] = $this->getEncodingType();
86+
}
87+
88+
if ($this->getContentId()) {
89+
$returnArray['sms']['content_id'] = $this->getContentId();
90+
}
91+
92+
if ($this->getEntityId()) {
93+
$returnArray['sms']['entity_id'] = $this->getEntityId();
94+
}
95+
96+
if ($this->getTtl()) {
97+
$returnArray['ttl'] = $this->getTtl();
98+
}
99+
30100
return $returnArray;
31101
}
32102
}

‎src/Messages/Channel/Viber/ViberFile.php‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
use Vonage\Messages\MessageObjects\FileObject;
66
use Vonage\Messages\Channel\BaseMessage;
7+
78
class ViberFile extends BaseMessage
89
{
910
use ViberServiceObjectTrait;
@@ -26,11 +27,11 @@ public function toArray(): array
2627
$returnArray['file'] = $this->fileObject->toArray();
2728

2829
if ($this->requiresViberServiceObject()) {
29-
$this->getCategory() ? $returnArray['viber_service']['category'] = $this->getCategory(): null;
30-
$this->getTtl() ? $returnArray['viber_service']['ttl'] = $this->getTtl(): null;
31-
$this->getType() ? $returnArray['viber_service']['type'] = $this->getType(): null;
30+
$this->getCategory() ? $returnArray['viber_service']['category'] = $this->getCategory() : null;
31+
$this->getTtl() ? $returnArray['viber_service']['ttl'] = $this->getTtl() : null;
32+
$this->getType() ? $returnArray['viber_service']['type'] = $this->getType() : null;
3233
}
3334

3435
return $returnArray;
3536
}
36-
}
37+
}

‎src/Messages/Channel/Viber/ViberServiceObjectTrait.php‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ trait ViberServiceObjectTrait
1010
private ?int $ttl = null;
1111
private ?string $type = null;
1212
private ?ViberActionObject $action = null;
13+
private string $duration;
14+
private string $fileSize;
1315

1416
public function requiresViberServiceObject(): bool
1517
{
@@ -63,4 +65,24 @@ public function setAction(ViberActionObject $viberActionObject): static
6365

6466
return $this;
6567
}
68+
69+
public function getDuration(): string
70+
{
71+
return $this->duration;
72+
}
73+
74+
public function setDuration(string $duration): void
75+
{
76+
$this->duration = $duration;
77+
}
78+
79+
public function getFileSize(): string
80+
{
81+
return $this->fileSize;
82+
}
83+
84+
public function setFileSize(string $fileSize): void
85+
{
86+
$this->fileSize = $fileSize;
87+
}
6688
}

‎src/Messages/Channel/Viber/ViberVideo.php‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,12 @@ public function __construct(
1919
string $to,
2020
string $from,
2121
string $thumbUrl,
22-
protected VideoObject $videoObject
22+
protected VideoObject $videoObject,
23+
string $duration,
24+
string $fileSize
2325
) {
26+
$this->fileSize = $fileSize;
27+
$this->duration = $duration;
2428
$this->to = $to;
2529
$this->from = $from;
2630
$this->thumbUrl = $thumbUrl;
@@ -33,6 +37,14 @@ public function toArray(): array
3337
$videoArray['thumb_url'] = $this->thumbUrl;
3438
$returnArray['video'] = $videoArray;
3539

40+
$returnArray['viber_service']['duration'] = $this->getDuration();
41+
$returnArray['viber_service']['file_size'] = $this->getFileSize();
42+
43+
$this->getCategory() ? $returnArray['viber_service']['category'] = $this->getCategory() : null;
44+
$this->getTtl() ? $returnArray['viber_service']['ttl'] = $this->getTtl() : null;
45+
$this->getType() ? $returnArray['viber_service']['type'] = $this->getType() : null;
46+
$this->getAction() ? $returnArray['viber_service']['action'] = $this->getAction()->toArray() : null;
47+
3648
return $returnArray;
3749
}
3850
}

‎src/Messages/MessageObjects/FileObject.php‎

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@
66

77
class FileObject implements ArrayHydrateInterface
88
{
9-
public function __construct(private string $url, private string $caption = '')
10-
{
9+
public function __construct(
10+
private string $url,
11+
private string $caption = '',
12+
private ?string $name = null,
13+
) {
1114
}
1215

1316
public function fromArray(array $data): FileObject
@@ -18,6 +21,10 @@ public function fromArray(array $data): FileObject
1821
$this->caption = $data['caption'];
1922
}
2023

24+
if (isset($data['name'])) {
25+
$this->name = $data['name'];
26+
}
27+
2128
return $this;
2229
}
2330

@@ -27,8 +34,12 @@ public function toArray(): array
2734
'url' => $this->url
2835
];
2936

30-
if ($this->caption) {
31-
$returnArray['caption'] = $this->caption;
37+
if ($this->getCaption()) {
38+
$returnArray['caption'] = $this->getCaption();
39+
}
40+
41+
if ($this->getName()) {
42+
$returnArray['name'] = $this->getName();
3243
}
3344

3445
return $returnArray;
@@ -43,4 +54,14 @@ public function getCaption(): string
4354
{
4455
return $this->caption;
4556
}
57+
58+
public function getName(): ?string
59+
{
60+
return $this->name;
61+
}
62+
63+
public function setName(?string $name): void
64+
{
65+
$this->name = $name;
66+
}
4667
}

‎src/Messages/MessageObjects/ImageObject.php‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66

77
class ImageObject implements ArrayHydrateInterface
88
{
9-
public function __construct(private string $url, private string $caption = '')
10-
{
9+
public function __construct(
10+
private string $url,
11+
private string $caption = '',
12+
) {
1113
}
1214

1315
public function fromArray(array $data): ImageObject
@@ -27,8 +29,8 @@ public function toArray(): array
2729
'url' => $this->url
2830
];
2931

30-
if ($this->caption) {
31-
$returnArray['caption'] = $this->caption;
32+
if ($this->getCaption()) {
33+
$returnArray['caption'] = $this->getCaption();
3234
}
3335

3436
return $returnArray;

‎src/Messages/MessageObjects/VCardObject.php‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66

77
class VCardObject implements ArrayHydrateInterface
88
{
9-
public function __construct(private string $url)
10-
{
9+
public function __construct(
10+
private string $url,
11+
private ?string $caption = null
12+
) {
1113
}
1214

1315
public function fromArray(array $data): VCardObject
@@ -28,4 +30,14 @@ public function getUrl(): string
2830
{
2931
return $this->url;
3032
}
33+
34+
public function getCaption(): ?string
35+
{
36+
return $this->caption;
37+
}
38+
39+
public function setCaption(?string $caption): void
40+
{
41+
$this->caption = $caption;
42+
}
3143
}

‎src/Messages/MessageObjects/VideoObject.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ public function toArray(): array
2727
'url' => $this->url
2828
];
2929

30-
if ($this->caption) {
31-
$returnArray['caption'] = $this->caption;
30+
if ($this->getCaption()) {
31+
$returnArray['caption'] = $this->getCaption();
3232
}
3333

3434
return $returnArray;

0 commit comments

Comments
 (0)