Thinkific.Api.Instructors (Thinkific API SDK v0.1.3)

API calls for all endpoints tagged Instructors.

Link to this section Summary

Functions

create_instructor(connection, body, opts \\ [])

createInstructor Creates a new Instructor

delete_instructor_by_id(connection, id, opts \\ [])

deleteInstructorByID Delete the Instructor identified by the provided id

get_instructor_by_id(connection, id, opts \\ [])

getInstructorByID Returns the Instructor identified by the provided id.

get_instructors(connection, opts \\ [])

getInstructors Retrieve a list of Instructors

update_instructor(connection, id, body, opts \\ [])

updateInstructor Updates the Instructor identified by the provided id

Link to this section Functions

create_instructor(connection, body, opts \\ [])

Specs

create_instructor(
  Tesla.Env.client(),
  Thinkific.Model.InstructorRequest.t(),
  keyword()
) :: {:ok, Thinkific.Model.InstructorResponse.t()} | {:error, Tesla.Env.t()}

createInstructor Creates a new Instructor

Parameters

connection (Thinkific.Connection): Connection to server
body (InstructorRequest): New instructor attributes
opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

delete_instructor_by_id(connection, id, opts \\ [])

Specs

delete_instructor_by_id(Tesla.Env.client(), float(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

deleteInstructorByID Delete the Instructor identified by the provided id

Parameters

connection (Thinkific.Connection): Connection to server
id (float()): ID of the Instructor in the form of an integer
opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

get_instructor_by_id(connection, id, opts \\ [])

Specs

get_instructor_by_id(Tesla.Env.client(), float(), keyword()) ::
  {:ok, Thinkific.Model.InstructorResponse.t()} | {:error, Tesla.Env.t()}

getInstructorByID Returns the Instructor identified by the provided id.

Parameters

connection (Thinkific.Connection): Connection to server
id (float()): ID of the Instructor in the form of an integer.
opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

get_instructors(connection, opts \\ [])

Specs

get_instructors(Tesla.Env.client(), keyword()) ::
  {:ok, Thinkific.Model.GetInstructorsResponse.t()} | {:error, Tesla.Env.t()}

getInstructors Retrieve a list of Instructors

Parameters

connection (Thinkific.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :page (float()): The page within the collection to fetch.
- :limit (float()): The number of items to be returned.

Returns

} on success {:error, info} on failure

update_instructor(connection, id, body, opts \\ [])

Specs

update_instructor(
  Tesla.Env.client(),
  float(),
  Thinkific.Model.InstructorRequest.t(),
  keyword()
) :: {:ok, Thinkific.Model.InstructorResponse.t()} | {:error, Tesla.Env.t()}

updateInstructor Updates the Instructor identified by the provided id

Parameters

connection (Thinkific.Connection): Connection to server
id (float()): ID of the Instructor in the form of an integer
body (InstructorRequest): New instructor attributes
opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure