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

API calls for all endpoints tagged CourseReviews.

Link to this section Summary

Functions

createCourseReview Create a course review

getCourseReviewByID Retrieve a Course Review identified by the provided id.

getCourseReviews Retrieve a list of Course Reviews

Link to this section Functions

Link to this function

create_course_review(connection, course_id, body, opts \\ [])

Specs

createCourseReview Create a course review

Parameters

  • connection (Thinkific.Connection): Connection to server
  • course_id (float()): ID of the Course for which the review needs to be created for.
  • body (CreateCourseReviewRequest): Course Review Attributes
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

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

Specs

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

getCourseReviewByID Retrieve a Course Review identified by the provided id.

Parameters

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

Returns

} on success {:error, info} on failure

Link to this function

get_course_reviews(connection, course_id, opts \\ [])

Specs

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

getCourseReviews Retrieve a list of Course Reviews

Parameters

  • connection (Thinkific.Connection): Connection to server
  • course_id (float()): ID of the Course 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.
    • :approved (boolean()): If true, returns only approved Course Reviews.

Returns

} on success {:error, info} on failure