Module: BookingSync::API::Client::Accounts

Included in:

BookingSync::API::Client

Defined in:

lib/bookingsync/api/client/accounts.rb

Instance Method Summary

• #account(account, options = {}) ⇒ BookingSync::API::Resource

  Get a single account.

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

  List accounts.

Instance Method Details

#account(account, options = {}) ⇒ BookingSync::API::Resource

Get a single account

Parameters:

• account (BookingSync::API::Resource|Integer) —

  Account or ID of the account.

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

  A customizable set of query options.

Options Hash (options):

• fields: (Array) —

  List of fields to be fetched.

Returns:

• (BookingSync::API::Resource)

# File 'lib/bookingsync/api/client/accounts.rb', line 26

def account(account, options = {})
  get("accounts/#{account}", options).pop
end

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

List accounts

Returns all the accounts that the user is authenticated with.

Examples:

Get the list of accounts for the current account

accounts = @api.accounts
accounts.first.email # => "user@example.com"

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 accounts.

See Also:

• http://developers.bookingsync.com/reference/endpoints/accounts/#list-accounts

# File 'lib/bookingsync/api/client/accounts.rb', line 15

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