BookingSync/bookingsync-api

View on GitHub
lib/bookingsync/api/client/bookings_taxes.rb

Summary

Maintainability
A
0 mins
Test Coverage
module BookingSync::API
  class Client
    module BookingsTaxes
      # List bookings taxes
      #
      # Returns bookings taxes 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 taxes.
      #
      # @example Get the list of bookings taxes for the current account
      #   bookings_taxes = @api.bookings_taxes
      #   bookings_taxes.first.percentage # => 20.0
      # @example Get the list of bookings taxes only with percentage for smaller response
      #   @api.bookings_taxes(fields: [:percentage])
      # @see http://developers.bookingsync.com/reference/endpoints/bookings_taxes/#list-bookings_taxes
      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