Merge pull request #359 from BookingSync/document-constraints-batch-6

Azdaroth · web-flow · commit a92d28f90e2a · 2022-03-23T08:57:34.000+01:00
Document constraints batch 6
diff --git a/api_calls/reference/rentals_taxes/create-request.json b/api_calls/reference/rentals_taxes/create-request.json
@@ -0,0 +1,8 @@
+{
+  "rentals_taxes": [
+    {
+      "tax_id": 2,
+      "tax_included_in_rate": true
+    }
+  ]
+}
diff --git a/api_calls/reference/rentals_taxes/public-rates_write-scope-response.json b/api_calls/reference/rentals_taxes/public-rates_write-scope-response.json
@@ -0,0 +1,18 @@
+{
+  "links": {
+    "rentals_taxes.rental": "https://www.bookingsync.com/api/v3/rentals/{rentals_taxes.rental}",
+    "rentals_taxes.tax": "https://www.bookingsync.com/api/v3/taxes/{rentals_taxes.tax}"
+  },
+  "rentals_taxes": [
+    {
+      "links": {
+        "rental": 1,
+        "tax": 2
+      },
+      "id": 3,
+      "tax_included_in_rate": true,
+      "created_at": "2015-08-05T15:15:47Z",
+      "updated_at": "2015-08-05T15:15:47Z"
+    }
+  ]
+}
diff --git a/api_calls/reference/rentals_taxes/update-request.json b/api_calls/reference/rentals_taxes/update-request.json
@@ -0,0 +1,7 @@
+{
+  "rentals_taxes": [
+    {
+      "tax_included_in_rate": true
+    }
+  ]
+}
diff --git a/api_calls/reference/reviews/dismiss-request.json b/api_calls/reference/reviews/dismiss-request.json
@@ -0,0 +1,9 @@
+{
+  "reviews": [
+    {
+      "disimissed_at": "2022-03-10T12:00Z:00",
+      "dismissed_by": "Airbnb",
+      "dismissal_reason": "Guest revealed personal details of a host"
+    }
+  ]
+}
diff --git a/content/reference/endpoints/fees_taxes.md b/content/reference/endpoints/fees_taxes.md
@@ -18,7 +18,7 @@ This resource represents Fees Taxes - the [taxes](/reference/endpoints/taxes/) f
 Name                   | Type    | Read/Write | Description
 -----------------------|---------|------------|------------
 account                | Integer | Read       | Account's ID related to the Fees Tax
-fee                    | Integer | Read       | Fees's ID related to the Fees Tax
+fee                    | Integer | Read       | Fee's ID related to the Fees Tax
 tax                    | Integer | Read       | Tax's ID related to the Fees Tax
 -----------------------|---------|------------|------------
 id                     | Integer | Read       | Fees Tax's id.
@@ -32,12 +32,11 @@ updated_at             | [Time](/reference/enums#formats) | Read       | Fees Ta
 Name                   | Type    | Read/Write | Description | Constraints
 -----------------------|---------|------------|-------------|
 account                | Integer | Read       | Account's ID related to the Fees Tax |
-fee                    | Integer | Read       | Fees's ID related to the Fees Tax |
+fee                    | Integer | Read       | Fee's ID related to the Fees Tax |
 tax                    | Integer | Read       | Tax's ID related to the Fees Tax |
------------------------|---------|------------|------------
 -----------------------|---------|------------|------------|
-id                     | Integer | Read       | Fees Tax's id. | **Required**
-tax_id                 | Integer | Write      | Tax's id. | **Required**
+id                     | Integer | Read       | Fees Tax's ID.
+tax_id                 | Integer | Write      | Tax's ID. | **Required**
 tax_included_in_rate   | Boolean | Read/Write | Whether Tax amount is already included in fee's rate or not. If fee's rate is 100 and there is a tax with a percentage of 10% assigned to it, that tax would already be included in 100 if it the value was set to `true`. However, if set to `false`, the "total" amount (in the context of [Bookings'](/reference/endpoints/bookings/) creation) would be 100 + 10% from 100 which is 110. | **Required**
 -----------------------|---------|------------|------------|
 created_at             | [Time](/reference/enums#formats) | Read       | Fees Tax's create time. |
diff --git a/content/reference/endpoints/rentals_contents_overrides.md b/content/reference/endpoints/rentals_contents_overrides.md
@@ -1,10 +1,14 @@
 # Rentals Contents Overrides
-Rental content overrides endpoint was made so that different channels could have different length validations for our fields like `headline, summary, description`.
-By using those objects clients applications can use full available length at each channel.
 
 1. TOC
 {:toc}
 
+## Overview
+
+This resource represents the Rental Content Overrides which allow different channels (other [Applications](/reference/endpoints/applications/).) to have customized content for fields like `headline`, `summary`, `description`, which also allows to bypass the length validation that is normally applied for these fields in [Rentals](/reference/endpoints/rentals/) endpoint.
+
+Note: An Application needs to be configured in a way that content overrides are permitted. Most likely you will need to reach out to us and ask for this feature to be enabled for your Application or if you want to customize the maximum length for the overridable fields. 
+
 ### Parameters
 <ul class="nav nav-pills" role="tablist">
   <li class="disabled"><a>OAuth Scopes:</a></li>
@@ -15,8 +19,11 @@ By using those objects clients applications can use full available length at eac
   <div class="tab-pane active" id="rentals_read" markdown="1">
 Name             | Type    | Read/Write | Description
 -----------------|---------|------------|------------
-id               | Integer | Read       | Rentals Contents Override's id.
+account          | Integer  | Read       | Account's ID related to the Rentals Contents Override
+application      | Integer  | Read       | Application's ID related to the Rentals Contents Override
+rental           | Integer  | Read       | Rental's ID related to the Rentals Contents Override
 -----------------|---------|------------|------------
+id               | Integer | Read       | Rentals Contents Override's ID.
 description      | [Object](/reference/enums#formats) | Read       | Description override for related application, list of locales described in [enums section](/reference/enums#locales).
 headline         | [Object](/reference/enums#formats) | Read       | Headline override for related application, list of locales described in [enums section](/reference/enums#locales).
 summary          | [Object](/reference/enums#formats) | Read       | Summary override for related application, list of locales described in [enums section](/reference/enums#locales).
@@ -26,18 +33,21 @@ updated_at       | [Time](/reference/enums#formats) | Read       | Rentals Conte
 {: class="table table-bordered"}
   </div>
   <div class="tab-pane" id="rentals_write" markdown="1">
-Name             | Type    | Read/Write | Description
------------------|---------|------------|------------
-id               | Integer | Read       | Rentals Contents Override's id.
-application_id   | Integer | Write      | Application id related to the Rentals Contents Override.
-rental_id        | Integer | Write      | Rental id related to the Rentals Contents Override.
------------------|---------|------------|------------
-description      | [Object](/reference/enums#formats) | Read/Write | Description override for related application, list of locales described in [enums section](/reference/enums#locales).
-headline         | [Object](/reference/enums#formats) | Read/Write | Headline override for related application, list of locales described in [enums section](/reference/enums#locales).
-summary          | [Object](/reference/enums#formats) | Read/Write | Summary override for related application, list of locales described in [enums section](/reference/enums#locales).
------------------|---------|------------|------------
-created_at       | [Time](/reference/enums#formats) | Read       | Rentals Contents Override's create time.
-updated_at       | [Time](/reference/enums#formats) | Read       | Rentals Contents Override's update time.
+Name             | Type    | Read/Write | Description | Constraints
+-----------------|---------|------------|-------------|
+account          | Integer  | Read       | Account's ID related to the Rentals Contents Override |
+application      | Integer  | Read       | Application's ID related to the Rentals Contents Override |
+rental           | Integer  | Read       | Rental's ID related to the Rentals Contents Override |
+-----------------|---------|------------|-------------|
+id               | Integer | Read       | Rentals Contents Override's ID. |
+application_id   | Integer | Write      | Application's Id related to the Rentals Contents Override. | **Required** on create
+rental_id        | Integer | Write      | Rental's ID related to the Rentals Contents Override. | **Required** on create
+description      | [Object](/reference/enums#formats) | Read/Write | Description override for related application, list of locales described in [enums section](/reference/enums#locales). | Maximum length: 10 000 (unless customized)
+headline         | [Object](/reference/enums#formats) | Read/Write | Headline override for related application, list of locales described in [enums section](/reference/enums#locales). | Maximum length: 75 (unless customized)
+summary          | [Object](/reference/enums#formats) | Read/Write | Summary override for related application, list of locales described in [enums section](/reference/enums#locales). | Maximum length: 150 (unless customized)
+-----------------|---------|------------|-------------|
+created_at       | [Time](/reference/enums#formats) | Read       | Rentals Contents Override's create time. |
+updated_at       | [Time](/reference/enums#formats) | Read       | Rentals Contents Override's update time. |
 {: class="table table-bordered"}
   </div>
 </div>
diff --git a/content/reference/endpoints/rentals_fees.md b/content/reference/endpoints/rentals_fees.md
@@ -3,6 +3,10 @@
 1. TOC
 {:toc}
 
+## Overview
+
+This resource represents Rentals Fees which are a way to define the relationship between [Rentals](/reference/endpoints/rentals/) and [Fees](/reference/endpoints/fees/) and provide a configuration for the behavior of the Fee within the scope of a given ental.
+
 ### Parameters
 <ul class="nav nav-pills" role="tablist">
   <li class="disabled"><a>OAuth Scopes:</a></li>
@@ -13,9 +17,13 @@
   <div class="tab-pane active" id="public" markdown="1">
 Name             | Type    | Read/Write | Description
 -----------------|---------|------------|------------
-id               | Integer | Read       | Rentals Fee's id.
+account          | Integer  | Read      | Account's ID related to the Rentals Fee
+fee              | Integer  | Read      | Fee's ID related to the Rentals Fee
+rental           | Integer  | Read      | Rental's ID related to the Rentals Fee
+seasons          | Array    | Read      | Seasons' IDs related to the Rentals Fee
 -----------------|---------|------------|------------
-always_applied   | Boolean | Read       | Available to all seasons and periods if set to true.
+id               | Integer | Read       | Rentals Fee's ID.
+always_applied   | Boolean | Read       | Rentals Fee will always be applicable if set to true (if set to false, the applicability periods are defined via `seasons` or `start_date`/`end_date`)
 maximum_bookable | Integer | Read       | Rentals Fee's maximum booked count.
 name             | [Object](/reference/enums#formats)   | Read       | Rentals Fee's name, list of locales described in [enums section](/reference/enums#locales).
 public           | Boolean | Read       | Publicly bookable by client if set to true.
@@ -26,35 +34,41 @@ required         | Boolean | Read       | Always included for new bookings, also
 archived_at      | [Time](/reference/enums#formats) | Read       | Rentals Fee's archive time.
 created_at       | [Time](/reference/enums#formats) | Read       | Rentals Fee's create time.
 updated_at       | [Time](/reference/enums#formats) | Read       | Rentals Fee's update time.
-start_date       | [Date](/reference/enums#formats) | Read       | Rentals Fee's start date.
-end_date         | [Date](/reference/enums#formats) | Read       | Rentals Fee's end date.
+start_date       | [Date](/reference/enums#formats) | Read       | Rentals Fee's start date (applicable only if `always_applied` is false and `seasons` are empty). 
+end_date         | [Date](/reference/enums#formats) | Read       | Rentals Fee's end date (applicable only if `always_applied` is false and `seasons` are empty).
 {: class="table table-bordered"}
   </div>
   <div class="tab-pane" id="rentals_write" markdown="1">
-Name             | Type    | Read/Write | Description
------------------|---------|------------|------------
-id               | Integer | Read       | Rentals Fee's id.
-fee_id           | Integer | Write      | Fee id related to the Rentals Fee.
-season_ids       | Array   | Write      | Season ids related to the Rentals Fee.
------------------|---------|------------|------------
-always_applied   | Boolean | Read/Write | Available to all seasons and periods if set to true.
-maximum_bookable | Integer | Read/Write | Rentals Fee's maximum booked count.
-name             | [Object](/reference/enums#formats)   | Read       | Rentals Fee's name, list of locales described in [enums section](/reference/enums#locales).
-public           | Boolean | Read       | Publicly bookable by client if set to true.
-rate             | [Decimal](/reference/enums#formats)  | Read       | Rentals Fee's rate.
-rate_kind        | String  | Read       | Rentals Fee's rate kind, list of fee's rate kinds described in [enums section](/reference/enums#fee-rate-kinds).
-required         | Boolean | Read       | Always included for new bookings, also public if set to true.
-status           | Boolean | Write      | Possible values are `public`, `required` or `private`.
------------------|---------|------------|------------
-archived_at      | [Time](/reference/enums#formats) | Read       | Rentals Fee's archive time.
-created_at       | [Time](/reference/enums#formats) | Read       | Rentals Fee's create time.
-updated_at       | [Time](/reference/enums#formats) | Read       | Rentals Fee's update time.
-start_date       | [Date](/reference/enums#formats) | Read/Write | Rentals Fee's start date.
-end_date         | [Date](/reference/enums#formats) | Read/Write | Rentals Fee's end date.
+Name             | Type    | Read/Write | Description | Constraints
+-----------------|---------|------------|-------------|
+account          | Integer  | Read      | Account's ID related to the Rentals Fee |
+fee              | Integer  | Read      | Fee's ID related to the Rentals Fee |
+rental           | Integer  | Read      | Rental's ID related to the Rentals Fee |
+seasons          | Array    | Read      | Seasons' IDs related to the Rentals Fee |
+-----------------|---------|------------|-------------|
+id               | Integer | Read       | Rentals Fee's ID. | 
+fee_id           | Integer | Write      | Fee's ID related to the Rentals Fee. | **Required**
+season_ids       | Array   | Write      | Seasons' IDs related to the Rentals Fee. | Use only one of these: `season_ids`, `always_applied`, `start_date`/`end_date`
+always_applied   | Boolean | Read/Write | Rentals Fee will always be applicable if set to true | Use only one of these: `season_ids`, `always_applied`, `start_date`/`end_date`
+maximum_bookable | Integer | Read/Write | Rentals Fee's maximum booked count. | Must be greater than 0 if present
+name             | [Object](/reference/enums#formats)   | Read       | Rentals Fee's name, list of locales described in [enums section](/reference/enums#locales). |
+public           | Boolean | Read       | Publicly bookable by client if set to true. |
+rate             | [Decimal](/reference/enums#formats)  | Read       | Rentals Fee's rate. |
+rate_kind        | String  | Read       | Rentals Fee's rate kind, list of fee's rate kinds described in [enums section](/reference/enums#fee-rate-kinds). | 
+required         | Boolean | Read       | Always included for new bookings, also public if set to true. |
+status           | Boolean | Write      | Possible values are `public`, `required` or `private`. | Must be `public`, `required` or `private`
+-----------------|---------|------------|-------------|
+archived_at      | [Time](/reference/enums#formats) | Read       | Rentals Fee's archive time. |
+created_at       | [Time](/reference/enums#formats) | Read       | Rentals Fee's create time. |
+updated_at       | [Time](/reference/enums#formats) | Read       | Rentals Fee's update time. |
+start_date       | [Date](/reference/enums#formats) | Read/Write | Rentals Fee's start date. | Use only one of these: `season_ids`, `always_applied`, `start_date`/`end_date`, **required** is `end_date` is present, must be before `end_date`
+end_date         | [Date](/reference/enums#formats) | Read/Write | Rentals Fee's end date. | Use only one of these: `season_ids`, `always_applied`, `start_date`/`end_date`, **required** is `start_date` is present, must be after `start_date`
 {: class="table table-bordered"}
   </div>
 </div>
 
+
+
 ## List rentals fees
 
 List all rentals fees for a given account(s).
diff --git a/content/reference/endpoints/rentals_tags.md b/content/reference/endpoints/rentals_tags.md
@@ -3,6 +3,10 @@
 1. TOC
 {:toc}
 
+## Overview
+
+This resource represents the Rentals Tags that can be associated with the [Rentals](/reference/endpoints/rentals/).
+
 ### Parameters
 <ul class="nav nav-pills" role="tablist">
   <li class="disabled"><a>OAuth Scopes:</a></li>
@@ -13,8 +17,9 @@
   <div class="tab-pane active" id="rentals_read" markdown="1">
 Name             | Type    | Read/Write | Description
 -----------------|---------|------------|------------
-id               | Integer | Read       | Rentals Tag's id.
+account          | Integer  | Read      | Account's ID related to the Rentals Tag
 -----------------|---------|------------|------------
+id               | Integer | Read       | Rentals Tag's ID.
 name             | [Object](/reference/enums#formats)| Read       | Rentals Tag's title, list of locales described in [enums section](/reference/enums#locales).
 logo             | String  | Read       | Rentals Tag's logo (Font Awesome class).
 color            | String  | Read       | Rentals Tag's color (hex).
@@ -24,16 +29,17 @@ updated_at       | [Time](/reference/enums#formats) | Read       | Rentals Tag's
 {: class="table table-bordered"}
   </div>
   <div class="tab-pane" id="rentals_write" markdown="1">
-Name             | Type    | Read/Write | Description
------------------|---------|------------|------------
-id               | Integer | Read       | Rentals Tag's id.
------------------|---------|------------|------------
-name             | [Object](/reference/enums#formats)| Read/Write | Rentals Tag's title, list of locales described in [enums section](/reference/enums#locales).
-logo             | String  | Read/Write | Rentals Tag's logo (Font Awesome class).
-color            | String  | Read/Write | Rentals Tag's color (hex).
------------------|---------|------------|------------
-created_at       | [Time](/reference/enums#formats) | Read       | Rentals Tag's create time.
-updated_at       | [Time](/reference/enums#formats) | Read       | Rentals Tag's update time.
+Name             | Type    | Read/Write | Description | Constraints
+-----------------|---------|------------|-------------| 
+account          | Integer  | Read      | Account's ID related to the Rentals Tag |
+-----------------|---------|------------|-------------|
+id               | Integer | Read       | Rentals Tag's ID. |
+name             | [Object](/reference/enums#formats)| Read/Write | Rentals Tag's title, list of locales described in [enums section](/reference/enums#locales). | **Required** 
+logo             | String  | Read/Write | Rentals Tag's logo (Font Awesome class). |
+color            | String  | Read/Write | Rentals Tag's color (hex). | **Required**
+-----------------|---------|------------|-------------|
+created_at       | [Time](/reference/enums#formats) | Read       | Rentals Tag's create time. |
+updated_at       | [Time](/reference/enums#formats) | Read       | Rentals Tag's update time. |
 {: class="table table-bordered"}
   </div>
 </div>
diff --git a/content/reference/endpoints/rentals_taxes.md b/content/reference/endpoints/rentals_taxes.md
diff --git a/content/reference/endpoints/reviews.md b/content/reference/endpoints/reviews.md

-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +{
 +  "rentals_taxes": [
 +    {
 +      "tax_included_in_rate": true
 +    }
 +  ]
 +}