summaryrefslogtreecommitdiffstats
path: root/lib/SparkPost.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/SparkPost.php')
-rw-r--r--lib/SparkPost.php14
1 files changed, 12 insertions, 2 deletions
diff --git a/lib/SparkPost.php b/lib/SparkPost.php
index 2a4b589..539b0db 100644
--- a/lib/SparkPost.php
+++ b/lib/SparkPost.php
@@ -8,11 +8,21 @@ class SparkPost {
public $transmission;
- public function __construct($globalOpts) {
+ /**
+ * @desc Sets up the config for the sdk suite
+ * @param array $globalOpts
+ */
+ public function __construct(array $globalOpts) {
Configuration::setConfig($globalOpts);
}
- public function Transmission(Array $options = null) {
+ /**
+ * @desc Creates a new Transmission object and returns it.
+ * @param array $options Transmission constructor options
+ * @see \MessageSystems\Transmission
+ * @return \MessageSystems\Transmission
+ */
+ public function Transmission(array $options = null) {
$this->transmission = new Transmission($options);
return $this->transmission;
}