Merge pull request #20 from johnjoey/master

add 429 response to /properties

Author: M1ke

src/Models/ContractCreation.php

@@ -28,17 +28,17 @@ class ContractCreation extends ContractAbstract
 	 * A unique identifier for a Tenancy Template fetched from
 	 * the /tenancy-templates endpoint. A tenancy template
 	 * allows a tenancy to be created for tenants who are renting
-	 * the property and can sign for it on StuRents
+	 * the property and can sign for it on StuRents. For properties that are only listing for advertising, this field can be set to an empty string.
 	 *
 	 * @var string
 	 * @required
 	 */
 	protected $template_id;
 
 	/**
-	 * An array of one or more ScheduleOption entities describing how
+	 * An array of zero or more ScheduleOption entities describing how
 	 * the rent for this contract can be structured and what additional
-	 * conditions are applied.
+	 * conditions are applied. For the property to be bookable directly via the platform, at least one schedule must be provided.
 	 *
 	 * @var ScheduleOption[]
 	 * @required

src/Models/RateLimitError.php

@@ -0,0 +1,38 @@
+<?php
+namespace SturentsLib\Api\Models;
+
+/**
+ * ** This file was generated automatically, you might want to avoid editing it **
+ *
+ * This endpoint is rate limited. Please try again after the specified time
+ */
+class RateLimitError extends SwaggerModel
+{
+	/**
+	 * Message indicating the rate limit has been exceeded and when to try again
+	 * @var string
+	 */
+	protected $error = '';
+
+
+	/**
+	 * @return string
+	 */
+	public function getError()
+	{
+		return $this->error;
+	}
+
+
+	/**
+	 * @param string $error
+	 *
+	 * @return $this
+	 */
+	public function setError($error)
+	{
+		$this->error = $error;
+
+		return $this;
+	}
+}

src/Models/ScheduleOption.php

@@ -5,7 +5,7 @@
  * ** This file was generated automatically, you might want to avoid editing it **
  *
  * A schedule that can be used to pay rent for a contract, with specific
- * rules regarding whether it requires a guarantor or allows use of Housing Hand
+ * rules regarding whether it requires a guarantor
  */
 class ScheduleOption extends SwaggerModel
 {
@@ -30,17 +30,6 @@ class ScheduleOption extends SwaggerModel
 	 */
 	protected $require_guarantor;
 
-	/**
-	 * The Housing Hand service is a partnership offered by StuRents
-	 * in order to provide guarantors for tenants who are otherwise
-	 * unable to acquire one. When a tenancy is created this field
-	 * states whether Housing Hand is permitted, if set to true,
-	 * not permitted if set to false.
-	 *
-	 * @var bool
-	 */
-	protected $housing_hand = false;
-
 
 	/**
 	 * @return string
@@ -84,26 +73,4 @@ public function setRequireGuarantor($require_guarantor)
 
 		return $this;
 	}
-
-
-	/**
-	 * @return bool
-	 */
-	public function getHousingHand()
-	{
-		return $this->housing_hand;
-	}
-
-
-	/**
-	 * @param bool $housing_hand
-	 *
-	 * @return $this
-	 */
-	public function setHousingHand($housing_hand)
-	{
-		$this->housing_hand = $housing_hand;
-
-		return $this;
-	}
 }

src/Requests/GetProperties.php

@@ -30,7 +30,7 @@ public function setPage($page)
 
 
 	/**
-	 * @return \SturentsLib\Api\Models\ListProperties|\SturentsLib\Api\Models\Error|\SturentsLib\Api\Models\AuthError|\SturentsLib\Api\Models\GetError|list<\SturentsLib\Api\Models\ListProperties>|list<\SturentsLib\Api\Models\Error>|list<\SturentsLib\Api\Models\AuthError>|list<\SturentsLib\Api\Models\GetError>
+	 * @return \SturentsLib\Api\Models\ListProperties|\SturentsLib\Api\Models\Error|\SturentsLib\Api\Models\AuthError|\SturentsLib\Api\Models\GetError|\SturentsLib\Api\Models\RateLimitError|list<\SturentsLib\Api\Models\ListProperties>|list<\SturentsLib\Api\Models\Error>|list<\SturentsLib\Api\Models\AuthError>|list<\SturentsLib\Api\Models\GetError>|list<\SturentsLib\Api\Models\RateLimitError>
 	 */
 	public function sendWith(SwaggerClient $client)
 	{
@@ -39,6 +39,7 @@ public function sendWith(SwaggerClient $client)
 			'400' => \SturentsLib\Api\Models\Error::class,
 			'401' => \SturentsLib\Api\Models\AuthError::class,
 			'404' => \SturentsLib\Api\Models\GetError::class,
+			'429' => \SturentsLib\Api\Models\RateLimitError::class,
 			'default' => \SturentsLib\Api\Models\Error::class
 		]);
 	}

swagger/api-channel.yml

@@ -115,6 +115,8 @@ paths:
           $ref: '#/definitions/AuthError'
         '404':
           $ref: '#/definitions/GetError'
+        '429':
+          $ref: '#/definitions/RateLimitError'
         default:
           $ref: '#/definitions/Error'
   /facilities:
@@ -172,7 +174,15 @@ definitions:
     properties:
       error:
         type: string
-        description: Another error message not related to authenticaiton
+        description: Another error message not related to authentication
+  RateLimitError:
+    description: |
+      This endpoint is rate limited. Please try again after the specified time
+    type: object
+    properties:
+      error:
+        type: string
+        description: Message indicating the rate limit has been exceeded and when to try again
   AuthError:
     description: |
       The key supplied did not match the property manager or channel

swagger/api.yml

@@ -110,6 +110,8 @@ paths:
           $ref: '#/definitions/AuthError'
         '404':
           $ref: '#/definitions/GetError'
+        '429':
+          $ref: '#/definitions/RateLimitError'
         default:
           $ref: '#/definitions/Error'
   /summary:
@@ -718,6 +720,14 @@ definitions:
         description: Keyed by field name (collapsed using . characters)
         items:
           type: string
+  RateLimitError:
+    description: |
+      This endpoint is rate limited. Please try again after the specified time
+    type: object
+    properties:
+      error:
+        type: string
+        description: Message indicating the rate limit has been exceeded and when to try again
   ListProperties:
     type: object
     properties: