bookingsync-api 0.0.6 → 0.0.7

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

@@ -16,7 +16,7 @@ module BookingSync::API
       # @option options [Array] status: Array of booking states.
       #   If specyfied bookings with given states are shown.
       #   Possible statuses: `:booked`, `:unavailable` and `:tentative`
-      # @return [Array<Sawyer::Resource>] Array of bookings.
+      # @return [Array<BookingSync::API::Resource>] Array of bookings.
       # @example
       #   @api.bookings(months: 12, states: [:booked, :unavailable], include_canceled: true)
       #
@@ -30,32 +30,30 @@ module BookingSync::API
         paginate :bookings, options, &block
       end
 
-
       # Create a booking
       #
       # @param options [Hash] Booking attributes
-      # @return <Sawyer::Resource> Newly create booking
+      # @return [BookingSync::API::Resource] Newly create booking
       def create_booking(options = {})
         post(:bookings, bookings: [options]).pop
       end
 
       # Edit a booking
       #
-      # @param booking [Sawyer::Resource|Integer] Booking or ID of the booking
+      # @param booking [BookingSync::API::Resource|Integer] Booking or ID of the booking
       #   to be updated
       # @param options [Hash] Booking attributes to be updated
-      # FIXME: should be changed resource
-      # @return [Array] An empty Array on success, exception is raised otherwise
+      # @return [BookingSync::API::Resource] Updated booking on success, exception is raised otherwise
       # @example
       #   booking = @api.bookings.first
-      #   @api.edit_booking(booking, {adults: 1}) => []
+      #   @api.edit_booking(booking, { adults: 1 })
       def edit_booking(booking, options = {})
-        put "bookings/#{booking}", bookings: [options]
+        put("bookings/#{booking}", bookings: [options]).pop
       end
 
       # Cancel a booking
       #
-      # @param booking [Sawyer::Resource|Integer] Booking or ID of the booking
+      # @param booking [BookingSync::API::Resource|Integer] Booking or ID of the booking
       #   to be canceled
       # @return [Array] An empty Array on success, exception is raised otherwise
       def cancel_booking(booking, options = {})

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

@@ -0,0 +1,22 @@
+module BookingSync::API
+  class Client
+    module BookingsPayments
+      # List bookings payments
+      #
+      # Returns bookings payments for the account user is authenticated with.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [Array<BookingSync::API::Resource>] Array of bookings payments.
+      #
+      # @example Get the list of bookings payments for the current account
+      #   bookings_payments = @api.bookings_payments
+      #   bookings_payments.first.amount # => 200
+      # @example Get the list of bookings payments only with amount and currency for smaller response
+      #   @api.bookings_payments(fields: [:amount, :currency])
+      # @see http://docs.api.bookingsync.com/reference/endpoints/bookings_payments/#list-bookings-payments
+      def bookings_payments(options = {}, &block)
+        paginate :bookings_payments, options, &block
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module BookingSync::API
+  class Client
+    module Clients
+      # List clients
+      #
+      # Returns clients for the account user is authenticated with.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [Array<BookingSync::API::Resource>] Array of clients.
+      #
+      # @example Get the list of clients for the current account
+      #   clients = @api.clients
+      #   clients.first.fullname # => "John Smith"
+      # @example Get the list of clients only with fullname and phone for smaller response
+      #   @api.clients(fields: [:fullname, :phone])
+      # @see http://docs.api.bookingsync.com/reference/endpoints/clients/#list-clients
+      def clients(options = {}, &block)
+        paginate :clients, options, &block
+      end
+
+      # Create a new client
+      #
+      # @param options [Hash] Client attributes
+      # @return [BookingSync::API::Resource] Newly created client
+      def create_client(options = {})
+        post(:clients, clients: [options]).pop
+      end
+
+      # Edit a client
+      #
+      # @param client [BookingSync::API::Resource|Integer] Client or ID of the client
+      #   to be updated
+      # @param options [Hash] Client attributes to be updated
+      # @return [BookingSync::API::Resource] Updated client on success, exception is raised otherwise
+      # @example
+      #   client = @api.clients.first
+      #   @api.edit_client(client, { fullname: "Gary Smith" })
+      def edit_client(client, options = {})
+        put("clients/#{client}", clients: [options]).pop
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module BookingSync::API
+  class Client
+    module Destinations
+      # List destinations
+      #
+      # Returns destinations for the account user is authenticated with.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [Array<BookingSync::API::Resource>] Array of destinations.
+      #
+      # @example Get the list of destinations for the current account
+      #   destinations = @api.destinations
+      #   destinations.first.fullname # => {"en":"Europe, World"}
+      # @example Get the list of destinations only with name and fullname for smaller response
+      #   @api.destinations(fields: [:name, :fullname])
+      # @see http://docs.api.bookingsync.com/reference/endpoints/destinations/#list-destinations
+      def destinations(options = {}, &block)
+        paginate :destinations, options, &block
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module BookingSync::API
       #
       # Return list of inquiries for current account.
       # @param options [Hash] A customizable set of query options.
-      # @return [Array<Sawyer::Resource>] Array of inquiries.
+      # @return [Array<BookingSync::API::Resource>] Array of inquiries.
       # @see http://docs.api.bookingsync.com/reference/endpoints/inquiries/#list-inquiries
       def inquiries(options = {}, &block)
         paginate :inquiries, options, &block
@@ -14,7 +14,7 @@ module BookingSync::API
       # Create a new inquiry
       #
       # @param options [Hash] Inquiry attributes
-      # @return <Sawyer::Resource> Newly create inquiry
+      # @return [BookingSync::API::Resource] Newly create inquiry
       def create_inquiry(options = {})
         post(:inquiries, inquiries: [options]).pop
       end

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

@@ -0,0 +1,53 @@
+module BookingSync::API
+  class Client
+    module Payments
+      # List payments
+      #
+      # Returns payments for the account user is authenticated with.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [Array<BookingSync::API::Resource>] Array of payments.
+      #
+      # @example Get the list of payments for the current account
+      #   payments = @api.payments
+      #   payments.first.kind # => "cash"
+      # @example Get the list of payments only with kind and currency for smaller response
+      #   @api.payments(fields: [:kind, :currency])
+      # @see http://docs.api.bookingsync.com/reference/endpoints/payments/#list-payments
+      def payments(options = {}, &block)
+        paginate :payments, options, &block
+      end
+
+      # Create a new payment
+      #
+      # @param booking_id [Integer] ID of the booking
+      # @param options [Hash] payment attributes
+      # @return [BookingSync::API::Resource] Newly created payment
+      def create_payment(booking_id, options = {})
+        post(:payments, booking_id: booking_id, payments: [options]).pop
+      end
+
+      # Edit a payment
+      #
+      # @param payment [BookingSync::API::Resource|Integer] payment or ID of the payment
+      # to be updated
+      # @param options [Hash] payment attributes to be updated
+      # @return [BookingSync::API::Resource] Updated payment on success, exception is raised otherwise
+      # @example
+      #   payment = @api.payments.first
+      #   @api.edit_payment(payment, { currency: "EURO" })
+      def edit_payment(payment, options = {})
+        put("payments/#{payment}", payments: [options]).pop
+      end
+
+      # Cancel a payment
+      #
+      # @param payment [BookingSync::API::Resource|Integer] payment or ID of the payment
+      # to be canceled
+      # @return [Array] An empty Array on success, exception is raised otherwise
+      def cancel_payment(payment, options = {})
+        delete "payments/#{payment}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module BookingSync::API
+  class Client
+    module Periods
+      # List periods
+      #
+      # Returns periods for the account user is authenticated with.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [Array<BookingSync::API::Resource>] Array of periods.
+      #
+      # @example Get the list of periods for the current account
+      #   periods = @api.periods
+      #   periods.first.start_at # => "2014-04-11"
+      # @example Get the list of periods only with start_at and end_at for smaller response
+      #   @api.periods(fields: [:start_at, :end_at])
+      # @see http://docs.api.bookingsync.com/reference/endpoints/periods/#list-periods
+      def periods(options = {}, &block)
+        paginate :periods, options, &block
+      end
+
+      # Create a new period
+      #
+      # @param season_id [Integer] ID of the season
+      # @param options [Hash] period attributes
+      # @return [BookingSync::API::Resource] Newly created period
+      def create_period(season_id, options = {})
+        post(:periods, season_id: season_id, periods: [options]).pop
+      end
+
+      # Edit a period
+      #
+      # @param period [BookingSync::API::Resource|Integer] period or ID of the period
+      # to be updated
+      # @param options [Hash] period attributes to be updated
+      # @return [BookingSync::API::Resource] Updated period on success,
+      # exception is raised otherwise
+      # @example
+      #   period = @api.periods.first
+      #   @api.edit_period(period, { end_at: "2014-04-28" })
+      def edit_period(period, options = {})
+        put("periods/#{period}", periods: [options]).pop
+      end
+
+      # Delete a period
+      #
+      # @param period [BookingSync::API::Resource|Integer] period or ID of the period
+      # to be deleted
+      # @return [Array] An empty Array on success, exception is raised otherwise
+      def delete_period(period, options = {})
+        delete "periods/#{period}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module BookingSync::API
+  class Client
+    module Photos
+      # List photos
+      #
+      # Returns photos for the account user is authenticated with.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [Array<BookingSync::API::Resource>] Array of photos.
+      #
+      # @example Get the list of photos for the current account
+      #   photos = @api.photos
+      #   photos.first.position # => 1
+      # @example Get the list of photos only with medium_url and position for smaller response
+      #   @api.photos(fields: [:medium_url, :position])
+      # @see http://docs.api.bookingsync.com/reference/endpoints/photos/#list-photos
+      def photos(options = {}, &block)
+        paginate :photos, options, &block
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module BookingSync::API
+  class Client
+    module Rates
+      # List rates
+      #
+      # Returns rates for the rentals of the account user is authenticated with.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [Array<BookingSync::API::Resource>] Array of rates.
+      #
+      # @example Get the list of rates for the current account
+      #   rates = @api.rates
+      #   rates.first.final_nightly_rate # => 700
+      # @example Get the list of rates only with final rates
+      #   for smaller response
+      #   @api.rates(fields: %w(final_nightly_rate final_weekely_rate final_monthly_rate))
+      # @see http://docs.api.bookingsync.com/reference/endpoints/rates/#list-rates
+      def rates(options = {}, &block)
+        paginate :rates, options, &block
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module BookingSync::API
+  class Client
+    module  RatesRules
+      # List rates rules
+      #
+      # Returns rates rules for the account user is authenticated with.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [Array<BookingSync::API::Resource>] Array of rates rules.
+      #
+      # @example Get the list of rates rules for the current account
+      #   rates_rules = @api.rates_rules
+      #   rates_rules.first.always_applied # => true
+      # @example Get the list of rates rules only with always_applied and kind for smaller response
+      #   @api.rates_rules(fields: [:always_applied, :kind])
+      # @see http://docs.api.bookingsync.com/reference/endpoints/rates_rules/#list-rates-rules
+      def rates_rules(options = {}, &block)
+        paginate :rates_rules, options, &block
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module BookingSync::API
+  class Client
+    module  RatesTables
+      # List rates table
+      #
+      # Returns rates tables for the account user is authenticated with.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [Array<BookingSync::API::Resource>] Array of rates tables.
+      #
+      # @example Get the list of rates tables for the current account
+      #   rates_tables = @api.rates_tables
+      #   rates_tables.first.name # => "Rates table 2"
+      # @example Get the list of rates tables only with name and account_id for smaller response
+      #   @api.rates_tables(fields: [:name, :account_id])
+      # @see http://docs.api.bookingsync.com/reference/endpoints/rates_tables/#list-rates-tables
+      def rates_tables(options = {}, &block)
+        paginate :rates_tables, options, &block
+      end
+
+      # Create a new rates_table
+      #
+      # @param options [Hash] rates_table attributes
+      # @return [BookingSync::API::Resource] Newly created rates table
+      def create_rates_table(options = {})
+        post(:rates_tables, rates_tables: [options]).pop
+      end
+
+      # Edit a rates_table
+      #
+      # @param rates_table [BookingSync::API::Resource|Integer] rates table or
+      # ID of the rates table to be updated
+      # @param options [Hash] rates table attributes to be updated
+      # @return [BookingSync::API::Resource] Updated rates table on success,
+      # exception is raised otherwise
+      # @example
+      #   rates_table = @api.rates_tables.first
+      #   @api.edit_rates_table(rates_table, { name: "Lorem" })
+      def edit_rates_table(rates_table, options = {})
+        put("rates_tables/#{rates_table}", rates_tables: [options]).pop
+      end
+
+      # delete a rates_table
+      #
+      # @param rates_table [BookingSync::API::Resource|Integer] rates table or
+      # ID of the rates table to be deleteed
+      # @return [Array] An empty Array on success, exception is raised otherwise
+      def delete_rates_table(rates_table, options = {})
+        delete "rates_tables/#{rates_table}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module BookingSync::API
+  class Client
+    module RentalAgreements
+      # List rental agreements
+      #
+      # Returns rental agreements for the rentals of the account user is authenticated with.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [Array<BookingSync::API::Resource>] Array of rental agreements.
+      #
+      # @example Get the list of rental agreements for the current account
+      #   agreement = @api.rental_agreements
+      #   agreement.first.body # => "My rental agreement"
+      # @example Get the list of rental agreements only with body for smaller response
+      #   @api.rentals(fields: :body)
+      # @see http://docs.api.bookingsync.com/reference/endpoints/rental_agreements/#list-rental_agreements
+      def rental_agreements(options = {}, &block)
+        paginate :rental_agreements, options, &block
+      end
+
+      # Create a new rental agreement for a booking
+      #
+      # @param booking_id [Integer] ID of the booking
+      # @param options [Hash] rental agreement attributes
+      # @return [BookingSync::API::Response] Newly created rental agreement
+      def create_rental_agreement_for_booking(booking_id, options = {})
+        post(:rental_agreements, booking_id: booking_id,
+             rental_agreements: [options]).pop
+      end
+
+      # Create a new rental agreement for a rental
+      #
+      # @param rental_id [Integer] ID of the rental
+      # @param options [Hash] rental agreement attributes
+      # @return [BookingSync::API::Response] Newly created rental agreement
+      def create_rental_agreement_for_rental(rental_id, options = {})
+        post(:rental_agreements, rental_id: rental_id,
+             rental_agreements: [options]).pop
+      end
+
+      # Create a new rental agreement for an account
+      #
+      # @param options [Hash] rental agreement attributes
+      # @return [BookingSync::API::Response] Newly created rental agreement
+      def create_rental_agreement(options = {})
+        post(:rental_agreements, rental_agreements: [options]).pop
+      end
+    end
+  end
+end