Module gototraining
ballerinax/gototraining Ballerina library
1.2.1
Overview
This is a generated connector for GoToTraining API v1.0 OpenAPI specification.
The GoToTraining API provides the capability to schedule training sessions and customize the trainings with panelists, polls, questions and surveys.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a LogMeIn account.
- Obtain tokens - Follow this guide.
Clients
gototraining: Client
Isolated
This is a generated connector for GoToTraining API v1.0 OpenAPI specification.
The GoToTraining API provides the capability to schedule training sessions and customize the trainings with panelists, polls, questions and surveys.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create a LogMeIn account and obtain tokens by following this guide.
init (ClientConfig clientConfig, string serviceUrl)- clientConfig ClientConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.getgo.com/G2T/rest" - URL of the target service
getAllOrganizers
DeprecatedIsolated FunctionRemote Function
Get Organizers
Parameters
- accountKey int - The key of the multi-user account
getAllTrainings
Isolated FunctionRemote Function
Get Trainings
Parameters
- organizerKey int - The key of the training organizer
scheduleTraining
Isolated FunctionRemote Function
function scheduleTraining(int organizerKey, TrainingReqCreate payload) returns string|errorCreate Training
Parameters
- organizerKey int - The key of the training organizer
- payload TrainingReqCreate - The details of the training to create
getTraining
Isolated FunctionRemote Function
Get Training
Parameters
- organizerKey int - The key of the training organizer
- trainingKey int - The key of the training
cancelTraining
Isolated FunctionRemote Function
Delete Training
Parameters
- organizerKey int - The key of the training organizer
- trainingKey int - The key of the training
getManageTrainingURL
Isolated FunctionRemote Function
Get Management URL for Training
Parameters
- organizerKey int - The key of the training organizer
- trainingKey int - The key of the training
updateTrainingNameDescription
Isolated FunctionRemote Function
function updateTrainingNameDescription(int organizerKey, int trainingKey, TrainingNameDescription payload) returns Response|errorUpdate Training Name and Description
Parameters
- organizerKey int - The key of the training organizer
- trainingKey int - The key of the training
- payload TrainingNameDescription - The new name and description for the training
getOrganizersForTraining
Isolated FunctionRemote Function
Get Training Organizers
Parameters
- organizerKey int - The key of the training organizer
- trainingKey int - The key of the training
updateOrganizersForTraining
Isolated FunctionRemote Function
function updateOrganizersForTraining(int organizerKey, int trainingKey, TrainingOrganizers payload) returns Response|errorUpdate Training Organizers
Parameters
- organizerKey int - The key of the training organizer
- trainingKey int - The key of the training
- payload TrainingOrganizers - Details required to update the list of organizers for a training
getRecordingsForTraining
Isolated FunctionRemote Function
function getRecordingsForTraining(int trainingKey) returns RecordingsListForTraining|errorGet Online Recordings for Training
Parameters
- trainingKey int - The key of the training
Return Type
getRecordingDownloadById
Isolated FunctionRemote Function
Get Download for Online Recordings
getRegistrants
Isolated FunctionRemote Function
function getRegistrants(int organizerKey, int trainingKey) returns Registrant[]|errorGet Training Registrants
Parameters
- organizerKey int - The key of the training organizer
- trainingKey int - The key of the training
Return Type
- Registrant[]|error - OK
registerForTraining
Isolated FunctionRemote Function
function registerForTraining(int organizerKey, int trainingKey, RegistrantReqCreate payload) returns RegistrantCreated|errorRegister for Training
Parameters
- organizerKey int - The key of the training organizer
- trainingKey int - The key of the training
- payload RegistrantReqCreate - The details of the registrant to create
Return Type
- RegistrantCreated|error - Created
getRegistrant
Isolated FunctionRemote Function
function getRegistrant(int organizerKey, int trainingKey, int registrantKey) returns Registrant|errorGet Registrant
Parameters
- organizerKey int - The key of the training organizer
- trainingKey int - The key of the training
- registrantKey int - The key of the registrant
Return Type
- Registrant|error - OK
cancelRegistration
Isolated FunctionRemote Function
function cancelRegistration(int organizerKey, int trainingKey, int registrantKey) returns Response|errorCancel Registration
Parameters
- organizerKey int - The key of the training organizer
- trainingKey int - The key of the training
- registrantKey int - The key of the registrant
updateRegistrationSettingsForTraining
Isolated FunctionRemote Function
function updateRegistrationSettingsForTraining(int organizerKey, int trainingKey, RegistrationSettings payload) returns Response|errorUpdate Training Registration Settings
Parameters
- organizerKey int - The key of the training organizer
- trainingKey int - The key of the training
- payload RegistrationSettings - The new registration settings for the training
getStartUrl
Isolated FunctionRemote Function
Get Start Url
Parameters
- organizerKey int - The key of the training organizer
- trainingKey int - The key of the training
startTraining
Isolated FunctionRemote Function
Start Training
Parameters
- trainingKey int - The key of the training
updateTrainingTimes
Isolated FunctionRemote Function
function updateTrainingTimes(int organizerKey, int trainingKey, TrainingTimes payload) returns NotifiedParties|errorUpdate Training Times
Parameters
- organizerKey int - The key of the training organizer
- trainingKey int - The key of the training
- payload TrainingTimes - The new start and end times for the scheduled training
Return Type
- NotifiedParties|error - OK
getSessionDetailsForDateRange
Isolated FunctionRemote Function
function getSessionDetailsForDateRange(int organizerKey, DateTimeRange payload) returns Session[]|errorGet Sessions by Date Range
Parameters
- organizerKey int - The key of the training organizer
- payload DateTimeRange - The start and end times for the time range over which to retrieve training sessions
getAttendanceDetails
Isolated FunctionRemote Function
Get Attendance Details
Parameters
- organizerKey int - The key of the training organizer
- sessionKey int - The key of the training session
getSessionDetailsForTraining
Isolated FunctionRemote Function
Get Sessions By Training
Records
gototraining: Attendance
Describes the times the attendee joined and left a part of a training session.
Fields
- joinTime string - The time the attendee joined a part of a training session
- leaveTime string - The time the attendee left a part of a training session
- timeInPartOfSession int - The time in minutes the attendee spent at a part of a training session
gototraining: Attendee
Describes the attendee of a training session.
Fields
- givenName string - The attendee's first name
- surname string - The attendee's surname
- email string - The attendee's email address
- timeInSession int - The total time in minutes spent at all the parts of the training session the attendee joined
- inSessionTimes Attendance[] - List of the parts of the training session the attendee joined
gototraining: ClientConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2PasswordGrantConfig|BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion string(default "1.1") - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects FollowRedirects?(default ()) - Configurations associated with Redirection
- poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig?(default ()) - Configurations associated with retrying
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket?(default ()) - SSL/TLS-related options
gototraining: DateTimeRange
A pair of DateTime values, the first of which serves as a start time and the second as an end time of an interval
Fields
- startDate string - The starting time of an interval
- endDate string - The ending time of an interval
gototraining: HostUrl
Host URL that can be used to start a training
Fields
- hostURL string - The host URL that can be used to start a training
gototraining: NotifiedParties
Number of parties notified of a change to a training session times
Fields
- notifiedRegistrants int - Number of registrants notified of changes to a training
- notifiedTrainers int - Number of trainers notified of changes to a training
gototraining: Organizer
Describes a training organizer.
Fields
- organizerKey string - The key of the training (co-)organizer
- email string - The email address of the training (co-)organizer
- givenName string - The (co-)organizer's first name
- surname string - The (co-)organizer's surname
gototraining: Recording
Describes an online recording of a training
Fields
- recordingId int - The unique id of the recording
- name string - The title of the recording
- description string? - The description of the recording
- registrationUrl string? - The url where attendees can register to view the recording
- downloadUrl string? - The url used to download the recording to the local device
- startDate string - The time the recording was started
- endDate string - The time the recording was ended
gototraining: RecordingsListForTraining
Contains a list of recordings for the training.
Fields
- recordingList Recording[] - The list of online recordings for the training
- trainingKey int - The training's unique key
gototraining: Registrant
Describes a training registrant.
Fields
- email string - The registrant's email address
- givenName string - The registrant's first name
- surname string - The registrant's surname
- status string - The registrant's status
- registrationDate string - The date and time the registration took place
- joinUrl string - The URL the registrant will use to join the training
- confirmationUrl string - The URL where the confirmation for the registration can be found
- registrantKey string - The registrant's key
gototraining: RegistrantCreated
Describes a newly created training registrant
Fields
- joinUrl string - The URL the registrant will use to join the training
- confirmationUrl string - The URL where confirmation for the registration can be found
- registrantKey string - The registrant's key
gototraining: RegistrantReqCreate
Details required to make a new training registration.
Fields
- email string - The registrant's email address
- givenName string - The registrant's first name
- surname string - The registrant's surname
gototraining: RegistrationSettings
Training settings, namely availability of web registration and confirmation emails to the training registrants
Fields
- disableConfirmationEmail boolean - Indicates whether confirmation emails to the training registrants are disabled
- disableWebRegistration boolean - Indicates whether the web registration for the training is disabled
gototraining: Session
Describes a completed training session.
Fields
- sessionKey string - The key of the training session
- trainingName string - The subject of the training
- sessionStartTime string - The time the training session started
- sessionEndTime string - The time the training session finished
- attendanceCount int - The number of attendees at the training session
- duration int - The duration of the training session in minutes
- organizers Organizer[] - The organizers of the training session.
gototraining: Training
Describes a scheduled training.
Fields
- trainingId string - The 9-digit training's ID
- name string - The training's subject
- description string? - The training's description
- timeZone string - The time zone where the training takes place
- times DateTimeRange[] - Array with startDate and endDate for the training sessions
- organizers Organizer[] - The list of (co-)organizers for the training
- registrationSettings RegistrationSettings - Training settings, namely availability of web registration and confirmation emails to the training registrants
- trainingKey string - The training's unique key
gototraining: TrainingNameDescription
Details required to update a training's name and description.
Fields
- name string - The training's name
- description string? - The training's description
gototraining: TrainingOrganizers
Details required to update the list of organizers for a training.
Fields
- organizers int[] - List of keys of the organizers for the training.
- notifyOrganizers boolean? - Specifies whether an email should be sent notifying of the change to the training's organizers.
gototraining: TrainingReqCreate
Describes the details used to create a new training.
Fields
- name string - Name of the training
- description string? - Description of the training
- timeZone string - Time zone of the training (must be a valid time zone ID, see Date and time conventions).
- times DateTimeRange[] - Array with startDate and endDate for the training sessions
- registrationSettings RegistrationSettings? - Training settings, namely availability of web registration and confirmation emails to the training registrants
- organizers int[]? - List of keys of the co-organizers for this training
gototraining: TrainingTimes
Details required to update the session times of a training.
Fields
- timeZone string - Time zone of the training (must be a valid time zone ID, see Date and time conventions).
- times DateTimeRange[] - Start and end times for the training sessions
- notifyRegistrants boolean? - Notify registrants via email of change to training. Default is true
- notifyTrainers boolean? - Notify trainers via email of change to training. Default is true