Update booking docs (#18)

* Fix incorrect lang example * Create gitignore to ignore build files * Fix booking/update?notify stating that it incorrectly has a default of true * Add partner_id query parameter to booking/index
Checkfront · Jun 7, 2018 · 3d1fd5a · 3d1fd5a
1 parent ecefb9a
commit 3d1fd5a
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+# Sphinx build folder
+_build*
diff --git a/docs/examples/response/booking-form.json b/docs/examples/response/booking-form.json
@@ -5,7 +5,7 @@
     "name": "Your Company",
     "locale": {
         "id": "en_US",
-        "lang": "_en",
+        "lang": "en",
         "currency": "CAD"
     },
      "request": {

diff --git a/docs/ref/booking/booking.rst b/docs/ref/booking/booking.rst
@@ -42,7 +42,7 @@ Specifying the ``status_id`` is **required**, but any other update fields are op
 	:param string booking_id: The unique booking code identifying a booking in the system.
 	:query string status_id: The status that this booking should be set to. See **Manage / Layout / Statuses** in your account for a list of all available statuses. The default available statuses are: **PEND, HOLD, PART, PAID, WAIT, STOP,** and **VOID**
 
-	:query boolean notify: Toggle whether to trigger notifications when this booking is changed. (default: 1)
+	:query boolean notify: Toggle whether to trigger notifications when this booking is changed. (default: false)
 	:query boolean set_paid: When set to **1** (true) on an *unpaid* booking, and the requested status_id is '**PAID**', attempt to create a POS transaction covering the remaining cost of the booking (cannot be used with other input).
 
 booking/[booking_id]/bookmark

diff --git a/docs/ref/booking/index.rst b/docs/ref/booking/index.rst
@@ -12,6 +12,7 @@ booking/index
 	:query string/timestamp start_date: The date the booking starts on (i.e. check-in).
 	:query string/timestamp end_date: The date the booking ends on (i.e. check-out).
 	:query string/timestamp last_modified: The date the booking was last changed. Useful for getting bookings added or changed since your last call.
+	:query string partner_id: The partner account ID that a booking is attributed to.
 	:query integer limit: The limit of bookings to return per page (default: 100).
 	:query integer page: The page of results to return.