Merge pull request #30 from johnjoey/master

add new rolling price field for initial period daily rate, make payme…

Author: craig-mcmahon

README.md

@@ -1,6 +1,6 @@
 # StuRents API Helper
 
-_Master branch is for v2.0 which is not available yet; please check releases for previous versions. For outbound data check 1.3.*, for inbound use 1.2.*_
+_Master branch is for v3 of the StuRents API. Please check releases for previous versions.
 
 Install using composer:
 

src/Models/Price.php

@@ -12,25 +12,18 @@
 class Price extends SwaggerModel
 {
 	/**
-	 * For fixed-term contracts, this is the monetary value indicating
+	 * A monetary value indicating
 	 * the weekly rent each tenant will be expected to pay during their
-	 * tenancy in the property.
+	 * fixed-term tenancy. This is required if is_fixed_term is true.
 	 *
-	 * For rolling contracts, this is the monetary value indicating the
-	 * daily rent each tenant will pay for the first payment period.
-	 * The first payment period covers the rent from the start date to
-	 * the day before the first rolling monthly payment day. The first payment rent
-	 * is calculated based on the number of days in the period multiplied by the per day rate.
-	 *
-	 * Whether fixed or rolling, this does not mean the rent is paid weekly or daily - the StuRents
+	 * This does not mean the rent is paid weekly - the StuRents
 	 * search and profiles display all rents as a weekly amount and this
 	 * will be used to calculate total and scheduled payments when
 	 * creating a tenancy and/or rent collection for the property
 	 *
-	 * @var float
-	 * @required
+	 * @var ?float
 	 */
-	protected $price_per_person_per_week;
+	protected $price_per_person_per_week = 0.0;
 
 	/**
 	 * A monetary value indicating the deposit each tenant will be
@@ -51,20 +44,33 @@ class Price extends SwaggerModel
 
 	/**
 	 * A monetary value indicating the monthly rent each tenant will
-	 * be expected to pay during their rolling tenancy in the property.
-	 * This is required if is_fixed_term is false
+	 * be expected to pay during their rolling tenancy.
+	 * This is required if is_fixed_term is false.
 	 *
-	 * The StuRents search and profiles display all rents as a weekly amount and this
+	 * The StuRents search and profiles display all rents as a weekly amount and this field's value
 	 * will be used to calculate total and scheduled payments when
 	 * creating a tenancy and/or rent collection for the property.
 	 *
 	 * @var ?float
 	 */
 	protected $rolling_price_per_person_per_month = 0.0;
 
+	/**
+	 * A monetary value indicating the
+	 * daily rent each tenant will pay for the first payment period for a rolling tenancy.
+	 * This is required if is_fixed_term is false.
+	 *
+	 * The first payment period covers the rent from the start date to
+	 * the day before the first rolling monthly payment day. The first payment rent
+	 * is calculated based on the number of days in the period multiplied by the per day rate.
+	 *
+	 * @var ?float
+	 */
+	protected $rolling_price_initial_period_per_person_per_day = 0.0;
+
 
 	/**
-	 * @return float
+	 * @return ?float
 	 */
 	public function getPricePerPersonPerWeek()
 	{
@@ -73,7 +79,7 @@ public function getPricePerPersonPerWeek()
 
 
 	/**
-	 * @param float $price_per_person_per_week
+	 * @param ?float $price_per_person_per_week
 	 *
 	 * @return $this
 	 */
@@ -149,4 +155,26 @@ public function setRollingPricePerPersonPerMonth($rolling_price_per_person_per_m
 
 		return $this;
 	}
+
+
+	/**
+	 * @return ?float
+	 */
+	public function getRollingPriceInitialPeriodPerPersonPerDay()
+	{
+		return $this->rolling_price_initial_period_per_person_per_day;
+	}
+
+
+	/**
+	 * @param ?float $rolling_price_initial_period_per_person_per_day
+	 *
+	 * @return $this
+	 */
+	public function setRollingPriceInitialPeriodPerPersonPerDay($rolling_price_initial_period_per_person_per_day)
+	{
+		$this->rolling_price_initial_period_per_person_per_day = $rolling_price_initial_period_per_person_per_day;
+
+		return $this;
+	}
 }

swagger/api-channel.yml

@@ -660,26 +660,19 @@ definitions:
       this will apply to all rooms. That field may be left null
       if the "room_prices" array is used instead.
     type: object
-    required:
-      - price_per_person_per_week
     properties:
       price_per_person_per_week:
         type: number
+        nullable: true
         description: |
-          For fixed-term contracts, this is the monetary value indicating 
+          A monetary value indicating 
           the weekly rent each tenant will be expected to pay during their 
-          tenancy in the property.
-          
-          For rolling contracts, this is the monetary value indicating the 
-          daily rent each tenant will pay for the first payment period.
-          The first payment period covers the rent from the start date to 
-          the day before the first rolling monthly payment day. The first payment rent 
-          is calculated based on the number of days in the period multiplied by the per day rate.
+          fixed-term tenancy. This is required if is_fixed_term is true.
 
-          Whether fixed or rolling, this does not mean the rent is paid weekly or daily - the StuRents
+          This does not mean the rent is paid weekly - the StuRents
           search and profiles display all rents as a weekly amount and this
           will be used to calculate total and scheduled payments when
-          creating a tenancy and/or rent collection for the property.
+          creating a tenancy and/or rent collection for the property
       deposit_per_person:
         type: number
         description: |
@@ -693,14 +686,26 @@ definitions:
           rent the property
       rolling_price_per_person_per_month:
         type: number
+        nullable: true
         description: |
           A monetary value indicating the monthly rent each tenant will
-          be expected to pay during their rolling tenancy in the property.
-          This is required if is_fixed_term is false
+          be expected to pay during their rolling tenancy.
+          This is required if is_fixed_term is false.
 
-          The StuRents search and profiles display all rents as a weekly amount and this
+          The StuRents search and profiles display all rents as a weekly amount and this field's value
           will be used to calculate total and scheduled payments when
           creating a tenancy and/or rent collection for the property.
+      rolling_price_initial_period_per_person_per_day:
+        type: number
+        nullable: true
+        description: |
+          A monetary value indicating the 
+          daily rent each tenant will pay for the first payment period for a rolling tenancy.
+          This is required if is_fixed_term is false.
+
+          The first payment period covers the rent from the start date to 
+          the day before the first rolling monthly payment day. The first payment rent 
+          is calculated based on the number of days in the period multiplied by the per day rate.
   PriceOutbound:
     description: |
       When fetching property details this describes a Price attached

swagger/api-display.yml

@@ -556,26 +556,19 @@ definitions:
       this will apply to all rooms. That field may be left null
       if the "room_prices" array is used instead.
     type: object
-    required:
-      - price_per_person_per_week
     properties:
       price_per_person_per_week:
         type: number
+        nullable: true
         description: |
-          For fixed-term contracts, this is the monetary value indicating 
+          A monetary value indicating 
           the weekly rent each tenant will be expected to pay during their 
-          tenancy in the property.
-          
-          For rolling contracts, this is the monetary value indicating the 
-          daily rent each tenant will pay for the first payment period.
-          The first payment period covers the rent from the start date to 
-          the day before the first rolling monthly payment day. The first payment rent 
-          is calculated based on the number of days in the period multiplied by the per day rate.
+          fixed-term tenancy. This is required if is_fixed_term is true.
 
-          Whether fixed or rolling, this does not mean the rent is paid weekly or daily - the StuRents
+          This does not mean the rent is paid weekly - the StuRents
           search and profiles display all rents as a weekly amount and this
           will be used to calculate total and scheduled payments when
-          creating a tenancy and/or rent collection for the property.
+          creating a tenancy and/or rent collection for the property
       deposit_per_person:
         type: number
         description: |
@@ -589,14 +582,26 @@ definitions:
           rent the property
       rolling_price_per_person_per_month:
         type: number
+        nullable: true
         description: |
           A monetary value indicating the monthly rent each tenant will
-          be expected to pay during their rolling tenancy in the property.
-          This is required if is_fixed_term is false
+          be expected to pay during their rolling tenancy.
+          This is required if is_fixed_term is false.
 
-          The StuRents search and profiles display all rents as a weekly amount and this
+          The StuRents search and profiles display all rents as a weekly amount and this field's value
           will be used to calculate total and scheduled payments when
           creating a tenancy and/or rent collection for the property.
+      rolling_price_initial_period_per_person_per_day:
+        type: number
+        nullable: true
+        description: |
+          A monetary value indicating the 
+          daily rent each tenant will pay for the first payment period for a rolling tenancy.
+          This is required if is_fixed_term is false.
+
+          The first payment period covers the rent from the start date to 
+          the day before the first rolling monthly payment day. The first payment rent 
+          is calculated based on the number of days in the period multiplied by the per day rate.
   PriceOutbound:
     description: |
       When fetching property details this describes a Price attached

swagger/api-upload.yml

@@ -1249,26 +1249,19 @@ definitions:
       this will apply to all rooms. That field may be left null
       if the "room_prices" array is used instead.
     type: object
-    required:
-      - price_per_person_per_week
     properties:
       price_per_person_per_week:
         type: number
+        nullable: true
         description: |
-          For fixed-term contracts, this is the monetary value indicating 
+          A monetary value indicating 
           the weekly rent each tenant will be expected to pay during their 
-          tenancy in the property.
-          
-          For rolling contracts, this is the monetary value indicating the 
-          daily rent each tenant will pay for the first payment period.
-          The first payment period covers the rent from the start date to 
-          the day before the first rolling monthly payment day. The first payment rent 
-          is calculated based on the number of days in the period multiplied by the per day rate.
+          fixed-term tenancy. This is required if is_fixed_term is true.
 
-          Whether fixed or rolling, this does not mean the rent is paid weekly or daily - the StuRents
+          This does not mean the rent is paid weekly - the StuRents
           search and profiles display all rents as a weekly amount and this
           will be used to calculate total and scheduled payments when
-          creating a tenancy and/or rent collection for the property.
+          creating a tenancy and/or rent collection for the property
       deposit_per_person:
         type: number
         description: |
@@ -1282,14 +1275,26 @@ definitions:
           rent the property
       rolling_price_per_person_per_month:
         type: number
+        nullable: true
         description: |
           A monetary value indicating the monthly rent each tenant will
-          be expected to pay during their rolling tenancy in the property.
-          This is required if is_fixed_term is false
+          be expected to pay during their rolling tenancy.
+          This is required if is_fixed_term is false.
 
-          The StuRents search and profiles display all rents as a weekly amount and this
+          The StuRents search and profiles display all rents as a weekly amount and this field's value
           will be used to calculate total and scheduled payments when
           creating a tenancy and/or rent collection for the property.
+      rolling_price_initial_period_per_person_per_day:
+        type: number
+        nullable: true
+        description: |
+          A monetary value indicating the 
+          daily rent each tenant will pay for the first payment period for a rolling tenancy.
+          This is required if is_fixed_term is false.
+
+          The first payment period covers the rent from the start date to 
+          the day before the first rolling monthly payment day. The first payment rent 
+          is calculated based on the number of days in the period multiplied by the per day rate.
   PriceOutbound:
     description: |
       When fetching property details this describes a Price attached

swagger/api.yml

@@ -1330,23 +1330,16 @@ definitions:
       this will apply to all rooms. That field may be left null
       if the "room_prices" array is used instead.
     type: object
-    required:
-      - price_per_person_per_week
     properties:
       price_per_person_per_week:
         type: number
+        nullable: true
         description: |
-          For fixed-term contracts, this is the monetary value indicating 
+          A monetary value indicating 
           the weekly rent each tenant will be expected to pay during their 
-          tenancy in the property.
-          
-          For rolling contracts, this is the monetary value indicating the 
-          daily rent each tenant will pay for the first payment period.
-          The first payment period covers the rent from the start date to 
-          the day before the first rolling monthly payment day. The first payment rent 
-          is calculated based on the number of days in the period multiplied by the per day rate.
+          fixed-term tenancy. This is required if is_fixed_term is true.
 
-          Whether fixed or rolling, this does not mean the rent is paid weekly or daily - the StuRents
+          This does not mean the rent is paid weekly - the StuRents
           search and profiles display all rents as a weekly amount and this
           will be used to calculate total and scheduled payments when
           creating a tenancy and/or rent collection for the property
@@ -1366,12 +1359,23 @@ definitions:
         nullable: true
         description: |
           A monetary value indicating the monthly rent each tenant will
-          be expected to pay during their rolling tenancy in the property.
-          This is required if is_fixed_term is false
+          be expected to pay during their rolling tenancy.
+          This is required if is_fixed_term is false.
 
-          The StuRents search and profiles display all rents as a weekly amount and this
+          The StuRents search and profiles display all rents as a weekly amount and this field's value
           will be used to calculate total and scheduled payments when
           creating a tenancy and/or rent collection for the property.
+      rolling_price_initial_period_per_person_per_day:
+        type: number
+        nullable: true
+        description: |
+          A monetary value indicating the 
+          daily rent each tenant will pay for the first payment period for a rolling tenancy.
+          This is required if is_fixed_term is false.
+          
+          The first payment period covers the rent from the start date to 
+          the day before the first rolling monthly payment day. The first payment rent 
+          is calculated based on the number of days in the period multiplied by the per day rate.
   PriceOutbound:
     description: |
       When fetching property details this describes a Price attached