module Checkpoints
Public Instance Methods
Create multiple checkpoints in a single request
@param roadmap_section_id [Integer] id for roadmap section the checkpoints belong to. @return [Array] Array of the created checkpoints. @example Create multiple checkpoints
Spartacus#batch_create_checkpoints( 163, [ { ids: [], name: 'Sample checkpoint 1', summary: 'Message from Tamriel', body: 'Listen to the Nine', position: 1 }, ... ] )
# File lib/client/checkpoints.rb, line 67 def batch_create_checkpoints(section_id=nil, checkpoints=[]) url = "#{@api_base_path}/checkpoints/batch_create" handle_timeouts do response = self.class.post( url, headers: auth_header, body: { section_id: section_id, checkpoints: checkpoints } ) convert_response(response, "checkpoint") end end
Get a checkpoint
@param id [Integer] A roadmap section id. @return [Checkpoint] The checkpoint. @example Get a checkpoint
Spartacus#get_checkpoint(1)
# File lib/client/checkpoints.rb, line 11 def get_checkpoint(id) url = "#{@api_base_path}/checkpoints/#{id}" handle_timeouts do response = self.class.get(url, headers: auth_header) convert_response(response, "checkpoint") end end
Update a checkpoint
@param id [Integer] A checkpoint id. @param options [Hash] A customizable set of options. @option options [String] :name Checkpoint name. @option options [String] :summary Checkpoint summary. @option options [String] :body Checkpoint body. @option options [String] :assignment Checkpoint assignment. @option options [String] :assignment Checkpoint body and assignment. @option options [Integer] :points Checkpoint point. @option options [String] :body_and_assignment Checkpoint body and Assignment @return [Checkpoint] The updated checkpoint @example Update a checkpoint
Spartacus#update_checkpoint(129, {name: 'Real Cool Checkpoint'})
# File lib/client/checkpoints.rb, line 34 def update_checkpoint(id, options={}) whitelist = ['name', 'summary', 'body', 'assignment','body_and_assignment', 'points'] options = convert_keys(options) checkpoint_params = whitelist_params(options, whitelist) url = "#{@api_base_path}/checkpoints/#{id}" handle_timeouts do response = self.class.put(url, headers: auth_header, body: { checkpoint: checkpoint_params }) convert_response(response, "checkpoint") end end