homeaway-api 1.0.0

data/lib/homeaway/api/domain/conversation.rb

@@ -0,0 +1,39 @@
+# Copyright (c) 2015 HomeAway.com, Inc.
+# All rights reserved.  http://www.homeaway.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module HomeAway
+  module API
+    module Domain
+      module Conversation
+
+        # Load Conversation content, including Messages, for a selected Conversation
+        #
+        # analogous to calling a GET on API url /public/conversation
+        #
+        # @note user must be logged in via 3 legged oauth to call this function without error
+        #
+        # Headers:
+        # * X-HomeAway-DisplayLocale: If a locale is not specified in a query param, it will be searched for in the X-HomeAway-DisplayLocale Header. If it is not supplied in either area the default locale of the user will be selected if it exists. Otherwise the Accept-Language Header will be used.
+        #
+        # @param id [String] The Conversation UUID to load.
+        # @return [HomeAway::API::Response] the result of the call to the API
+        def conversation(id)
+          params = {'id' => HomeAway::API::Util::Validators.uuid(id)}
+          get '/public/conversation', HomeAway::API::Util::Validators.query_keys(params)
+        end
+      end
+    end
+  end
+end

data/lib/homeaway/api/domain/listing.rb

@@ -0,0 +1,39 @@
+# Copyright (c) 2015 HomeAway.com, Inc.
+# All rights reserved.  http://www.homeaway.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module HomeAway
+  module API
+    module Domain
+      module Listing
+
+        # Given a listing id, return details about the listing.
+        #
+        # analogous to calling a GET on API url /public/listing
+        #
+        # Headers:
+        # * X-HomeAway-DisplayLocale: If a locale is not specified in a query param, it will be searched for in the X-HomeAway-DisplayLocale Header. If it is not supplied in either area the default locale of the user will be selected if it exists. Otherwise the Accept-Language Header will be used.
+        #
+        # @param id [String] The id of the listing.
+        # @option opts [String] :q Use the q parameter to fetch specific listing details.Valid options are AVAILABILITY, DETAILS, LOCATIONS, PHOTOS, RATES, REVIEWS If no value is given, the listing is returned with minimal content., can be an array of multiple values
+        # @return [HomeAway::API::Response] the result of the call to the API
+        def listing(id, q=nil)
+          params = {'id' => id.to_s}
+          params['q'] = HomeAway::API::Util::Validators.array(q) unless q == nil
+          get '/public/listing', HomeAway::API::Util::Validators.query_keys(params)
+        end
+      end
+    end
+  end
+end

data/lib/homeaway/api/domain/listing_reviews.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2015 HomeAway.com, Inc.
+# All rights reserved.  http://www.homeaway.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module HomeAway
+  module API
+    module Domain
+      module ListingReviews
+
+        # Returns a page of reviews for the specified listing and unit
+        #
+        # analogous to calling a GET on API url /public/listingReviews
+        #
+        # @param listing_id [String] The listing id to be booked as retrieved from the search operation
+        # @param unit_id [Integer] The id of the unit being booked for the stay
+        # @option opts [Integer] :page The page number to fetch
+        # @option opts [Integer] :page_size The number of reviews to return per page
+        # @return [HomeAway::API::Paginator] the result of the call to the API
+        def listing_reviews(listing_id, unit_id, opts={})
+          params = {
+              'listingId' => listing_id.to_s,
+              'unitId' => unit_id.to_s,
+              'page' => 1,
+              'pageSize' => @configuration.page_size
+          }.merge(HomeAway::API::Util::Validators.query_keys(opts))
+          hashie = get '/public/listingReviews', params
+          HomeAway::API::Paginator.new(self, hashie, @configuration.auto_pagination)
+        end
+      end
+    end
+  end
+end

data/lib/homeaway/api/domain/me.rb

@@ -0,0 +1,35 @@
+# Copyright (c) 2015 HomeAway.com, Inc.
+# All rights reserved.  http://www.homeaway.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module HomeAway
+  module API
+    module Domain
+      module Me
+
+        # Returns information about the logged in user.
+        #
+        # analogous to calling a GET on API url /public/me
+        #
+        # @note user must be logged in via 3 legged oauth to call this function without error
+        #
+        #
+        # @return [HomeAway::API::Response] the result of the call to the API
+        def me
+          get '/public/me', {}
+        end
+      end
+    end
+  end
+end

data/lib/homeaway/api/domain/my_inbox.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2015 HomeAway.com, Inc.
+# All rights reserved.  http://www.homeaway.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module HomeAway
+  module API
+    module Domain
+      module MyInbox
+
+        # Load the Owner's Inbox for the logged-in User
+        #
+        # analogous to calling a GET on API url /public/myInbox
+        #
+        # @note user must be logged in via 3 legged oauth to call this function without error
+        #
+        # Headers:
+        # * X-HomeAway-DisplayLocale: If a locale is not specified in a query param, it will be searched for in the X-HomeAway-DisplayLocale Header. If it is not supplied in either area the default locale of the user will be selected if it exists. Otherwise the Accept-Language Header will be used.
+        #
+        # @option opts [String] :status The conversation status by which to filter the inbox. The supported values for this param are: BLOCKED_RESERVATION, BOOKING, CANCELLED, INQUIRY, PAYMENT_REQUEST_SENT, POST_STAY, QUOTE_SENT, REPLIED, RESERVATION, RESERVATION_DOWNLOADABLE, RESERVATION_REQUEST, RESERVATION_REQUEST_DECLINED, RESERVATION_REQUEST_EXPIRED, STAYING, TENTATIVE_RESERVATION, UNKNOWN, RECALCULATE
+        # @option opts [Boolean] :unreplied_only A flag indicating that the inbox should be populated by only unreplied conversations
+        # @option opts [String] :sort The field by which to Sort Conversations.
+        # @option opts [DateTime or Date parsible string] :before_date Conversations will not be included in the results unless they had some activity on or before this date. Use yyyy-MM-dd as the format
+        # @option opts [Boolean] :archived A flag indicating that the inbox should be populated by only archived conversations
+        # @option opts [String] :search A string to search for.
+        # @option opts [Boolean] :inquiries A flag indicating the inbox should be populated by only inquiries
+        # @option opts [Boolean] :sort_reservation_requests_inline If True, in the default Inbox view, sort Reservation Requests inline rather than at the top.
+        # @option opts [Boolean] :reservations A flag indicating the inbox should be populated by only reservations
+        # @option opts [String] :sort_order The order to sort by, ASC or DESC.
+        # @option opts [Boolean] :unread_only A flag indicating that the inbox should be populated by only unread conversations
+        # @option opts [DateTime or Date parsible string] :after_date Conversations will not be included in the results unless they had some activity on or after this date. Use yyyy-MM-dd as the format
+        # @option opts [Integer] :page The page of the result set
+        # @option opts [Integer] :page_size The size of a page of results
+        # @option opts [Boolean] :as_traveler set this to true if you are attempting to get a traveler's inbox, defaults to false which will retrieve an owner's inbox
+        # @return [HomeAway::API::Paginator] the result of the call to the API
+        def my_inbox(opts={})
+          params = {
+              'page' => 1,
+              'pageSize' => @configuration.page_size,
+              'asTraveler' => false
+          }.merge(HomeAway::API::Util::Validators.query_keys(opts))
+          hashie = get '/public/myInbox', params
+          HomeAway::API::Paginator.new(self, hashie, @configuration.auto_pagination)
+        end
+      end
+    end
+  end
+end

data/lib/homeaway/api/domain/my_listings.rb

@@ -0,0 +1,48 @@
+# Copyright (c) 2015 HomeAway.com, Inc.
+# All rights reserved.  http://www.homeaway.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module HomeAway
+  module API
+    module Domain
+      module MyListings
+
+        # Returns a paginated summary of the owner's listings.
+        #
+        # analogous to calling a GET on API url /public/myListings
+        #
+        # @note user must be logged in via 3 legged oauth to call this function without error
+        #
+        # Headers:
+        # * X-HomeAway-DisplayLocale: If a locale is not specified in a query param, it will be searched for in the X-HomeAway-DisplayLocale Header. If it is not supplied in either area the default locale of the user will be selected if it exists. Otherwise the Accept-Language Header will be used.
+        #
+        # @option opts [String] :filter_product_type Filter result by the subscription type of the listing: sub|ppb
+        # @option opts [String] :filter_status Filter result by the enabled status of the listing: ENABLED|DISABLED
+        # @option opts [String] :address_contains Filter results by a word contained in the address
+        # @option opts [String] :sort_by Sort (format [field:ASC|DESC,field:ASC|DESC,...]) result by one or more of the following: status|updated|firstLive|subscriptionEnd|subscriptionStart|tierCode|productType
+        # @option opts [Integer] :page The page of the listing set.
+        # @option opts [Integer] :page_size The size of the page to return
+        # @return [HomeAway::API::Paginator] the result of the call to the API
+        def my_listings(opts={})
+          params = {
+              'page' => 1,
+              'pageSize' => @configuration.page_size
+          }.merge(HomeAway::API::Util::Validators.query_keys(opts))
+          hashie = get '/public/myListings', params
+          HomeAway::API::Paginator.new(self, hashie, @configuration.auto_pagination)
+        end
+      end
+    end
+  end
+end

data/lib/homeaway/api/domain/my_reservations.rb

@@ -0,0 +1,53 @@
+# Copyright (c) 2015 HomeAway.com, Inc.
+# All rights reserved.  http://www.homeaway.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module HomeAway
+  module API
+    module Domain
+      module MyReservations
+
+        # Returns a paginated list of the current and future reservations for the given listing from oldest to newest.
+        #
+        # analogous to calling a GET on API url /public/myReservations
+        #
+        # @note user must be logged in via 3 legged oauth to call this function without error
+        #
+        #
+        # @param listing_id [String] The listingId of the listing to get the reservations for.
+        # @option opts [String] :degin_date Lower bound date of the reservations to find in the format yyyy-MM-dd
+        # @option opts [String] :reference_number Reference number to filter on
+        # @option opts [String] :end_date Upper bound date of the reservations to find in the format yyyy-MM-dd
+        # @option opts [String] :last_name Last name of traveler to filter on
+        # @option opts [String] :payment_status PaymentStatus to filter on
+        # @option opts [String] :availability_status Status to filter on
+        # @option opts [String] :first_name First name of traveler to filter on
+        # @option opts [String] :email Email of traveler to filter on
+        # @option opts [String] :sort_by Sort (format [field:ASC|DESC,field:ASC|DESC,...]) result by one or more of the following: availabilityStatus|beginDate|paymentStatus
+        # @option opts [Integer] :page The page of the listing set.
+        # @option opts [Integer] :page_size The size of the page to return
+        # @return [HomeAway::API::Paginator] the result of the call to the API
+        def my_reservations(listing_id, opts={})
+          params = {
+              'page' => 1,
+              'pageSize' => @configuration.page_size,
+              'listingId' => listing_id.to_s
+          }.merge(HomeAway::API::Util::Validators.query_keys(opts))
+          hashie = get '/public/myReservations', params
+          HomeAway::API::Paginator.new(self, hashie, @configuration.auto_pagination)
+        end
+      end
+    end
+  end
+end

data/lib/homeaway/api/domain/quote.rb

@@ -0,0 +1,53 @@
+# Copyright (c) 2015 HomeAway.com, Inc.
+# All rights reserved.  http://www.homeaway.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module HomeAway
+  module API
+    module Domain
+      module Quote
+
+        # Generates an up to date quote and booking url
+        #
+        # analogous to calling a GET on API url /public/bookStay
+        #
+        # Headers:
+        # * X-HomeAway-DisplayLocale: If a locale is not specified in a query param, it will be searched for in the X-HomeAway-DisplayLocale Header. If it is not supplied in either area the default locale of the user will be selected if it exists. Otherwise the Accept-Language Header will be used.
+        #
+        # @param listing_id [String] The listing id to be booked as retrieved from the search operation
+        # @param unit_id [String] The id of the unit being booked for the stay
+        # @param adults_count [Integer] The number of adults being booked for the stay
+        # @param departure_date [String] The departure date in the form yyyy-MM-dd
+        # @param arrival_date [String] The arrival date in the form yyyy-MM-dd
+        # @option opts [String] :currency_code The currency to generate the quote in (optional defaults to USD)
+        # @option opts [Boolean] :pet_included Optional boolean indicating that a pet will accompany the guests
+        # @option opts [Integer] :children_count The optional number of children being booked for the stay
+        # @return [HomeAway::API::Response] the result of the call to the API
+        def quote(listing_id, unit_id, adults_count, arrival_date, departure_date, opts={})
+          params = {
+              'listingId' => listing_id.to_s,
+              'unitId' => unit_id.to_s,
+              'departureDate' => HomeAway::API::Util::Validators.date(departure_date),
+              'adultsCount' => HomeAway::API::Util::Validators.integer(adults_count),
+              'arrivalDate' => HomeAway::API::Util::Validators.date(arrival_date),
+              'locale' => 'en'
+          }.merge(HomeAway::API::Util::Validators.query_keys(opts))
+          get '/public/quote', params
+        end
+
+        alias_method :book_stay, :quote
+      end
+    end
+  end
+end

data/lib/homeaway/api/domain/search.rb

@@ -0,0 +1,74 @@
+# Copyright (c) 2015 HomeAway.com, Inc.
+# All rights reserved.  http://www.homeaway.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module HomeAway
+  module API
+    module Domain
+      module Search
+
+        # Search for listings
+        #
+        # analogous to calling a GET on API url /public/search
+        #
+        # Headers:
+        # * Authenticated: _required_: By specifying a Client object in the method signature, all incoming requests MUST have a valid current OAuth authenticated client
+        # * X-HomeAway-DisplayLocale: _required_: If a locale is not specified in a query param, it will be searched for in the X-HomeAway-DisplayLocale Header. If it is not supplied in either area the default locale of the user will be selected if it exists. Otherwise the Accept-Language Header will be used.
+        #
+        # @option opts [String] :q The query to search for listings with, for example 'austin sleeps 6'
+        # @option opts [Integer] :min_bedrooms Minimum number of bedrooms to search (optional)
+        # @option opts [Integer] :min_sleeps Minimum number of sleeps to search (optional)
+        # @option opts [String] :availability_start Date formatted as yyyy-MM-dd to indicate the earliest available date  (lower bound) in the search (optional)
+        # @option opts [Integer] :max_sleeps Maximum number of sleeps to search (optional)
+        # @option opts [String] :availability_end Date formatted as yyyy-MM-dd to indicate the latest available date  (upper bound) in the search (optional)
+        # @option opts [Integer] :min_bathrooms Minimum number of bathrooms to search (optional)
+        # @option opts [Float] :center_point_latitude Uses a proximity search to limit results to listings located within a max distance from a specific location, must be sent with centerPointLongitude and distanceInKm
+        # @option opts [String] :refine Refine the search with the given comma delimited refinements (optional comes from a search refinement)
+        # @option opts [String] :sort Sort the results <field:asc|desc> where field is one of (availabilityUpdated, bathrooms, bedrooms, prices, travelerReviewCount, averageRating) (optional)
+        # @option opts [Float] :upper_right_longitude Adds a geographical bounding box constraint to the search. Only listings located within this bounding box will be returned in the results, must be sent with lowerLeftLongitude, upperRightLatitude and upperRightLongitude
+        # @option opts [Float] :distance_in_km Uses a proximity search to limit results to listings located within a max distance from a specific location, must be sent with centerPointLatitude and centerPointLongitude
+        # @option opts [Float] :upper_right_latitude Adds a geographical bounding box constraint to the search. Only listings located within this bounding box will be returned in the results, must be sent with lowerLeftLongitude, upperRightLatitude and upperRightLongitude
+        # @option opts [Integer] :max_bedrooms Maximum number of bedrooms to search (optional)
+        # @option opts [Integer] :max_bathrooms Maximum number of bathrooms to search (optional)
+        # @option opts [Float] :center_point_longitude Uses a proximity search to limit results to listings located within a max distance from a specific location, must be sent with centerPointLatitude and distanceInKm
+        # @option opts [Float] :min_price Minimum price to search (optional)
+        # @option opts [Float] :lower_left_latitude Adds a geographical bounding box constraint to the search. Only listings located within this bounding box will be returned in the results, must be sent with lowerLeftLongitude, upperRightLatitude and upperRightLongitude
+        # @option opts [Float] :lower_left_longitude Adds a geographical bounding box constraint to the search. Only listings located within this bounding box will be returned in the results, must be sent with lowerLeftLongitude, upperRightLatitude and upperRightLongitude
+        # @option opts [Float] :max_price Maximum price to search (optional)
+        # @option opts [String] :image_size Size of the image to return the URL for (optional) must be one of: SMALL, MEDIUM, LARGE
+        # @option opts [Integer] :page The page of the result set
+        # @option opts [Integer] :page_size The size of a page of results
+        # @return [HomeAway::API::Paginator] the result of the call to the API
+        def search(opts={})
+          encoded_opts = opts.merge(opts) do |_, v|
+            if v.is_a? ::String
+              HomeAway::API::Util::Validators.uri_encoded(v)
+            else
+              v
+            end
+          end
+          params = {
+              'locale' => 'en',
+              'page' => 1,
+              'pageSize' => @configuration.page_size
+          }.merge(HomeAway::API::Util::Validators.query_keys(encoded_opts))
+          params['availabilityStart'] = HomeAway::API::Util::Validators.date(params['availabilityStart']) if params.has_key?('availabilityStart')
+          params['availabilityEnd'] = HomeAway::API::Util::Validators.date(params['availabilityEnd']) if params.has_key?('availabilityEnd')
+          hashie = get '/public/search', params
+          HomeAway::API::Paginator.new(self, hashie, @configuration.auto_pagination)
+        end
+      end
+    end
+  end
+end