Module: BookingSync::API::Client::Applications

Included in:
BookingSync::API::Client
Defined in:
lib/bookingsync/api/client/applications.rb

Instance Method Summary collapse

Instance Method Details

#application(application) ⇒ BookingSync::API::Resource

Get a single application

Parameters:

Returns:

See Also:



25
26
27
 
# File 'lib/bookingsync/api/client/applications.rb', line 25

def application(application)
  get("applications/#{application}").pop
end

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

List applications

Returns all applications supported in BookingSync.

Examples:

Get the list of applications for the current account

applications = @api.applications
applications.first.title # => "Internet"

Parameters:

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

    A customizable set of options.

Options Hash (options):

  • fields: (Array) —

    List of fields to be fetched.

Returns:

See Also:



15
16
17
 
# File 'lib/bookingsync/api/client/applications.rb', line 15

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

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

Edit an application

to be updated

Examples:

application = @api.applications.first
@api.edit_application(application, { default_price_increase: 3 })

Parameters:

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

    application or ID of the application

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

    application attributes to be updated

Returns:



38
39
40
 
# File 'lib/bookingsync/api/client/applications.rb', line 38

def edit_application(application, options = {})
  put("applications/#{application}", applications: [options]).pop
end