bookingsync-api 0.0.29 → 0.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df0f78f0a79e9a32da557bccb9ad5777f77e2ea2
-  data.tar.gz: 6003bf2692a48dfe8cf60fe537161ed3991cb89d
+  metadata.gz: e684e01278017c058321923e665bf96ba3caa420
+  data.tar.gz: 6a2121dd54961a277ae61b9bf5d7f23ef8519e58
 SHA512:
-  metadata.gz: 0358693bc5ae14c4038876ddd2ab0c5c7226e7ab60bea6b2c968fb04976e501d4112a590eac504b2ff9182b94251738f331ded764941824d9ddb9bd495343285
-  data.tar.gz: 372ca716f9c91593ac6d27c15ef1f4492bca2961a0c2ad31e653d0f0e0954e412c43d606eb92a2d4141670a41550f65cfd22064197cccd1b8689701991d852a8
+  metadata.gz: cd3d7e0824cb828a2b384c7288e5f347d1208439703892aeffb3a60cc216570d17f6479fd1b702624ac1529ba51d57f48272a1f4581d5961aab4fd229b6d3a44
+  data.tar.gz: decd8c0854ee18f3f5cd9e9cb3c1989712cd0ec95d5d43f5f38ef0fa0225e9c7c353bbc83faaf27dec6e73671527fe0f75367f1eebcda96d39622e881aeb54b8

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 
-## master
+## 0.0.30
+
+- Add missing CRUD actions to existing endpoints.
+- Remove unused BillingAddresses endpoint.
 
 ## 0.0.29
 

data/README.md

@@ -9,23 +9,31 @@ This gem allows Ruby developers to programmatically access https://www.bookingsy
 
 Add this line to your application's Gemfile:
 
-    gem 'bookingsync-api'
+```ruby
+gem 'bookingsync-api'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install bookingsync-api
+```
+$ gem install bookingsync-api
+```
 
 ## Usage
 
 Gem assumes that you already have OAuth token for an account.
 
-    api = BookingSync::API.new("OAUTH_TOKEN")
-    rentals = api.rentals # => [BookingSync::API::Resource, BookingSync::API::Resource]
-    rentals.first.name # => "Small apartment"
+```ruby
+api = BookingSync::API.new("OAUTH_TOKEN")
+rentals = api.rentals # => [BookingSync::API::Resource, BookingSync::API::Resource]
+rentals.first.name # => "Small apartment"
+```
 
 ### Pagination
 
@@ -33,25 +41,33 @@ All endpoints returning a collection of resources can be paginated. There are th
 
 Specify `:per_page` and `:page` params. It's useful when implementing pagination on your site.
 
-    api.bookings(per_page: 10, page: 1) => [BookingSync::API::Resource, BookingSync::API::Resource, ...]
+```ruby
+api.bookings(per_page: 10, page: 1) => [BookingSync::API::Resource, BookingSync::API::Resource, ...]
+```
 
 Use pagination with a block.
 
-    api.bookings(per_page: 10) do |batch|
-      # display 10 bookings, will make one HTTP request for each batch
-    end
+```ruby
+api.bookings(per_page: 10) do |batch|
+  # display 10 bookings, will make one HTTP request for each batch
+end
+```
 
 Fetch all resources (with multiple requests under the hood) and return one big array.
 
-    api.bookings(auto_paginate: true) => [BookingSync::API::Resource, BookingSync::API::Resource, ...]
+```ruby
+api.bookings(auto_paginate: true) => [BookingSync::API::Resource, BookingSync::API::Resource, ...]
+```
 
 ### Meta information
 
 Some endpoints return additional info about resource in meta section. To fetch it you need to
 access last response.
 
-    api.rentals(updated_since: "2014-01-01 15:43:96 UTC") # => [BookingSync::API::Resource,    BookingSync::API::Resource, ...]
-    api.last_response.meta # => {"deleted_ids" => [1, 3, 4]}
+```ruby
+api.rentals(updated_since: "2014-01-01 15:43:96 UTC") # => [BookingSync::API::Resource,    BookingSync::API::Resource, ...]
+api.last_response.meta # => {"deleted_ids" => [1, 3, 4]}
+```
 
 ### Logging
 
@@ -64,7 +80,9 @@ There are two ways to enable logging:
 
 2. Pass your own logger to API client, it can be for example `Rails.logger`.
 
-        api = BookingSync::API.new("OAUTH_TOKEN", logger: Rails.logger)
+  ```ruby
+  api = BookingSync::API.new("OAUTH_TOKEN", logger: Rails.logger)
+  ```
 
 ### Instrumentation
 
@@ -75,7 +93,9 @@ information anywhere.
 To hook instrumentations into `ActiveSupport::Notifications`, pass the
 module into the API client initializer:
 
-    api = BookingSync::API.new("OAUTH_TOKEN", instrumenter: ActiveSupport::Notifications)
+```ruby
+api = BookingSync::API.new("OAUTH_TOKEN", instrumenter: ActiveSupport::Notifications)
+```
 
 #### Log levels
 
@@ -94,18 +114,24 @@ See [API documentation](http://docs.api.bookingsync.com).
 
 ## Running specs
 
-    bundle exec rspec
+```
+bundle exec rspec
+```
 
 OR
 
-    bundle exec guard
+```
+bundle exec guard
+```
 
 ### Recording VCR cassettes
 
 For developing bookingsync-api gem you need OAuth access token. In order to record a cassette,
 you need to run spec with below environment variables.
 
-    ACCESS_TOKEN=abc bundle exec rspec
+```
+ACCESS_TOKEN=abc bundle exec rspec
+```
 
 If you want to change a cassette, you need to delete it first.
 

data/lib/bookingsync/api/client.rb

@@ -2,7 +2,6 @@ require "bookingsync/api/middleware/logger"
 require "bookingsync/api/client/accounts"
 require "bookingsync/api/client/amenities"
 require "bookingsync/api/client/availabilities"
-require "bookingsync/api/client/billing_addresses"
 require "bookingsync/api/client/bathrooms"
 require "bookingsync/api/client/bedrooms"
 require "bookingsync/api/client/bookings"
@@ -43,7 +42,6 @@ module BookingSync::API
     include BookingSync::API::Client::Accounts
     include BookingSync::API::Client::Amenities
     include BookingSync::API::Client::Availabilities
-    include BookingSync::API::Client::BillingAddresses
     include BookingSync::API::Client::Bathrooms
     include BookingSync::API::Client::Bedrooms
     include BookingSync::API::Client::Bookings

data/lib/bookingsync/api/client/accounts.rb

@@ -15,6 +15,17 @@ module BookingSync::API
       def accounts(options = {}, &block)
         paginate :accounts, options, &block
       end
+
+      # Get a single account
+      #
+      # @param account [BookingSync::API::Resource|Integer] Account or ID
+      #   of the account.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def account(account, options = {})
+        get("accounts/#{account}", options).pop
+      end
     end
   end
 end

data/lib/bookingsync/api/client/bathrooms.rb

@@ -17,6 +17,17 @@ module BookingSync::API
         paginate :bathrooms, options, &block
       end
 
+      # Get a single bathroom
+      #
+      # @param bathroom [BookingSync::API::Resource|Integer] Bedroom or ID
+      #   of the bathroom.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def bathroom(bathroom, options = {})
+        get("bathrooms/#{bathroom}", options).pop
+      end
+
       # Create a new bathroom
       #
       # @param rental [BookingSync::API::Resource|Integer] Rental or ID of

data/lib/bookingsync/api/client/bedrooms.rb

@@ -17,6 +17,17 @@ module BookingSync::API
         paginate :bedrooms, options, &block
       end
 
+      # Get a single bedroom
+      #
+      # @param bedroom [BookingSync::API::Resource|Integer] Bedroom or ID
+      #   of the bedroom.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def bedroom(bedroom, options = {})
+        get("bedrooms/#{bedroom}", options).pop
+      end
+
       # Create a new bedroom
       #
       # @param rental [BookingSync::API::Resource|Integer] Rental or ID of

data/lib/bookingsync/api/client/bookings_fees.rb

@@ -17,6 +17,17 @@ module BookingSync::API
       def bookings_fees(options = {}, &block)
         paginate :bookings_fees, options, &block
       end
+
+      # Get a single bookings fee
+      #
+      # @param bookings_fee [BookingSync::API::Resource|Integer] BookingsFee or ID
+      #   of the bookings fee.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def bookings_fee(bookings_fee, options = {})
+        get("bookings_fees/#{bookings_fee}", options).pop
+      end
     end
   end
 end

data/lib/bookingsync/api/client/bookings_payments.rb

@@ -17,6 +17,17 @@ module BookingSync::API
       def bookings_payments(options = {}, &block)
         paginate :bookings_payments, options, &block
       end
+
+      # Get a single bookings payment
+      #
+      # @param bookings_payment [BookingSync::API::Resource|Integer] BookingsPayment or ID
+      #   of the bookings payment.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def bookings_payment(bookings_payment, options = {})
+        get("bookings_payments/#{bookings_payment}", options).pop
+      end
     end
   end
 end

data/lib/bookingsync/api/client/bookings_taxes.rb

@@ -17,6 +17,17 @@ module BookingSync::API
       def bookings_taxes(options = {}, &block)
         paginate :bookings_taxes, options, &block
       end
+
+      # Get a single bookings tax
+      #
+      # @param bookings_tax [BookingSync::API::Resource|Integer] BookingsTax or ID
+      #   of the bookings tax.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def bookings_tax(bookings_tax, options = {})
+        get("bookings_taxes/#{bookings_tax}", options).pop
+      end
     end
   end
 end

data/lib/bookingsync/api/client/clients.rb

@@ -18,6 +18,17 @@ module BookingSync::API
         paginate :clients, options, &block
       end
 
+      # Get a single client
+      #
+      # @param client [BookingSync::API::Resource|Integer] Client or ID
+      #   of the client.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def client(client, options = {})
+        get("clients/#{client}", options).pop
+      end
+
       # Create a new client
       #
       # @param options [Hash] Client attributes

data/lib/bookingsync/api/client/destinations.rb

@@ -17,6 +17,17 @@ module BookingSync::API
       def destinations(options = {}, &block)
         paginate :destinations, options, &block
       end
+
+      # Get a single destination
+      #
+      # @param destination [BookingSync::API::Resource|Integer] Destination or ID
+      #   of the destination.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def destination(destination, options = {})
+        get("destinations/#{destination}", options).pop
+      end
     end
   end
 end

data/lib/bookingsync/api/client/fees.rb

@@ -17,6 +17,17 @@ module BookingSync::API
       def fees(options = {}, &block)
         paginate :fees, options, &block
       end
+
+      # Get a single fee
+      #
+      # @param fee [BookingSync::API::Resource|Integer] Fee or ID
+      #   of the fee.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def fee(fee, options = {})
+        get("fees/#{fee}", options).pop
+      end
     end
   end
 end

data/lib/bookingsync/api/client/inquiries.rb

@@ -11,6 +11,17 @@ module BookingSync::API
         paginate :inquiries, options, &block
       end
 
+      # Get a single inquiry
+      #
+      # @param inquiry [BookingSync::API::Resource|Integer] Inquiry or ID
+      #   of the inquiry.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def inquiry(inquiry, options = {})
+        get("inquiries/#{inquiry}", options).pop
+      end
+
       # Create a new inquiry
       #
       # @param rental [BookingSync::API::Resource] Rental or ID of the rental

data/lib/bookingsync/api/client/payments.rb

@@ -18,6 +18,17 @@ module BookingSync::API
         paginate :payments, options, &block
       end
 
+      # Get a single payment
+      #
+      # @param payment [BookingSync::API::Resource|Integer] Payment or ID
+      #   of the payment.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def payment(payment, options = {})
+        get("payments/#{payment}", options).pop
+      end
+
       # Create a new payment
       #
       # @param booking_id [Integer] ID of the booking

data/lib/bookingsync/api/client/periods.rb

@@ -18,6 +18,17 @@ module BookingSync::API
         paginate :periods, options, &block
       end
 
+      # Get a single period
+      #
+      # @param period [BookingSync::API::Resource|Integer] Period or ID
+      #   of the period.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def period(period, options = {})
+        get("periods/#{period}", options).pop
+      end
+
       # Create a new period
       #
       # @param season [BookingSync::API::Resource|Integer] Season or ID of

data/lib/bookingsync/api/client/photos.rb

@@ -20,6 +20,17 @@ module BookingSync::API
         paginate :photos, options, &block
       end
 
+      # Get a single photo
+      #
+      # @param photo [BookingSync::API::Resource|Integer] Photo or ID
+      #   of the photo.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def photo(photo, options = {})
+        get("photos/#{photo}", options).pop
+      end
+
       # Create a photo
       #
       # @param rental [BookingSync::API::Resource|Integer] Rental object or ID

data/lib/bookingsync/api/client/rates.rb

@@ -18,6 +18,17 @@ module BookingSync::API
       def rates(options = {}, &block)
         paginate :rates, options, &block
       end
+
+      # Get a single rate
+      #
+      # @param rate [BookingSync::API::Resource|Integer] Rate or ID
+      #   of the rate.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def rate(rate, options = {})
+        get("rates/#{rate}", options).pop
+      end
     end
   end
 end

data/lib/bookingsync/api/client/rates_rules.rb

@@ -17,6 +17,50 @@ module BookingSync::API
       def rates_rules(options = {}, &block)
         paginate :rates_rules, options, &block
       end
+
+      # Get a single rates_rule
+      #
+      # @param rates_rule [BookingSync::API::Resource|Integer] RatesRule or ID
+      #   of the rates_rule.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def rates_rule(rates_rule, options = {})
+        get("rates_rules/#{rates_rule}", options).pop
+      end
+
+      # Create a new rates_rule
+      #
+      # @param rates_table [BookingSync::API::Resource|Integer] RatesTable or ID of
+      #   the rates_table for which rates_rule will be created.
+      # @param options [Hash] RatesRule's attributes.
+      # @return [BookingSync::API::Resource] Newly created rates_rule.
+      def create_rates_rule(rates_table, options = {})
+        post("rates_tables/#{rates_table}/rates_rules", rates_rules: [options]).pop
+      end
+
+      # Edit a rates_rule
+      #
+      # @param rates_rule [BookingSync::API::Resource|Integer] RatesRule or ID of
+      #   the rates_rule to be updated.
+      # @param options [Hash] RatesRule attributes to be updated.
+      # @return [BookingSync::API::Resource] Updated rates_rule on success,
+      #   exception is raised otherwise.
+      # @example
+      #   rates_rule = @api.rates_rules.first
+      #   @api.edit_rates_rule(rates_rule, { percentage: 10 })
+      def edit_rates_rule(rates_rule, options = {})
+        put("rates_rules/#{rates_rule}", rates_rules: [options]).pop
+      end
+
+      # Delete a rates_rule
+      #
+      # @param rates_rule [BookingSync::API::Resource|Integer] RatesRule or ID
+      #   of the rates_rule to be deleted.
+      # @return [NilClass] Returns nil on success.
+      def delete_rates_rule(rates_rule)
+        delete "rates_rules/#{rates_rule}"
+      end
     end
   end
 end