Thinkific.Api.Bundles (Thinkific API SDK v0.1.3)
API calls for all endpoints tagged Bundles.
Link to this section Summary
Functions
createEnrollmentInBundle This endpoint enrolls a User in a Bundle and each of the Courses contained within the Bundle
getBundleByID Retrieves the Bundle identified by the provided id
getBundleEnrollments Retrieves all the enrollments in the bundle identified by the provided id
List Courses by bundle ID Retrieves the Courses within the Bundle identified by the provided id
updateEnrollmentsInBundle This endpoint updates a User’s Enrollment in a Bundle and each of the Courses contained within the Bundle.
Link to this section Functions
create_enrollment_in_bundle(connection, id, opts \\ [])
Specs
create_enrollment_in_bundle(Tesla.Env.client(), float(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
createEnrollmentInBundle This endpoint enrolls a User in a Bundle and each of the Courses contained within the Bundle
Parameters
- connection (Thinkific.Connection): Connection to server
- id (float()): ID of the bundle in a form of integer
- opts (KeywordList): [optional] Optional parameters
- :body (BundlesEnrollmentsRequest):
Returns
} on success {:error, info} on failure
get_bundle_by_id(connection, id, opts \\ [])
Specs
get_bundle_by_id(Tesla.Env.client(), float(), keyword()) :: {:ok, Thinkific.Model.BundleResponse.t()} | {:error, Tesla.Env.t()}
getBundleByID Retrieves the Bundle identified by the provided id
Parameters
- connection (Thinkific.Connection): Connection to server
- id (float()): ID of the Bundle in the form of an integer
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_bundle_enrollments(connection, id, opts \\ [])
Specs
get_bundle_enrollments(Tesla.Env.client(), float(), keyword()) :: {:ok, Thinkific.Model.GetEnrollmentsResponse.t()} | {:error, Tesla.Env.t()}
getBundleEnrollments Retrieves all the enrollments in the bundle identified by the provided id
Parameters
- connection (Thinkific.Connection): Connection to server
- id (float()): ID of the Bundle 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
list_coursesbybundle_id(connection, id, opts \\ [])
Specs
list_coursesbybundle_id(Tesla.Env.client(), float(), keyword()) :: {:ok, Thinkific.Model.GetCoursesResponse.t()} | {:error, Tesla.Env.t()}
List Courses by bundle ID Retrieves the Courses within the Bundle identified by the provided id
Parameters
- connection (Thinkific.Connection): Connection to server
- id (float()): ID of the Bundle 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
update_enrollments_in_bundle(connection, id, opts \\ [])
Specs
update_enrollments_in_bundle(Tesla.Env.client(), float(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
updateEnrollmentsInBundle This endpoint updates a User’s Enrollment in a Bundle and each of the Courses contained within the Bundle.
Parameters
- connection (Thinkific.Connection): Connection to server
- id (float()): ID of the bundle in a form of integer
- opts (KeywordList): [optional] Optional parameters
- :body (BundlesEnrollmentsRequest):
Returns
} on success {:error, info} on failure