Merge pull request #93 from guiajlopes/feature/ENG-128-hsm-message

Implement HSM messages

Author: marcel corso gonzalez

examples/conversations/create-hsm.php

@@ -0,0 +1,39 @@
+<?php
+
+// Initiates a conversation by sending a first message. This example uses a hsm message.
+
+require(__DIR__ . '/../../autoload.php');
+
+$messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
+
+$content = new \MessageBird\Objects\Conversation\Content();
+
+$hsm = new \MessageBird\Objects\Conversation\HSM\Message();
+
+$hsmParams = new \MessageBird\Objects\Conversation\HSM\Params();
+$hsmParams->default = 'YOUR TEMPLATE PARAM';
+
+$hsmLanguage = new \MessageBird\Objects\Conversation\HSM\Language();
+$hsmLanguage->policy = \MessageBird\Objects\Conversation\HSM\Language::DETERMINISTIC_POLICY;
+//$hsmLanguage->policy = \MessageBird\Objects\Conversation\HSM\Language::FALLBACK_POLICY;
+$hsmLanguage->code = 'YOUR LANGUAGE CODE';
+
+$hsm->templateName = 'YOUR TEMPLATE NAME';
+$hsm->namespace = 'YOUR NAMESPACE';
+$hsm->params = array($hsmParams);
+$hsm->language = $hsmLanguage;
+$content->hsm = $hsm;
+
+$message = new \MessageBird\Objects\Conversation\Message();
+$message->channelId = 'YOUR CHANNEL ID';
+$message->content = $content;
+$message->to = 'YOUR MSISDN';
+$message->type = 'hsm';
+
+try {
+    $conversation = $messageBird->conversations->start($message);
+
+    var_dump($conversation);
+} catch (\Exception $e) {
+    echo sprintf("%s: %s", get_class($e), $e->getMessage());
+}

src/MessageBird/Objects/Conversation/Content.php

@@ -4,6 +4,7 @@
 
 use JsonSerializable;
 use MessageBird\Objects\Base;
+use MessageBird\Objects\Conversation\HSM\Message as HSMMessage;
 
 /**
  * Represents a Message object's actual content. Formatted depending on type.
@@ -16,6 +17,7 @@ class Content extends Base implements JsonSerializable
     const TYPE_LOCATION = 'location';
     const TYPE_TEXT = 'text';
     const TYPE_VIDEO = 'video';
+    const TYPE_HSM = 'hsm';
 
     /**
      * @var string[]
@@ -47,6 +49,11 @@ class Content extends Base implements JsonSerializable
      */
     public $video;
 
+    /**
+     * @var HSMMessage
+     */
+    public $hsm;
+
     /**
      * @param $object
      *

src/MessageBird/Objects/Conversation/HSM/Currency.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace MessageBird\Objects\Conversation\HSM;
+
+class Currency
+{
+    /**
+     * @var string $code
+     */
+    public $code;
+
+    /**
+     * @var int $amount
+     */
+    public $amount;
+}

src/MessageBird/Objects/Conversation/HSM/Language.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace MessageBird\Objects\Conversation\HSM;
+
+class Language
+{
+    // Will deliver the message template in the user's device language. If the settings can't be found on the user's
+    // device the fallback language is used.
+    const FALLBACK_POLICY = 'fallback';
+
+    // Will deliver the message template exactly in the language and locale asked for.
+    const DETERMINISTIC_POLICY = 'deterministic';
+
+    /**
+     * It accepts FALLBACK_POLICY or DETERMINISTIC_POLICY.
+     *
+     * @var string $policy
+     */
+    public $policy;
+
+    /**
+     * Code can be both language and language_locale formats (e.g. en and en_US).
+     *
+     * @var string $code
+     */
+    public $code;
+}

src/MessageBird/Objects/Conversation/HSM/Message.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace MessageBird\Objects\Conversation\HSM;
+
+class Message
+{
+    /**
+     * @var string $namespace
+     */
+    public $namespace;
+
+    /**
+     * @var string $templateName
+     */
+    public $templateName;
+
+    /**
+     * @var Language $language
+     */
+    public $language;
+
+    /**
+     * @var Params[] $params
+     */
+    public $params;
+}
+
+

src/MessageBird/Objects/Conversation/HSM/Params.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace MessageBird\Objects\Conversation\HSM;
+
+class Params
+{
+    /**
+     * @var string $default
+     */
+    public $default;
+
+    /**
+     * @var Currency $currency
+     */
+    public $currency;
+
+    /**
+     * Date formatted as RFC3339
+     *
+     * @var string $dateTime
+     */
+    public $dateTime;
+}