Thinkific.Api.Courses (Thinkific API SDK v0.1.3)
API calls for all endpoints tagged Courses.
Link to this section Summary
Functions
getChapterOfCourseByID Returns the Chapter of the course identified by the provided id.
getCourseByID Returns the Course identified by the provided id.
getCourses Retrieve a list of Courses
Link to this section Functions
Link to this function
get_chapter_of_course_by_id(connection, id, opts \\ [])
Specs
get_chapter_of_course_by_id(Tesla.Env.client(), float(), keyword()) :: {:ok, Thinkific.Model.GetChaptersResponse.t()} | {:error, Tesla.Env.t()}
getChapterOfCourseByID Returns the Chapter of the course identified by the provided id.
Parameters
- connection (Thinkific.Connection): Connection to server
- id (float()): ID of the Chapter in the form of an integer.
- 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
Link to this function
get_course_by_id(connection, id, opts \\ [])
Specs
get_course_by_id(Tesla.Env.client(), float(), keyword()) :: {:ok, Thinkific.Model.CourseResponse.t()} | {:error, Tesla.Env.t()}
getCourseByID Returns the Course identified by the provided id.
Parameters
- connection (Thinkific.Connection): Connection to server
- id (float()): ID of the Course in the form of an integer.
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Link to this function
get_courses(connection, opts \\ [])
Specs
get_courses(Tesla.Env.client(), keyword()) :: {:ok, Thinkific.Model.GetCoursesResponse.t()} | {:error, Tesla.Env.t()}
getCourses Retrieve a list of Courses
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