Skip to content

document constraints / update docs / overview - batch 1 #354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 4, 2022
Merged

document constraints / update docs / overview - batch 1 #354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3660d6a
document constraints / update docs / overview - batch 1
Azdaroth Mar 1, 2022
16900f4
feedback
Azdaroth Mar 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions content/reference/endpoints/accounts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@
1. TOC
{:toc}

## Overview

This resource represents the available Accounts.

When using <a href="/reference/authorization/#client-credentials-flow">Client Credentials Flow</a>, you can get the list of all Accounts installed for your application. When using Authorization Flow, you will only get a single account that represents a Resource Owner for a given token.

Combining <a href="/reference/authorization/#client-credentials-flow">Client Credentials Flow</a> and <a href="/guides/updated-since-flow/">updated_since flow</a> allows you also to get the list of accounts that have been canceled, suspended or uninstalled your application.


### Parameters
<ul class="nav nav-pills" role="tablist">
<li class="disabled"><a>OAuth Scopes:</a></li>
Expand All @@ -18,14 +27,17 @@ Group | Subgroup | Name | Type | Read/Write | Description
| | address2 | String | Read | Extension of company's address.
| | business_name | String | Read | Account's business name.
| | city | String | Read | City in which company is located.
| | country_code | String | Read | Code of a country in which caompany is based in.
| | country_code | String | Read | Code of a country in which company is based in.
| | default_locale | String | Read | Account's default locale. List of all available locales is described in [enums section](/reference/enums/#locales).
| | email | String | Read | Account's email.
| | selected_locales | Array | Read | Array of all locales selected for this Account. List of all available locales is described in [enums section](/reference/enums/#locales).
| | state | String | Read | State in which company is located.
| | status | String | Read | Account's status, list of statuses described in [enums section](/reference/enums/#account-statuses).
| | website | String | | Company's website
| | website | String | Read | Company's website
| | zip | String | Read | Zip code.
| | demo | Boolean | Read | Account's demo status. If the value is `true`, you probably don't want to treat as a real production Account.
| | test | Boolean | Read | Account's test status. If the value is `true`, you probably don't want to treat as a real production Account.
| | inbox_email | Boolean | Read | Account's email address within Inbox context (requires [`inbox_read` scope](/reference/authorization/#scopes)).
-----------|----------|------------------|---------|------------|------------
| | created_at | [Time](/reference/enums#formats) | Read | Account's create time.
| | updated_at | [Time](/reference/enums#formats) | Read | Account's update time.
Expand All @@ -35,15 +47,18 @@ phones | | | Object | Read
| | mobile | String | Read | Company's mobile phone number.
| | fax | String | Read | Company's fax number.
-----------|----------|------------------|---------|------------|------------
prefrences | | | Object | Read | Set of account's preferences.
| bookings | | Object | Read | Set of booking's preferences.
| | default_arrival_time | Integer | Read | Default checkin hour.
| | default_departure_time | Integer | Read | Default checkout hour.
| | default_communication_locale | String | Read | Default language locale for communication with customer. List of all available locales is described in [enums section](/reference/enums/#locales).
preferences| | | Object | Read | Set of account's preferences.
| bookings | | Object | Read | Set of booking's preferences.
| | default_arrival_time | Integer | Read | Default checkin hour.
| | default_arrival_end_time | Integer | Read | Default arrival end time.
| | default_departure_time | Integer | Read | Default checkout hour.
| | default_communication_locale | String | Read | Default language locale for communication with customer. List of all available locales is described in [enums section](/reference/enums/#locales).
| privacy_policy | | [Object](/reference/enums#formats) | Read | Account's privacy policy, list of locales described in [enums section](/reference/enums#locales).
{: class="table table-bordered"}
</div>
</div>


## List accounts

List all authorized accounts.
Expand Down
8 changes: 8 additions & 0 deletions content/reference/endpoints/amenities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
1. TOC
{:toc}

## Overview

This resource represents the available Amenities, that can be assigned to the Rentals by creating [Rentals Amenities](/reference/endpoints/rentals_amenities).

### Parameters
<ul class="nav nav-pills" role="tablist">
<li class="disabled"><a>OAuth Scopes:</a></li>
Expand All @@ -16,10 +20,14 @@ id | Integer | Read | Amenity's id.
-----------------|---------|------------|------------
key | String | Read | Amenity's key.
title | [Object](/reference/enums#formats)| Read | Amenity's title, list of locales described in [enums section](/reference/enums#locales).
-----------------|---------|------------|------------
created_at | [Time](/reference/enums#formats) | Read | Amenity's create time.
updated_at | [Time](/reference/enums#formats) | Read | Amenity's update time.
{: class="table table-bordered"}
</div>
</div>


## List amenities

List all amenities for a given account(s). Amenities can repeat because each
Expand Down
23 changes: 22 additions & 1 deletion content/reference/endpoints/applications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,39 @@
1. TOC
{:toc}

## Overview

This resource represents the installed Applications for the Account(s) via [OAuth](/reference/authorization/) - these are the actual applications that you, as a Partner, can register in [Partners Section](https://www.bookingsync.com/en/partners/).

### Parameters
<ul class="nav nav-pills" role="tablist">
<li class="disabled"><a>OAuth Scopes:</a></li>
<li class="active"><a href="#applications_read" role="tab" data-toggle="pill">applications_read</a></li>
<li><a href="#applications_write" role="tab" data-toggle="pill">applications_write</a></li>
</ul>
<div class="tab-content" markdown="1">
<div class="tab-pane active" id="applications_read" markdown="1">
Name | Type | Read/Write | Description
-----------------|---------|------------|------------
id | Integer | Read | Application's id.
-----------------|---------|------------|------------
name | String | Read | Application's name.
name | String | Read | Application's name.
default_price_increase | [Decimal](/reference/enums#formats) | Read | Application's default price increase for [Bookings](/reference/endpoints/bookings) originating from a given Application. Also, this increase is reflected in [Rates](/reference/endpoints/rates) and [LOS Records](/reference/endpoints/los_records)
--------------------|---------|------------|------------
created_at | [Time](/reference/enums#formats) | Read | Applications's create time.
updated_at | [Time](/reference/enums#formats) | Read | Applications's update time.
{: class="table table-bordered"}
</div>
<div class="tab-pane" id="rentals_write" markdown="1">
Name | Type | Read/Write | Description | Constraints
--------------------|---------|------------|------------
id | Integer | Read | Application's id. |
--------------------|---------|------------|------------
name | String | Read | Application's name. |
default_price_increase | [Decimal](/reference/enums#formats) | Read/Write | Application's default price increase for [Bookings](/reference/endpoints/bookings) originating from a given Application. Also, this increase is reflected in [Rates](/reference/endpoints/rates) and [LOS Records](/reference/endpoints/los_records) | greater than: 0, less than: 100
--------------------|---------|------------|------------
created_at | [Time](/reference/enums#formats) | Read | Application's create time.
updated_at | [Time](/reference/enums#formats) | Read | Application's update time.
{: class="table table-bordered"}
</div>
</div>
Expand Down
15 changes: 14 additions & 1 deletion content/reference/endpoints/availabilities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@
1. TOC
{:toc}

## Overview

This resource represents the Availabilities for a given Rental. The `map` represents consecutive 1096 days starting from `start_date` and tells whether a given day is available (there is no [Booking](/reference/endpoints/bookings) for that day) or unavailable (there is already a [Booking](/reference/endpoints/bookings) for that day).

Availabilities are regenerated after creation of Bookings and at the beginning of each month and `start_date` always points to the beginning of current month.

Particularly useful when implementing a UI containing calendar that allows to select dates for a Booking - using this map you can block unavailable dates.

However, this resource doesn't cover all cases why a given day might be unavailable (e.g. it doesn't cover [Rates Rules](/reference/endpoints/rates_rules/)). You might want to check [ChangeOvers](http://developers.bookingsync.com/reference/endpoints/change_overs/) to have a map covering these cases.

### Parameters
<ul class="nav nav-pills" role="tablist">
<li class="disabled"><a>OAuth Scopes:</a></li>
Expand All @@ -12,11 +22,14 @@
<div class="tab-pane active" id="public" markdown="1">
Name | Type | Read/Write | Description
-----------------|---------|------------|------------
id | Integer | Read | Availability's id.
account | Integer | Read | Account's ID related to the Availability
rental | Integer | Read | Rental's ID related to the Availability
-----------------|---------|------------|------------
id | Integer | Read | Availability's id.
map | String | Read | Availability's map of booking status. There is a total of 1096 characters, each representing one day. List of statuses described in [enums section](/reference/enums#availability-map-statuses).
-----------------|---------|------------|------------
start_date | [Date](/reference/enums#formats) | Read | Availability's start date.
created_at | [Time](/reference/enums#formats) | Read | Availability's creation time.
updated_at | [Time](/reference/enums#formats) | Read | Availability's update time.
{: class="table table-bordered"}
</div>
Expand Down
26 changes: 17 additions & 9 deletions content/reference/endpoints/bathrooms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
1. TOC
{:toc}

## Overview

This resource represents the rental's bathrooms. This resource is mostly static information used for presentational purposes.

### Parameters
<ul class="nav nav-pills" role="tablist">
<li class="disabled"><a>OAuth Scopes:</a></li>
Expand All @@ -13,8 +17,10 @@
<div class="tab-pane active" id="public" markdown="1">
Name | Type | Read/Write | Description
--------------------|---------|------------|------------
id | Integer | Read | Bathroom's id.
account | Integer | Read | Account's ID related to the Bathroom
rental | Integer | Read | Rental's ID related to the Bathroom
--------------------|---------|------------|------------
id | Integer | Read | Bathroom's id.
name | [Object](/reference/enums#formats)| Read | Bathroom's name, list of locales described in [enums section](/reference/enums#locales).
bath_count | Integer | Read | Bathroom's number of baths.
shower_count | Integer | Read | Bathroom's number of showers.
Expand All @@ -25,14 +31,16 @@ updated_at | [Time](/reference/enums#formats) | Read | Bathroom'
{: class="table table-bordered"}
</div>
<div class="tab-pane" id="rentals_write" markdown="1">
Name | Type | Read/Write | Description
--------------------|---------|------------|------------
id | Integer | Read | Bathroom's id.
--------------------|---------|------------|------------
name | [Object](/reference/enums#formats)| Read/Write | **Required**. Bathroom's name, list of locales described in [enums section](/reference/enums#locales).
bath_count | Integer | Read/Write | Bathroom's number of baths.
shower_count | Integer | Read/Write | Bathroom's number of showers.
wc_count | Integer | Read/Write | Bathroom's number of wc's.
Name | Type | Read/Write | Description | Constraints
--------------------|---------|------------|------------ |
account | Integer | Read | Account's ID related to the Bathroom |
rental | Integer | Read | Rental's ID related to the Bathroom |
--------------------|---------|------------|------------|
id | Integer | Read | Bathroom's id. |
name | [Object](/reference/enums#formats)| Read/Write | Bathroom's name, list of locales described in [enums section](/reference/enums#locales). | **Required**, maximum length: 25
bath_count | Integer | Read/Write | Bathroom's number of baths. | integer only, greater than or equal to: 0
shower_count | Integer | Read/Write | Bathroom's number of showers. | integer only, greater than or equal to: 0
wc_count | Integer | Read/Write | Bathroom's number of wc's. | integer only, greater than or equal to: 0
--------------------|---------|------------|------------
created_at | [Time](/reference/enums#formats) | Read | Bathroom's create time.
updated_at | [Time](/reference/enums#formats) | Read | Bathroom's update time.
Expand Down
41 changes: 27 additions & 14 deletions content/reference/endpoints/bedrooms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
1. TOC
{:toc}

## Overview

This resource represents the rental's bedrooms. This resource is mostly static information used for presentational purposes.

### Parameters
<ul class="nav nav-pills" role="tablist">
<li class="disabled"><a>OAuth Scopes:</a></li>
Expand All @@ -13,35 +17,44 @@
<div class="tab-pane active" id="public" markdown="1">
Name | Type | Read/Write | Description
--------------------|---------|------------|------------
id | Integer | Read | Bedroom's id.
account | Integer | Read | Account's ID related to the Bedroom
rental | Integer | Read | Rental's ID related to the Bedroom
--------------------|---------|------------|------------
id | Integer | Read | Bedroom's id.
name | [Object](/reference/enums#formats)| Read | Bedroom's name, list of locales described in [enums section](/reference/enums#locales).
bunk_beds_count | Integer | Read | Bedroom's number of bunk beds.
double_beds_count | Integer | Read | Bedroom's number of double beds.
kingsize_beds_count | Integer | Read | Bedroom's number of kingsize beds.
queensize_beds_count| Integer | Read | Bedroom's number of queensize beds.
single_beds_count | Integer | Read | Bedroom's number of single beds.
sofa_beds_count | Integer | Read | Bedroom's number of sofa beds.
futon_beds_count | Integer | Read | Bedroom's number of futon beds.
floor_mattress_beds_count | Integer | Read | Bedroom's number of floor mattress beds.
toddler_beds_count | Integer | Read | Bedroom's number of toddler beds.
crib_beds_count | Integer | Read | Bedroom's number of crib beds.
air_mattress_beds_count | Integer | Read | Bedroom's number of air mattress beds.
--------------------|---------|------------|------------
created_at | [Time](/reference/enums#formats) | Read | Bedroom's create time.
updated_at | [Time](/reference/enums#formats) | Read | Bedroom's update time.
{: class="table table-bordered"}
</div>
<div class="tab-pane" id="rentals_write" markdown="1">
Name | Type | Read/Write | Description
Name | Type | Read/Write | Description | Constraints
--------------------|---------|------------|---------------|
account | Integer | Read | Account's ID related to the Bedroom |
rental | Integer | Read | Rental's ID related to the Bedroom |
--------------------|---------|------------|---------------|
id | Integer | Read | Bedroom's id. |
name | [Object](/reference/enums#formats)| Read/Write | Bedroom's name, list of locales described in [enums section](/reference/enums#locales). | **Required**, maximum length: 25
bunk_beds_count | Integer | Read/Write | Bedroom's number of bunk beds. | integer only, greater than or equal to: 0
double_beds_count | Integer | Read/Write | Bedroom's number of double beds. | integer only, greater than or equal to: 0
kingsize_beds_count | Integer | Read/Write | Bedroom's number of kingsize beds. | integer only, greater than or equal to: 0
queensize_beds_count | Integer | Read/Write | Bedroom's number of queensize beds. | integer only, greater than or equal to: 0
single_beds_count | Integer | Read/Write | Bedroom's number of single beds. | integer only, greater than or equal to: 0
sofa_beds_count | Integer | Read/Write | Bedroom's number of sofa beds. | integer only, greater than or equal to: 0
--------------------|---------|------------|------------
id | Integer | Read | Bedroom's id.
--------------------|---------|------------|------------
name | [Object](/reference/enums#formats)| Read/Write | **Required**. Bedroom's name, list of locales described in [enums section](/reference/enums#locales).
bunk_beds_count | Integer | Read/Write | Bedroom's number of bunk beds.
double_beds_count | Integer | Read/Write | Bedroom's number of double beds.
kingsize_beds_count | Integer | Read/Write | Bedroom's number of kingsize beds.
queensize_beds_count| Integer | Read/Write | Bedroom's number of queensize beds.
single_beds_count | Integer | Read/Write | Bedroom's number of single beds.
sofa_beds_count | Integer | Read/Write | Bedroom's number of sofa beds.
--------------------|---------|------------|------------
created_at | [Time](/reference/enums#formats) | Read | Bedroom's create time.
updated_at | [Time](/reference/enums#formats) | Read | Bedroom's update time.
created_at | [Time](/reference/enums#formats) | Read | Bedroom's create time. |
updated_at | [Time](/reference/enums#formats) | Read | Bedroom's update time. |
{: class="table table-bordered"}
</div>
</div>
Expand Down
Loading