rustici_software_cloud_v2 4.0.0 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +8 -5
- data/lib/rustici_software_cloud_v2/api/about_api.rb +1 -1
- data/lib/rustici_software_cloud_v2/api/application_management_api.rb +15 -15
- data/lib/rustici_software_cloud_v2/api/authentication_api.rb +2 -2
- data/lib/rustici_software_cloud_v2/api/content_connectors_api.rb +4 -4
- data/lib/rustici_software_cloud_v2/api/course_api.rb +46 -37
- data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +47 -41
- data/lib/rustici_software_cloud_v2/api/invitations_api.rb +26 -20
- data/lib/rustici_software_cloud_v2/api/learner_api.rb +6 -6
- data/lib/rustici_software_cloud_v2/api/ping_api.rb +1 -1
- data/lib/rustici_software_cloud_v2/api/registration_api.rb +27 -27
- data/lib/rustici_software_cloud_v2/api/reporting_api.rb +3 -3
- data/lib/rustici_software_cloud_v2/api/xapi_api.rb +10 -10
- data/lib/rustici_software_cloud_v2/api_client.rb +2 -2
- data/lib/rustici_software_cloud_v2/models/about_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_info_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_token.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/comment_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/connector_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/connector_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_connector_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/credential_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/destination_info_id_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/destination_info_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/destination_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/destination_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_lti13_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +2 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +12 -2
- data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_connector_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/{zoomi_company_id.rb → invitation_email_update_schema.rb} +20 -9
- data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/learner_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/lti13_platform_configuration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/lti13_tool_configuration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/message_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/objective_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/paginated_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/ping_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/preview_launch_link_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +25 -5
- data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +2 -2
- data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +12 -13
- data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +1 -3
- data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/registration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/response_error.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/score_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_item.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/title_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/update_connector_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_account.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_context.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_result.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_score.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +1 -1
- data/lib/rustici_software_cloud_v2/version.rb +1 -1
- data/lib/rustici_software_cloud_v2.rb +1 -3
- data/rustici_software_cloud_v2.gemspec +9 -13
- data/spec/api_client_spec.rb +1 -1
- metadata +29 -120
- data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +0 -538
- data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +0 -204
|
@@ -35,7 +35,7 @@ module RusticiSoftwareCloudV2
|
|
|
35
35
|
# Creates a private invitation job which sends emails with a link to the course. Invitations are meant as a way to provide access to your content. Registrations will be created from the provided email addresses. The email job will asynchronously send emails to those addresses inviting them to the course. When the learners visit the link in the email, the course will be launched with the already created registration. The private invitation ID can be used with GetPrivateInvitationJobStatus to view the status of the email job. >**Info:** >While invitations are a way to provide access to your content, the majority of use cases would be better suited by creating a registration and building a launch link with the registration endpoints instead. Invitations build upon registrations by grouping a set of registrations together and adding access control measures to said group. Invitations could be used to pass yearly compliance training to an entire company. Invitations also have an associated expiration date which determines when the course will no longer be launchable. >**Note:** >The behavior of a private invitation request sent to a learner who has already been sent an invitation to the course can be specified with the `duplicateRegistrationOption` parameter. The available options are: >- `FAIL`: Do not send an invitation to any learners who have already received an invitation to the course. Use this option when a list of emails might contain learners who have and have not received an invitation and you only want to send the invitation to the learners who have not yet received an invitation. >- `INSTANCE_EXISTING`: Send an invitation to all learners in the list. For learners who have previously been sent an invitation, instance their existing registration. Use this option to force the learner to start the course from the beginning, regardless if they have taken the course in the past. Results from all instances of a registration can be fetched <a href=\\\"https://cloud.scorm.com/docs/v2/reference/swagger/#/registration/GetRegistrationInstances\\\">here</a> >- `SEND_EXISTING`: For any learners who have previously been sent an invitation to the course, use the existing registration on the previous invitation. Use this if you want to remind a learner to take their course or continue their existing course. >- `CREATE_NEW`: For any learners who have previously been sent an invitation to the course, create a new registration for the learner. Use this if you'd like to have simultaneous records of the same user to one course.
|
|
36
36
|
# @param private_invitation_request
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
38
|
-
# @return [Array<(InvitationSummarySchema,
|
|
38
|
+
# @return [Array<(InvitationSummarySchema, Integer, Hash)>] InvitationSummarySchema data, response status code and response headers
|
|
39
39
|
def create_private_invitation_with_http_info(private_invitation_request, opts = {})
|
|
40
40
|
if @api_client.config.debugging
|
|
41
41
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.create_private_invitation ...'
|
|
@@ -90,7 +90,7 @@ module RusticiSoftwareCloudV2
|
|
|
90
90
|
# Creates an invitation link to the course which can then be publicly distributed. Invitations are meant as a way to provide access to your content. When a learner visits the link, they will be prompted for name and email, a registration will be created from the information provided, and they will be redirected to the course. Since anyone visiting the link will create a registration, it is highly advised that you set the `registrationCap` parameter when calling this method. >**Info:** >While invitations are a way to provide access to your content, the majority of use cases would be better suited by creating a registration and building a launch link with the registration endpoints instead. Invitations build upon registrations by grouping a set of registrations together and adding access control measures to said group. Invitations could be used to pass yearly compliance training to an entire company. Invitations also have an associated expiration date which determines when the course will no longer be launchable.
|
|
91
91
|
# @param public_invitation_request A description of the public invitation to be created.
|
|
92
92
|
# @param [Hash] opts the optional parameters
|
|
93
|
-
# @return [Array<(PublicInvitationSchema,
|
|
93
|
+
# @return [Array<(PublicInvitationSchema, Integer, Hash)>] PublicInvitationSchema data, response status code and response headers
|
|
94
94
|
def create_public_invitation_with_http_info(public_invitation_request, opts = {})
|
|
95
95
|
if @api_client.config.debugging
|
|
96
96
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.create_public_invitation ...'
|
|
@@ -147,7 +147,7 @@ module RusticiSoftwareCloudV2
|
|
|
147
147
|
# @param invitation_id
|
|
148
148
|
# @param tags
|
|
149
149
|
# @param [Hash] opts the optional parameters
|
|
150
|
-
# @return [Array<(nil,
|
|
150
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
151
151
|
def delete_invitation_tags_with_http_info(invitation_id, tags, opts = {})
|
|
152
152
|
if @api_client.config.debugging
|
|
153
153
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.delete_invitation_tags ...'
|
|
@@ -223,7 +223,7 @@ module RusticiSoftwareCloudV2
|
|
|
223
223
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
|
224
224
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
|
225
225
|
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token.
|
|
226
|
-
# @return [Array<(InvitationSummaryList,
|
|
226
|
+
# @return [Array<(InvitationSummaryList, Integer, Hash)>] InvitationSummaryList data, response status code and response headers
|
|
227
227
|
def get_all_invitations_with_http_info(opts = {})
|
|
228
228
|
if @api_client.config.debugging
|
|
229
229
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_all_invitations ...'
|
|
@@ -284,7 +284,7 @@ module RusticiSoftwareCloudV2
|
|
|
284
284
|
# Returns the tags for the invitation.
|
|
285
285
|
# @param invitation_id
|
|
286
286
|
# @param [Hash] opts the optional parameters
|
|
287
|
-
# @return [Array<(TagListSchema,
|
|
287
|
+
# @return [Array<(TagListSchema, Integer, Hash)>] TagListSchema data, response status code and response headers
|
|
288
288
|
def get_invitation_tags_with_http_info(invitation_id, opts = {})
|
|
289
289
|
if @api_client.config.debugging
|
|
290
290
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_invitation_tags ...'
|
|
@@ -341,7 +341,7 @@ module RusticiSoftwareCloudV2
|
|
|
341
341
|
# @param invitation_id
|
|
342
342
|
# @param [Hash] opts the optional parameters
|
|
343
343
|
# @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
|
|
344
|
-
# @return [Array<(PrivateInvitationSchema,
|
|
344
|
+
# @return [Array<(PrivateInvitationSchema, Integer, Hash)>] PrivateInvitationSchema data, response status code and response headers
|
|
345
345
|
def get_private_invitation_with_http_info(invitation_id, opts = {})
|
|
346
346
|
if @api_client.config.debugging
|
|
347
347
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_private_invitation ...'
|
|
@@ -397,7 +397,7 @@ module RusticiSoftwareCloudV2
|
|
|
397
397
|
# Check the status of a private invitation email job. This can be called incrementally to check the progress of the emails.
|
|
398
398
|
# @param invitation_id
|
|
399
399
|
# @param [Hash] opts the optional parameters
|
|
400
|
-
# @return [Array<(InvitationJobStatusSchema,
|
|
400
|
+
# @return [Array<(InvitationJobStatusSchema, Integer, Hash)>] InvitationJobStatusSchema data, response status code and response headers
|
|
401
401
|
def get_private_invitation_job_status_with_http_info(invitation_id, opts = {})
|
|
402
402
|
if @api_client.config.debugging
|
|
403
403
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_private_invitation_job_status ...'
|
|
@@ -439,7 +439,7 @@ module RusticiSoftwareCloudV2
|
|
|
439
439
|
end
|
|
440
440
|
|
|
441
441
|
# Get a list of Private Invitations
|
|
442
|
-
# Returns a list of private invitations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
|
|
442
|
+
# Returns a list of private invitations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. >**Info:** >This endpoint caches the launched registration count and total registration count of all private invitations for 24 hours if the `includeRegistrationCount` parameter is set to `true`. Since these values are cached for an extended period, any changes made to the number of launched registrations for a private invitation will not be reflected in the results of this endpoint until the caching period has passed. >If you want to get up-to-date values of the launched or total registration counts for a single private invitation within the caching period, use the GetPrivateInvitation endpoint with `includeRegistrationCount` set to `true`. GetPrivateInvitation *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that private invitation.
|
|
443
443
|
# @param [Hash] opts the optional parameters
|
|
444
444
|
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
|
445
445
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
@@ -450,6 +450,7 @@ module RusticiSoftwareCloudV2
|
|
|
450
450
|
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to invitation_id)
|
|
451
451
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
|
452
452
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
|
453
|
+
# @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
|
|
453
454
|
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token. (default to false)
|
|
454
455
|
# @return [PrivateInvitationList]
|
|
455
456
|
def get_private_invitations(opts = {})
|
|
@@ -458,7 +459,7 @@ module RusticiSoftwareCloudV2
|
|
|
458
459
|
end
|
|
459
460
|
|
|
460
461
|
# Get a list of Private Invitations
|
|
461
|
-
# Returns a list of private invitations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
|
|
462
|
+
# Returns a list of private invitations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. >**Info:** >This endpoint caches the launched registration count and total registration count of all private invitations for 24 hours if the `includeRegistrationCount` parameter is set to `true`. Since these values are cached for an extended period, any changes made to the number of launched registrations for a private invitation will not be reflected in the results of this endpoint until the caching period has passed. >If you want to get up-to-date values of the launched or total registration counts for a single private invitation within the caching period, use the GetPrivateInvitation endpoint with `includeRegistrationCount` set to `true`. GetPrivateInvitation *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that private invitation.
|
|
462
463
|
# @param [Hash] opts the optional parameters
|
|
463
464
|
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
|
464
465
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
@@ -469,8 +470,9 @@ module RusticiSoftwareCloudV2
|
|
|
469
470
|
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
|
470
471
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
|
471
472
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
|
473
|
+
# @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
|
|
472
474
|
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token.
|
|
473
|
-
# @return [Array<(PrivateInvitationList,
|
|
475
|
+
# @return [Array<(PrivateInvitationList, Integer, Hash)>] PrivateInvitationList data, response status code and response headers
|
|
474
476
|
def get_private_invitations_with_http_info(opts = {})
|
|
475
477
|
if @api_client.config.debugging
|
|
476
478
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_private_invitations ...'
|
|
@@ -489,6 +491,7 @@ module RusticiSoftwareCloudV2
|
|
|
489
491
|
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
|
490
492
|
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
|
491
493
|
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
|
494
|
+
query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
|
|
492
495
|
query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
|
|
493
496
|
|
|
494
497
|
# header parameters
|
|
@@ -549,7 +552,7 @@ module RusticiSoftwareCloudV2
|
|
|
549
552
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
|
550
553
|
# @option opts [BOOLEAN] :include_registration_report Optional flag to include basic registration information
|
|
551
554
|
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token.
|
|
552
|
-
# @return [Array<(UserInvitationList,
|
|
555
|
+
# @return [Array<(UserInvitationList, Integer, Hash)>] UserInvitationList data, response status code and response headers
|
|
553
556
|
def get_private_user_invitations_with_http_info(invitation_id, opts = {})
|
|
554
557
|
if @api_client.config.debugging
|
|
555
558
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_private_user_invitations ...'
|
|
@@ -615,7 +618,7 @@ module RusticiSoftwareCloudV2
|
|
|
615
618
|
# @param invitation_id
|
|
616
619
|
# @param [Hash] opts the optional parameters
|
|
617
620
|
# @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
|
|
618
|
-
# @return [Array<(PublicInvitationSchema,
|
|
621
|
+
# @return [Array<(PublicInvitationSchema, Integer, Hash)>] PublicInvitationSchema data, response status code and response headers
|
|
619
622
|
def get_public_invitation_with_http_info(invitation_id, opts = {})
|
|
620
623
|
if @api_client.config.debugging
|
|
621
624
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_public_invitation ...'
|
|
@@ -658,7 +661,7 @@ module RusticiSoftwareCloudV2
|
|
|
658
661
|
end
|
|
659
662
|
|
|
660
663
|
# Get a list of Public Invitations
|
|
661
|
-
# Returns a list of public invitations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
|
|
664
|
+
# Returns a list of public invitations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. >**Info:** >This endpoint caches the registration count of all public invitations for 24 hours if the `includeRegistrationCount` parameter is set to `true`. Since this value is cached for an extended period, any changes made to the number of registrations for a public invitation will not be reflected in the results of this endpoint until the caching period has passed. >If you want to get an up-to-date value of the registration count for a single public invitation within the caching period, use the GetPublicInvitation endpoint with `includeRegistrationCount` set to `true`. GetPublicInvitation *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that public invitation.
|
|
662
665
|
# @param [Hash] opts the optional parameters
|
|
663
666
|
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
|
664
667
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
@@ -669,6 +672,7 @@ module RusticiSoftwareCloudV2
|
|
|
669
672
|
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to invitation_id)
|
|
670
673
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
|
671
674
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
|
675
|
+
# @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
|
|
672
676
|
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token. (default to false)
|
|
673
677
|
# @return [PublicInvitationList]
|
|
674
678
|
def get_public_invitations(opts = {})
|
|
@@ -677,7 +681,7 @@ module RusticiSoftwareCloudV2
|
|
|
677
681
|
end
|
|
678
682
|
|
|
679
683
|
# Get a list of Public Invitations
|
|
680
|
-
# Returns a list of public invitations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
|
|
684
|
+
# Returns a list of public invitations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. >**Info:** >This endpoint caches the registration count of all public invitations for 24 hours if the `includeRegistrationCount` parameter is set to `true`. Since this value is cached for an extended period, any changes made to the number of registrations for a public invitation will not be reflected in the results of this endpoint until the caching period has passed. >If you want to get an up-to-date value of the registration count for a single public invitation within the caching period, use the GetPublicInvitation endpoint with `includeRegistrationCount` set to `true`. GetPublicInvitation *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that public invitation.
|
|
681
685
|
# @param [Hash] opts the optional parameters
|
|
682
686
|
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
|
683
687
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
@@ -688,8 +692,9 @@ module RusticiSoftwareCloudV2
|
|
|
688
692
|
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
|
689
693
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
|
690
694
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
|
695
|
+
# @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
|
|
691
696
|
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token.
|
|
692
|
-
# @return [Array<(PublicInvitationList,
|
|
697
|
+
# @return [Array<(PublicInvitationList, Integer, Hash)>] PublicInvitationList data, response status code and response headers
|
|
693
698
|
def get_public_invitations_with_http_info(opts = {})
|
|
694
699
|
if @api_client.config.debugging
|
|
695
700
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_public_invitations ...'
|
|
@@ -708,6 +713,7 @@ module RusticiSoftwareCloudV2
|
|
|
708
713
|
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
|
709
714
|
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
|
710
715
|
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
|
716
|
+
query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
|
|
711
717
|
query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
|
|
712
718
|
|
|
713
719
|
# header parameters
|
|
@@ -768,7 +774,7 @@ module RusticiSoftwareCloudV2
|
|
|
768
774
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
|
769
775
|
# @option opts [BOOLEAN] :include_registration_report Optional flag to include basic registration information
|
|
770
776
|
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token.
|
|
771
|
-
# @return [Array<(UserInvitationList,
|
|
777
|
+
# @return [Array<(UserInvitationList, Integer, Hash)>] UserInvitationList data, response status code and response headers
|
|
772
778
|
def get_public_user_invitations_with_http_info(invitation_id, opts = {})
|
|
773
779
|
if @api_client.config.debugging
|
|
774
780
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_public_user_invitations ...'
|
|
@@ -834,7 +840,7 @@ module RusticiSoftwareCloudV2
|
|
|
834
840
|
# @param invitation_id
|
|
835
841
|
# @param tags
|
|
836
842
|
# @param [Hash] opts the optional parameters
|
|
837
|
-
# @return [Array<(nil,
|
|
843
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
838
844
|
def put_invitation_tags_with_http_info(invitation_id, tags, opts = {})
|
|
839
845
|
if @api_client.config.debugging
|
|
840
846
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.put_invitation_tags ...'
|
|
@@ -892,7 +898,7 @@ module RusticiSoftwareCloudV2
|
|
|
892
898
|
# Applies all of the provided tags on all of the provided invitations. Both public and private invitations may be tagged via this operation. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetInvitations).
|
|
893
899
|
# @param batch Array of ids, and array of tags for bulk tag operations
|
|
894
900
|
# @param [Hash] opts the optional parameters
|
|
895
|
-
# @return [Array<(nil,
|
|
901
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
896
902
|
def put_invitation_tags_batch_with_http_info(batch, opts = {})
|
|
897
903
|
if @api_client.config.debugging
|
|
898
904
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.put_invitation_tags_batch ...'
|
|
@@ -948,7 +954,7 @@ module RusticiSoftwareCloudV2
|
|
|
948
954
|
# @param invitation_id
|
|
949
955
|
# @param invitation_update_schema Object with values to be updated. Any value not specified above will be ignored.
|
|
950
956
|
# @param [Hash] opts the optional parameters
|
|
951
|
-
# @return [Array<(PrivateInvitationSchema,
|
|
957
|
+
# @return [Array<(PrivateInvitationSchema, Integer, Hash)>] PrivateInvitationSchema data, response status code and response headers
|
|
952
958
|
def update_private_invitation_with_http_info(invitation_id, invitation_update_schema, opts = {})
|
|
953
959
|
if @api_client.config.debugging
|
|
954
960
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.update_private_invitation ...'
|
|
@@ -1009,7 +1015,7 @@ module RusticiSoftwareCloudV2
|
|
|
1009
1015
|
# @param invitation_id
|
|
1010
1016
|
# @param invitation_update_schema Object with values to be updated. Any value not specified above will be ignored.
|
|
1011
1017
|
# @param [Hash] opts the optional parameters
|
|
1012
|
-
# @return [Array<(PublicInvitationSchema,
|
|
1018
|
+
# @return [Array<(PublicInvitationSchema, Integer, Hash)>] PublicInvitationSchema data, response status code and response headers
|
|
1013
1019
|
def update_public_invitation_with_http_info(invitation_id, invitation_update_schema, opts = {})
|
|
1014
1020
|
if @api_client.config.debugging
|
|
1015
1021
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.update_public_invitation ...'
|
|
@@ -37,7 +37,7 @@ module RusticiSoftwareCloudV2
|
|
|
37
37
|
# @param learner_id The id of the learner
|
|
38
38
|
# @param user_email The email of the user initiating this request on behalf of the learner being deleted. This must be a valid primary email address for a SCORM Cloud realm which this application is in.
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
40
|
-
# @return [Array<(nil,
|
|
40
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
41
41
|
def delete_all_learner_data_with_http_info(learner_id, user_email, opts = {})
|
|
42
42
|
if @api_client.config.debugging
|
|
43
43
|
@api_client.config.logger.debug 'Calling API: LearnerApi.delete_all_learner_data ...'
|
|
@@ -98,7 +98,7 @@ module RusticiSoftwareCloudV2
|
|
|
98
98
|
# @param learner_id The id of the learner
|
|
99
99
|
# @param tags
|
|
100
100
|
# @param [Hash] opts the optional parameters
|
|
101
|
-
# @return [Array<(nil,
|
|
101
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
102
102
|
def delete_learner_tags_with_http_info(learner_id, tags, opts = {})
|
|
103
103
|
if @api_client.config.debugging
|
|
104
104
|
@api_client.config.logger.debug 'Calling API: LearnerApi.delete_learner_tags ...'
|
|
@@ -156,7 +156,7 @@ module RusticiSoftwareCloudV2
|
|
|
156
156
|
# Returns the tags for the learner.
|
|
157
157
|
# @param learner_id The id of the learner
|
|
158
158
|
# @param [Hash] opts the optional parameters
|
|
159
|
-
# @return [Array<(TagListSchema,
|
|
159
|
+
# @return [Array<(TagListSchema, Integer, Hash)>] TagListSchema data, response status code and response headers
|
|
160
160
|
def get_learner_tags_with_http_info(learner_id, opts = {})
|
|
161
161
|
if @api_client.config.debugging
|
|
162
162
|
@api_client.config.logger.debug 'Calling API: LearnerApi.get_learner_tags ...'
|
|
@@ -213,7 +213,7 @@ module RusticiSoftwareCloudV2
|
|
|
213
213
|
# @param learner_id The id of the learner
|
|
214
214
|
# @param tags
|
|
215
215
|
# @param [Hash] opts the optional parameters
|
|
216
|
-
# @return [Array<(nil,
|
|
216
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
217
217
|
def put_learner_tags_with_http_info(learner_id, tags, opts = {})
|
|
218
218
|
if @api_client.config.debugging
|
|
219
219
|
@api_client.config.logger.debug 'Calling API: LearnerApi.put_learner_tags ...'
|
|
@@ -271,7 +271,7 @@ module RusticiSoftwareCloudV2
|
|
|
271
271
|
# Applies all of the provided tags on all of the provided learners. Tags are used to easily identify resources. Adding tags can enable more refined searches when working with Reportage.
|
|
272
272
|
# @param batch Array of ids, and array of tags for bulk tag operations
|
|
273
273
|
# @param [Hash] opts the optional parameters
|
|
274
|
-
# @return [Array<(nil,
|
|
274
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
275
275
|
def put_learner_tags_batch_with_http_info(batch, opts = {})
|
|
276
276
|
if @api_client.config.debugging
|
|
277
277
|
@api_client.config.logger.debug 'Calling API: LearnerApi.put_learner_tags_batch ...'
|
|
@@ -327,7 +327,7 @@ module RusticiSoftwareCloudV2
|
|
|
327
327
|
# @param learner_id The id of the learner
|
|
328
328
|
# @param learner_info
|
|
329
329
|
# @param [Hash] opts the optional parameters
|
|
330
|
-
# @return [Array<(nil,
|
|
330
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
331
331
|
def update_learner_info_with_http_info(learner_id, learner_info, opts = {})
|
|
332
332
|
if @api_client.config.debugging
|
|
333
333
|
@api_client.config.logger.debug 'Calling API: LearnerApi.update_learner_info ...'
|
|
@@ -33,7 +33,7 @@ module RusticiSoftwareCloudV2
|
|
|
33
33
|
# Ping the API
|
|
34
34
|
# Get back a message indicating that the API is working.
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
|
-
# @return [Array<(PingSchema,
|
|
36
|
+
# @return [Array<(PingSchema, Integer, Hash)>] PingSchema data, response status code and response headers
|
|
37
37
|
def ping_app_id_with_http_info(opts = {})
|
|
38
38
|
if @api_client.config.debugging
|
|
39
39
|
@api_client.config.logger.debug 'Calling API: PingApi.ping_app_id ...'
|
|
@@ -37,7 +37,7 @@ module RusticiSoftwareCloudV2
|
|
|
37
37
|
# @param registration_id
|
|
38
38
|
# @param launch_link_request
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
40
|
-
# @return [Array<(LaunchLinkSchema,
|
|
40
|
+
# @return [Array<(LaunchLinkSchema, Integer, Hash)>] LaunchLinkSchema data, response status code and response headers
|
|
41
41
|
def build_registration_launch_link_with_http_info(registration_id, launch_link_request, opts = {})
|
|
42
42
|
if @api_client.config.debugging
|
|
43
43
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.build_registration_launch_link ...'
|
|
@@ -96,7 +96,7 @@ module RusticiSoftwareCloudV2
|
|
|
96
96
|
# Creates a new instance of the registration. Registration instances will be automatically created when a learner launches a new version of the course. This allows for tracking registration progress for each of the versions of the course the learner has taken. When the created registration instance is \"launched\", the course specified at creation time will be launched.
|
|
97
97
|
# @param registration_id
|
|
98
98
|
# @param [Hash] opts the optional parameters
|
|
99
|
-
# @return [Array<(nil,
|
|
99
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
100
100
|
def create_new_registration_instance_with_http_info(registration_id, opts = {})
|
|
101
101
|
if @api_client.config.debugging
|
|
102
102
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.create_new_registration_instance ...'
|
|
@@ -152,7 +152,7 @@ module RusticiSoftwareCloudV2
|
|
|
152
152
|
# @param registration
|
|
153
153
|
# @param [Hash] opts the optional parameters
|
|
154
154
|
# @option opts [Integer] :course_version Unless you have a reason for using this you probably do not need to.
|
|
155
|
-
# @return [Array<(nil,
|
|
155
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
156
156
|
def create_registration_with_http_info(registration, opts = {})
|
|
157
157
|
if @api_client.config.debugging
|
|
158
158
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.create_registration ...'
|
|
@@ -207,7 +207,7 @@ module RusticiSoftwareCloudV2
|
|
|
207
207
|
# Deletes the specified registration. >**Caution:** >This will also delete all instances of the registration.
|
|
208
208
|
# @param registration_id
|
|
209
209
|
# @param [Hash] opts the optional parameters
|
|
210
|
-
# @return [Array<(nil,
|
|
210
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
211
211
|
def delete_registration_with_http_info(registration_id, opts = {})
|
|
212
212
|
if @api_client.config.debugging
|
|
213
213
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration ...'
|
|
@@ -263,7 +263,7 @@ module RusticiSoftwareCloudV2
|
|
|
263
263
|
# @param registration_id
|
|
264
264
|
# @param setting_id
|
|
265
265
|
# @param [Hash] opts the optional parameters
|
|
266
|
-
# @return [Array<(nil,
|
|
266
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
267
267
|
def delete_registration_configuration_setting_with_http_info(registration_id, setting_id, opts = {})
|
|
268
268
|
if @api_client.config.debugging
|
|
269
269
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_configuration_setting ...'
|
|
@@ -321,7 +321,7 @@ module RusticiSoftwareCloudV2
|
|
|
321
321
|
# Deletes the global data associated with the registration, but the registration itself will remain. This means any progress towards the global objectives will be removed.
|
|
322
322
|
# @param registration_id
|
|
323
323
|
# @param [Hash] opts the optional parameters
|
|
324
|
-
# @return [Array<(nil,
|
|
324
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
325
325
|
def delete_registration_global_data_with_http_info(registration_id, opts = {})
|
|
326
326
|
if @api_client.config.debugging
|
|
327
327
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_global_data ...'
|
|
@@ -377,7 +377,7 @@ module RusticiSoftwareCloudV2
|
|
|
377
377
|
# @param registration_id
|
|
378
378
|
# @param instance_id
|
|
379
379
|
# @param [Hash] opts the optional parameters
|
|
380
|
-
# @return [Array<(nil,
|
|
380
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
381
381
|
def delete_registration_instance_with_http_info(registration_id, instance_id, opts = {})
|
|
382
382
|
if @api_client.config.debugging
|
|
383
383
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_instance ...'
|
|
@@ -439,7 +439,7 @@ module RusticiSoftwareCloudV2
|
|
|
439
439
|
# @param instance_id
|
|
440
440
|
# @param setting_id
|
|
441
441
|
# @param [Hash] opts the optional parameters
|
|
442
|
-
# @return [Array<(nil,
|
|
442
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
443
443
|
def delete_registration_instance_configuration_setting_with_http_info(registration_id, instance_id, setting_id, opts = {})
|
|
444
444
|
if @api_client.config.debugging
|
|
445
445
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_instance_configuration_setting ...'
|
|
@@ -501,7 +501,7 @@ module RusticiSoftwareCloudV2
|
|
|
501
501
|
# Deletes the data associated with the registration, but the registration itself will remain. This means any of the launch history, and progress will be removed. After the data has been deleted, the registration will automatically register itself for the latest version of the course.
|
|
502
502
|
# @param registration_id
|
|
503
503
|
# @param [Hash] opts the optional parameters
|
|
504
|
-
# @return [Array<(nil,
|
|
504
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
505
505
|
def delete_registration_progress_with_http_info(registration_id, opts = {})
|
|
506
506
|
if @api_client.config.debugging
|
|
507
507
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_progress ...'
|
|
@@ -557,7 +557,7 @@ module RusticiSoftwareCloudV2
|
|
|
557
557
|
# @param registration_id
|
|
558
558
|
# @param tags
|
|
559
559
|
# @param [Hash] opts the optional parameters
|
|
560
|
-
# @return [Array<(nil,
|
|
560
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
561
561
|
def delete_registration_tags_with_http_info(registration_id, tags, opts = {})
|
|
562
562
|
if @api_client.config.debugging
|
|
563
563
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_tags ...'
|
|
@@ -615,7 +615,7 @@ module RusticiSoftwareCloudV2
|
|
|
615
615
|
# Checks that the registration exists within SCORM Cloud. >**Info:** >No registration data will be returned for this call. A successful `200` response indicates that the registration exists. If the registration does not exist, a `404` error will be returned instead. If you are looking for information about the registration, try calling `GetRegistrationProgress` instead.
|
|
616
616
|
# @param registration_id
|
|
617
617
|
# @param [Hash] opts the optional parameters
|
|
618
|
-
# @return [Array<(nil,
|
|
618
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
619
619
|
def get_registration_with_http_info(registration_id, opts = {})
|
|
620
620
|
if @api_client.config.debugging
|
|
621
621
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration ...'
|
|
@@ -671,7 +671,7 @@ module RusticiSoftwareCloudV2
|
|
|
671
671
|
# @param registration_id
|
|
672
672
|
# @param [Hash] opts the optional parameters
|
|
673
673
|
# @option opts [BOOLEAN] :include_metadata
|
|
674
|
-
# @return [Array<(SettingListSchema,
|
|
674
|
+
# @return [Array<(SettingListSchema, Integer, Hash)>] SettingListSchema data, response status code and response headers
|
|
675
675
|
def get_registration_configuration_with_http_info(registration_id, opts = {})
|
|
676
676
|
if @api_client.config.debugging
|
|
677
677
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_configuration ...'
|
|
@@ -731,7 +731,7 @@ module RusticiSoftwareCloudV2
|
|
|
731
731
|
# @param instance_id
|
|
732
732
|
# @param [Hash] opts the optional parameters
|
|
733
733
|
# @option opts [BOOLEAN] :include_metadata
|
|
734
|
-
# @return [Array<(SettingListSchema,
|
|
734
|
+
# @return [Array<(SettingListSchema, Integer, Hash)>] SettingListSchema data, response status code and response headers
|
|
735
735
|
def get_registration_instance_configuration_with_http_info(registration_id, instance_id, opts = {})
|
|
736
736
|
if @api_client.config.debugging
|
|
737
737
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_configuration ...'
|
|
@@ -795,7 +795,7 @@ module RusticiSoftwareCloudV2
|
|
|
795
795
|
# @param instance_id
|
|
796
796
|
# @param [Hash] opts the optional parameters
|
|
797
797
|
# @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history
|
|
798
|
-
# @return [Array<(LaunchHistoryListSchema,
|
|
798
|
+
# @return [Array<(LaunchHistoryListSchema, Integer, Hash)>] LaunchHistoryListSchema data, response status code and response headers
|
|
799
799
|
def get_registration_instance_launch_history_with_http_info(registration_id, instance_id, opts = {})
|
|
800
800
|
if @api_client.config.debugging
|
|
801
801
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_launch_history ...'
|
|
@@ -863,7 +863,7 @@ module RusticiSoftwareCloudV2
|
|
|
863
863
|
# @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
|
|
864
864
|
# @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
|
|
865
865
|
# @option opts [BOOLEAN] :include_runtime Include runtime details in the results
|
|
866
|
-
# @return [Array<(RegistrationSchema,
|
|
866
|
+
# @return [Array<(RegistrationSchema, Integer, Hash)>] RegistrationSchema data, response status code and response headers
|
|
867
867
|
def get_registration_instance_progress_with_http_info(registration_id, instance_id, opts = {})
|
|
868
868
|
if @api_client.config.debugging
|
|
869
869
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_progress ...'
|
|
@@ -933,7 +933,7 @@ module RusticiSoftwareCloudV2
|
|
|
933
933
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
934
934
|
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
935
935
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
|
936
|
-
# @return [Array<(XapiStatementResult,
|
|
936
|
+
# @return [Array<(XapiStatementResult, Integer, Hash)>] XapiStatementResult data, response status code and response headers
|
|
937
937
|
def get_registration_instance_statements_with_http_info(registration_id, instance_id, opts = {})
|
|
938
938
|
if @api_client.config.debugging
|
|
939
939
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_statements ...'
|
|
@@ -1007,7 +1007,7 @@ module RusticiSoftwareCloudV2
|
|
|
1007
1007
|
# @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
|
|
1008
1008
|
# @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
|
|
1009
1009
|
# @option opts [BOOLEAN] :include_runtime Include runtime details in the results
|
|
1010
|
-
# @return [Array<(RegistrationListSchema,
|
|
1010
|
+
# @return [Array<(RegistrationListSchema, Integer, Hash)>] RegistrationListSchema data, response status code and response headers
|
|
1011
1011
|
def get_registration_instances_with_http_info(registration_id, opts = {})
|
|
1012
1012
|
if @api_client.config.debugging
|
|
1013
1013
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instances ...'
|
|
@@ -1070,7 +1070,7 @@ module RusticiSoftwareCloudV2
|
|
|
1070
1070
|
# @param registration_id
|
|
1071
1071
|
# @param [Hash] opts the optional parameters
|
|
1072
1072
|
# @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history
|
|
1073
|
-
# @return [Array<(LaunchHistoryListSchema,
|
|
1073
|
+
# @return [Array<(LaunchHistoryListSchema, Integer, Hash)>] LaunchHistoryListSchema data, response status code and response headers
|
|
1074
1074
|
def get_registration_launch_history_with_http_info(registration_id, opts = {})
|
|
1075
1075
|
if @api_client.config.debugging
|
|
1076
1076
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_launch_history ...'
|
|
@@ -1132,7 +1132,7 @@ module RusticiSoftwareCloudV2
|
|
|
1132
1132
|
# @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
|
|
1133
1133
|
# @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
|
|
1134
1134
|
# @option opts [BOOLEAN] :include_runtime Include runtime details in the results
|
|
1135
|
-
# @return [Array<(RegistrationSchema,
|
|
1135
|
+
# @return [Array<(RegistrationSchema, Integer, Hash)>] RegistrationSchema data, response status code and response headers
|
|
1136
1136
|
def get_registration_progress_with_http_info(registration_id, opts = {})
|
|
1137
1137
|
if @api_client.config.debugging
|
|
1138
1138
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_progress ...'
|
|
@@ -1196,7 +1196,7 @@ module RusticiSoftwareCloudV2
|
|
|
1196
1196
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
1197
1197
|
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
|
1198
1198
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
|
1199
|
-
# @return [Array<(XapiStatementResult,
|
|
1199
|
+
# @return [Array<(XapiStatementResult, Integer, Hash)>] XapiStatementResult data, response status code and response headers
|
|
1200
1200
|
def get_registration_statements_with_http_info(registration_id, opts = {})
|
|
1201
1201
|
if @api_client.config.debugging
|
|
1202
1202
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_statements ...'
|
|
@@ -1254,7 +1254,7 @@ module RusticiSoftwareCloudV2
|
|
|
1254
1254
|
# Returns the tags for the registration.
|
|
1255
1255
|
# @param registration_id
|
|
1256
1256
|
# @param [Hash] opts the optional parameters
|
|
1257
|
-
# @return [Array<(TagListSchema,
|
|
1257
|
+
# @return [Array<(TagListSchema, Integer, Hash)>] TagListSchema data, response status code and response headers
|
|
1258
1258
|
def get_registration_tags_with_http_info(registration_id, opts = {})
|
|
1259
1259
|
if @api_client.config.debugging
|
|
1260
1260
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_tags ...'
|
|
@@ -1335,7 +1335,7 @@ module RusticiSoftwareCloudV2
|
|
|
1335
1335
|
# @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
|
|
1336
1336
|
# @option opts [BOOLEAN] :include_runtime Include runtime details in the results
|
|
1337
1337
|
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token.
|
|
1338
|
-
# @return [Array<(RegistrationListSchema,
|
|
1338
|
+
# @return [Array<(RegistrationListSchema, Integer, Hash)>] RegistrationListSchema data, response status code and response headers
|
|
1339
1339
|
def get_registrations_with_http_info(opts = {})
|
|
1340
1340
|
if @api_client.config.debugging
|
|
1341
1341
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registrations ...'
|
|
@@ -1402,7 +1402,7 @@ module RusticiSoftwareCloudV2
|
|
|
1402
1402
|
# @param registration_id
|
|
1403
1403
|
# @param tags
|
|
1404
1404
|
# @param [Hash] opts the optional parameters
|
|
1405
|
-
# @return [Array<(nil,
|
|
1405
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1406
1406
|
def put_registration_tags_with_http_info(registration_id, tags, opts = {})
|
|
1407
1407
|
if @api_client.config.debugging
|
|
1408
1408
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.put_registration_tags ...'
|
|
@@ -1460,7 +1460,7 @@ module RusticiSoftwareCloudV2
|
|
|
1460
1460
|
# Applies all of the provided tags on all of the provided registrations. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetRegistrations).
|
|
1461
1461
|
# @param batch Array of ids, and array of tags for bulk tag operations
|
|
1462
1462
|
# @param [Hash] opts the optional parameters
|
|
1463
|
-
# @return [Array<(nil,
|
|
1463
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1464
1464
|
def put_registration_tags_batch_with_http_info(batch, opts = {})
|
|
1465
1465
|
if @api_client.config.debugging
|
|
1466
1466
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.put_registration_tags_batch ...'
|
|
@@ -1516,7 +1516,7 @@ module RusticiSoftwareCloudV2
|
|
|
1516
1516
|
# @param registration_id
|
|
1517
1517
|
# @param configuration_settings
|
|
1518
1518
|
# @param [Hash] opts the optional parameters
|
|
1519
|
-
# @return [Array<(nil,
|
|
1519
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1520
1520
|
def set_registration_configuration_with_http_info(registration_id, configuration_settings, opts = {})
|
|
1521
1521
|
if @api_client.config.debugging
|
|
1522
1522
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.set_registration_configuration ...'
|
|
@@ -1578,7 +1578,7 @@ module RusticiSoftwareCloudV2
|
|
|
1578
1578
|
# @param instance_id
|
|
1579
1579
|
# @param configuration_settings
|
|
1580
1580
|
# @param [Hash] opts the optional parameters
|
|
1581
|
-
# @return [Array<(nil,
|
|
1581
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1582
1582
|
def set_registration_instance_configuration_with_http_info(registration_id, instance_id, configuration_settings, opts = {})
|
|
1583
1583
|
if @api_client.config.debugging
|
|
1584
1584
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.set_registration_instance_configuration ...'
|
|
@@ -1640,7 +1640,7 @@ module RusticiSoftwareCloudV2
|
|
|
1640
1640
|
# Sends a postback with dummy data to the url specified. The postback will use additional information from the configuration provided with the request (e.g. a provided username/password will be sent along with the postback to allow for logging in to a secure page. The format of the data sent will differ depending on whether `httpbasic` or `form` is passed for `authType`. - With httpbasic, an authorization header will be sent with the base64 encoded credentials. The body will be JSON formatted data. - With form, the username and password will be sent in the body of the request along with the data. The whole body will be url encoded. >**Note:** >The data that will be sent to the provided url is the same format as the output of the GetRegistrationProgress endpoint.
|
|
1641
1641
|
# @param post_back
|
|
1642
1642
|
# @param [Hash] opts the optional parameters
|
|
1643
|
-
# @return [Array<(nil,
|
|
1643
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1644
1644
|
def test_registration_postback_with_http_info(post_back, opts = {})
|
|
1645
1645
|
if @api_client.config.debugging
|
|
1646
1646
|
@api_client.config.logger.debug 'Calling API: RegistrationApi.test_registration_postback ...'
|
|
@@ -33,7 +33,7 @@ module RusticiSoftwareCloudV2
|
|
|
33
33
|
# Get account information
|
|
34
34
|
# Returns all of the account information for the specified application.
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
|
-
# @return [Array<(ReportageAccountInfoSchema,
|
|
36
|
+
# @return [Array<(ReportageAccountInfoSchema, Integer, Hash)>] ReportageAccountInfoSchema data, response status code and response headers
|
|
37
37
|
def get_account_info_with_http_info(opts = {})
|
|
38
38
|
if @api_client.config.debugging
|
|
39
39
|
@api_client.config.logger.debug 'Calling API: ReportingApi.get_account_info ...'
|
|
@@ -86,7 +86,7 @@ module RusticiSoftwareCloudV2
|
|
|
86
86
|
# @param nav_permission The navigation permissions for this Reportage session
|
|
87
87
|
# @param [Hash] opts the optional parameters
|
|
88
88
|
# @option opts [BOOLEAN] :admin Grant admin privileges to this Reportage session
|
|
89
|
-
# @return [Array<(ReportageAuthTokenSchema,
|
|
89
|
+
# @return [Array<(ReportageAuthTokenSchema, Integer, Hash)>] ReportageAuthTokenSchema data, response status code and response headers
|
|
90
90
|
def get_reportage_auth_token_with_http_info(nav_permission, opts = {})
|
|
91
91
|
if @api_client.config.debugging
|
|
92
92
|
@api_client.config.logger.debug 'Calling API: ReportingApi.get_reportage_auth_token ...'
|
|
@@ -145,7 +145,7 @@ module RusticiSoftwareCloudV2
|
|
|
145
145
|
# @param auth The Reportage authentication token retrieved from a previous call to `GET reportageAuth`
|
|
146
146
|
# @param report_url The Reportage URL to try and access. Common values are the Reportage homepage `https://cloud.scorm.com/Reportage/reportage.php?appId={{your appId}}` or a URL pointing to a specific report within Reportage. The latter type of URL includes lots of parameters of the report, such as the date range, demographic (via tags), specific course or learner, and so on.
|
|
147
147
|
# @param [Hash] opts the optional parameters
|
|
148
|
-
# @return [Array<(ReportageLinkSchema,
|
|
148
|
+
# @return [Array<(ReportageLinkSchema, Integer, Hash)>] ReportageLinkSchema data, response status code and response headers
|
|
149
149
|
def get_reportage_link_with_http_info(auth, report_url, opts = {})
|
|
150
150
|
if @api_client.config.debugging
|
|
151
151
|
@api_client.config.logger.debug 'Calling API: ReportingApi.get_reportage_link ...'
|