quandoo 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +197 -0
- data/Rakefile +8 -0
- data/config.json +8 -0
- data/docs/AgentTracking.md +8 -0
- data/docs/AreaDto.md +10 -0
- data/docs/AvailabilitiesApi.md +132 -0
- data/docs/ChainDto.md +9 -0
- data/docs/ChangedReviewDto.md +10 -0
- data/docs/CoordinatesDto.md +9 -0
- data/docs/CreateReviewDto.md +10 -0
- data/docs/CreatedMasterCustomer.md +8 -0
- data/docs/CreatedReservation.md +11 -0
- data/docs/CreatedReservationData.md +10 -0
- data/docs/CreatedReservationEnquiry.md +8 -0
- data/docs/CreatedReservationEnquiryData.md +10 -0
- data/docs/CustomerDataList.md +10 -0
- data/docs/CustomerDto.md +10 -0
- data/docs/CustomerResponse.md +17 -0
- data/docs/CustomerReviewData.md +11 -0
- data/docs/CustomerStatisticsData.md +10 -0
- data/docs/CustomersApi.md +183 -0
- data/docs/DealData.md +10 -0
- data/docs/DocumentDto.md +11 -0
- data/docs/ErrorResponse.md +9 -0
- data/docs/GetReservationEnquiryData.md +14 -0
- data/docs/GetReviewDto.md +14 -0
- data/docs/GetReviewsDto.md +11 -0
- data/docs/ImageDto.md +8 -0
- data/docs/LinkRelationDto.md +10 -0
- data/docs/LocationDto.md +9 -0
- data/docs/MarketingSettingDto.md +9 -0
- data/docs/MenusApi.md +300 -0
- data/docs/MerchantAddressDto.md +12 -0
- data/docs/MerchantAvailabilityDaysDto.md +9 -0
- data/docs/MerchantAvailabilityDto.md +11 -0
- data/docs/MerchantAvailabilityDtoList.md +10 -0
- data/docs/MerchantCustomer.md +15 -0
- data/docs/MerchantCustomerData.md +21 -0
- data/docs/MerchantDetailsDto.md +24 -0
- data/docs/MerchantDetailsDtoList.md +11 -0
- data/docs/MerchantMenuCategoryDto.md +10 -0
- data/docs/MerchantMenuDto.md +13 -0
- data/docs/MerchantMenuItemDto.md +11 -0
- data/docs/MerchantMenusDto.md +8 -0
- data/docs/MerchantReservation.md +18 -0
- data/docs/MerchantReservationData.md +10 -0
- data/docs/MerchantReservationEnquiry.md +13 -0
- data/docs/MerchantReservationEnquiryData.md +10 -0
- data/docs/MerchantReservationSettingsDto.md +18 -0
- data/docs/MerchantSubscription.md +8 -0
- data/docs/MerchantVaultSettingsDto.md +11 -0
- data/docs/MerchantWithRecommendationsDto.md +10 -0
- data/docs/MerchantsApi.md +334 -0
- data/docs/OpeningTimesDto.md +8 -0
- data/docs/ReservationData.md +18 -0
- data/docs/ReservationDataList.md +8 -0
- data/docs/ReservationDetails.md +11 -0
- data/docs/ReservationEnquiriesApi.md +230 -0
- data/docs/ReservationEnquiryMessageData.md +10 -0
- data/docs/ReservationEnquiryMessageList.md +8 -0
- data/docs/ReservationMenuData.md +8 -0
- data/docs/ReservationMenuItemData.md +12 -0
- data/docs/ReservationSettingsApi.md +56 -0
- data/docs/ReservationsApi.md +168 -0
- data/docs/RestCookie.md +9 -0
- data/docs/ReviewDto.md +12 -0
- data/docs/ReviewDtoList.md +11 -0
- data/docs/ReviewsApi.md +235 -0
- data/docs/StandardOpeningTimesDto.md +7 -0
- data/docs/StatusApi.md +90 -0
- data/docs/TagGroupDto.md +9 -0
- data/docs/Tracking.md +9 -0
- data/docs/TranslatedTagDto.md +9 -0
- data/docs/UpdateReservationData.md +8 -0
- data/docs/UpdateReservationEnquiryData.md +8 -0
- data/docs/UpdateReviewDto.md +10 -0
- data/docs/ValidationsApi.md +59 -0
- data/git_push.sh +55 -0
- data/lib/quandoo.rb +113 -0
- data/lib/quandoo/api/availabilities_api.rb +171 -0
- data/lib/quandoo/api/customers_api.rb +185 -0
- data/lib/quandoo/api/menus_api.rb +301 -0
- data/lib/quandoo/api/merchants_api.rb +357 -0
- data/lib/quandoo/api/reservation_enquiries_api.rb +232 -0
- data/lib/quandoo/api/reservation_settings_api.rb +73 -0
- data/lib/quandoo/api/reservations_api.rb +178 -0
- data/lib/quandoo/api/reviews_api.rb +241 -0
- data/lib/quandoo/api/status_api.rb +111 -0
- data/lib/quandoo/api/validations_api.rb +76 -0
- data/lib/quandoo/api_client.rb +389 -0
- data/lib/quandoo/api_error.rb +38 -0
- data/lib/quandoo/configuration.rb +216 -0
- data/lib/quandoo/models/agent_tracking.rb +189 -0
- data/lib/quandoo/models/area_dto.rb +204 -0
- data/lib/quandoo/models/chain_dto.rb +192 -0
- data/lib/quandoo/models/changed_review_dto.rb +250 -0
- data/lib/quandoo/models/coordinates_dto.rb +192 -0
- data/lib/quandoo/models/create_review_dto.rb +214 -0
- data/lib/quandoo/models/created_master_customer.rb +189 -0
- data/lib/quandoo/models/created_reservation.rb +229 -0
- data/lib/quandoo/models/created_reservation_data.rb +221 -0
- data/lib/quandoo/models/created_reservation_enquiry.rb +189 -0
- data/lib/quandoo/models/created_reservation_enquiry_data.rb +221 -0
- data/lib/quandoo/models/customer_data_list.rb +203 -0
- data/lib/quandoo/models/customer_dto.rb +201 -0
- data/lib/quandoo/models/customer_response.rb +362 -0
- data/lib/quandoo/models/customer_review_data.rb +214 -0
- data/lib/quandoo/models/customer_statistics_data.rb +219 -0
- data/lib/quandoo/models/deal_data.rb +253 -0
- data/lib/quandoo/models/document_dto.rb +210 -0
- data/lib/quandoo/models/error_response.rb +226 -0
- data/lib/quandoo/models/get_reservation_enquiry_data.rb +249 -0
- data/lib/quandoo/models/get_review_dto.rb +288 -0
- data/lib/quandoo/models/get_reviews_dto.rb +216 -0
- data/lib/quandoo/models/image_dto.rb +183 -0
- data/lib/quandoo/models/link_relation_dto.rb +235 -0
- data/lib/quandoo/models/location_dto.rb +192 -0
- data/lib/quandoo/models/marketing_setting_dto.rb +238 -0
- data/lib/quandoo/models/merchant_address_dto.rb +219 -0
- data/lib/quandoo/models/merchant_availability_days_dto.rb +198 -0
- data/lib/quandoo/models/merchant_availability_dto.rb +226 -0
- data/lib/quandoo/models/merchant_availability_dto_list.rb +215 -0
- data/lib/quandoo/models/merchant_customer.rb +271 -0
- data/lib/quandoo/models/merchant_customer_data.rb +390 -0
- data/lib/quandoo/models/merchant_details_dto.rb +402 -0
- data/lib/quandoo/models/merchant_details_dto_list.rb +218 -0
- data/lib/quandoo/models/merchant_menu_category_dto.rb +216 -0
- data/lib/quandoo/models/merchant_menu_dto.rb +251 -0
- data/lib/quandoo/models/merchant_menu_item_dto.rb +224 -0
- data/lib/quandoo/models/merchant_menus_dto.rb +185 -0
- data/lib/quandoo/models/merchant_reservation.rb +301 -0
- data/lib/quandoo/models/merchant_reservation_data.rb +219 -0
- data/lib/quandoo/models/merchant_reservation_enquiry.rb +311 -0
- data/lib/quandoo/models/merchant_reservation_enquiry_data.rb +219 -0
- data/lib/quandoo/models/merchant_reservation_settings_dto.rb +290 -0
- data/lib/quandoo/models/merchant_subscription.rb +217 -0
- data/lib/quandoo/models/merchant_vault_settings_dto.rb +231 -0
- data/lib/quandoo/models/merchant_with_recommendations_dto.rb +248 -0
- data/lib/quandoo/models/opening_times_dto.rb +189 -0
- data/lib/quandoo/models/reservation_data.rb +331 -0
- data/lib/quandoo/models/reservation_data_list.rb +185 -0
- data/lib/quandoo/models/reservation_details.rb +229 -0
- data/lib/quandoo/models/reservation_enquiry_message_data.rb +241 -0
- data/lib/quandoo/models/reservation_enquiry_message_list.rb +185 -0
- data/lib/quandoo/models/reservation_menu_data.rb +190 -0
- data/lib/quandoo/models/reservation_menu_item_data.rb +219 -0
- data/lib/quandoo/models/rest_cookie.rb +194 -0
- data/lib/quandoo/models/review_dto.rb +238 -0
- data/lib/quandoo/models/review_dto_list.rb +218 -0
- data/lib/quandoo/models/standard_opening_times_dto.rb +174 -0
- data/lib/quandoo/models/tag_group_dto.rb +228 -0
- data/lib/quandoo/models/tracking.rb +199 -0
- data/lib/quandoo/models/translated_tag_dto.rb +192 -0
- data/lib/quandoo/models/update_reservation_data.rb +189 -0
- data/lib/quandoo/models/update_reservation_enquiry_data.rb +184 -0
- data/lib/quandoo/models/update_review_dto.rb +209 -0
- data/lib/quandoo/version.rb +15 -0
- data/quandoo.gemspec +45 -0
- data/spec/api/availabilities_api_spec.rb +69 -0
- data/spec/api/customers_api_spec.rb +75 -0
- data/spec/api/menus_api_spec.rb +100 -0
- data/spec/api/merchants_api_spec.rb +119 -0
- data/spec/api/reservation_enquiries_api_spec.rb +84 -0
- data/spec/api/reservation_settings_api_spec.rb +47 -0
- data/spec/api/reservations_api_spec.rb +72 -0
- data/spec/api/reviews_api_spec.rb +86 -0
- data/spec/api/status_api_spec.rb +57 -0
- data/spec/api/validations_api_spec.rb +48 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/agent_tracking_spec.rb +41 -0
- data/spec/models/area_dto_spec.rb +53 -0
- data/spec/models/chain_dto_spec.rb +47 -0
- data/spec/models/changed_review_dto_spec.rb +57 -0
- data/spec/models/coordinates_dto_spec.rb +47 -0
- data/spec/models/create_review_dto_spec.rb +53 -0
- data/spec/models/created_master_customer_spec.rb +41 -0
- data/spec/models/created_reservation_data_spec.rb +53 -0
- data/spec/models/created_reservation_enquiry_data_spec.rb +53 -0
- data/spec/models/created_reservation_enquiry_spec.rb +41 -0
- data/spec/models/created_reservation_spec.rb +59 -0
- data/spec/models/customer_data_list_spec.rb +53 -0
- data/spec/models/customer_dto_spec.rb +53 -0
- data/spec/models/customer_response_spec.rb +99 -0
- data/spec/models/customer_review_data_spec.rb +59 -0
- data/spec/models/customer_statistics_data_spec.rb +53 -0
- data/spec/models/deal_data_spec.rb +57 -0
- data/spec/models/document_dto_spec.rb +59 -0
- data/spec/models/error_response_spec.rb +51 -0
- data/spec/models/get_reservation_enquiry_data_spec.rb +77 -0
- data/spec/models/get_review_dto_spec.rb +81 -0
- data/spec/models/get_reviews_dto_spec.rb +59 -0
- data/spec/models/image_dto_spec.rb +41 -0
- data/spec/models/link_relation_dto_spec.rb +57 -0
- data/spec/models/location_dto_spec.rb +47 -0
- data/spec/models/marketing_setting_dto_spec.rb +55 -0
- data/spec/models/merchant_address_dto_spec.rb +65 -0
- data/spec/models/merchant_availability_days_dto_spec.rb +47 -0
- data/spec/models/merchant_availability_dto_list_spec.rb +53 -0
- data/spec/models/merchant_availability_dto_spec.rb +59 -0
- data/spec/models/merchant_customer_data_spec.rb +119 -0
- data/spec/models/merchant_customer_spec.rb +83 -0
- data/spec/models/merchant_details_dto_list_spec.rb +59 -0
- data/spec/models/merchant_details_dto_spec.rb +137 -0
- data/spec/models/merchant_menu_category_dto_spec.rb +53 -0
- data/spec/models/merchant_menu_dto_spec.rb +71 -0
- data/spec/models/merchant_menu_item_dto_spec.rb +59 -0
- data/spec/models/merchant_menus_dto_spec.rb +41 -0
- data/spec/models/merchant_reservation_data_spec.rb +53 -0
- data/spec/models/merchant_reservation_enquiry_data_spec.rb +53 -0
- data/spec/models/merchant_reservation_enquiry_spec.rb +71 -0
- data/spec/models/merchant_reservation_settings_dto_spec.rb +101 -0
- data/spec/models/merchant_reservation_spec.rb +101 -0
- data/spec/models/merchant_subscription_spec.rb +45 -0
- data/spec/models/merchant_vault_settings_dto_spec.rb +59 -0
- data/spec/models/merchant_with_recommendations_dto_spec.rb +57 -0
- data/spec/models/opening_times_dto_spec.rb +41 -0
- data/spec/models/reservation_data_list_spec.rb +41 -0
- data/spec/models/reservation_data_spec.rb +101 -0
- data/spec/models/reservation_details_spec.rb +59 -0
- data/spec/models/reservation_enquiry_message_data_spec.rb +57 -0
- data/spec/models/reservation_enquiry_message_list_spec.rb +41 -0
- data/spec/models/reservation_menu_data_spec.rb +41 -0
- data/spec/models/reservation_menu_item_data_spec.rb +65 -0
- data/spec/models/rest_cookie_spec.rb +47 -0
- data/spec/models/review_dto_list_spec.rb +59 -0
- data/spec/models/review_dto_spec.rb +65 -0
- data/spec/models/standard_opening_times_dto_spec.rb +35 -0
- data/spec/models/tag_group_dto_spec.rb +51 -0
- data/spec/models/tracking_spec.rb +47 -0
- data/spec/models/translated_tag_dto_spec.rb +47 -0
- data/spec/models/update_reservation_data_spec.rb +41 -0
- data/spec/models/update_reservation_enquiry_data_spec.rb +41 -0
- data/spec/models/update_review_dto_spec.rb +53 -0
- data/spec/spec_helper.rb +111 -0
- metadata +538 -0
@@ -0,0 +1,12 @@
|
|
1
|
+
# Quandoo::MerchantAddressDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**street** | **String** | | [optional]
|
7
|
+
**number** | **String** | | [optional]
|
8
|
+
**zipcode** | **String** | | [optional]
|
9
|
+
**city** | **String** | | [optional]
|
10
|
+
**country** | **String** | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Quandoo::MerchantAvailabilityDaysDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**days** | **Array<Date>** | The days that are available for a reservation | [optional]
|
7
|
+
**links** | [**Array<LinkRelationDto>**](LinkRelationDto.md) | The links for possible operations related to this entity | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Quandoo::MerchantAvailabilityDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**date_time** | **DateTime** | The date and time when the reservation will take place. Format: yyyy-MM-ddTHH:mm:ssZ |
|
7
|
+
**occupancy** | **Integer** | The occupancy of this availability option across the restaurant. This is an integer number between 0 and 100. |
|
8
|
+
**area_ids** | **Array<Integer>** | The ids of the areas this availability option can be reserved for. | [optional]
|
9
|
+
**vault_settings_id** | **String** | The id of the Vault Settings applicable on this availability option. | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Quandoo::MerchantAvailabilityDtoList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**time_slots** | [**Array<MerchantAvailabilityDto>**](MerchantAvailabilityDto.md) | The availability time slots to reserve. | [optional]
|
7
|
+
**vault_settings** | [**Array<MerchantVaultSettingsDto>**](MerchantVaultSettingsDto.md) | The credit card vault settings. | [optional]
|
8
|
+
**links** | [**Array<LinkRelationDto>**](LinkRelationDto.md) | The links related to this entity. |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Quandoo::MerchantCustomer
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | Identifier of the customer for the calling agent. (Agent dependent field) | [optional]
|
7
|
+
**first_name** | **String** | The first name of the customer. Optional. | [optional]
|
8
|
+
**last_name** | **String** | The last name of the customer. | [optional]
|
9
|
+
**email_address** | **String** | The email address of the customer. | [optional]
|
10
|
+
**phone_number** | **String** | The phone number of the customer. The expected format is E164 e.g. +4930120765890 |
|
11
|
+
**locale** | **String** | The locale of the customer. E.g. de_DE |
|
12
|
+
**country** | **String** | The 2 letter ISO country of the customer, e.g. DE |
|
13
|
+
**subscriptions** | [**Array<MerchantSubscription>**](MerchantSubscription.md) | The requested subscriptions, e.g. QUANDOO, MERCHANT | [optional]
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# Quandoo::MerchantCustomerData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The id of the customer. |
|
7
|
+
**customer_ref** | **String** | Customer reference |
|
8
|
+
**marketing_flags** | [**Array<MarketingSettingDto>**](MarketingSettingDto.md) | Marketing flags for customer. |
|
9
|
+
**title** | **String** | Title of the customer. |
|
10
|
+
**first_name** | **String** | First name of the customer. |
|
11
|
+
**last_name** | **String** | Last name of the customer. |
|
12
|
+
**email** | **String** | Email of the customer. |
|
13
|
+
**phone_number** | **String** | Fixed line phone number of the customer. |
|
14
|
+
**mobile_number** | **String** | Mobile phone number of the customer. |
|
15
|
+
**locale** | **String** | Locale of the customer. |
|
16
|
+
**links** | [**Array<LinkRelationDto>**](LinkRelationDto.md) | The links related to this entity. |
|
17
|
+
**subscriptions** | [**Array<MerchantSubscription>**](MerchantSubscription.md) | The newsletter subscriptions, e.g. QUANDOO, MERCHANT. |
|
18
|
+
**statistics** | [**CustomerStatisticsData**](CustomerStatisticsData.md) | Statistics about the customer |
|
19
|
+
**updated_at** | **DateTime** | The date and time when the reservation will take place. Format: yyyy-MM-ddTHH:mm:ssZ |
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# Quandoo::MerchantDetailsDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **Integer** | The id of the merchant. |
|
7
|
+
**name** | **String** | The name of the merchant. |
|
8
|
+
**phone_number** | **String** | The phone number of the merchant. |
|
9
|
+
**currency** | **String** | The currency of the merchant. | [optional]
|
10
|
+
**locale** | **String** | The locale of the merchant. | [optional]
|
11
|
+
**timezone** | **String** | The timezone of the merchant. |
|
12
|
+
**location** | [**LocationDto**](LocationDto.md) | The location of the merchant. |
|
13
|
+
**review_score** | **String** | The review score of the merchant. |
|
14
|
+
**tag_groups** | [**Array<TagGroupDto>**](TagGroupDto.md) | The tag groups this merchant belongs to. | [optional]
|
15
|
+
**images** | [**Array<ImageDto>**](ImageDto.md) | The images this merchant has. | [optional]
|
16
|
+
**documents** | [**Array<DocumentDto>**](DocumentDto.md) | The documents this merchant has. | [optional]
|
17
|
+
**links** | [**Array<LinkRelationDto>**](LinkRelationDto.md) | The links related to this entity. |
|
18
|
+
**bookable** | **BOOLEAN** | The flag indicates whether the merchant is bookable or not. |
|
19
|
+
**opening_times** | [**OpeningTimesDto**](OpeningTimesDto.md) | All opening times of the merchant. |
|
20
|
+
**ccv_enabled** | **BOOLEAN** | If true, credit card information is required when creating a reservation. |
|
21
|
+
**chain** | [**ChainDto**](ChainDto.md) | The chain of the merchant. | [optional]
|
22
|
+
**ivr_redirect_number** | **String** | The IVR forwarding phone number. | [optional]
|
23
|
+
|
24
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Quandoo::MerchantDetailsDtoList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**merchants** | [**Array<MerchantDetailsDto>**](MerchantDetailsDto.md) | Merchant details collection. |
|
7
|
+
**size** | **Integer** | | [optional]
|
8
|
+
**offset** | **Integer** | | [optional]
|
9
|
+
**limit** | **Integer** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Quandoo::MerchantMenuCategoryDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **Integer** | ID for the menu category |
|
7
|
+
**name** | **String** | Name/title of menu category | [optional]
|
8
|
+
**items** | [**Array<MerchantMenuItemDto>**](MerchantMenuItemDto.md) | Items inside the menu category |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# Quandoo::MerchantMenuDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **Integer** | ID of the menu |
|
7
|
+
**name** | **String** | The name/title of the menu |
|
8
|
+
**description** | **String** | Menu description | [optional]
|
9
|
+
**price** | **String** | Total price for the menu | [optional]
|
10
|
+
**sort_order** | **Integer** | Display order for the menu |
|
11
|
+
**categories** | [**Array<MerchantMenuCategoryDto>**](MerchantMenuCategoryDto.md) | Categories of the menu | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Quandoo::MerchantMenuItemDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **Integer** | The id of this menu item |
|
7
|
+
**name** | **String** | Name of menu item |
|
8
|
+
**description** | **String** | Menu item description | [optional]
|
9
|
+
**price** | **String** | Item price | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Quandoo::MerchantReservation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The identifier of the reservation for the calling agent (Agent-dependent field) | [optional]
|
7
|
+
**merchant_id** | **Integer** | The ID of the merchant at which this reservation will be made. |
|
8
|
+
**capacity** | **Integer** | The capacity (people count) of the reservation. |
|
9
|
+
**area_id** | **Integer** | The id of the area this reservation should be in. Optional. | [optional]
|
10
|
+
**date_time** | **DateTime** | The date and time when the reservation will take place. Format: yyyy-MM-ddTHH:mm:ssZ |
|
11
|
+
**order_id** | **String** | The id of the order to which this reservation is associated. Optional. | [optional]
|
12
|
+
**extra_info** | **String** | Any extra information that the customer likes to provide. Optional. | [optional]
|
13
|
+
**promo_code** | **String** | A promotion code which should be used with this reservation. Optional. | [optional]
|
14
|
+
**credit_card_vault_settings_id** | **String** | A credit card vault settings to be used by this reservation. Optional. | [optional]
|
15
|
+
**recurring_card_detail_id** | **String** | A customer credit card reference to be used if credit card vault should be applied. Optional. | [optional]
|
16
|
+
**deals** | [**Array<DealData>**](DealData.md) | A list of deals data which should be used with this reservation. Optional. | [optional]
|
17
|
+
|
18
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Quandoo::MerchantReservationData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**reservation** | [**MerchantReservation**](MerchantReservation.md) | The reservation data. |
|
7
|
+
**customer** | [**MerchantCustomer**](MerchantCustomer.md) | The customer data. |
|
8
|
+
**tracking** | [**Tracking**](Tracking.md) | The tracking data. |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# Quandoo::MerchantReservationEnquiry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The unique identifier of the reservation enquiry for the calling agent (Agent dependent field) or NULL if the agent identifier should be created. Optional. |
|
7
|
+
**merchant_id** | **Integer** | The ID of the merchant at which this reservation will be made. |
|
8
|
+
**capacity** | **Integer** | The capacity (people count) of the reservation enquiry. |
|
9
|
+
**start_date_time** | **String** | The start date and time of the potential reservation. Format: yyyy-MM-ddTHH:mm:ssZ |
|
10
|
+
**end_date_time** | **String** | The end date and time of the potential reservation. Format: yyyy-MM-ddTHH:mm:ssZ |
|
11
|
+
**message** | **String** | A message from the customer. |
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Quandoo::MerchantReservationEnquiryData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**reservation_enquiry** | [**MerchantReservationEnquiry**](MerchantReservationEnquiry.md) | The reservation enquiry data. |
|
7
|
+
**customer** | [**MerchantCustomer**](MerchantCustomer.md) | The customer data. |
|
8
|
+
**tracking** | [**Tracking**](Tracking.md) | The tracking data. |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Quandoo::MerchantReservationSettingsDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**area_ids** | [**Array<AreaDto>**](AreaDto.md) | List of all the areas defined for the merchant. Each area will contain: | [optional]
|
7
|
+
**capacities** | **Array<Integer>** | Number of guests allowed in a reservation | [optional]
|
8
|
+
**merchant_newsletter_selection_required** | **BOOLEAN** | If true, a separate checkbox is displayed in the checkout for newsletter received from the restaurant | [optional]
|
9
|
+
**area_selection_required** | **BOOLEAN** | If true, we display available areas in a dropdown when a guest is making an online reservation | [optional]
|
10
|
+
**reservation_enquiry_enabled** | **BOOLEAN** | If true, the restaurants allows enquiries | [optional]
|
11
|
+
**minimum_capacity_for_enquiries** | **Integer** | Minimum number of guests for an enquiry | [optional]
|
12
|
+
**online_reservation_interval** | **Integer** | Time slots displayed for making a reservation | [optional]
|
13
|
+
**special_terms** | **String** | If true, special terms and conditions of the restaurant need to be confirmed upon making an online reservation | [optional]
|
14
|
+
**links** | [**Array<LinkRelationDto>**](LinkRelationDto.md) | Related links that can be followed based on this response | [optional]
|
15
|
+
**automatic_confirmation** | **BOOLEAN** | If true, the customer will receive an automatic email confirmation after he makes a reservation | [optional]
|
16
|
+
**ccv_enabled** | **BOOLEAN** | If true, credit card information is required when creating a reservation | [optional]
|
17
|
+
|
18
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Quandoo::MerchantVaultSettingsDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The id of the vault settings. |
|
7
|
+
**fee** | **Float** | The fee customer should pay in the case of cancellation. |
|
8
|
+
**fee_type** | **String** | The type of the fee to pay. |
|
9
|
+
**fee_percentage_for_time** | **Hash<String, Integer>** | Fee percentage depending of the time of cancellation. | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Quandoo::MerchantWithRecommendationsDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**merchant** | [**MerchantDetailsDto**](MerchantDetailsDto.md) | The merchant that was searched for. Only filled if it is bookable. |
|
7
|
+
**merchant_search_message** | **String** | Additional information about the search result: MERCHANT_NOT_BOOKABLE if the merchant exists but is not bookable |
|
8
|
+
**recommended_merchants** | [**MerchantDetailsDtoList**](MerchantDetailsDtoList.md) | Recommendations for similar merchants. | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,334 @@
|
|
1
|
+
# Quandoo::MerchantsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.quandoo.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get_reservations2**](MerchantsApi.md#get_reservations2) | **GET** /v1/merchants/{merchantId}/reservations | Get merchant reservations
|
8
|
+
[**get_reviews1**](MerchantsApi.md#get_reviews1) | **GET** /v1/merchants/{merchantId}/reviews | Retrieves customer reviews for a merchant, specified by reviewId
|
9
|
+
[**search**](MerchantsApi.md#search) | **GET** /v1/merchants | Allows to get merchant information by parameters
|
10
|
+
[**search2**](MerchantsApi.md#search2) | **GET** /v1/merchants/{merchantId} | Allows to get a merchant by id
|
11
|
+
[**search_similar1**](MerchantsApi.md#search_similar1) | **GET** /v1/merchants/{merchantId}/similar | Allows to get a merchant by id and find similar merchants
|
12
|
+
|
13
|
+
|
14
|
+
# **get_reservations2**
|
15
|
+
> ReservationDataList get_reservations2(merchant_id, opts)
|
16
|
+
|
17
|
+
Get merchant reservations
|
18
|
+
|
19
|
+
This endpoint allows an agent to get reservations of a merchant. The results will be filtered by agent id. Reservation IDs in response are agent-specific. The agent needs to be authenticated. The endpoint will return `HTTP 404 - Not Found` if the merchant with the specified id could not be found. It will return `HTTP 403 - Forbidden` if the agent is not authenticated or the agent doesn't have permissions. ####Request: * **merchantId**: ID of the merchant * **offset**: sets the starting element to be returned. Defaults to 0 when unset or malformed. * **limit**: maximum number of results to be returned. Value must be between 1 and 100. Defaults to 100 when unset, malformed or outside bounds. * **earliest**: earliest date time of time window in UTC. Format: yyyy-MM-dd HH:mm:ss * **latest**: latest date time of time window in UTC. Format: yyyy-MM-dd HH:mm:ss ####Response: The response will be a _list_ of reservations. Each reservation has the fields explained below: * **id**: The public id of the reservation * **number**: Quandoo internal identifier of the reservation. * **quandooId**: The public id of this reservation on quandoo system. * **status**: The status of the reservation eg. CREATED, CONFIRMED, CUSTOMER CANCELED etc. * **startTime**: The start time of the reservation. Format: `yyyy-MM-ddTHH:mm:ssZ` * **endTime**: The end time of the reservation. Format: `yyyy-MM-ddTHH:mm:ssZ` * **capacity**: The capacity (people count) of the reservation * **merchantId**: The ID of the merchant at which this reservation was made. * **customerId**: The public ID of the customer to which this reservation belongs * **promoCode**: The promotion code associated with this reservation. Optional. * **extraInfo**: extra information that the customer provided for the reservation. Optional. * **links**: Related links that can be followed based on this response. * **createdAt**: The date the reservation was created. Format: `yyyy-MM-ddTHH:mm:ssZ` * **updatedAt**: The date the reservation was last updated. Format: `yyyy-MM-ddTHH:mm:ssZ` Example curl: ``` curl https://{host}/v{X}/merchants/32489/reservations ``` Example response: ``` { \"reservations\": [ { \"id\": \"07f53b36-3f48-11e5-a151-feff819cdc9f\", \"number\": 8734957, \"quandooId\": \"07f53b36-3f48-11e5-a151-feff819cdc9f\", \"status\": \"CREATED\", \"startTime\": \"2015-06-22T12:00:00+00:00\", \"endTime\": \"2015-06-22T13:00:00+00:00\", \"capacity\": 4, \"merchantId\": 1384, \"customerId\": \"ce0706ff-a95d-4229-a220-d21dcd175342\", \"promocode\": \"SOME_CAMPAIGN_CODE\", \"extraInfo\": \"request for baby chair\", \"links\": [ { \"href\": \"https://{host}/v{X}/reservations/07f53b36-3f48-11e5-a151-feff819cdc9f\", \"method\": \"GET\", \"rel\": \"self\" }, { \"href\": \"https://{host}/v{X}/reservations/07f53b36-3f48-11e5-a151-feff819cdc9f\", \"method\": \"PATCH\", \"rel\": \"update\" } ], \"createdAt\": \"2015-06-01T15:21:54Z\", \"updatedAt\": \"2015-06-01T18:45:30Z\" }, { \"id\": \"d8f53b36-3f48-11e5-a151-feff819cdc7a\", \"number\": 8734958, \"quandooId\": \"d8f53b36-3f48-11e5-a151-feff819cdc7a\", \"status\": \"CONFIRMED\", \"startTime\": \"2015-06-22T12:00:00+00:00\", \"endTime\": \"2015-06-22T13:00:00+00:00\", \"capacity\": 3, \"merchantId\": 1384, \"customerId\": \"ce0706ff-a95d-4229-a220-d21dcd175342\", \"promocode\": \"SOME_CAMPAIGN_CODE\", \"links\": [ { \"href\": \"https://{host}/v{X}/reservations/d8f53b36-3f48-11e5-a151-feff819cdc7a\", \"method\": \"GET\", \"rel\": \"self\" }, { \"href\": \"https://{host}/v{X}/reservations/d8f53b36-3f48-11e5-a151-feff819cdc7a\", \"method\": \"PATCH\", \"rel\": \"update\" } ], \"createdAt\": \"2015-06-01T15:21:54Z\", \"updatedAt\": \"2015-06-01T18:45:30Z\" } ] } ```
|
20
|
+
|
21
|
+
### Example
|
22
|
+
```ruby
|
23
|
+
# load the gem
|
24
|
+
require 'quandoo'
|
25
|
+
# setup authorization
|
26
|
+
Quandoo.configure do |config|
|
27
|
+
# Configure API key authorization: API_TOKEN
|
28
|
+
config.api_key['X-Quandoo-AuthToken'] = 'YOUR API KEY'
|
29
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
|
+
#config.api_key_prefix['X-Quandoo-AuthToken'] = 'Bearer'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = Quandoo::MerchantsApi.new
|
34
|
+
|
35
|
+
merchant_id = 56 # Integer | Id of the merchant
|
36
|
+
|
37
|
+
opts = {
|
38
|
+
offset: 0, # Integer | Skip first n reservations
|
39
|
+
limit: 100, # Integer | limit
|
40
|
+
earliest: DateTime.parse('\"2018-01-01 00:00:00\"'), # DateTime | earliest date time of time window in UTC. Format: yyyy-MM-dd HH:mm:ss
|
41
|
+
latest: DateTime.parse('\"2018-03-01 00:00:00\"') # DateTime | latest date time of time window in UTC. Format: yyyy-MM-dd HH:mm:ss
|
42
|
+
}
|
43
|
+
|
44
|
+
begin
|
45
|
+
#Get merchant reservations
|
46
|
+
result = api_instance.get_reservations2(merchant_id, opts)
|
47
|
+
p result
|
48
|
+
rescue Quandoo::ApiError => e
|
49
|
+
puts "Exception when calling MerchantsApi->get_reservations2: #{e}"
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
### Parameters
|
54
|
+
|
55
|
+
Name | Type | Description | Notes
|
56
|
+
------------- | ------------- | ------------- | -------------
|
57
|
+
**merchant_id** | **Integer**| Id of the merchant |
|
58
|
+
**offset** | **Integer**| Skip first n reservations | [optional] [default to 0]
|
59
|
+
**limit** | **Integer**| limit | [optional] [default to 100]
|
60
|
+
**earliest** | **DateTime**| earliest date time of time window in UTC. Format: yyyy-MM-dd HH:mm:ss | [optional]
|
61
|
+
**latest** | **DateTime**| latest date time of time window in UTC. Format: yyyy-MM-dd HH:mm:ss | [optional]
|
62
|
+
|
63
|
+
### Return type
|
64
|
+
|
65
|
+
[**ReservationDataList**](ReservationDataList.md)
|
66
|
+
|
67
|
+
### Authorization
|
68
|
+
|
69
|
+
[API_TOKEN](../README.md#API_TOKEN)
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: Not defined
|
74
|
+
- **Accept**: Not defined
|
75
|
+
|
76
|
+
|
77
|
+
|
78
|
+
# **get_reviews1**
|
79
|
+
> ReviewDtoList get_reviews1(merchant_id, opts)
|
80
|
+
|
81
|
+
Retrieves customer reviews for a merchant, specified by reviewId
|
82
|
+
|
83
|
+
This endpoint retrieves customer reviews for a particular merchant with rating, description, locale, date & the customer's information.This merchant should be specified by their identifier **merchantId**, which is mandatory. Supports pagination via offset & limit parameters in the request. `offset` allows skipping the first n reviews. `limit` makes sure the response contains a maximum of n reviews. If not supplied, offset will be 0 and limit will be 10 ####Response: * **customer**: block contains link to customer's profile image, customer's first name & first letter of customer's last name. * **rating**: a value between 1 and 6, where 1 represents the worst rating and 6 represents the best. * **description**: the review description entered by the customer. * **locale**: represents the language settings of the customer, in the format: <language code>_<country code> * **date**: represents the date of the review, with the format: yyyy-MM-dd Example curl: ``` curl https://{host}/v{X}/merchants/15/reviews?offset=10&limit=5 ``` Example response: ``` { reviews: [ { customer: { firstName: \"Hans\", lastName: \"W\", profileImage: { url: \"https://www...\" }, }, rating: 1, description: \"Foo bar\", locale: \"de_DE\", date: \"2017-07-21\" } ], offset: 10, limit: 5, size: 1 } ```
|
84
|
+
|
85
|
+
### Example
|
86
|
+
```ruby
|
87
|
+
# load the gem
|
88
|
+
require 'quandoo'
|
89
|
+
|
90
|
+
api_instance = Quandoo::MerchantsApi.new
|
91
|
+
|
92
|
+
merchant_id = 56 # Integer |
|
93
|
+
|
94
|
+
opts = {
|
95
|
+
offset: 0, # Integer | Skip first n reviews
|
96
|
+
limit: 10 # Integer | Max number of reviews to be retrieved
|
97
|
+
}
|
98
|
+
|
99
|
+
begin
|
100
|
+
#Retrieves customer reviews for a merchant, specified by reviewId
|
101
|
+
result = api_instance.get_reviews1(merchant_id, opts)
|
102
|
+
p result
|
103
|
+
rescue Quandoo::ApiError => e
|
104
|
+
puts "Exception when calling MerchantsApi->get_reviews1: #{e}"
|
105
|
+
end
|
106
|
+
```
|
107
|
+
|
108
|
+
### Parameters
|
109
|
+
|
110
|
+
Name | Type | Description | Notes
|
111
|
+
------------- | ------------- | ------------- | -------------
|
112
|
+
**merchant_id** | **Integer**| |
|
113
|
+
**offset** | **Integer**| Skip first n reviews | [optional] [default to 0]
|
114
|
+
**limit** | **Integer**| Max number of reviews to be retrieved | [optional] [default to 10]
|
115
|
+
|
116
|
+
### Return type
|
117
|
+
|
118
|
+
[**ReviewDtoList**](ReviewDtoList.md)
|
119
|
+
|
120
|
+
### Authorization
|
121
|
+
|
122
|
+
No authorization required
|
123
|
+
|
124
|
+
### HTTP request headers
|
125
|
+
|
126
|
+
- **Content-Type**: Not defined
|
127
|
+
- **Accept**: application/json
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
# **search**
|
132
|
+
> MerchantDetailsDtoList search(capacity, opts)
|
133
|
+
|
134
|
+
Allows to get merchant information by parameters
|
135
|
+
|
136
|
+
###Description This endpoint is used to search merchants by a set of parameters. For each merchant in the result there is information about location, language and tags that describe this merchant's basic characteristics, there is also a set of images selected by the merchant. ####Possible query parameters: * **query**: Filter merchants using text similarity on a number of merchant fields like name, description, categories and tags * **place**: Filter for merchant on a country, city or district whose name matches the parameter. (if the parameter does not match any city or district on the system it is ignored) * **centerPoint**: Filter merchants within the circle defined by center on centerPoint and radius defined by radius parameter (if not informed defaults to 10). Center point has the format LATITUDE,LONGITUDE with both parameters as numbers with . as decimal separator (e.g `centerPoint=52.547928,13.4085728`) * **radius**: The radius of the circle to filter merchants in **kilometers**. Defaults to 10 and is only used if *centerPoint* is also informed * **bookable**: Boolean value, if informed true means that only merchants that are online bookable will be returned and false means that only merchants that are NOT online bookable will be returned * **tags**: Filter out merchants with the selected tags text. Semicolon separated text value. All or nothing field: if a tag is not found, the query will fail. Cannot be used in conjunction with 'tagIds' parameter. * **tagIds**: Filter out merchants with the selected tag ids. Semicolon separated text value. All or nothing field: if a tag is not found, the query will fail. Cannot be used in conjunction with 'tags' parameter. * **reviewScoreMax**: Filter out merchants with review score higher than the one informed. * **onlyWithAttributes**: This field only accepts the value **documents** for now. If informed only merchants with documents will be returned. You need to be **authenticated** to use this filter * **capacity**: Number of people. In order to be effective, \"place\", \"date\" and \"fromTime\" must also be set. * **date**: Date of the desired reservation in merchants' time zone. Format: yyyy-MM-dd. Availability search is only activated if \"place\" is specified. * **fromTime**: Beginning of the desired reservation time frame in merchants' time zone. Format: HH:mm. Consider a 3h buffer for the time (0.5h before the given time and 2.5h after) * **offset**: Number of merchants to skip on the result. Defaults to 0 * **limit**: Maximum number of merchants to return. Defaults to 100 and cannot be more than 100. * **bookable**: This flag indicates whether the merchant is bookable or not. ####Result fields for Merchant object: * **id**: Id of the merchant * **name**: Name of the merchant * **phoneNumber**: The phone number of the merchant * **currency**: Currency of the merchant in the ISO 4217 letter format * **locale**: Locale used to communicate with this merchant * **timezone**: Canonical Timezone name * **location**: Location of the merchant, contains both an geo located point and an address if available * **reviewScore**: Review score of the merchant * **tagGroups**: Tags (grouped) about relevant merchant characteristics * **images**: Group of images selected by the merchant * **documents**: Group of documents released by this merchant (e.g seasonal menus ) * **links**: Links for other pages or api operations for this merchant * **openingTimes**: Group of opening times: restaurant opening times for this merchant. Time range beginning may be greater than the end time of the range, when this range goes beyond the day when it was started, e.g. 19:00:00 - 02:00:00 * **ccvEnabled**: If true, credit card information is required when creating a reservation * **chain**: Merchant chain information, if any ###Authenticated use of the api: * Field `documents` is only accessible for authorized callers and will be empty otherwise. * Queries with parameter `onlyWithAttributes` are only allowed for authorized callers and will return `HTTP 403` for unauthorized requests #####How? In order to make an authenticated call the caller must send a header name `X-Quandoo-AuthToken` with the token obtained from contact with Quandoo. ###Pagination of the result: The result contains the fields `size` with the number of all merchants that matched the informed parameters, `offset` and `limit` defining which merchants from the complete list are on this response, and the caller can use query parameters `offset` and `limit` to get different merchants on the result list ###Examples: Example curl: ``` curl -H 'X-Quandoo-AuthToken: INSERT_KEY_HERE' 'https://{host}/v{X}/merchants?query=Zim&place=Berlin&centerPoint=52.5479288%2C13.4085728&radius=10&bookable=true&reviewScoreMax=200&onlyWithAttributes=documents&offset=0&limit=100' ``` Example response: ``` { \"merchants\": [ { \"id\": 215, \"name\": \"a-merchant-Zim\", \"phoneNumber\": \"+49153153153\", \"currency\": \"EUR\", \"locale\": \"de_DE\", \"timezone\": \"Europe/Berlin\", \"location\": { \"coordinates\": { \"latitude\": 55, \"longitude\": 12 }, \"address\": {} }, \"reviewScore\": \"5.3\", \"tagGroups\": [ { \"type\": \"CUISINE\", \"tags\": [ { \"id\": 63, \"name\": \"Testküche Hauptkategorie\" }, { \"id\": 66, \"name\": \"Test cuisine\" } ] } ], \"images\": [], \"documents\": [ { \"name\": \"Main Menu\", \"url\": \"https://d2s6u6f7snurg9.cloudfront.net/partner/uploads/MD-document-3ec1dc15-1b69-463f-bdd2-c060b9bf844d.pdf\", \"format\": \"pdf\", \"description\": \"Seasonal Main Menu\" } ], \"links\": [ { \"href\": \"https://{host}/{path}?aid=16\", \"method\": \"GET\", \"rel\": \"DETAILS\" }, { \"href\": \"https://{host}/{path}?aid=16&countryId=NLD\", \"method\": \"GET\", \"rel\": \"WIDGET\" }, { \"href\": \"https://{host}/{path}/details?aid=16&countryId=NLD\", \"method\": \"GET\", \"rel\": \"WIDGET_DETAILS\" } ], \"bookable\": true, \"ccvEnabled\": true, \"chain\": { \"id\": 1, \"name\": \"Test chain\" } }, { \"id\": 219, \"name\": \"another merchants Zim\", \"phoneNumber\": \"+49154154154\", \"currency\": \"EUR\", \"locale\": \"de_DE\", \"timezone\": \"Europe/Berlin\", \"location\": { \"coordinates\": { \"latitude\": 52, \"longitude\": 13 }, \"address\": { \"street\": \"Wintersteinstr.\", \"number\": \"15\", \"zipcode\": \"10587\", \"city\": \"Berlin\", \"country\": \"DEU\" } }, \"reviewScore\": \"4.7\", \"tagGroups\": [ { \"type\": \"CUISINE\", \"tags\": [ { \"id\": 79, \"name\": \"Testküche Hauptkategorie\" }, { \"id\": 82, \"name\": \"Test Japanese\" } ] }, { \"type\": \"PRICE\", \"tags\": [ { \"id\": 84, \"name\": \"Test expensive\" } ] } ], \"images\": [ { \"url\": \"https://dci5ez2ey8tr9.cloudfront.net/1482eec7-e585-4821-b096-8a9941e0d2eb/25_sld.jpg\" } ], \"documents\": [], \"links\": [ { \"href\": \"https://{host}/{path}?aid=16\", \"method\": \"GET\", \"rel\": \"DETAILS\" }, { \"href\": \"https://{host}/{path}?aid=16&countryId=NLD\", \"method\": \"GET\", \"rel\": \"WIDGET\" }, { \"href\": \"https://{host}/{path}/details?aid=16&countryId=NLD\", \"method\": \"GET\", \"rel\": \"WIDGET_DETAILS\" } ], \"bookable\": true, \"openingTimes\": { \"standardOpeningTimes\": { \"SATURDAY\": [ { \"start\": \"09:00:00\", \"end\": \"20:00:00\" } ], \"SUNDAY\": [ { \"start\": \"09:00:00\", \"end\": \"18:00:00\" } ] } }, \"ccvEnabled\": true, \"chain\": { \"id\": 1, \"name\": \"Test chain\" } } ], \"size\": 2, \"offset\": 0, \"limit\": 100 } ```
|
137
|
+
|
138
|
+
### Example
|
139
|
+
```ruby
|
140
|
+
# load the gem
|
141
|
+
require 'quandoo'
|
142
|
+
# setup authorization
|
143
|
+
Quandoo.configure do |config|
|
144
|
+
# Configure API key authorization: API_TOKEN
|
145
|
+
config.api_key['X-Quandoo-AuthToken'] = 'YOUR API KEY'
|
146
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
147
|
+
#config.api_key_prefix['X-Quandoo-AuthToken'] = 'Bearer'
|
148
|
+
end
|
149
|
+
|
150
|
+
api_instance = Quandoo::MerchantsApi.new
|
151
|
+
|
152
|
+
capacity = 2 # Integer | Number of people. In order to be effective, \"date\" and \"fromTime\" must also be set.
|
153
|
+
|
154
|
+
opts = {
|
155
|
+
query: 'query_example', # String | Search query for a merchant name
|
156
|
+
place: 'place_example', # String | Search query for a place (country, city or district) name: the most relevant places, if any, are taken as a filter
|
157
|
+
center_point: 'center_point_example', # String | Search with coordinates and radius. \"radius\" argument can be set, otherwise default value of 10 km will be used.<br>Format:<br>53.1222,13.0303<br>where latitude=53.1222, longitude=13.0303
|
158
|
+
radius: 10, # Integer | Radius for coordinate-based search
|
159
|
+
bookable: true, # BOOLEAN | Filter only bookable merchants
|
160
|
+
tags: 'tags_example', # String | Filter by tags found by text. The value can be either in English or in the specific locale. Semicolon separated. All or nothing behaviour: if one single tag is not found, the whole request fails. Cannot be used in combination with 'groupedTagIds' parameter.
|
161
|
+
tag_ids: 'tag_ids_example', # String | Filter by tags found by id. Semicolon separated. All or nothing behaviour: if one single tag id is not found, the whole request fails. Cannot be used in combination with 'tags' parameter.
|
162
|
+
review_score_max: 56, # Integer | Filter by max review score (100 - 600)
|
163
|
+
only_with_attributes: 'only_with_attributes_example', # String | Search with attributes specified only. Attribute \"documents\" is currently supported
|
164
|
+
date: Date.parse('\"2019-01-11\"'), # Date | Date of the desired reservation in merchants' time zone. Format: yyyy-MM-dd. Availability search is only activated if \"place\" is specified.
|
165
|
+
from_time: '\"20:00\"', # String | Beginning of the desired reservation time frame in merchants' time zone. Format: HH:mm. Consider a 3h buffer for the time (0.5h before the given time and 2.5h after)
|
166
|
+
offset: 0, # Integer | offset
|
167
|
+
limit: 100, # Integer | limit
|
168
|
+
accept_language: 'accept_language_example' # String | language
|
169
|
+
}
|
170
|
+
|
171
|
+
begin
|
172
|
+
#Allows to get merchant information by parameters
|
173
|
+
result = api_instance.search(capacity, opts)
|
174
|
+
p result
|
175
|
+
rescue Quandoo::ApiError => e
|
176
|
+
puts "Exception when calling MerchantsApi->search: #{e}"
|
177
|
+
end
|
178
|
+
```
|
179
|
+
|
180
|
+
### Parameters
|
181
|
+
|
182
|
+
Name | Type | Description | Notes
|
183
|
+
------------- | ------------- | ------------- | -------------
|
184
|
+
**capacity** | **Integer**| Number of people. In order to be effective, \"date\" and \"fromTime\" must also be set. | [default to 2]
|
185
|
+
**query** | **String**| Search query for a merchant name | [optional]
|
186
|
+
**place** | **String**| Search query for a place (country, city or district) name: the most relevant places, if any, are taken as a filter | [optional]
|
187
|
+
**center_point** | **String**| Search with coordinates and radius. \"radius\" argument can be set, otherwise default value of 10 km will be used.<br>Format:<br>53.1222,13.0303<br>where latitude=53.1222, longitude=13.0303 | [optional]
|
188
|
+
**radius** | **Integer**| Radius for coordinate-based search | [optional] [default to 10]
|
189
|
+
**bookable** | **BOOLEAN**| Filter only bookable merchants | [optional]
|
190
|
+
**tags** | **String**| Filter by tags found by text. The value can be either in English or in the specific locale. Semicolon separated. All or nothing behaviour: if one single tag is not found, the whole request fails. Cannot be used in combination with 'groupedTagIds' parameter. | [optional]
|
191
|
+
**tag_ids** | **String**| Filter by tags found by id. Semicolon separated. All or nothing behaviour: if one single tag id is not found, the whole request fails. Cannot be used in combination with 'tags' parameter. | [optional]
|
192
|
+
**review_score_max** | **Integer**| Filter by max review score (100 - 600) | [optional]
|
193
|
+
**only_with_attributes** | **String**| Search with attributes specified only. Attribute \"documents\" is currently supported | [optional]
|
194
|
+
**date** | **Date**| Date of the desired reservation in merchants' time zone. Format: yyyy-MM-dd. Availability search is only activated if \"place\" is specified. | [optional]
|
195
|
+
**from_time** | **String**| Beginning of the desired reservation time frame in merchants' time zone. Format: HH:mm. Consider a 3h buffer for the time (0.5h before the given time and 2.5h after) | [optional]
|
196
|
+
**offset** | **Integer**| offset | [optional] [default to 0]
|
197
|
+
**limit** | **Integer**| limit | [optional] [default to 100]
|
198
|
+
**accept_language** | **String**| language | [optional]
|
199
|
+
|
200
|
+
### Return type
|
201
|
+
|
202
|
+
[**MerchantDetailsDtoList**](MerchantDetailsDtoList.md)
|
203
|
+
|
204
|
+
### Authorization
|
205
|
+
|
206
|
+
[API_TOKEN](../README.md#API_TOKEN)
|
207
|
+
|
208
|
+
### HTTP request headers
|
209
|
+
|
210
|
+
- **Content-Type**: Not defined
|
211
|
+
- **Accept**: application/json
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
# **search2**
|
216
|
+
> MerchantDetailsDto search2(merchant_id, opts)
|
217
|
+
|
218
|
+
Allows to get a merchant by id
|
219
|
+
|
220
|
+
This endpoint allows to receive detailed information on a particular merchant in the system. This merchant should be specified by their identifier **merchantId**, which is mandatory. The endpoint can take optional request header **Accept-Language**. This header is used to determine correct locale and has an effect on translation of merchant's entity fields, that may be omitted. The expected value of the header **Accept-Language** should contain language and can contain country, e.g. \"de_DE\" or \"de\". Locale by default is \"en_GB\". The endpoint returns status `HTTP 200` if the request is successful. The endpoint will return status `HTTP 404` if the merchant, specified by identifier, was not found or has no products, allowed for a web search. Example curl: ``` curl -H 'X-Quandoo-AuthToken: {INSERT_KEY_HERE}' -H 'Accept-Language: de_DE' 'https://{host}/v{X}/merchants/11' ``` Example response: ``` { \"id\":11, \"name\":\"Test merchant\", \"phoneNumber\":\"+27113901837\", \"currency\":\"ZAR\", \"locale\":\"en_ZA\", \"timezone\":\"Africa/Johannesburg\", \"location\":{ \"coordinates\":{ \"latitude\":33.9, \"longitude\":18.4 }, \"address\":{ \"street\":\"Tamerlan street\", \"number\":\"6A\", \"zipcode\":\"10787\", \"city\":\"Cape Town\", \"country\":\"ZAF\" } }, \"reviewScore\": \"5.3\", \"tagGroups\":[ { \"type\":\"CUISINE\", \"tags\":[ { \"id\":25, \"name\":\"Testküche Hauptkategorie\" }, { \"id\":28, \"name\":\"Test cuisine\" } ] } ], \"images\":[ { \"url\":\"https://dci5ez2ey8tr9.cloudfront.net/8e4d1063-9171-40b1-94b7-5e9337591a90/7_sld.jpg\" } ], \"documents\":[], \"links\":[ { \"href\":\"https://{host}/{path}?aid=16\", \"method\":\"GET\", \"rel\":\"DETAILS\" }, { \"href\":\"https://{host}/{path}?aid=16&countryId=NLD\", \"method\":\"GET\", \"rel\":\"WIDGET\" }, { \"href\":\"https://{host}/{path}/details?aid=16&countryId=NLD\", \"method\":\"GET\", \"rel\":\"WIDGET_DETAILS\" } ], \"bookable\": true, \"openingTimes\": { \"standardOpeningTimes\": { \"SATURDAY\": [ { \"start\": \"09:00:00\", \"end\": \"20:00:00\" } ], \"SUNDAY\": [ { \"start\": \"09:00:00\", \"end\": \"18:00:00\" } ] } }, \"ccvEnabled\": true, \"chain\": { \"id\": 1, \"name\": \"Test chain\" } } ```
|
221
|
+
|
222
|
+
### Example
|
223
|
+
```ruby
|
224
|
+
# load the gem
|
225
|
+
require 'quandoo'
|
226
|
+
# setup authorization
|
227
|
+
Quandoo.configure do |config|
|
228
|
+
# Configure API key authorization: API_TOKEN
|
229
|
+
config.api_key['X-Quandoo-AuthToken'] = 'YOUR API KEY'
|
230
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
231
|
+
#config.api_key_prefix['X-Quandoo-AuthToken'] = 'Bearer'
|
232
|
+
end
|
233
|
+
|
234
|
+
api_instance = Quandoo::MerchantsApi.new
|
235
|
+
|
236
|
+
merchant_id = 56 # Integer | merchantId
|
237
|
+
|
238
|
+
opts = {
|
239
|
+
accept_language: 'en_GB' # String | Locale.<br>Format:<br><language code>[_<country code>]
|
240
|
+
}
|
241
|
+
|
242
|
+
begin
|
243
|
+
#Allows to get a merchant by id
|
244
|
+
result = api_instance.search2(merchant_id, opts)
|
245
|
+
p result
|
246
|
+
rescue Quandoo::ApiError => e
|
247
|
+
puts "Exception when calling MerchantsApi->search2: #{e}"
|
248
|
+
end
|
249
|
+
```
|
250
|
+
|
251
|
+
### Parameters
|
252
|
+
|
253
|
+
Name | Type | Description | Notes
|
254
|
+
------------- | ------------- | ------------- | -------------
|
255
|
+
**merchant_id** | **Integer**| merchantId |
|
256
|
+
**accept_language** | **String**| Locale.<br>Format:<br>&lt;language code&gt;[_&lt;country code&gt;] | [optional] [default to en_GB]
|
257
|
+
|
258
|
+
### Return type
|
259
|
+
|
260
|
+
[**MerchantDetailsDto**](MerchantDetailsDto.md)
|
261
|
+
|
262
|
+
### Authorization
|
263
|
+
|
264
|
+
[API_TOKEN](../README.md#API_TOKEN)
|
265
|
+
|
266
|
+
### HTTP request headers
|
267
|
+
|
268
|
+
- **Content-Type**: Not defined
|
269
|
+
- **Accept**: application/json
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
# **search_similar1**
|
274
|
+
> MerchantWithRecommendationsDto search_similar1(merchant_id, opts)
|
275
|
+
|
276
|
+
Allows to get a merchant by id and find similar merchants
|
277
|
+
|
278
|
+
This endpoint allows to receive detailed information for a particular merchant in the system and for restaurants that are similar to this one. A merchant is similar if all the following conditions are met: 1. Location: the recommended merchants are within 30 km radius from the main merchant 2. The similar merchants are bookable online 3. The similar merchants have the main cuisine in common This merchant should be specified by their identifier **merchantId**, which is mandatory. The endpoint can take optional request header **Accept-Language**. This header is used to determine correct locale and has an effect on translation of merchant's entity fields, that may be omitted. The expected value of the header **Accept-Language** should contain language and can contain country, e.g. \"de_DE\" or \"de\". Locale by default is \"en_GB\". The endpoint returns status `HTTP 200` if the request is successful. In a successful requests the specified merchant was found. If the merchant has no products allowed for a web search, i.e. is not bookable, response data with `HTTP 200` is returned, but the field `merchant` is not set. Instead, the merchant search message is set. The endpoint will return status `HTTP 404` if the merchant, specified by identifier, was not found. Example curl: ``` curl -H 'X-Quandoo-AuthToken: {INSERT_KEY_HERE}' -H 'Accept-Language: de_DE' 'https://{host}/v{X}/merchants/11/similar' ``` Example responses: `merchant bookable` ``` { \"merchant\": { \"id\":11, \"name\":\"Test merchant\", \"phoneNumber\":\"+27113901837\", \"currency\":\"ZAR\", \"locale\":\"en_ZA\", \"timezone\":\"Africa/Johannesburg\", \"location\":{ \"coordinates\":{ \"latitude\":33.9, \"longitude\":18.4 }, \"address\":{ \"street\":\"Tamerlan street\", \"number\":\"6A\", \"zipcode\":\"10787\", \"city\":\"Cape Town\", \"country\":\"ZAF\" } }, \"reviewScore\": \"5.3\", \"tagGroups\":[ { \"type\":\"CUISINE\", \"tags\":[ { \"id\":25, \"name\":\"Testküche Hauptkategorie\" }, { \"id\":28, \"name\":\"Test cuisine\" } ] } ], \"images\":[ { \"url\":\"https://dci5ez2ey8tr9.cloudfront.net/8e4d1063-9171-40b1-94b7-5e9337591a90/7_sld.jpg\" } ], \"documents\":[], \"links\":[ { \"href\":\"https://{host}/{path}?aid=16\", \"method\":\"GET\", \"rel\":\"DETAILS\" }, { \"href\":\"https://{host}/{path}?aid=16&countryId=NLD\", \"method\":\"GET\", \"rel\":\"WIDGET\" }, { \"href\":\"https://{host}/{path}/details?aid=16&countryId=NLD\", \"method\":\"GET\", \"rel\":\"WIDGET_DETAILS\" } ], \"bookable\": true, \"openingTimes\": { \"standardOpeningTimes\": { \"SATURDAY\": [ { \"start\": \"09:00:00\", \"end\": \"20:00:00\" } ], \"SUNDAY\": [ { \"start\": \"09:00:00\", \"end\": \"18:00:00\" } ] } }, \"ccvEnabled\": true, \"chain\": { \"id\": 1, \"name\": \"Test chain\" } }, \"recommendedMerchants\": { \"merchants\": [ { \"id\":12, \"name\":\"similar merchant\", \"phoneNumber\":\"+27113901838\", \"currency\":\"ZAR\", \"locale\":\"en_ZA\", \"timezone\":\"Africa/Johannesburg\", \"location\":{ \"coordinates\":{ \"latitude\":33.8, \"longitude\":18.4 }, \"address\":{ \"street\":\"Tamerlan street\", \"number\":\"5A\", \"zipcode\":\"10787\", \"city\":\"Cape Town\", \"country\":\"ZAF\" } }, \"reviewScore\": \"5.3\", \"tagGroups\":[ { \"type\":\"CUISINE\", \"tags\":[ { \"id\":25, \"name\":\"Testküche Hauptkategorie\" }, { \"id\":28, \"name\":\"Test cuisine\" } ] } ], \"images\":[ { \"url\":\"https://dci5ez2ey8tr9.cloudfront.net/8e4d1063-9171-40b1-94b7-5e9337591a90/7_sld.jpg\" } ], \"documents\":[], \"links\":[ { \"href\":\"https://{host}/{path}?aid=16\", \"method\":\"GET\", \"rel\":\"DETAILS\" }, { \"href\":\"https://{host}/{path}?aid=16&countryId=NLD\", \"method\":\"GET\", \"rel\":\"WIDGET\" }, { \"href\":\"https://{host}/{path}/details?aid=16&countryId=NLD\", \"method\":\"GET\", \"rel\":\"WIDGET_DETAILS\" } ], \"bookable\": true, \"openingTimes\": { \"standardOpeningTimes\": { \"SATURDAY\": [ { \"start\": \"09:00:00\", \"end\": \"20:00:00\" } ], \"SUNDAY\": [ { \"start\": \"09:00:00\", \"end\": \"18:00:00\" } ] } }, \"ccvEnabled\": true, \"chain\": { \"id\": 1, \"name\": \"Test chain\" } } ], \"size\": 1, \"offset\": 0, \"limit\": 10 } } ``` `merchant not bookable` ``` { \"merchantSearchMessage\": \"MERCHANT_NOT_BOOKABLE\", \"recommendedMerchants\": { \"limit\": 10, \"merchants\": [...], \"offset\": 0, \"size\": 0 } } ```
|
279
|
+
|
280
|
+
### Example
|
281
|
+
```ruby
|
282
|
+
# load the gem
|
283
|
+
require 'quandoo'
|
284
|
+
# setup authorization
|
285
|
+
Quandoo.configure do |config|
|
286
|
+
# Configure API key authorization: API_TOKEN
|
287
|
+
config.api_key['X-Quandoo-AuthToken'] = 'YOUR API KEY'
|
288
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
289
|
+
#config.api_key_prefix['X-Quandoo-AuthToken'] = 'Bearer'
|
290
|
+
end
|
291
|
+
|
292
|
+
api_instance = Quandoo::MerchantsApi.new
|
293
|
+
|
294
|
+
merchant_id = 56 # Integer | merchantId
|
295
|
+
|
296
|
+
opts = {
|
297
|
+
sort: 'CLOSEST', # String | Sort order. Default sorting will be by proximity.
|
298
|
+
limit: 10, # Integer | Max number of merchant recommendations to return.
|
299
|
+
accept_language: 'en_GB' # String | Locale.<br>Format:<br><language code>[_<country code>]
|
300
|
+
}
|
301
|
+
|
302
|
+
begin
|
303
|
+
#Allows to get a merchant by id and find similar merchants
|
304
|
+
result = api_instance.search_similar1(merchant_id, opts)
|
305
|
+
p result
|
306
|
+
rescue Quandoo::ApiError => e
|
307
|
+
puts "Exception when calling MerchantsApi->search_similar1: #{e}"
|
308
|
+
end
|
309
|
+
```
|
310
|
+
|
311
|
+
### Parameters
|
312
|
+
|
313
|
+
Name | Type | Description | Notes
|
314
|
+
------------- | ------------- | ------------- | -------------
|
315
|
+
**merchant_id** | **Integer**| merchantId |
|
316
|
+
**sort** | **String**| Sort order. Default sorting will be by proximity. | [optional] [default to CLOSEST]
|
317
|
+
**limit** | **Integer**| Max number of merchant recommendations to return. | [optional] [default to 10]
|
318
|
+
**accept_language** | **String**| Locale.<br>Format:<br>&lt;language code&gt;[_&lt;country code&gt;] | [optional] [default to en_GB]
|
319
|
+
|
320
|
+
### Return type
|
321
|
+
|
322
|
+
[**MerchantWithRecommendationsDto**](MerchantWithRecommendationsDto.md)
|
323
|
+
|
324
|
+
### Authorization
|
325
|
+
|
326
|
+
[API_TOKEN](../README.md#API_TOKEN)
|
327
|
+
|
328
|
+
### HTTP request headers
|
329
|
+
|
330
|
+
- **Content-Type**: Not defined
|
331
|
+
- **Accept**: application/json
|
332
|
+
|
333
|
+
|
334
|
+
|