Module: Karatekit::Client::Instructors

Included in:

Karatekit::Client

Defined in:

lib/karatekit/client/instructors.rb

Overview

Methods for the Instructors API

See Also:

• https://...

Instance Method Summary

• #instructor(id, options = {}) ⇒ Sawyer::Resource

  Get a single instructor.

• #instructors(options = {}) ⇒ Array<Sawyer::Resource>

  List instructors.

Instance Method Details

#instructor(id, options = {}) ⇒ Sawyer::Resource

Get a single instructor

Parameters:

• id (Integer) —

  ID of the instructor

Returns:

• (Sawyer::Resource) —

  A single instructor

See Also:

• https://...

# File 'lib/karatekit/client/instructors.rb', line 22

def instructor(id, options = {})
  get "instructors/#{id}", options
end

#instructors(options = {}) ⇒ Array<Sawyer::Resource>

List instructors

Returns:

• (Array<Sawyer::Resource>) —

  An array of hashes representing instructors

See Also:

• https://...

# File 'lib/karatekit/client/instructors.rb', line 13

def instructors(options = {})
  paginate "instructors", options
end