class Citrix::Training::Namespace::Trainings
Attributes
Set the credentials.
Public Instance Methods
Retrieve information on all scheduled trainings for a given organizer.
The trainings are returned in the order in which they were created. Completed trainings are not included; ongoing trainings with past sessions are included along with the past sessions. If the organizer does not have any scheduled trainings, the response will be empty.
Endpoint: developer.citrixonline.com/api/gototraining-rest-api/apimethod/get-trainings
# File lib/citrix/training/namespace/trainings.rb, line 59 def all url = url_for("organizers", credentials.organizer_key, "trainings") response = http_client.get(url) if response.ok? trainings = response.data.map do |attrs| Resource::Training.new Resource::Training.deserialize(attrs) end end [response, trainings] end
Create a new training.
response, training = client.trainings.create({ name: "Ruby on Rails", description: "Getting started with Ruby on Rails", timezone: "America/Sao_Paulo", dates: [date], web_registration: false, confirmation_email: false, organizers: [organizer] }) if response.ok? else end
Options:
-
`name`: Name of the training. Required.
-
`description`: Description of the training. Required.
-
`timezone`: Time zone of the training. Required.
-
`dates`: Array containing instances of `Citrix::Training::TrainingDate`. Required.
-
`organizers`: Array containing instances of `Citrix::Training::Organizer`. Optional.
-
`web_registration`: Disable/Enable web registration. Optional.
-
`confirmation_email`: Disable/Enable confirmation e-mails. Optional.
Endpoint: developer.citrixonline.com/api/gototraining-rest-api/apimethod/create-training-0
# File lib/citrix/training/namespace/trainings.rb, line 39 def create(attributes) training = Resource::Training.new(attributes) url = url_for("organizers", credentials.organizer_key, "trainings") response = http_client.post(url, training.serialize) training.key = json_parser.load(response.body) if response.ok? [response, training] end
Find a scheduled or completed training by its key.
# File lib/citrix/training/namespace/trainings.rb, line 73 def find(key) url = url_for("organizers", credentials.organizer_key, "trainings", key) response = http_client.get(url) if response.ok? training = Resource::Training.new Resource::Training.deserialize(response.data) end [response, training] end
Deletes a scheduled or completed training.
For scheduled trainings, it deletes all scheduled sessions of the training. For completed trainings, the sessions remain in the database. No email is sent to organizers or registrants, but when participants attempt to start or join the training, they are directed to a page that states: `Training Not Found: The training you are trying to join is no longer available.`
response = client.trainings.remove(training) response.ok? #=> successfully removed
# File lib/citrix/training/namespace/trainings.rb, line 96 def remove(training) url = url_for("organizers", credentials.organizer_key, "trainings", training.key) http_client.delete(url) end