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,10 @@
|
|
1
|
+
# Quandoo::CreatedReservationData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**reservation** | [**CreatedReservation**](CreatedReservation.md) | The object holding the reservation data. |
|
7
|
+
**customer** | [**CreatedMasterCustomer**](CreatedMasterCustomer.md) | The object holding the customer data. |
|
8
|
+
**links** | [**Array<LinkRelationDto>**](LinkRelationDto.md) | Related links to follow |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# Quandoo::CreatedReservationEnquiry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The identifier of the reservation enquiry for the calling agent (Agent-dependent field) |
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Quandoo::CreatedReservationEnquiryData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**reservation_enquiry** | [**CreatedReservationEnquiry**](CreatedReservationEnquiry.md) | The object holding the reservation enquiry data. |
|
7
|
+
**customer** | [**CreatedMasterCustomer**](CreatedMasterCustomer.md) | The object holding the customer data. |
|
8
|
+
**links** | [**Array<LinkRelationDto>**](LinkRelationDto.md) | Related links to follow |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Quandoo::CustomerDataList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**result** | [**Array<MerchantCustomerData>**](MerchantCustomerData.md) | | [optional]
|
7
|
+
**offset** | **Integer** | | [optional]
|
8
|
+
**limit** | **Integer** | | [optional]
|
9
|
+
|
10
|
+
|
data/docs/CustomerDto.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# Quandoo::CustomerDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**first_name** | **String** | | [optional]
|
7
|
+
**last_name** | **String** | | [optional]
|
8
|
+
**profile_image** | [**ImageDto**](ImageDto.md) | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# Quandoo::CustomerResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The id of the customer. |
|
7
|
+
**first_name** | **String** | First name of the customer. |
|
8
|
+
**last_name** | **String** | Last name of the customer. |
|
9
|
+
**gender** | **String** | Gender of the customer. |
|
10
|
+
**email** | **String** | Email of the customer. |
|
11
|
+
**phone_number** | **String** | Fixed line phone number of the customer. |
|
12
|
+
**mobile_number** | **String** | Mobile phone number of the customer. |
|
13
|
+
**country** | **String** | 2-letter ISO country code of the customer, e.g. DE. |
|
14
|
+
**links** | [**Array<LinkRelationDto>**](LinkRelationDto.md) | The links related to this entity. |
|
15
|
+
**subscriptions** | [**Array<MerchantSubscription>**](MerchantSubscription.md) | The newsletter subscriptions, e.g. QUANDOO, MERCHANT. |
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Quandoo::CustomerReviewData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**identifier** | **String** | Identifier of the customer associated to this review. Only in detailed view. | [optional]
|
7
|
+
**first_name** | **String** | Customer first name associated to this review. Only in detailed view. | [optional]
|
8
|
+
**last_name** | **String** | First letter of customer last name associated to this review. Only in detailed view. | [optional]
|
9
|
+
**profile_image** | **String** | Customer profile image URL associated to this review. Only in detailed view. | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Quandoo::CustomerStatisticsData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**reservation_successful_count** | **Integer** | The number of reservations made by the customer that were actually seated |
|
7
|
+
**reservation_cancelled_count** | **Integer** | The number of reservations made by the customer that were cancelled before taking place |
|
8
|
+
**reservation_no_show_count** | **Integer** | The number of reservations made by the customer that he did not show up |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,183 @@
|
|
1
|
+
# Quandoo::CustomersApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.quandoo.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get_customer1**](CustomersApi.md#get_customer1) | **GET** /v1/customers/{customerId} | Get customer Data
|
8
|
+
[**get_customers_of_merchant1**](CustomersApi.md#get_customers_of_merchant1) | **GET** /v1/merchants/{merchantId}/customers | Get a list of Customers of a merchant
|
9
|
+
[**get_reservations1**](CustomersApi.md#get_reservations1) | **GET** /v1/customers/{customerId}/reservations | Get customer reservations
|
10
|
+
|
11
|
+
|
12
|
+
# **get_customer1**
|
13
|
+
> CustomerResponse get_customer1(customer_id)
|
14
|
+
|
15
|
+
Get customer Data
|
16
|
+
|
17
|
+
This endpoint allows an agent to get customer information by id. Customer id both in the request and response are agent-specific. The agent needs to be authenticated. The endpoint will return `HTTP 404 - Not Found` if the customer 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: * **customerId**: Agent-specific ID of the customer ####Response: The response contains the following data of the customer as explained below: * **id**: The agent-dependent identifier of the customer * **email**: The given email of this customer. _Optional_ * **firstName**: First name of the customer. _Optional_ * **lastName**: Last name of the customer. _Optional_ * **gender**: The given gender of the customer (one of MALE, FEMALE, OTHER or UNDEFINED). _Optional_ * **phoneNumber**: The ID of the merchant at which this reservation was made * **mobileNumber**: The ID of the customer to which this reservation belongs * **country**: 2-letter ISO country code of the customer, e.g. DE * **links**: Related links that can be followed based on this response * **subscriptions**: The newsletter subscriptions, e.g. QUANDOO, MERCHANT Example curl: ``` curl https://{host}/v{X}/customers/9ffb3466-3562-42cc-add1-92a46a2f0902 ``` Example response: ``` { \"id\": \"9ffb3466-3562-42cc-add1-92a46a2f0902\", \"firstName\": \"Gaius\", \"lastName\": \"Octavius\", \"gender\": \"male\", \"email\": \"c2f22117-6148-45b8-ae79-41eda25eae67augustus@spqr.com\", \"phoneNumber\": \"+4917312345678\", \"country\": \"DE\", \"links\": [ { \"href\": \"http://localhost:39250/v1/customers/9ffb3466-3562-42cc-add1-92a46a2f0902/reservations\", \"method\": \"GET\", \"rel\": \"get-customer-reservations\" } ], \"subscriptions\": [ { \"id\": \"QUANDOO\" } ] } ```
|
18
|
+
|
19
|
+
### Example
|
20
|
+
```ruby
|
21
|
+
# load the gem
|
22
|
+
require 'quandoo'
|
23
|
+
# setup authorization
|
24
|
+
Quandoo.configure do |config|
|
25
|
+
# Configure API key authorization: API_TOKEN
|
26
|
+
config.api_key['X-Quandoo-AuthToken'] = 'YOUR API KEY'
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
+
#config.api_key_prefix['X-Quandoo-AuthToken'] = 'Bearer'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = Quandoo::CustomersApi.new
|
32
|
+
|
33
|
+
customer_id = 'customer_id_example' # String | Id of the customer
|
34
|
+
|
35
|
+
|
36
|
+
begin
|
37
|
+
#Get customer Data
|
38
|
+
result = api_instance.get_customer1(customer_id)
|
39
|
+
p result
|
40
|
+
rescue Quandoo::ApiError => e
|
41
|
+
puts "Exception when calling CustomersApi->get_customer1: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
### Parameters
|
46
|
+
|
47
|
+
Name | Type | Description | Notes
|
48
|
+
------------- | ------------- | ------------- | -------------
|
49
|
+
**customer_id** | **String**| Id of the customer |
|
50
|
+
|
51
|
+
### Return type
|
52
|
+
|
53
|
+
[**CustomerResponse**](CustomerResponse.md)
|
54
|
+
|
55
|
+
### Authorization
|
56
|
+
|
57
|
+
[API_TOKEN](../README.md#API_TOKEN)
|
58
|
+
|
59
|
+
### HTTP request headers
|
60
|
+
|
61
|
+
- **Content-Type**: Not defined
|
62
|
+
- **Accept**: Not defined
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
# **get_customers_of_merchant1**
|
67
|
+
> CustomerDataList get_customers_of_merchant1(merchant_id, opts)
|
68
|
+
|
69
|
+
Get a list of Customers of a merchant
|
70
|
+
|
71
|
+
This endpoint allows a third party to get a list of customers of a merchant. The list is filtered, showing only the customers that the third party system has access. Customer id is agent-specific if the customer was created by the agent. 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**: Identifier 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. * **modifiedSince**: earliest date time of time window in UTC. Format: yyyy-MM-dd HH:mm:ss * **modifiedUntil**: latest date time of time window in UTC. Format: yyyy-MM-dd HH:mm:ss ####Response: The response contains the following data of the customer as explained below: * **id**: The agent-dependent identifier of the customer * **title**: The title of the customer. _Optional_ * **firstName**: First name of the customer. _Optional_ * **lastName**: Last name of the customer. _Optional_ * **email**: The given email of this customer. _Optional_ * **gender**: The given gender of the customer (one of MALE, FEMALE, OTHER or UNDEFINED). _Optional_ * **phoneNumber**: The phone number of the customer. _Optional_ * **mobileNumber**: The mobile phone number of the customer. _Optional_ * **locale**: The locale of the customer. * **links**: Related links that can be followed based on this response * **subscriptions**: The newsletter subscriptions, e.g. QUANDOO, MERCHANT * **statistics**: The customer statistics: number of successful, cancelled and no-show reservations * **createdAt**: The date the customer was created. Format: yyyy-MM-ddTHH:mm:ssZ * **updatedAt**: The date the customer was last updated. Format: yyyy-MM-ddTHH:mm:ssZ Example curl: ``` curl https://{host}/v{X}/merchants/1234/customers ``` Example response: ``` { \"result\": [ { \"id\": \"9ffb3466-3562-42cc-add1-92a46a2f0902\", \"customerRef\": \"9ffb3466-3562-42cc-add1-92a46a2f0902\", \"marketingFlags\": [ { \"marketingSettingType\": \"NEWSLETTERS\", \"marketingSettingStatus\": \"INACTIVE\" }, { \"marketingSettingType\": \"PROMO_CODES\", \"marketingSettingStatus\": \"ACTIVE\" } ], \"title\": \"Mr.\", \"firstName\": \"John\", \"lastName\": \"Doe\", \"email\": \"test@quandoo.de\", \"phoneNumber\": \"+493012345678\", \"mobileNumber\": \"+17712345678\", \"locale\": \"de_DE\", \"links\": [ { \"href\": \"http://localhost:39250/v1/customers/9ffb3466-3562-42cc-add1-92a46a2f0902/reservations\", \"method\": \"GET\", \"rel\": \"get-customer-reservations\" } ], \"subscriptions\": [ { \"id\": \"QUANDOO\" } ], \"statistics\": { \"reservationSuccessfulCount\": 8, \"reservationCancelledCount\": 5, \"reservationNoShowCount\": 2 }, \"createdAt\": \"2018-11-22T18:42:16Z\", \"updatedAt\": \"2018-11-30T18:16:02Z\" } ], \"offset\": 0, \"limit\": 100 } ```
|
72
|
+
|
73
|
+
### Example
|
74
|
+
```ruby
|
75
|
+
# load the gem
|
76
|
+
require 'quandoo'
|
77
|
+
# setup authorization
|
78
|
+
Quandoo.configure do |config|
|
79
|
+
# Configure API key authorization: API_TOKEN
|
80
|
+
config.api_key['X-Quandoo-AuthToken'] = 'YOUR API KEY'
|
81
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
82
|
+
#config.api_key_prefix['X-Quandoo-AuthToken'] = 'Bearer'
|
83
|
+
end
|
84
|
+
|
85
|
+
api_instance = Quandoo::CustomersApi.new
|
86
|
+
|
87
|
+
merchant_id = 56 # Integer | Id of the merchant
|
88
|
+
|
89
|
+
opts = {
|
90
|
+
offset: 0, # Integer | offset
|
91
|
+
limit: 100, # Integer | limit
|
92
|
+
modified_since: DateTime.parse('\"2018-01-01 00:00:00\"'), # DateTime | modifiedSince. Format: yyyy-MM-dd HH:mm:ss
|
93
|
+
modified_until: DateTime.parse('\"2018-03-01 00:00:00\"') # DateTime | modifiedUntil. Format: yyyy-MM-dd HH:mm:ss
|
94
|
+
}
|
95
|
+
|
96
|
+
begin
|
97
|
+
#Get a list of Customers of a merchant
|
98
|
+
result = api_instance.get_customers_of_merchant1(merchant_id, opts)
|
99
|
+
p result
|
100
|
+
rescue Quandoo::ApiError => e
|
101
|
+
puts "Exception when calling CustomersApi->get_customers_of_merchant1: #{e}"
|
102
|
+
end
|
103
|
+
```
|
104
|
+
|
105
|
+
### Parameters
|
106
|
+
|
107
|
+
Name | Type | Description | Notes
|
108
|
+
------------- | ------------- | ------------- | -------------
|
109
|
+
**merchant_id** | **Integer**| Id of the merchant |
|
110
|
+
**offset** | **Integer**| offset | [optional] [default to 0]
|
111
|
+
**limit** | **Integer**| limit | [optional] [default to 100]
|
112
|
+
**modified_since** | **DateTime**| modifiedSince. Format: yyyy-MM-dd HH:mm:ss | [optional]
|
113
|
+
**modified_until** | **DateTime**| modifiedUntil. Format: yyyy-MM-dd HH:mm:ss | [optional]
|
114
|
+
|
115
|
+
### Return type
|
116
|
+
|
117
|
+
[**CustomerDataList**](CustomerDataList.md)
|
118
|
+
|
119
|
+
### Authorization
|
120
|
+
|
121
|
+
[API_TOKEN](../README.md#API_TOKEN)
|
122
|
+
|
123
|
+
### HTTP request headers
|
124
|
+
|
125
|
+
- **Content-Type**: Not defined
|
126
|
+
- **Accept**: Not defined
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
# **get_reservations1**
|
131
|
+
> ReservationDataList get_reservations1(customer_id)
|
132
|
+
|
133
|
+
Get customer reservations
|
134
|
+
|
135
|
+
This endpoint allows an agent to get reservations of a customer. The results will be filtered by agent id. Customer id in the request and reservation IDs in response are agent-specific. The agent needs to be authenticated. The endpoint will return `HTTP 404 - Not Found` if the customer 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: * **customerId**: Agent-specific ID of the customer ####Response: The response will be a _list_ of reservations. Each reservation has the fields explained below: * **id**: The agent-dependent unique 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}/customers/ce0706ff-a95d-4229-a220-d21dcd175342/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\" } ] } ```
|
136
|
+
|
137
|
+
### Example
|
138
|
+
```ruby
|
139
|
+
# load the gem
|
140
|
+
require 'quandoo'
|
141
|
+
# setup authorization
|
142
|
+
Quandoo.configure do |config|
|
143
|
+
# Configure API key authorization: API_TOKEN
|
144
|
+
config.api_key['X-Quandoo-AuthToken'] = 'YOUR API KEY'
|
145
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
146
|
+
#config.api_key_prefix['X-Quandoo-AuthToken'] = 'Bearer'
|
147
|
+
end
|
148
|
+
|
149
|
+
api_instance = Quandoo::CustomersApi.new
|
150
|
+
|
151
|
+
customer_id = 'customer_id_example' # String | Id of the customer
|
152
|
+
|
153
|
+
|
154
|
+
begin
|
155
|
+
#Get customer reservations
|
156
|
+
result = api_instance.get_reservations1(customer_id)
|
157
|
+
p result
|
158
|
+
rescue Quandoo::ApiError => e
|
159
|
+
puts "Exception when calling CustomersApi->get_reservations1: #{e}"
|
160
|
+
end
|
161
|
+
```
|
162
|
+
|
163
|
+
### Parameters
|
164
|
+
|
165
|
+
Name | Type | Description | Notes
|
166
|
+
------------- | ------------- | ------------- | -------------
|
167
|
+
**customer_id** | **String**| Id of the customer |
|
168
|
+
|
169
|
+
### Return type
|
170
|
+
|
171
|
+
[**ReservationDataList**](ReservationDataList.md)
|
172
|
+
|
173
|
+
### Authorization
|
174
|
+
|
175
|
+
[API_TOKEN](../README.md#API_TOKEN)
|
176
|
+
|
177
|
+
### HTTP request headers
|
178
|
+
|
179
|
+
- **Content-Type**: Not defined
|
180
|
+
- **Accept**: Not defined
|
181
|
+
|
182
|
+
|
183
|
+
|
data/docs/DealData.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# Quandoo::DealData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The deal id. |
|
7
|
+
**count** | **Integer** | The deal count. |
|
8
|
+
**type** | **String** | The deal type. |
|
9
|
+
|
10
|
+
|
data/docs/DocumentDto.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# Quandoo::DocumentDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | | [optional]
|
7
|
+
**url** | **String** | | [optional]
|
8
|
+
**format** | **String** | | [optional]
|
9
|
+
**description** | **String** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# Quandoo::GetReservationEnquiryData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The agent-dependent unique id of the reservation enquiry | [optional]
|
7
|
+
**merchant_id** | **Integer** | The ID of the merchant at which this reservation enquiry was made | [optional]
|
8
|
+
**customer_id** | **String** | The ID of the customer to which this reservation enquiry belongs |
|
9
|
+
**capacity** | **Integer** | The capacity (people count) of the reservation enquiry | [optional]
|
10
|
+
**start_date_time** | **String** | The start date time of the reservation enquiry. Format: yyyy-MM-ddTHH:mm:ssZ | [optional]
|
11
|
+
**end_date_time** | **String** | The end date time of the reservation enquiry. Format: yyyy-MM-ddTHH:mm:ssZ | [optional]
|
12
|
+
**status** | **String** | The status of the reservation enquiry which can be one of: NEW, IN_PROGRESS, ACCEPTED or REJECTED | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# Quandoo::GetReviewDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**review_id** | **String** | UUID identifying the review. |
|
7
|
+
**merchant_id** | **Integer** | Merchant Id associated to this review. Only in detailed view. | [optional]
|
8
|
+
**customer** | [**CustomerReviewData**](CustomerReviewData.md) | Data about the customer that made this review. Only in detailed view. | [optional]
|
9
|
+
**status** | **String** | Current review status. Possible values are 'AVAILABLE_TO_REVIEW','CREATED', 'DENIED', 'PUBLISHED'. | [optional]
|
10
|
+
**locale** | **String** | Locale of the created review. Only in detailed view. | [optional]
|
11
|
+
**rating** | **Integer** | Rating associated to this review. Possible values: 1 to 6. |
|
12
|
+
**description** | **String** | Description associated to this review. | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Quandoo::GetReviewsDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**reviews** | [**Array<GetReviewDto>**](GetReviewDto.md) | List of returned reviews. | [optional]
|
7
|
+
**size** | **Integer** | Number of reviews returned in this object. | [optional]
|
8
|
+
**offset** | **Integer** | Offset to apply on the next pagination request. Can be higher than the number of available reviews. | [optional]
|
9
|
+
**limit** | **Integer** | Expected number of reviews that could be retrieved in the next pagination request. Can actually be less than the number returned. Its value is 0 when it is sure there are no more reviews available for pagination using the 'offset' as starting point. | [optional]
|
10
|
+
|
11
|
+
|
data/docs/ImageDto.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# Quandoo::LinkRelationDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**href** | **String** | | [optional]
|
7
|
+
**method** | **String** | | [optional]
|
8
|
+
**rel** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
data/docs/LocationDto.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# Quandoo::LocationDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**coordinates** | [**CoordinatesDto**](CoordinatesDto.md) | | [optional]
|
7
|
+
**address** | [**MerchantAddressDto**](MerchantAddressDto.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Quandoo::MarketingSettingDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**marketing_setting_type** | **String** | | [optional]
|
7
|
+
**marketing_setting_status** | **String** | | [optional]
|
8
|
+
|
9
|
+
|
data/docs/MenusApi.md
ADDED
@@ -0,0 +1,300 @@
|
|
1
|
+
# Quandoo::MenusApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.quandoo.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**add_preordered_items1**](MenusApi.md#add_preordered_items1) | **PATCH** /v1/reservations/{reservationId}/preorders | Add/remove menu items to/from a reservation's preorders
|
8
|
+
[**find_menus_for_reservation1**](MenusApi.md#find_menus_for_reservation1) | **GET** /v1/reservations/{reservationId}/menus | Get all available menus for a reservation
|
9
|
+
[**get_menu_for_reservation1**](MenusApi.md#get_menu_for_reservation1) | **GET** /v1/reservations/{reservationId}/menus/{menuId} | Get information about an available reservation menu
|
10
|
+
[**get_preordered_items1**](MenusApi.md#get_preordered_items1) | **GET** /v1/reservations/{reservationId}/preorders | Get preorders of a reservation
|
11
|
+
[**save_preordered_items1**](MenusApi.md#save_preordered_items1) | **PUT** /v1/reservations/{reservationId}/preorders | Preorder menu items for a reservation
|
12
|
+
|
13
|
+
|
14
|
+
# **add_preordered_items1**
|
15
|
+
> ReservationMenuData add_preordered_items1(reservation_id, body)
|
16
|
+
|
17
|
+
Add/remove menu items to/from a reservation's preorders
|
18
|
+
|
19
|
+
This endpoint will add/remove menu items to/from preorders of a reservation. If an item already exists, the quantitiy specified for the item will be added to the existing quantity. For example, if an item has a quantity of 2, and a PATCH request specifies the same item with a quantity of 1, the result will be a quantity of 3 for that item. This can be also used to remove items, by specifying a negative quantity. For example, if an item has a quantity of 2, and a PATCH request specifies the same item with a quantity of -1, the result will be a quantity of 1. No item can have a negative quantity in the end, which means a PATCH request with a quantity of -5 for an item that currently has a quantity of 2, will result in that item to be simply deleted from the preorder, instead of having a final quantity of -3. If an item does not exist in the current preorders, it will be added, provided it has a positive quantity. The reservation ID in the request is the public ID of the reservation and **not** agent-specific. This endpoint requires user to be logged in. The endpoint will return `HTTP 404 - Not Found` if the reservation with the specified id could not be found. It will return `HTTP 403 - Forbidden` if the user is not authenticated or the reservation doesn't belong to the customer associated with the user. ####Request: * **reservationId**: Public ID of the reservation. Path parameter. Request body has the same structure as Get Preorder response, except not having the `href` field. * **items**: List of menu items to be edited. Each menu item will have the fields explained below. * **menuId**: The Id of the menu that this item belongs to. **Required**. * **itemId**: The Id of the menu item. **Required**. * **quantity**: Change in quantity to be applied to the existing item's quantity. See above for explanation. **Required**. * **guestPublicId**: The ID of the guest for whom this item is being preordered. Optional. Format: UUID. ####Response: * **items**: The response will be a _list_ of successfully preordered menu items. Each menu item has the fields explained below: * **menuId**: The Id of the menu that this item belongs to * **itemId**: The Id of the menu item * **quantity**: Quantity of this menu item selected for the reservation * **guestPublicId**: The ID of the guest for whom this item has been preordered, if any. * **href**: Link that can be followed to get information about the menu and its available items Example curl: ``` curl -H \"Content Type: application/json\" -X PATCH -d ' { \"items\": [ { \"menuId\": 1846, \"itemId\": 1477, \"quantity\": 1, \"guestPublicId\": \"a8a66a11-446a-443b-8834-591742825ad4\" }, { \"menuId\": 1846, \"itemId\": 1478, \"quantity\": -1 } ] } ' https://{host}/v{X}/reservations/ce0706ff-a95d-4229-a220-d21dcd175342/preorders ``` Example response: ``` { \"items\": [ { \"menuId\": 1846, \"itemId\": 1477, \"quantity\": 2, \"guestPublicId\": \"a8a66a11-446a-443b-8834-591742825ad4\", \"href\": \"https://{host}/v{X}/reservations/ce0706ff-a95d-4229-a220-d21dcd175342/menus/1846\" }, { \"menuId\": 1846, \"itemId\": 1478, \"quantity\": 1, \"guestPublicId\": \"f871d6d7-e92e-4672-b24a-edb76963073b\", \"href\": \"https://{host}/v{X}/reservations/ce0706ff-a95d-4229-a220-d21dcd175342/menus/1846\" } ] } ```
|
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: CUSTOMER_SESSION
|
28
|
+
config.api_key['X-Quandoo-User-Session'] = '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-User-Session'] = 'Bearer'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = Quandoo::MenusApi.new
|
34
|
+
|
35
|
+
reservation_id = 'reservation_id_example' # String | Public Id of the reservation
|
36
|
+
|
37
|
+
body = Quandoo::ReservationMenuData.new # ReservationMenuData | Menu items to add
|
38
|
+
|
39
|
+
|
40
|
+
begin
|
41
|
+
#Add/remove menu items to/from a reservation's preorders
|
42
|
+
result = api_instance.add_preordered_items1(reservation_id, body)
|
43
|
+
p result
|
44
|
+
rescue Quandoo::ApiError => e
|
45
|
+
puts "Exception when calling MenusApi->add_preordered_items1: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
### Parameters
|
50
|
+
|
51
|
+
Name | Type | Description | Notes
|
52
|
+
------------- | ------------- | ------------- | -------------
|
53
|
+
**reservation_id** | **String**| Public Id of the reservation |
|
54
|
+
**body** | [**ReservationMenuData**](ReservationMenuData.md)| Menu items to add |
|
55
|
+
|
56
|
+
### Return type
|
57
|
+
|
58
|
+
[**ReservationMenuData**](ReservationMenuData.md)
|
59
|
+
|
60
|
+
### Authorization
|
61
|
+
|
62
|
+
[CUSTOMER_SESSION](../README.md#CUSTOMER_SESSION)
|
63
|
+
|
64
|
+
### HTTP request headers
|
65
|
+
|
66
|
+
- **Content-Type**: application/json
|
67
|
+
- **Accept**: Not defined
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
# **find_menus_for_reservation1**
|
72
|
+
> MerchantMenusDto find_menus_for_reservation1(reservation_id, opts)
|
73
|
+
|
74
|
+
Get all available menus for a reservation
|
75
|
+
|
76
|
+
This endpoint will return the available menus for a reservation. The reservation ID in the request is the public ID of the reservation and **not** agent-specific. This endpoint requires user to be logged in. The endpoint will return `HTTP 404 - Not Found` if the reservation with the specified id could not be found. It will return `HTTP 403 - Forbidden` if the user is not authenticated or the reservation doesn't belong to the customer associated with the user. ####Request: * **reservationId**: Public Id of the reservation * **locale**: Locale for translated info. Default: _en_ ####Response: The response will be a _list_ of available menus. Each menu has the fields explained below: * **id**: The unique id of the menu * **name**: The name or title of the menu * **description**: Menu description * **price**: Total price for the menu * **sortOrder**: The order in which this menu should be displayed * **categories**: Categories of the menu * **id**: The Id of the menu category * **name**: Name or title of the menu category * **items**: Items inside the menu category * **id**: Id of the menu item * **name**: Name of menu item * **description**: Menu item description * **price**: Item price Example curl: ``` curl https://{host}/v{X}/reservations/ce0706ff-a95d-4229-a220-d21dcd175342/menus?locale=en ``` Example response: ``` { \"menus\": [ { \"id\": 1836, \"name\": \"special menu 1\", \"price\": \"100.00\", \"sortOrder\": 0, \"categories\": [ { \"id\": 1109, \"name\": \"starters\", \"items\": [ { \"id\": 1469, \"name\": \"fries\", \"price\": \"20.00\" } ] }, { \"id\": 1110, \"name\": \"fish\", \"items\": [ { \"id\": 1470, \"name\": \"salmon\", \"price\": \"60.00\" } ] }, { \"id\": 1111, \"name\": \"dessert\", \"items\": [ { \"id\": 1471, \"name\": \"sundae\", \"price\": \"20.00\" } ] } ] } ] } ```
|
77
|
+
|
78
|
+
### Example
|
79
|
+
```ruby
|
80
|
+
# load the gem
|
81
|
+
require 'quandoo'
|
82
|
+
# setup authorization
|
83
|
+
Quandoo.configure do |config|
|
84
|
+
# Configure API key authorization: CUSTOMER_SESSION
|
85
|
+
config.api_key['X-Quandoo-User-Session'] = 'YOUR API KEY'
|
86
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
87
|
+
#config.api_key_prefix['X-Quandoo-User-Session'] = 'Bearer'
|
88
|
+
end
|
89
|
+
|
90
|
+
api_instance = Quandoo::MenusApi.new
|
91
|
+
|
92
|
+
reservation_id = 'reservation_id_example' # String | Public Id of the reservation
|
93
|
+
|
94
|
+
opts = {
|
95
|
+
locale: 'en' # String | Locale for translated info
|
96
|
+
}
|
97
|
+
|
98
|
+
begin
|
99
|
+
#Get all available menus for a reservation
|
100
|
+
result = api_instance.find_menus_for_reservation1(reservation_id, opts)
|
101
|
+
p result
|
102
|
+
rescue Quandoo::ApiError => e
|
103
|
+
puts "Exception when calling MenusApi->find_menus_for_reservation1: #{e}"
|
104
|
+
end
|
105
|
+
```
|
106
|
+
|
107
|
+
### Parameters
|
108
|
+
|
109
|
+
Name | Type | Description | Notes
|
110
|
+
------------- | ------------- | ------------- | -------------
|
111
|
+
**reservation_id** | **String**| Public Id of the reservation |
|
112
|
+
**locale** | **String**| Locale for translated info | [optional] [default to en]
|
113
|
+
|
114
|
+
### Return type
|
115
|
+
|
116
|
+
[**MerchantMenusDto**](MerchantMenusDto.md)
|
117
|
+
|
118
|
+
### Authorization
|
119
|
+
|
120
|
+
[CUSTOMER_SESSION](../README.md#CUSTOMER_SESSION)
|
121
|
+
|
122
|
+
### HTTP request headers
|
123
|
+
|
124
|
+
- **Content-Type**: Not defined
|
125
|
+
- **Accept**: Not defined
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
# **get_menu_for_reservation1**
|
130
|
+
> MerchantMenuDto get_menu_for_reservation1(reservation_id, menu_id, opts)
|
131
|
+
|
132
|
+
Get information about an available reservation menu
|
133
|
+
|
134
|
+
This endpoint will return details for a single available menu. The reservation ID in the request is the public ID of the reservation and **not** agent-specific. This endpoint requires user to be logged in. The endpoint will return `HTTP 404 - Not Found` if the reservation or menu with the specified id could not be found. It will return `HTTP 403 - Forbidden` if the user is not authenticated or the reservation doesn't belong to the customer associated with the user. ####Request: * **reservationId**: Public id of the reservation * **menuId**: Id of the menu * **locale**: Locale for translated info. Default: _en_ ####Response: The response will be a menu with each field as explained below: * **id**: The unique id of the menu * **name**: The name or title of the menu * **description**: Menu description * **price**: Total price for the menu * **sortOrder**: The order in which this menu should be displayed * **categories**: Categories of the menu * **id**: The id of the menu category * **name**: Name or title of the menu category * **items**: Items inside the menu category * **id**: Id of the menu item * **name**: Name of menu item * **description**: Menu item description * **price**: Item price Example curl: ``` curl https://{host}/v{X}/reservations/ce0706ff-a95d-4229-a220-d21dcd175342/menus/1836?locale=en ``` Example response: ``` { \"id\": 1836, \"name\": \"special menu 1\", \"price\": \"100.00\", \"sortOrder\": 0, \"categories\": [ { \"id\": 1109, \"name\": \"starters\", \"items\": [ { \"id\": 1469, \"name\": \"fries\", \"price\": \"20.00\" } ] }, { \"id\": 1110, \"name\": \"fish\", \"items\": [ { \"id\": 1470, \"name\": \"salmon\", \"price\": \"60.00\" } ] }, { \"id\": 1111, \"name\": \"dessert\", \"items\": [ { \"id\": 1471, \"name\": \"sundae\", \"price\": \"20.00\" } ] } ] } ```
|
135
|
+
|
136
|
+
### Example
|
137
|
+
```ruby
|
138
|
+
# load the gem
|
139
|
+
require 'quandoo'
|
140
|
+
# setup authorization
|
141
|
+
Quandoo.configure do |config|
|
142
|
+
# Configure API key authorization: CUSTOMER_SESSION
|
143
|
+
config.api_key['X-Quandoo-User-Session'] = 'YOUR API KEY'
|
144
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
145
|
+
#config.api_key_prefix['X-Quandoo-User-Session'] = 'Bearer'
|
146
|
+
end
|
147
|
+
|
148
|
+
api_instance = Quandoo::MenusApi.new
|
149
|
+
|
150
|
+
reservation_id = 'reservation_id_example' # String | Public Id of the reservation
|
151
|
+
|
152
|
+
menu_id = 56 # Integer | Id of the menu
|
153
|
+
|
154
|
+
opts = {
|
155
|
+
locale: 'en' # String | Locale for translated info
|
156
|
+
}
|
157
|
+
|
158
|
+
begin
|
159
|
+
#Get information about an available reservation menu
|
160
|
+
result = api_instance.get_menu_for_reservation1(reservation_id, menu_id, opts)
|
161
|
+
p result
|
162
|
+
rescue Quandoo::ApiError => e
|
163
|
+
puts "Exception when calling MenusApi->get_menu_for_reservation1: #{e}"
|
164
|
+
end
|
165
|
+
```
|
166
|
+
|
167
|
+
### Parameters
|
168
|
+
|
169
|
+
Name | Type | Description | Notes
|
170
|
+
------------- | ------------- | ------------- | -------------
|
171
|
+
**reservation_id** | **String**| Public Id of the reservation |
|
172
|
+
**menu_id** | **Integer**| Id of the menu |
|
173
|
+
**locale** | **String**| Locale for translated info | [optional] [default to en]
|
174
|
+
|
175
|
+
### Return type
|
176
|
+
|
177
|
+
[**MerchantMenuDto**](MerchantMenuDto.md)
|
178
|
+
|
179
|
+
### Authorization
|
180
|
+
|
181
|
+
[CUSTOMER_SESSION](../README.md#CUSTOMER_SESSION)
|
182
|
+
|
183
|
+
### HTTP request headers
|
184
|
+
|
185
|
+
- **Content-Type**: Not defined
|
186
|
+
- **Accept**: Not defined
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
# **get_preordered_items1**
|
191
|
+
> ReservationMenuData get_preordered_items1(reservation_id)
|
192
|
+
|
193
|
+
Get preorders of a reservation
|
194
|
+
|
195
|
+
This endpoint will return the preordered menu items of a reservation. The reservation ID in the request is the public ID of the reservation and **not** agent-specific. This endpoint requires user to be logged in. The endpoint will return `HTTP 404 - Not Found` if the reservation with the specified id could not be found. It will return `HTTP 403 - Forbidden` if the user is not authenticated or the reservation doesn't belong to the customer associated with the user. ####Request: * **reservationId**: Public ID of the reservation ####Response: The response will be a _list_ of menu items. Each menu item has the fields explained below: * **menuId**: The Id of the menu that this item belongs to * **itemId**: The Id of the menu item * **quantity**: Quantity of this menu item selected for the reservation * **guestPublicId**: The ID of the guest for whom this item has been preordered, if any. * **href**: Link that can be followed to get information about the menu and its available items Example curl: ``` curl https://{host}/v{X}/reservations/ce0706ff-a95d-4229-a220-d21dcd175342/preorders ``` Example response: ``` { \"items\": [ { \"menuId\": 1846, \"itemId\": 1477, \"quantity\": 1, \"guestPublicId\": \"a8a66a11-446a-443b-8834-591742825ad4\", \"href\": \"https://{host}/v{X}/reservations/ce0706ff-a95d-4229-a220-d21dcd175342/menus/1846\" }, { \"menuId\": 1846, \"itemId\": 1478, \"quantity\": 2, \"guestPublicId\": \"a8a66a11-446a-443b-8834-591742825ad4\", \"href\": \"https://{host}/v{X}/reservations/ce0706ff-a95d-4229-a220-d21dcd175342/menus/1846\" } ] } ```
|
196
|
+
|
197
|
+
### Example
|
198
|
+
```ruby
|
199
|
+
# load the gem
|
200
|
+
require 'quandoo'
|
201
|
+
# setup authorization
|
202
|
+
Quandoo.configure do |config|
|
203
|
+
# Configure API key authorization: CUSTOMER_SESSION
|
204
|
+
config.api_key['X-Quandoo-User-Session'] = 'YOUR API KEY'
|
205
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
206
|
+
#config.api_key_prefix['X-Quandoo-User-Session'] = 'Bearer'
|
207
|
+
end
|
208
|
+
|
209
|
+
api_instance = Quandoo::MenusApi.new
|
210
|
+
|
211
|
+
reservation_id = 'reservation_id_example' # String | Public Id of the reservation
|
212
|
+
|
213
|
+
|
214
|
+
begin
|
215
|
+
#Get preorders of a reservation
|
216
|
+
result = api_instance.get_preordered_items1(reservation_id)
|
217
|
+
p result
|
218
|
+
rescue Quandoo::ApiError => e
|
219
|
+
puts "Exception when calling MenusApi->get_preordered_items1: #{e}"
|
220
|
+
end
|
221
|
+
```
|
222
|
+
|
223
|
+
### Parameters
|
224
|
+
|
225
|
+
Name | Type | Description | Notes
|
226
|
+
------------- | ------------- | ------------- | -------------
|
227
|
+
**reservation_id** | **String**| Public Id of the reservation |
|
228
|
+
|
229
|
+
### Return type
|
230
|
+
|
231
|
+
[**ReservationMenuData**](ReservationMenuData.md)
|
232
|
+
|
233
|
+
### Authorization
|
234
|
+
|
235
|
+
[CUSTOMER_SESSION](../README.md#CUSTOMER_SESSION)
|
236
|
+
|
237
|
+
### HTTP request headers
|
238
|
+
|
239
|
+
- **Content-Type**: Not defined
|
240
|
+
- **Accept**: Not defined
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
# **save_preordered_items1**
|
245
|
+
> ReservationMenuData save_preordered_items1(reservation_id, body)
|
246
|
+
|
247
|
+
Preorder menu items for a reservation
|
248
|
+
|
249
|
+
This endpoint will preorder menu items for a reservation. The reservation ID in the request is the public ID of the reservation and **not** agent-specific. This endpoint requires user to be logged in. The endpoint will return `HTTP 404 - Not Found` if the reservation with the specified id could not be found. It will return `HTTP 403 - Forbidden` if the user is not authenticated or the reservation doesn't belong to the customer associated with the user. ####Request: * **reservationId**: Public ID of the reservation. Path parameter. Request body has the same structure as Get Preorder response, except not having the `href` field. * **items**: List of menu items to be preordered. Each menu item will have the fields explained below. * **menuId**: The Id of the menu that this item belongs to. **Required**. * **itemId**: The Id of the menu item. **Required**. * **quantity**: Number of specified items to be preordered. **Required**. * **guestPublicId**: The ID of the guest for whom this item is being preordered. Optional. Format: UUID. ####Response: * **items**: The response will be a _list_ of successfully preordered menu items. Each menu item has the fields explained below: * **menuId**: The Id of the menu that this item belongs to * **itemId**: The Id of the menu item * **quantity**: Quantity of this menu item selected for the reservation * **guestPublicId**: The ID of the guest for whom this item has been preordered, if any. * **href**: Link that can be followed to get information about the menu and its available items Example curl: ``` curl -H \"Content Type: application/json\" -X PUT -d ' { \"items\": [ { \"menuId\": 1846, \"itemId\": 1477, \"quantity\": 1, \"guestPublicId\": \"a8a66a11-446a-443b-8834-591742825ad4\" }, { \"menuId\": 1846, \"itemId\": 1478, \"quantity\": 2 } ] } ' https://{host}/v{X}/reservations/ce0706ff-a95d-4229-a220-d21dcd175342/preorders ``` Example response: ``` { \"items\": [ { \"menuId\": 1846, \"itemId\": 1477, \"quantity\": 1, \"guestPublicId\": \"a8a66a11-446a-443b-8834-591742825ad4\", \"href\": \"https://{host}/v{X}/reservations/ce0706ff-a95d-4229-a220-d21dcd175342/menus/1846\" }, { \"menuId\": 1846, \"itemId\": 1478, \"quantity\": 2, \"href\": \"https://{host}/v{X}/reservations/ce0706ff-a95d-4229-a220-d21dcd175342/menus/1846\" } ] } ```
|
250
|
+
|
251
|
+
### Example
|
252
|
+
```ruby
|
253
|
+
# load the gem
|
254
|
+
require 'quandoo'
|
255
|
+
# setup authorization
|
256
|
+
Quandoo.configure do |config|
|
257
|
+
# Configure API key authorization: CUSTOMER_SESSION
|
258
|
+
config.api_key['X-Quandoo-User-Session'] = 'YOUR API KEY'
|
259
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
260
|
+
#config.api_key_prefix['X-Quandoo-User-Session'] = 'Bearer'
|
261
|
+
end
|
262
|
+
|
263
|
+
api_instance = Quandoo::MenusApi.new
|
264
|
+
|
265
|
+
reservation_id = 'reservation_id_example' # String | Public Id of the reservation
|
266
|
+
|
267
|
+
body = Quandoo::ReservationMenuData.new # ReservationMenuData | Menu items for this reservation
|
268
|
+
|
269
|
+
|
270
|
+
begin
|
271
|
+
#Preorder menu items for a reservation
|
272
|
+
result = api_instance.save_preordered_items1(reservation_id, body)
|
273
|
+
p result
|
274
|
+
rescue Quandoo::ApiError => e
|
275
|
+
puts "Exception when calling MenusApi->save_preordered_items1: #{e}"
|
276
|
+
end
|
277
|
+
```
|
278
|
+
|
279
|
+
### Parameters
|
280
|
+
|
281
|
+
Name | Type | Description | Notes
|
282
|
+
------------- | ------------- | ------------- | -------------
|
283
|
+
**reservation_id** | **String**| Public Id of the reservation |
|
284
|
+
**body** | [**ReservationMenuData**](ReservationMenuData.md)| Menu items for this reservation |
|
285
|
+
|
286
|
+
### Return type
|
287
|
+
|
288
|
+
[**ReservationMenuData**](ReservationMenuData.md)
|
289
|
+
|
290
|
+
### Authorization
|
291
|
+
|
292
|
+
[CUSTOMER_SESSION](../README.md#CUSTOMER_SESSION)
|
293
|
+
|
294
|
+
### HTTP request headers
|
295
|
+
|
296
|
+
- **Content-Type**: application/json
|
297
|
+
- **Accept**: Not defined
|
298
|
+
|
299
|
+
|
300
|
+
|