Module: BookingSync::API::Client::BookingsPayments

Included in:

BookingSync::API::Client

Defined in:

lib/bookingsync/api/client/bookings_payments.rb

Instance Method Summary

• #bookings_payments(options = {}, &block) ⇒ Array<BookingSync::API::Resource>

  List bookings payments.

Instance Method Details

#bookings_payments(options = {}, &block) ⇒ Array<BookingSync::API::Resource>

List bookings payments

Returns bookings payments for the account user is authenticated with.

Examples:

Get the list of bookings payments for the current account

bookings_payments = @api.bookings_payments
bookings_payments.first.amount # => 200

Get the list of bookings payments only with amount and currency for smaller response

@api.bookings_payments(fields: [:amount, :currency])

Parameters:

• options (Hash) (defaults to: {}) —

  A customizable set of options.

Options Hash (options):

• fields: (Array) —

  List of fields to be fetched.

Returns:

• (Array<BookingSync::API::Resource>) —

  Array of bookings payments.

See Also:

• http://docs.api.bookingsync.com/reference/endpoints/bookings_payments/#list-bookings-payments

# File 'lib/bookingsync/api/client/bookings_payments.rb', line 17

def bookings_payments(options = {}, &block)
  paginate :bookings_payments, options, &block
end