Merge pull request #21 from johnjoey/master

PS-286: add promo_value, restricted_code, and restricted properties to channel doc

Author: M1ke

src/Models/ContractAbstract.php

@@ -34,6 +34,26 @@ class ContractAbstract extends SwaggerModel
 	 */
 	protected $end_date;
 
+	/**
+	 * Is true if the availability is restricted
+	 * @var bool
+	 */
+	protected $restricted = false;
+
+	/**
+	 * The discount value of the promotion for this contract
+	 *
+	 * @var float
+	 */
+	protected $promo_value = 0.0;
+
+	/**
+	 * Reporting code for tracking promotion usage. Will appear in the Tenants report in Report Builder on the StuRents platform
+	 *
+	 * @var string
+	 */
+	protected $restricted_code = '';
+
 	/**
 	 * The minimum time a tenant may rent the property for in days
 	 *
@@ -120,6 +140,72 @@ public function setEndDate($end_date)
 	}
 
 
+	/**
+	 * @return bool
+	 */
+	public function getRestricted()
+	{
+		return $this->restricted;
+	}
+
+
+	/**
+	 * @param bool $restricted
+	 *
+	 * @return $this
+	 */
+	public function setRestricted($restricted)
+	{
+		$this->restricted = $restricted;
+
+		return $this;
+	}
+
+
+	/**
+	 * @return float
+	 */
+	public function getPromoValue()
+	{
+		return $this->promo_value;
+	}
+
+
+	/**
+	 * @param float $promo_value
+	 *
+	 * @return $this
+	 */
+	public function setPromoValue($promo_value)
+	{
+		$this->promo_value = $promo_value;
+
+		return $this;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getRestrictedCode()
+	{
+		return $this->restricted_code;
+	}
+
+
+	/**
+	 * @param string $restricted_code
+	 *
+	 * @return $this
+	 */
+	public function setRestrictedCode($restricted_code)
+	{
+		$this->restricted_code = $restricted_code;
+
+		return $this;
+	}
+
+
 	/**
 	 * @return int
 	 */

swagger/api-channel.yml

@@ -587,6 +587,17 @@ definitions:
         description: |
           The latest date at which it is possible to vacate the property
           in yyyy-mm-dd format
+      restricted:
+        type: boolean
+        description: Is true if the availability is restricted
+      promo_value:
+        type: number
+        description: |
+          The discount value of the promotion for this contract
+      restricted_code:
+        type: string
+        description: |
+          Reporting code for tracking promotion usage. Will appear in the Tenants report in Report Builder on the StuRents platform
       min_contract_days:
         type: integer
         description: |

swagger/api.yml

@@ -1150,6 +1150,17 @@ definitions:
         description: |
           The latest date at which it is possible to vacate the property
           in yyyy-mm-dd format
+      restricted:
+        type: boolean
+        description: Is true if the availability is restricted
+      promo_value:
+        type: number
+        description: |
+          The discount value of the promotion for this contract
+      restricted_code:
+        type: string
+        description: |
+          Reporting code for tracking promotion usage. Will appear in the Tenants report in Report Builder on the StuRents platform
       min_contract_days:
         type: integer
         description: |