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
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 10f70cf986e3afbd37f00b7a74090e535d9d9688
|
4
|
+
data.tar.gz: 2c2579092cfc4bc91a6408073f6a0ba44560fa58
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: f0d7769cdd0a8a4c81c844ed3c707546be0a21c4a1fe618c0e5be9fb0f23337f22c6c74ac35cfd3a52d185b1604d5fdd86b23c1c42d8e64b8a0acf5311947e24
|
7
|
+
data.tar.gz: 8aa3cb82824bc7bf4a28c485d36ca75ef6faf9099f2913d699b8cd9248cc7db4d2b7aeb103a013f482e771764ae7f32a7bf48c832e62712db22ce17b01a7d5a3
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,197 @@
|
|
1
|
+
# quandoo
|
2
|
+
|
3
|
+
Quandoo - the Ruby gem for the Quandoo API Documentation
|
4
|
+
|
5
|
+
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
|
+
|
9
|
+
- API version: 1.0.0
|
10
|
+
- Package version: 1.0.0
|
11
|
+
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
### Build a gem
|
16
|
+
|
17
|
+
To build the Ruby code into a gem:
|
18
|
+
|
19
|
+
```shell
|
20
|
+
gem build quandoo.gemspec
|
21
|
+
```
|
22
|
+
|
23
|
+
Then either install the gem locally:
|
24
|
+
|
25
|
+
```shell
|
26
|
+
gem install ./quandoo-1.0.0.gem
|
27
|
+
```
|
28
|
+
(for development, run `gem install --dev ./quandoo-1.0.0.gem` to install the development dependencies)
|
29
|
+
|
30
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
|
+
|
32
|
+
Finally add this to the Gemfile:
|
33
|
+
|
34
|
+
gem 'quandoo', '~> 1.0.0'
|
35
|
+
|
36
|
+
### Install from Git
|
37
|
+
|
38
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
39
|
+
|
40
|
+
gem 'quandoo', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
41
|
+
|
42
|
+
### Include the Ruby code directly
|
43
|
+
|
44
|
+
Include the Ruby code directly using `-I` as follows:
|
45
|
+
|
46
|
+
```shell
|
47
|
+
ruby -Ilib script.rb
|
48
|
+
```
|
49
|
+
|
50
|
+
## Getting Started
|
51
|
+
|
52
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
53
|
+
```ruby
|
54
|
+
# Load the gem
|
55
|
+
require 'quandoo'
|
56
|
+
|
57
|
+
api_instance = Quandoo::AvailabilitiesApi.new
|
58
|
+
|
59
|
+
merchant_id = 56 # Integer | Id of the merchant
|
60
|
+
|
61
|
+
agent_id = 56 # Integer | Id of the agent
|
62
|
+
|
63
|
+
opts = {
|
64
|
+
capacity: 56 # Integer | Number of people
|
65
|
+
}
|
66
|
+
|
67
|
+
begin
|
68
|
+
#Get merchant availability days
|
69
|
+
result = api_instance.availability_days1(merchant_id, agent_id, opts)
|
70
|
+
p result
|
71
|
+
rescue Quandoo::ApiError => e
|
72
|
+
puts "Exception when calling AvailabilitiesApi->availability_days1: #{e}"
|
73
|
+
end
|
74
|
+
|
75
|
+
```
|
76
|
+
|
77
|
+
## Documentation for API Endpoints
|
78
|
+
|
79
|
+
All URIs are relative to *https://api.quandoo.com*
|
80
|
+
|
81
|
+
Class | Method | HTTP request | Description
|
82
|
+
------------ | ------------- | ------------- | -------------
|
83
|
+
*Quandoo::AvailabilitiesApi* | [**availability_days1**](docs/AvailabilitiesApi.md#availability_days1) | **GET** /v1/merchants/{merchantId}/availabilities | Get merchant availability days
|
84
|
+
*Quandoo::AvailabilitiesApi* | [**availability_options1**](docs/AvailabilitiesApi.md#availability_options1) | **GET** /v1/merchants/{merchantId}/availabilities/{date}/times | Get merchant availability time slots
|
85
|
+
*Quandoo::CustomersApi* | [**get_customer1**](docs/CustomersApi.md#get_customer1) | **GET** /v1/customers/{customerId} | Get customer Data
|
86
|
+
*Quandoo::CustomersApi* | [**get_customers_of_merchant1**](docs/CustomersApi.md#get_customers_of_merchant1) | **GET** /v1/merchants/{merchantId}/customers | Get a list of Customers of a merchant
|
87
|
+
*Quandoo::CustomersApi* | [**get_reservations1**](docs/CustomersApi.md#get_reservations1) | **GET** /v1/customers/{customerId}/reservations | Get customer reservations
|
88
|
+
*Quandoo::MenusApi* | [**add_preordered_items1**](docs/MenusApi.md#add_preordered_items1) | **PATCH** /v1/reservations/{reservationId}/preorders | Add/remove menu items to/from a reservation's preorders
|
89
|
+
*Quandoo::MenusApi* | [**find_menus_for_reservation1**](docs/MenusApi.md#find_menus_for_reservation1) | **GET** /v1/reservations/{reservationId}/menus | Get all available menus for a reservation
|
90
|
+
*Quandoo::MenusApi* | [**get_menu_for_reservation1**](docs/MenusApi.md#get_menu_for_reservation1) | **GET** /v1/reservations/{reservationId}/menus/{menuId} | Get information about an available reservation menu
|
91
|
+
*Quandoo::MenusApi* | [**get_preordered_items1**](docs/MenusApi.md#get_preordered_items1) | **GET** /v1/reservations/{reservationId}/preorders | Get preorders of a reservation
|
92
|
+
*Quandoo::MenusApi* | [**save_preordered_items1**](docs/MenusApi.md#save_preordered_items1) | **PUT** /v1/reservations/{reservationId}/preorders | Preorder menu items for a reservation
|
93
|
+
*Quandoo::MerchantsApi* | [**get_reservations2**](docs/MerchantsApi.md#get_reservations2) | **GET** /v1/merchants/{merchantId}/reservations | Get merchant reservations
|
94
|
+
*Quandoo::MerchantsApi* | [**get_reviews1**](docs/MerchantsApi.md#get_reviews1) | **GET** /v1/merchants/{merchantId}/reviews | Retrieves customer reviews for a merchant, specified by reviewId
|
95
|
+
*Quandoo::MerchantsApi* | [**search**](docs/MerchantsApi.md#search) | **GET** /v1/merchants | Allows to get merchant information by parameters
|
96
|
+
*Quandoo::MerchantsApi* | [**search2**](docs/MerchantsApi.md#search2) | **GET** /v1/merchants/{merchantId} | Allows to get a merchant by id
|
97
|
+
*Quandoo::MerchantsApi* | [**search_similar1**](docs/MerchantsApi.md#search_similar1) | **GET** /v1/merchants/{merchantId}/similar | Allows to get a merchant by id and find similar merchants
|
98
|
+
*Quandoo::ReservationEnquiriesApi* | [**create_reservation_enquiry1**](docs/ReservationEnquiriesApi.md#create_reservation_enquiry1) | **PUT** /v1/reservation-enquiries | Create reservation enquiries
|
99
|
+
*Quandoo::ReservationEnquiriesApi* | [**get_messages_for_reservation_enquiry1**](docs/ReservationEnquiriesApi.md#get_messages_for_reservation_enquiry1) | **GET** /v1/reservation-enquiries/{reservationEnquiryId}/messages | Get all messages of a reservation enquiry
|
100
|
+
*Quandoo::ReservationEnquiriesApi* | [**get_reservation_enquiry1**](docs/ReservationEnquiriesApi.md#get_reservation_enquiry1) | **GET** /v1/reservation-enquiries/{reservationEnquiryId} | Get reservation enquiry by id
|
101
|
+
*Quandoo::ReservationEnquiriesApi* | [**update_reservation_enquiry1**](docs/ReservationEnquiriesApi.md#update_reservation_enquiry1) | **PATCH** /v1/reservation-enquiries/{reservationEnquiryId} | Update status of reservation enquiry by id
|
102
|
+
*Quandoo::ReservationSettingsApi* | [**reservation_settings1**](docs/ReservationSettingsApi.md#reservation_settings1) | **GET** /v1/merchants/{merchantId}/reservation-settings | Get merchant reservation settings
|
103
|
+
*Quandoo::ReservationsApi* | [**create_reservation1**](docs/ReservationsApi.md#create_reservation1) | **PUT** /v1/reservations | Create reservations
|
104
|
+
*Quandoo::ReservationsApi* | [**get_reservation1**](docs/ReservationsApi.md#get_reservation1) | **GET** /v1/reservations/{reservationId} | Get reservation by id
|
105
|
+
*Quandoo::ReservationsApi* | [**update_reservation1**](docs/ReservationsApi.md#update_reservation1) | **PATCH** /v1/reservations/{reservationId} | Update reservation by id
|
106
|
+
*Quandoo::ReviewsApi* | [**create_review1**](docs/ReviewsApi.md#create_review1) | **PUT** /v1/reviews | Create a review for a reservation
|
107
|
+
*Quandoo::ReviewsApi* | [**get_review1**](docs/ReviewsApi.md#get_review1) | **GET** /v1/reviews/{reviewId} | Get details for a specific review
|
108
|
+
*Quandoo::ReviewsApi* | [**get_reviews2**](docs/ReviewsApi.md#get_reviews2) | **GET** /v1/reviews | Get information from reviews in a list
|
109
|
+
*Quandoo::ReviewsApi* | [**update_review1**](docs/ReviewsApi.md#update_review1) | **PATCH** /v1/reviews | Updated a review
|
110
|
+
*Quandoo::StatusApi* | [**get_status_by_get1**](docs/StatusApi.md#get_status_by_get1) | **GET** /v1/status | Provides information on the status of the service
|
111
|
+
*Quandoo::StatusApi* | [**get_status_by_head1**](docs/StatusApi.md#get_status_by_head1) | **HEAD** /v1/status | Provides information on the status of the service
|
112
|
+
*Quandoo::ValidationsApi* | [**validate_phone_number1**](docs/ValidationsApi.md#validate_phone_number1) | **GET** /v1/validations/phone-numbers | Validate phone number
|
113
|
+
|
114
|
+
|
115
|
+
## Documentation for Models
|
116
|
+
|
117
|
+
- [Quandoo::AgentTracking](docs/AgentTracking.md)
|
118
|
+
- [Quandoo::AreaDto](docs/AreaDto.md)
|
119
|
+
- [Quandoo::ChainDto](docs/ChainDto.md)
|
120
|
+
- [Quandoo::ChangedReviewDto](docs/ChangedReviewDto.md)
|
121
|
+
- [Quandoo::CoordinatesDto](docs/CoordinatesDto.md)
|
122
|
+
- [Quandoo::CreateReviewDto](docs/CreateReviewDto.md)
|
123
|
+
- [Quandoo::CreatedMasterCustomer](docs/CreatedMasterCustomer.md)
|
124
|
+
- [Quandoo::CreatedReservation](docs/CreatedReservation.md)
|
125
|
+
- [Quandoo::CreatedReservationData](docs/CreatedReservationData.md)
|
126
|
+
- [Quandoo::CreatedReservationEnquiry](docs/CreatedReservationEnquiry.md)
|
127
|
+
- [Quandoo::CreatedReservationEnquiryData](docs/CreatedReservationEnquiryData.md)
|
128
|
+
- [Quandoo::CustomerDataList](docs/CustomerDataList.md)
|
129
|
+
- [Quandoo::CustomerDto](docs/CustomerDto.md)
|
130
|
+
- [Quandoo::CustomerResponse](docs/CustomerResponse.md)
|
131
|
+
- [Quandoo::CustomerReviewData](docs/CustomerReviewData.md)
|
132
|
+
- [Quandoo::CustomerStatisticsData](docs/CustomerStatisticsData.md)
|
133
|
+
- [Quandoo::DealData](docs/DealData.md)
|
134
|
+
- [Quandoo::DocumentDto](docs/DocumentDto.md)
|
135
|
+
- [Quandoo::ErrorResponse](docs/ErrorResponse.md)
|
136
|
+
- [Quandoo::GetReservationEnquiryData](docs/GetReservationEnquiryData.md)
|
137
|
+
- [Quandoo::GetReviewDto](docs/GetReviewDto.md)
|
138
|
+
- [Quandoo::GetReviewsDto](docs/GetReviewsDto.md)
|
139
|
+
- [Quandoo::ImageDto](docs/ImageDto.md)
|
140
|
+
- [Quandoo::LinkRelationDto](docs/LinkRelationDto.md)
|
141
|
+
- [Quandoo::LocationDto](docs/LocationDto.md)
|
142
|
+
- [Quandoo::MarketingSettingDto](docs/MarketingSettingDto.md)
|
143
|
+
- [Quandoo::MerchantAddressDto](docs/MerchantAddressDto.md)
|
144
|
+
- [Quandoo::MerchantAvailabilityDaysDto](docs/MerchantAvailabilityDaysDto.md)
|
145
|
+
- [Quandoo::MerchantAvailabilityDto](docs/MerchantAvailabilityDto.md)
|
146
|
+
- [Quandoo::MerchantAvailabilityDtoList](docs/MerchantAvailabilityDtoList.md)
|
147
|
+
- [Quandoo::MerchantCustomer](docs/MerchantCustomer.md)
|
148
|
+
- [Quandoo::MerchantCustomerData](docs/MerchantCustomerData.md)
|
149
|
+
- [Quandoo::MerchantDetailsDto](docs/MerchantDetailsDto.md)
|
150
|
+
- [Quandoo::MerchantDetailsDtoList](docs/MerchantDetailsDtoList.md)
|
151
|
+
- [Quandoo::MerchantMenuCategoryDto](docs/MerchantMenuCategoryDto.md)
|
152
|
+
- [Quandoo::MerchantMenuDto](docs/MerchantMenuDto.md)
|
153
|
+
- [Quandoo::MerchantMenuItemDto](docs/MerchantMenuItemDto.md)
|
154
|
+
- [Quandoo::MerchantMenusDto](docs/MerchantMenusDto.md)
|
155
|
+
- [Quandoo::MerchantReservation](docs/MerchantReservation.md)
|
156
|
+
- [Quandoo::MerchantReservationData](docs/MerchantReservationData.md)
|
157
|
+
- [Quandoo::MerchantReservationEnquiry](docs/MerchantReservationEnquiry.md)
|
158
|
+
- [Quandoo::MerchantReservationEnquiryData](docs/MerchantReservationEnquiryData.md)
|
159
|
+
- [Quandoo::MerchantReservationSettingsDto](docs/MerchantReservationSettingsDto.md)
|
160
|
+
- [Quandoo::MerchantSubscription](docs/MerchantSubscription.md)
|
161
|
+
- [Quandoo::MerchantVaultSettingsDto](docs/MerchantVaultSettingsDto.md)
|
162
|
+
- [Quandoo::MerchantWithRecommendationsDto](docs/MerchantWithRecommendationsDto.md)
|
163
|
+
- [Quandoo::OpeningTimesDto](docs/OpeningTimesDto.md)
|
164
|
+
- [Quandoo::ReservationData](docs/ReservationData.md)
|
165
|
+
- [Quandoo::ReservationDataList](docs/ReservationDataList.md)
|
166
|
+
- [Quandoo::ReservationDetails](docs/ReservationDetails.md)
|
167
|
+
- [Quandoo::ReservationEnquiryMessageData](docs/ReservationEnquiryMessageData.md)
|
168
|
+
- [Quandoo::ReservationEnquiryMessageList](docs/ReservationEnquiryMessageList.md)
|
169
|
+
- [Quandoo::ReservationMenuData](docs/ReservationMenuData.md)
|
170
|
+
- [Quandoo::ReservationMenuItemData](docs/ReservationMenuItemData.md)
|
171
|
+
- [Quandoo::RestCookie](docs/RestCookie.md)
|
172
|
+
- [Quandoo::ReviewDto](docs/ReviewDto.md)
|
173
|
+
- [Quandoo::ReviewDtoList](docs/ReviewDtoList.md)
|
174
|
+
- [Quandoo::StandardOpeningTimesDto](docs/StandardOpeningTimesDto.md)
|
175
|
+
- [Quandoo::TagGroupDto](docs/TagGroupDto.md)
|
176
|
+
- [Quandoo::Tracking](docs/Tracking.md)
|
177
|
+
- [Quandoo::TranslatedTagDto](docs/TranslatedTagDto.md)
|
178
|
+
- [Quandoo::UpdateReservationData](docs/UpdateReservationData.md)
|
179
|
+
- [Quandoo::UpdateReservationEnquiryData](docs/UpdateReservationEnquiryData.md)
|
180
|
+
- [Quandoo::UpdateReviewDto](docs/UpdateReviewDto.md)
|
181
|
+
|
182
|
+
|
183
|
+
## Documentation for Authorization
|
184
|
+
|
185
|
+
|
186
|
+
### API_TOKEN
|
187
|
+
|
188
|
+
- **Type**: API key
|
189
|
+
- **API key parameter name**: X-Quandoo-AuthToken
|
190
|
+
- **Location**: HTTP header
|
191
|
+
|
192
|
+
### CUSTOMER_SESSION
|
193
|
+
|
194
|
+
- **Type**: API key
|
195
|
+
- **API key parameter name**: X-Quandoo-User-Session
|
196
|
+
- **Location**: HTTP header
|
197
|
+
|
data/Rakefile
ADDED
data/config.json
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
{
|
2
|
+
"apiPackage" : "quandoo",
|
3
|
+
"gemName": "quandoo",
|
4
|
+
"moduleName": "Quandoo",
|
5
|
+
"gemSummary": "A Ruby wrapper for the Quandoo API",
|
6
|
+
"gemDescription": "This gem maps all of the publicly available methods in the Quandoo API to a Ruby library",
|
7
|
+
"gemAuthor": "Joshua Kelly"
|
8
|
+
}
|
data/docs/AreaDto.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# Quandoo::AreaDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **Integer** | Id of the area | [optional]
|
7
|
+
**name** | **String** | Name of the area | [optional]
|
8
|
+
**priority** | **Integer** | Priority set for this area | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,132 @@
|
|
1
|
+
# Quandoo::AvailabilitiesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.quandoo.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**availability_days1**](AvailabilitiesApi.md#availability_days1) | **GET** /v1/merchants/{merchantId}/availabilities | Get merchant availability days
|
8
|
+
[**availability_options1**](AvailabilitiesApi.md#availability_options1) | **GET** /v1/merchants/{merchantId}/availabilities/{date}/times | Get merchant availability time slots
|
9
|
+
|
10
|
+
|
11
|
+
# **availability_days1**
|
12
|
+
> MerchantAvailabilityDaysDto availability_days1(merchant_id, agent_id, opts)
|
13
|
+
|
14
|
+
Get merchant availability days
|
15
|
+
|
16
|
+
This endpoint returns days which a customer can select for his reservation. The response is based on when the merchant is known to be open. It is not guaranteed that they have available times for reservation. The days are returned starting from the first available day up to the merchant-defined limit, but never more than 365 days. ####Request parameters: * **merchantId**: Id of the merchant. Path parameter. * **agentId**: Id of the agent making the request * **capacity**: Specifies the number of people in reservation. Availability days will be returned based on this capacity. ####Response: The response returns availability days that could be selected for reservation. * **days**: List of availability days that could be reserved. Format: yyyy-MM-dd * **links**: Related links that can be followed based on this response. ####Example curl: ``` curl https://{host}/v{X}/merchants/15/availabilities?agentId=3&capacity=4 ``` ####Example response: ``` { \"days\": [ \"2017-01-01\", \"2017-01-02\", \"2017-01-03\", ... ], \"links\": [ { \"href\": \"https://{host}/v{X}/merchants/15\", \"method\": \"GET\", \"rel\": \"parent\" }, { \"href\": \"https://{host}/v{X}/merchants/15/reservation-settings\", \"method\": \"GET\", \"rel\": \"settings\" }, { \"href\": \"https://{host}/v{X}/merchants/15/availabilities/2017-01-01/times\", \"method\": \"GET\", \"rel\": \"availabilities\" } ] } ```
|
17
|
+
|
18
|
+
### Example
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'quandoo'
|
22
|
+
|
23
|
+
api_instance = Quandoo::AvailabilitiesApi.new
|
24
|
+
|
25
|
+
merchant_id = 56 # Integer | Id of the merchant
|
26
|
+
|
27
|
+
agent_id = 56 # Integer | Id of the agent
|
28
|
+
|
29
|
+
opts = {
|
30
|
+
capacity: 56 # Integer | Number of people
|
31
|
+
}
|
32
|
+
|
33
|
+
begin
|
34
|
+
#Get merchant availability days
|
35
|
+
result = api_instance.availability_days1(merchant_id, agent_id, opts)
|
36
|
+
p result
|
37
|
+
rescue Quandoo::ApiError => e
|
38
|
+
puts "Exception when calling AvailabilitiesApi->availability_days1: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
### Parameters
|
43
|
+
|
44
|
+
Name | Type | Description | Notes
|
45
|
+
------------- | ------------- | ------------- | -------------
|
46
|
+
**merchant_id** | **Integer**| Id of the merchant |
|
47
|
+
**agent_id** | **Integer**| Id of the agent |
|
48
|
+
**capacity** | **Integer**| Number of people | [optional]
|
49
|
+
|
50
|
+
### Return type
|
51
|
+
|
52
|
+
[**MerchantAvailabilityDaysDto**](MerchantAvailabilityDaysDto.md)
|
53
|
+
|
54
|
+
### Authorization
|
55
|
+
|
56
|
+
No authorization required
|
57
|
+
|
58
|
+
### HTTP request headers
|
59
|
+
|
60
|
+
- **Content-Type**: Not defined
|
61
|
+
- **Accept**: Not defined
|
62
|
+
|
63
|
+
|
64
|
+
|
65
|
+
# **availability_options1**
|
66
|
+
> MerchantAvailabilityDtoList availability_options1(merchant_id, agent_id, capacity, date, opts)
|
67
|
+
|
68
|
+
Get merchant availability time slots
|
69
|
+
|
70
|
+
This endpoint returns availability time slots which can be reserved for a given capacity. ####Request parameters: * **merchantId**: Id of the merchant. Path parameter. * **date**: Specifies date of the desired reservation. Format: `yyyy-MM-dd`. Path parameter. * **fromTime**: Beginning of the desired reservation time frame. Format: `HH:mm`. Optional. * **toTime**: End of the desired reservation time frame. Format: `HH:mm`. Optional. * **agentId**: Id of the agent making the request * **capacity**: Specifies the number of people in reservation. Availabilities will be returned based on this capacity. If not provided, the default value is 2. * **areaId**: Restricts availabilities to a certain area. Optional. * **dealId/dealType**: Filter availabilities for a certain deal. Optional. If used, both must be provided. * **dealType** specifies type of the deal. Can be `OFFER`, `DISCOUNT` or `SPECIAL`. * **dealId** specifies the ID of the deal. ####Response: The response returns availability time slots that could be reserved, along with the areas it is associated with and contains information on how much should be paid if the reservation is cancelled by a client. * **timeSlots**: List of available time slots. * **areaIds**: List of areas for which this time slot can be reserved. * **dateTime**: Date and time of the available slot. Format: `yyyy-MM-dd'T'HH:mm:ssZ` * **occupancy**: Occupancy of the available time slot. This is an integer between `0` and `100`. * **vaultSettingId**: ID of the vault setting, if there is any. See: `vaultSettings` * **vaultSettings**: Credit card vault settings representing the fees to be paid in case of cancellation. * **id**: ID of the setting as shown in `timeSlots`. * **fee**: Fee to be paid in case of cancellation. Currency is defined by merchant. See reservation-settings. * **feeType**: Type of fee to be paid. Can be `PER_PERSON` or `PER_RESERVATION`. * **feePercentageForTime**: Fee percentage depending of the time of cancellation. Format: `\"{hoursStart}-{hoursEnd}\": {percentage}` , where hours are the number of hours before the visit. * **links**: Related links that can be followed based on this response. ####Example curl: ``` curl https://{host}/v{X}/merchants/15/availabilities/2017-11-09/times?capacity=2&areaId=24&agentId=3&dealId=ce0706ff-a95d-4229-a220-d21dcd175342&dealType=OFFER&fromTime=10:45&toTime=12:45 ``` ####Example response: ``` { \"timeSlots\": [ { \"areaIds\": [33532, 33533], \"dateTime\": \"2017-09-27T10:45:00+01:00\", \"occupancy\": 0, \"vaultSettingId\": \"284d701f-f79a-4efa-9859-fd09851dfdce\" }, ... ], \"vaultSettings\": [ { \"id\": \"284d701f-f79a-4efa-9859-fd09851dfdce\", \"fee\": \"10.00\", \"feeType\": \"PER_PERSON\", \"feePercentageForTime\": { \"0-12\":100, \"12-24\":50, \"24-48\":20 } } ], \"links\": [ { \"href\": \"https://{host}/v{X}/merchants/15\", \"method\": \"GET\", \"rel\": \"parent\" }, { \"href\": \"https://{host}/v{X}/merchants/15/reservation-settings\", \"method\": \"GET\", \"rel\": \"reservation-settings\" }, { \"href\": \"https://{host}/v{X}/merchants/reservations\", \"method\": \"PUT\", \"rel\": \"create-reservation\" } ] } ```
|
71
|
+
|
72
|
+
### Example
|
73
|
+
```ruby
|
74
|
+
# load the gem
|
75
|
+
require 'quandoo'
|
76
|
+
|
77
|
+
api_instance = Quandoo::AvailabilitiesApi.new
|
78
|
+
|
79
|
+
merchant_id = 56 # Integer | Id of the merchant
|
80
|
+
|
81
|
+
agent_id = 56 # Integer | Id of the agent
|
82
|
+
|
83
|
+
capacity = 2 # Integer | Number of people
|
84
|
+
|
85
|
+
date = Date.parse('\"2018-01-25\"') # Date | Date of the desired reservation. Format: yyyy-MM-dd
|
86
|
+
|
87
|
+
opts = {
|
88
|
+
from_time: '\"10:45\"', # String | Beginning of the desired reservation time frame. Format: HH:mm
|
89
|
+
to_time: '\"12:45\"', # String | End of the desired reservation time frame. Format: HH:mm
|
90
|
+
area_id: 56, # Integer | Id of the area
|
91
|
+
deal_id: 'deal_id_example', # String | Id of the deal
|
92
|
+
deal_type: 'deal_type_example' # String | type of the deal - SPECIAL, DISCOUNT or OFFER
|
93
|
+
}
|
94
|
+
|
95
|
+
begin
|
96
|
+
#Get merchant availability time slots
|
97
|
+
result = api_instance.availability_options1(merchant_id, agent_id, capacity, date, opts)
|
98
|
+
p result
|
99
|
+
rescue Quandoo::ApiError => e
|
100
|
+
puts "Exception when calling AvailabilitiesApi->availability_options1: #{e}"
|
101
|
+
end
|
102
|
+
```
|
103
|
+
|
104
|
+
### Parameters
|
105
|
+
|
106
|
+
Name | Type | Description | Notes
|
107
|
+
------------- | ------------- | ------------- | -------------
|
108
|
+
**merchant_id** | **Integer**| Id of the merchant |
|
109
|
+
**agent_id** | **Integer**| Id of the agent |
|
110
|
+
**capacity** | **Integer**| Number of people | [default to 2]
|
111
|
+
**date** | **Date**| Date of the desired reservation. Format: yyyy-MM-dd |
|
112
|
+
**from_time** | **String**| Beginning of the desired reservation time frame. Format: HH:mm | [optional]
|
113
|
+
**to_time** | **String**| End of the desired reservation time frame. Format: HH:mm | [optional]
|
114
|
+
**area_id** | **Integer**| Id of the area | [optional]
|
115
|
+
**deal_id** | [**String**](.md)| Id of the deal | [optional]
|
116
|
+
**deal_type** | **String**| type of the deal - SPECIAL, DISCOUNT or OFFER | [optional]
|
117
|
+
|
118
|
+
### Return type
|
119
|
+
|
120
|
+
[**MerchantAvailabilityDtoList**](MerchantAvailabilityDtoList.md)
|
121
|
+
|
122
|
+
### Authorization
|
123
|
+
|
124
|
+
No authorization required
|
125
|
+
|
126
|
+
### HTTP request headers
|
127
|
+
|
128
|
+
- **Content-Type**: Not defined
|
129
|
+
- **Accept**: Not defined
|
130
|
+
|
131
|
+
|
132
|
+
|
data/docs/ChainDto.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# Quandoo::ChangedReviewDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**review_id** | **String** | Id of to the review. |
|
7
|
+
**status** | **String** | The status of the change. | [optional]
|
8
|
+
**links** | [**Array<LinkRelationDto>**](LinkRelationDto.md) | The links related to this entity. |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Quandoo::CreateReviewDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**reservation_id** | **String** | The reservation public reviewId for which this review is created. |
|
7
|
+
**rating** | **Integer** | Possible values: 1 to 6. |
|
8
|
+
**description** | **String** | The description of the review. | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Quandoo::CreatedReservation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The id of this reservation for the calling agent. (Agent dependent field) |
|
7
|
+
**number** | **Integer** | The id of this reservation on quandoo system. |
|
8
|
+
**status** | **String** | The status of the reservation. | [optional]
|
9
|
+
**quandoo_id** | **String** | The public id of this reservation on quandoo system. |
|
10
|
+
|
11
|
+
|