Skip to content

document preferences general settings endpoint #335

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

Open
Azdaroth wants to merge 1 commit into
base: master
Choose a base branch
from
Open

document preferences general settings endpoint #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 37 additions & 0 deletions .../preferences_general_settings_read-preferences_general_settings_write-scope-response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
"links": {
"preferences_general_settings.account": "https://www.bookingsync.com/api/v3/accounts/{preferences_general_settings.account}"
},
"preferences_general_settings": [
{
"links": {
"account": 1059638631
},
"id": 1059638632,
"email": "email@email.com",
"default_arrival_time": 16,
"default_arrival_end_time": 18,
"default_departure_time": 10,
"selected_locales": ["en", "fr", "de"],
"business_name": "Business",
"website": "https://www.example.com",
"phone": "800 100 100",
"mobile": "800 200 200",
"fax": "800 300 300",
"address1": "Behind the corner 2",
"address2": "",
"city": "Capital",
"state": "Main",
"zip": "91-123",
"country": "Poland",
"country_code": "PL",
"full_address": "Behind the corner 2\n91-123 Capital\nMain\nPoland",
"default_communication_locale": "en",
"created_at": "2021-02-01T06:59:36Z",
"updated_at": "2021-02-01T06:59:36Z",
"rounding_percentage_up": "1.0",
"rounding_percentage_down": "1.0"
}
],
"meta": {}
}
7 changes: 7 additions & 0 deletions api_calls/reference/preferences_general_settings/update-request.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"preferences_general_settings": [
{
"selected_locales": ["en", "fr", "de"]
}
]
}
106 changes: 106 additions & 0 deletions content/reference/endpoints/preferences_general_settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# Accounts

1. TOC
{:toc}

### Parameters
<ul class="nav nav-pills" role="tablist">
<li class="disabled"><a>OAuth Scopes:</a></li>
<li class="active"><a href="#preferences_general_settings_read" role="tab" data-toggle="pill">preferences_general_settings_read</a></li>
<li><a href="#preferences_general_settings_write" role="tab" data-toggle="pill">preferences_general_settings_write</a></li>
</ul>
<div class="tab-content" markdown="1">
<div class="tab-pane active" id="public" markdown="1">
Name | Type | Read/Write | Description
--------------------|---------|------------|------------
id | Integer | Read | Preferences General Setting's id.
--------------------|---------|------------|------------
email | String | Read | Account's email
default_arrival_time | [Object](/reference/enums#formats)| Read | Default arrival time for bookings
default_arrival_end_time | Integer | Read | Default arrival end time for bookings
default_departure_time | Integer | Read | Default departure time for bookings
selected_locales | Array[String] | Read/Write | List of locales supported by the account
business_name | String | Read | Account's business name
website | String | Read | Account's website
phone | String | Read | Account's phone
mobile | String | Read | Account's mobile
fax | String | Read | Account's fax
address1 | String | Read | Account's address1
address2 | String | Read | Account's address2
city | String | Read | Account's city
state | String | Read | Account's state
zip | String | Read | Account's zip
country | String | Read | Account's country
country_code | String | Read | Account's country code
full_address | String | Read | Account's full address
default_communication_locale | String | Read | Account's default communicaton locale
rounding_percentage_up | [Decimal](/reference/enums#formats) | Read | Rounding percentage up setting used for rounding rental's price
rounding_percentage_down | [Decimal](/reference/enums#formats) | Read | Rounding percentage down setting used for rounding rental's price
--------------------|---------|------------|------------
created_at | [Time](/reference/enums#formats) | Read | Preferences General Setting's create time.
updated_at | [Time](/reference/enums#formats) | Read | Preferences General Setting's update time.
{: class="table table-bordered"}
</div>
<div class="tab-pane" id="preferences_general_settings_write" markdown="1">
Name | Type | Read/Write | Description
--------------------|---------|------------|------------
id | Integer | Read | Preferences General Setting's id.
--------------------|---------|------------|------------
email | String | Read | Account's email
default_arrival_time | [Object](/reference/enums#formats)| Read | Bathroom's name, list of locales described in [enums section](/reference/enums#locales).
default_arrival_end_time | Integer | Read | Default arrival end time for bookings
default_departure_time | Integer | Read | Default departure time for bookings
selected_locales | Array[String] | Read/Write | List of locales supported by the account
business_name | String | Read | Account's business name
website | String | Read | Account's website
phone | String | Read | Account's phone
mobile | String | Read | Account's mobile
fax | String | Read | Account's fax
address1 | String | Read | Account's address1
address2 | String | Read | Account's address2
city | String | Read | Account's city
state | String | Read | Account's state
zip | String | Read | Account's zip
country | String | Read | Account's country
country_code | String | Read | Account's country code
full_address | String | Read | Account's full address
default_communication_locale | String | Read | Account's default communicaton locale
rounding_percentage_up | [Decimal](/reference/enums#formats) | Read | Rounding percentage up setting used for rounding rental's price
rounding_percentage_down | [Decimal](/reference/enums#formats) | Read | Rounding percentage down setting used for rounding rental's price
--------------------|---------|------------|------------
created_at | [Time](/reference/enums#formats) | Read | Preferences General Setting's create time.
updated_at | [Time](/reference/enums#formats) | Read | Preferences General Setting's update time.
{: class="table table-bordered"}
</div>
</div>

## List preferences general settings

List all preferences general settings for authorized accounts.

~~~
GET /preferences_general_settings
~~~

<%= render 'json_response', endpoint: "preferences_general_settings", scopes: %w(preferences_general_settings_read-preferences_general_settings_write) %>

## Get a preferences general setting

Returns a single preferences general setting identified by ID.

~~~
GET /preferences_general_settings/:preferences_general_setting_id
~~~

<%= render 'json_response', endpoint: "preferences_general_settings", scopes: %w(preferences_general_settings_read-preferences_general_settings_write) %>

## Update a preferences general setting

Returns an updated preferences general setting identified by ID.

~~~
PUT /preferences_general_settings/:preferences_general_setting_id
~~~

<%= render 'json_response', endpoint: "preferences_general_settings", request: "update",
scopes: [{ preferences_general_settings_write: "preferences_general_settings_read-preferences_general_settings_write" }] %>
2 changes: 2 additions & 0 deletions layouts/reference.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,8 @@ <h3 class="panel-title">Endpoints</h3>
class: "list-group-item") %>
<%= link_to_with_current("Photos", "/reference/endpoints/photos/",
class: "list-group-item") %>
<%= link_to_with_current("Preferences General Settings", "/reference/endpoints/preferences_general_settings/",
class: "list-group-item") %>
<%= link_to_with_current("Rates", "/reference/endpoints/rates/",
class: "list-group-item") %>
<%= link_to_with_current("Rates Rules", "/reference/endpoints/rates_rules/",
Expand Down