Merge pull request #16 from Vitafy/programs

Programs and enrolments

Author: romanpitak

src/DataTypes/ApiProgram.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ *
+ * @author Roman Piták <[email protected]>
+ * @author Alexander Turiak <[email protected]>
+ *
+ */
+
+
+namespace DotMailer\Api\DataTypes;
+
+
+/**
+ * Class ApiProgram
+ *
+ * @property XsInt ID
+ * @property XsString Name
+ * @property ApiProgramStatus Status
+ * @property XsDateTime DateCreated
+ */
+final class ApiProgram extends JsonObject
+{
+    protected function getProperties()
+    {
+        return array(
+            'ID' => 'XsInt',
+            'Name' => 'XsString',
+            'Status' => 'ApiProgramStatus',
+            'DateCreated' => 'XsDateTime',
+        );
+    }
+
+}

src/DataTypes/ApiProgramEnrolment.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ *
+ * @author Roman Piták <[email protected]>
+ * @author Alexander Turiak <[email protected]>
+ *
+ */
+
+
+namespace DotMailer\Api\DataTypes;
+
+
+/**
+ * Class ApiProgramEnrolment
+ *
+ * @property Guid ID
+ * @property XsInt ProgramId
+ * @property ApiProgramEnrolmentStatus Status
+ * @property XsDateTime DateCreated
+ * @property Int32List Contacts
+ * @property Int32List AddressBooks
+ */
+final class ApiProgramEnrolment extends JsonObject
+{
+    protected function getProperties()
+    {
+        return array(
+            'ID' => 'Guid',
+            'ProgramId' => 'XsInt',
+            'Status' => 'ApiProgramEnrolmentStatus',
+            'DateCreated' => 'XsDateTime',
+            'Contacts' => 'Int32List',
+            'AddressBooks' => 'Int32List'
+        );
+    }
+
+}

src/DataTypes/ApiProgramEnrolmentList.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ *
+ * @author Roman Piták <[email protected]>
+ * @author Alexander Turiak <[email protected]>
+ *
+ */
+
+
+namespace DotMailer\Api\DataTypes;
+
+
+final class ApiProgramEnrolmentList extends JsonArray
+{
+
+    protected function getDataClass()
+    {
+        return 'ApiProgramEnrolment';
+    }
+
+}

src/DataTypes/ApiProgramEnrolmentStatus.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ *
+ * @author Roman Piták <[email protected]>
+ * @author Alexander Turiak <[email protected]>
+ *
+ */
+
+
+namespace DotMailer\Api\DataTypes;
+
+
+final class ApiProgramEnrolmentStatus extends Enum
+{
+
+    const PROCESSING = 'Processing';
+    const FINISHED   = 'Finished';
+    const NOT_AVAILABLE_IN_THIS_VERSION = 'NotAvailableInThisVersion';
+
+
+    /*
+     * ========== Enum ==========
+     */
+
+    protected function getDataClass()
+    {
+        return 'XsString';
+    }
+
+    protected function getPossibleValues()
+    {
+        return array(
+            self::PROCESSING,
+            self::FINISHED,
+            self::NOT_AVAILABLE_IN_THIS_VERSION
+        );
+    }
+
+}

src/DataTypes/ApiProgramList.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ *
+ * @author Roman Piták <[email protected]>
+ * @author Alexander Turiak <[email protected]>
+ *
+ */
+
+
+namespace DotMailer\Api\DataTypes;
+
+
+final class ApiProgramList extends JsonArray
+{
+
+    protected function getDataClass()
+    {
+        return 'ApiProgram';
+    }
+
+}

src/DataTypes/ApiProgramStatus.php

@@ -0,0 +1,43 @@
+<?php
+/**
+ *
+ * @author Roman Piták <[email protected]>
+ * @author Alexander Turiak <[email protected]>
+ *
+ */
+
+
+namespace DotMailer\Api\DataTypes;
+
+
+final class ApiProgramStatus extends Enum
+{
+
+    const DRAFT       = 'Draft';
+    const DEACTIVATED = 'Deactivated';
+    const ACTIVE      = 'Active';
+    const READONLY    = 'ReadOnly';
+    const NOT_AVAILABLE_IN_THIS_VERSION = 'NotAvailableInThisVersion';
+
+
+    /*
+     * ========== Enum ==========
+     */
+
+    protected function getDataClass()
+    {
+        return 'XsString';
+    }
+
+    protected function getPossibleValues()
+    {
+        return array(
+            self::DRAFT,
+            self::DEACTIVATED,
+            self::ACTIVE,
+            self::READONLY,
+            self::NOT_AVAILABLE_IN_THIS_VERSION
+        );
+    }
+
+}

src/Resources/IResources.php

@@ -44,6 +44,10 @@
 use DotMailer\Api\DataTypes\ApiImage;
 use DotMailer\Api\DataTypes\ApiImageFolder;
 use DotMailer\Api\DataTypes\ApiImageFolderList;
+use DotMailer\Api\DataTypes\ApiProgram;
+use DotMailer\Api\DataTypes\ApiProgramList;
+use DotMailer\Api\DataTypes\ApiProgramEnrolment;
+use DotMailer\Api\DataTypes\ApiProgramEnrolmentList;
 use DotMailer\Api\DataTypes\ApiResubscribeResult;
 use DotMailer\Api\DataTypes\ApiSegmentList;
 use DotMailer\Api\DataTypes\ApiSegmentRefresh;
@@ -865,6 +869,60 @@ public function GetImageFolderById(XsInt $folderId);
      */
     public function PostImageFolder(XsInt $folderId, ApiImageFolder $apiImageFolder);
 
+    /*
+    * ========== programs and enrolments ==========
+    */
+
+    /**
+     * Gets a program by id.
+     *
+     * @param int|XsInt $programId
+     * @return ApiProgram
+     */
+    public function GetProgramById(XsInt $programId);
+
+    /**
+     * Creates a new program enrolment.
+     *
+     * @param ApiProgramEnrolment $apiProgramEnrolment
+     */
+    public function PostProgramsEnrolments(ApiProgramEnrolment $apiProgramEnrolment);
+
+    /**
+     * Gets an enrolment by id.
+     *
+     * @param string|Guid $enrolmentId
+     * @return ApiProgramEnrolment
+     */
+    public function GetProgramsEnrolmentByEnrolmentId($enrolmentId);
+
+    /**
+     * Gets faults by an enrolment id.
+     *
+     * @param string|Guid $enrolmentId
+     * @return ApiProgramEnrolment
+     */
+    public function GetProgramsEnrolmentReportFaults($enrolmentId);
+
+    /**
+     * Gets enrolments by status.
+     *
+     * @param string|XsString $status
+     * @param int $select
+     * @param int $skip
+     * @return ApiProgramEnrolmentList
+     */
+    public function GetProgramsEnrolmentByStatus($status, $select = 1000, $skip = 0);
+
+    /**
+     * Gets all programs.
+     *
+     * @param int $select
+     * @param int $skip
+     * @return ApiProgramList
+     */
+    public function GetPrograms($select = 1000, $skip = 0);
+
     /*
      * ========== segments ==========
      */

src/Resources/Resources.php

@@ -43,6 +43,10 @@
 use DotMailer\Api\DataTypes\ApiImage;
 use DotMailer\Api\DataTypes\ApiImageFolder;
 use DotMailer\Api\DataTypes\ApiImageFolderList;
+use DotMailer\Api\DataTypes\ApiProgram;
+use DotMailer\Api\DataTypes\ApiProgramList;
+use DotMailer\Api\DataTypes\ApiProgramEnrolment;
+use DotMailer\Api\DataTypes\ApiProgramEnrolmentList;
 use DotMailer\Api\DataTypes\ApiResubscribeResult;
 use DotMailer\Api\DataTypes\ApiSegmentList;
 use DotMailer\Api\DataTypes\ApiSegmentRefresh;
@@ -603,6 +607,45 @@ public function PostImageFolder(XsInt $folderId, ApiImageFolder $apiImageFolder)
         return new ApiImageFolder($this->execute($url, 'POST', $apiImageFolder->toJson()));
     }
 
+    /*
+    * ========== programs and enrolments ==========
+    */
+
+    public function GetProgramById(XsInt $programId)
+    {
+        $url = sprintf("programs/%s", $programId);
+        return new ApiProgram($this->execute($url));
+    }
+
+    public function PostProgramsEnrolments(ApiProgramEnrolment $apiProgramEnrolment)
+    {
+        $this->execute('programs/enrolments', 'POST', $apiProgramEnrolment->toJson());
+    }
+
+    public function GetProgramsEnrolmentByEnrolmentId($enrolmentId)
+    {
+        $url = sprintf("programs/enrolments/%s", $enrolmentId);
+        return new ApiProgramEnrolment($this->execute($url));
+    }
+
+    public function GetProgramsEnrolmentReportFaults($enrolmentId)
+    {
+        $url = sprintf("programs/enrolments/%s/report-faults", $enrolmentId);
+        return new ApiProgramEnrolment($this->execute($url));
+    }
+
+    public function GetProgramsEnrolmentByStatus($status, $select = 1000, $skip = 0)
+    {
+        $url = sprintf("programs/enrolments/%s/?select=%s&skip=%s", $status, $select, $skip);
+        return new ApiProgramEnrolmentList($this->execute($url));
+    }
+
+    public function GetPrograms($select = 1000, $skip = 0)
+    {
+        $url = sprintf("programs/?select=%s&skip=%s", $select, $skip);
+        return new ApiProgramList($this->execute($url));
+    }
+
     /*
      * ========== segments ==========
      */