Thinkific.Api.Chapters (Thinkific API SDK v0.1.3)
API calls for all endpoints tagged Chapters.
Link to this section Summary
Functions
getChapterByID Returns a chapter
getContentsByID Retrieves the Contents within the Chapter identified by the provided id
Link to this section Functions
Link to this function
get_chapter_by_id(connection, id, opts \\ [])
Specs
get_chapter_by_id(Tesla.Env.client(), float(), keyword()) :: {:ok, Thinkific.Model.ChapterResponse.t()} | {:error, Tesla.Env.t()}
getChapterByID Returns a chapter
Parameters
- connection (Thinkific.Connection): Connection to server
- id (float()): ID of the Chapter in the form of an integer.
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Link to this function
get_contents_by_id(connection, id, opts \\ [])
Specs
get_contents_by_id(Tesla.Env.client(), float(), keyword()) :: {:ok, Thinkific.Model.GetContentsResponse.t()} | {:error, Tesla.Env.t()}
getContentsByID Retrieves the Contents within the Chapter 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