From 83ae1b3a742aec0611ded9486901c40178c985f4 Mon Sep 17 00:00:00 2001 From: Karol Galanciak Date: Mon, 1 Feb 2021 09:06:15 +0100 Subject: [PATCH] document preferences general settings endpoint --- ...general_settings_write-scope-response.json | 37 ++++++ .../update-request.json | 7 ++ .../endpoints/preferences_general_settings.md | 106 ++++++++++++++++++ layouts/reference.html | 2 + 4 files changed, 152 insertions(+) create mode 100644 api_calls/reference/preferences_general_settings/preferences_general_settings_read-preferences_general_settings_write-scope-response.json create mode 100644 api_calls/reference/preferences_general_settings/update-request.json create mode 100644 content/reference/endpoints/preferences_general_settings.md diff --git a/api_calls/reference/preferences_general_settings/preferences_general_settings_read-preferences_general_settings_write-scope-response.json b/api_calls/reference/preferences_general_settings/preferences_general_settings_read-preferences_general_settings_write-scope-response.json new file mode 100644 index 00000000..d756f77b --- /dev/null +++ b/api_calls/reference/preferences_general_settings/preferences_general_settings_read-preferences_general_settings_write-scope-response.json @@ -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": {} +} diff --git a/api_calls/reference/preferences_general_settings/update-request.json b/api_calls/reference/preferences_general_settings/update-request.json new file mode 100644 index 00000000..034548e5 --- /dev/null +++ b/api_calls/reference/preferences_general_settings/update-request.json @@ -0,0 +1,7 @@ +{ + "preferences_general_settings": [ + { + "selected_locales": ["en", "fr", "de"] + } + ] +} diff --git a/content/reference/endpoints/preferences_general_settings.md b/content/reference/endpoints/preferences_general_settings.md new file mode 100644 index 00000000..be29d9d3 --- /dev/null +++ b/content/reference/endpoints/preferences_general_settings.md @@ -0,0 +1,106 @@ +# Accounts + +1. TOC +{:toc} + +### Parameters + +
+
+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"} +
+
+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"} +
+
+ +## 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" }] %> diff --git a/layouts/reference.html b/layouts/reference.html index ee5450b3..3b131458 100644 --- a/layouts/reference.html +++ b/layouts/reference.html @@ -90,6 +90,8 @@

Endpoints

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/",