RubyGems - rustici_software_cloud_v2 - Versions diffs - 2.1.0 → 4.0.0 - Mend

rustici_software_cloud_v2 2.1.0 → 4.0.0

Files changed (165) hide show

data/lib/rustici_software_cloud_v2/api/invitations_api.rb CHANGED Viewed

@@ -6,7 +6,6 @@
 OpenAPI spec version: 2.0
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 =end
@@ -19,8 +18,11 @@ module RusticiSoftwareCloudV2
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    extend Gem::Deprecate
     # Create a Private Invitation to a Course
-    # 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.
+    # 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.
     # @param private_invitation_request
     # @param [Hash] opts the optional parameters
     # @return [InvitationSummarySchema]
@@ -30,7 +32,7 @@ module RusticiSoftwareCloudV2
     end
     # Create a Private Invitation to a Course
-    # 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.  &gt;**Info:** &gt;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.
+    # 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.  &gt;**Info:** &gt;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.  &gt;**Note:** &gt;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 &#x60;duplicateRegistrationOption&#x60; parameter. The available options are: &gt;- &#x60;FAIL&#x60;: 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. &gt;- &#x60;INSTANCE_EXISTING&#x60;: 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 &lt;a href&#x3D;\\\&quot;https://cloud.scorm.com/docs/v2/reference/swagger/#/registration/GetRegistrationInstances\\\&quot;&gt;here&lt;/a&gt; &gt;- &#x60;SEND_EXISTING&#x60;: 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. &gt;- &#x60;CREATE_NEW&#x60;: For any learners who have previously been sent an invitation to the course, create a new registration for the learner. Use this if you&#39;d like to have simultaneous records of the same user to one course.
     # @param private_invitation_request
     # @param [Hash] opts the optional parameters
     # @return [Array<(InvitationSummarySchema, Fixnum, Hash)>] InvitationSummarySchema data, response status code and response headers
@@ -73,6 +75,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Create a Public Invitation to a Course
     # 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.
     # @param public_invitation_request A description of the public invitation to be created.
@@ -127,6 +130,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Delete tags from an Invitation
     # Deletes the specified tags from the invitation.  Deleting tags that do not exist will still result in a success.
     # @param invitation_id
@@ -186,6 +190,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get a list of Invitations
     # Returns a list of invitations (both public and private).  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.
     # @param [Hash] opts the optional parameters
@@ -198,6 +203,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.  (default to invitation_id)
     # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.  (default to updated_asc)
     # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
+    # @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 &#x60;more&#x60; token.  (default to false)
     # @return [InvitationSummaryList]
     def get_all_invitations(opts = {})
       data, _status_code, _headers = get_all_invitations_with_http_info(opts)
@@ -216,6 +222,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
     # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
     # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
+    # @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 &#x60;more&#x60; token.
     # @return [Array<(InvitationSummaryList, Fixnum, Hash)>] InvitationSummaryList data, response status code and response headers
     def get_all_invitations_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -235,6 +242,7 @@ module RusticiSoftwareCloudV2
       query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
       query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
       query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
+      query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
       # header parameters
       header_params = {}
@@ -261,6 +269,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get tags for an Invitation
     # Returns the tags for the invitation.
     # @param invitation_id
@@ -315,6 +324,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get detailed information about a Private Invitation
     # Returns detailed information about the private invitation.  This includes the email sent, course ID, and whether new the invitation can still be launched or not.
     # @param invitation_id
@@ -372,6 +382,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get email job status for a Private Invitation
     # Check the status of a private invitation email job.  This can be called incrementally to check the progress of the emails.
     # @param invitation_id
@@ -426,6 +437,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get a list of Private Invitations
     # 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.
     # @param [Hash] opts the optional parameters
@@ -438,6 +450,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.  (default to invitation_id)
     # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.  (default to updated_asc)
     # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
+    # @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 &#x60;more&#x60; token.  (default to false)
     # @return [PrivateInvitationList]
     def get_private_invitations(opts = {})
       data, _status_code, _headers = get_private_invitations_with_http_info(opts)
@@ -456,6 +469,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
     # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
     # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
+    # @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 &#x60;more&#x60; token.
     # @return [Array<(PrivateInvitationList, Fixnum, Hash)>] PrivateInvitationList data, response status code and response headers
     def get_private_invitations_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -475,6 +489,7 @@ module RusticiSoftwareCloudV2
       query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
       query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
       query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
+      query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
       # header parameters
       header_params = {}
@@ -501,6 +516,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get a list of Private User Invitations
     # Get a list of user who were invited to view the course.  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.
     # @param invitation_id
@@ -513,6 +529,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.  (default to updated_asc)
     # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
     # @option opts [BOOLEAN] :include_registration_report Optional flag to include basic registration information
+    # @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 &#x60;more&#x60; token.  (default to false)
     # @return [UserInvitationList]
     def get_private_user_invitations(invitation_id, opts = {})
       data, _status_code, _headers = get_private_user_invitations_with_http_info(invitation_id, opts)
@@ -531,6 +548,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
     # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
     # @option opts [BOOLEAN] :include_registration_report Optional flag to include basic registration information
+    # @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 &#x60;more&#x60; token.
     # @return [Array<(UserInvitationList, Fixnum, Hash)>] UserInvitationList data, response status code and response headers
     def get_private_user_invitations_with_http_info(invitation_id, opts = {})
       if @api_client.config.debugging
@@ -553,6 +571,7 @@ module RusticiSoftwareCloudV2
       query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
       query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
       query_params[:'includeRegistrationReport'] = opts[:'include_registration_report'] if !opts[:'include_registration_report'].nil?
+      query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
       # header parameters
       header_params = {}
@@ -579,6 +598,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get detailed information about a Public Invitation
     # Returns detailed information about the public invitation.  This includes url, registration cap, and whether new learners can accept the invitation or not.
     # @param invitation_id
@@ -636,6 +656,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get a list of Public Invitations
     # 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.
     # @param [Hash] opts the optional parameters
@@ -648,6 +669,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.  (default to invitation_id)
     # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.  (default to updated_asc)
     # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
+    # @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 &#x60;more&#x60; token.  (default to false)
     # @return [PublicInvitationList]
     def get_public_invitations(opts = {})
       data, _status_code, _headers = get_public_invitations_with_http_info(opts)
@@ -666,6 +688,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
     # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
     # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
+    # @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 &#x60;more&#x60; token.
     # @return [Array<(PublicInvitationList, Fixnum, Hash)>] PublicInvitationList data, response status code and response headers
     def get_public_invitations_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -685,6 +708,7 @@ module RusticiSoftwareCloudV2
       query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
       query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
       query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
+      query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
       # header parameters
       header_params = {}
@@ -711,6 +735,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get a list of Public User Invitations
     # Returns a list of users who have visited the public invitation link.  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.
     # @param invitation_id
@@ -723,6 +748,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.  (default to updated_asc)
     # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
     # @option opts [BOOLEAN] :include_registration_report Optional flag to include basic registration information
+    # @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 &#x60;more&#x60; token.  (default to false)
     # @return [UserInvitationList]
     def get_public_user_invitations(invitation_id, opts = {})
       data, _status_code, _headers = get_public_user_invitations_with_http_info(invitation_id, opts)
@@ -741,6 +767,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
     # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
     # @option opts [BOOLEAN] :include_registration_report Optional flag to include basic registration information
+    # @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 &#x60;more&#x60; token.
     # @return [Array<(UserInvitationList, Fixnum, Hash)>] UserInvitationList data, response status code and response headers
     def get_public_user_invitations_with_http_info(invitation_id, opts = {})
       if @api_client.config.debugging
@@ -763,6 +790,7 @@ module RusticiSoftwareCloudV2
       query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
       query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
       query_params[:'includeRegistrationReport'] = opts[:'include_registration_report'] if !opts[:'include_registration_report'].nil?
+      query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
       # header parameters
       header_params = {}
@@ -789,6 +817,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Add tags to an Invitation
     # Applies the provided tags to the invitation.  Tags are used to easily identify resources.  Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetInvitations).
     # @param invitation_id
@@ -848,6 +877,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Add a group of tags to a group of Invitations
     # 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).
     # @param batch Array of ids, and array of tags for bulk tag operations
@@ -901,6 +931,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Update information about a Private Invitation
     # Updates information about the private invitation, such as the expiration date and registration cap.  Only non-null values that are provided will be updated.
     # @param invitation_id
@@ -961,6 +992,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Update information about a Public Invitation
     # Updates information about the public invitation, such as the expiration date and registration cap.  Only non-null values that are provided will be updated.
     # @param invitation_id

data/lib/rustici_software_cloud_v2/api/learner_api.rb CHANGED Viewed

@@ -6,7 +6,6 @@
 OpenAPI spec version: 2.0
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 =end
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    extend Gem::Deprecate
     # Deletes all PII for a learnerId
     # Deletes all of the PII information for the learner.  This is meant for use with complying with GDPR requests from learners.  >**Note:** >This method is asynchronous.  A returned success status indicates a background process has been started, but there will still be a delay before the deletion of PII information takes place.
     # @param learner_id The id of the learner
@@ -79,6 +81,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Delete tags from a learnerId
     # Delete the specified tags from the learner.  Deleting tags that do not exist will still result in a success.
     # @param learner_id The id of the learner
@@ -138,6 +141,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get tags for a learnerId
     # Returns the tags for the learner.
     # @param learner_id The id of the learner
@@ -192,6 +196,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Add tags to a learnerId
     # Applies the provided tags to the learner.  Tags are used to easily identify resources.  Adding tags can enable more refined searches when working with Reportage.
     # @param learner_id The id of the learner
@@ -251,6 +256,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Add a group of tags to a group of learnerIds
     # 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.
     # @param batch Array of ids, and array of tags for bulk tag operations
@@ -304,6 +310,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Update all Registrations for a learnerId
     # Updates information about a group of registrations, such as learner email and name.  A learner in SCORM Cloud is not an entity on its own.  In fact, learners only exist as information on individual registrations.  This method will update the information on each of the registrations that the provided `learnerId` is attached to.  >**Caution:** >Providing an empty string will cause the value in SCORM Cloud to be set to empty.  This may have unintended consequences with regards to functionality.  >**Note:** >This method is asynchronous.  A returned success status indicates a background process has been started, but there will still be a delay before the changes on the registrations take place.
     # @param learner_id The id of the learner

data/lib/rustici_software_cloud_v2/api/ping_api.rb CHANGED Viewed

@@ -6,7 +6,6 @@
 OpenAPI spec version: 2.0
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 =end
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    extend Gem::Deprecate
     # Ping the API
     # Get back a message indicating that the API is working.
     # @param [Hash] opts the optional parameters

data/lib/rustici_software_cloud_v2/api/registration_api.rb CHANGED Viewed

@@ -6,7 +6,6 @@
 OpenAPI spec version: 2.0
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 =end
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    extend Gem::Deprecate
     # Get a launch link for a Registration
     # Returns the launch link to use to launch the course for the registration.   Launch links are meant as a way to provide access to your content.  When a learner visits the link, the course will be launched and registration progress will start to be tracked.
     # @param registration_id
@@ -79,6 +81,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Create a Registration Instance
     # 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.
     # @param registration_id
@@ -132,6 +135,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Create a Registration
     # Creates a new registration.  Registrations are the billable unit in SCORM Cloud, and represent a link between a learner and a course.  A registration will contain a few pieces of information such as learner identifiers, the id of the course being registered for, and several other optional fields. A registration must be tied to a specific course at creation time.  When the created registration is \"launched\", the course specified at creation time will be launched.
     # @param registration
@@ -188,6 +192,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Delete a Registration
     # Deletes the specified registration.  >**Caution:** >This will also delete all instances of the registration.
     # @param registration_id
@@ -241,6 +246,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Delete a configuration setting explicitly set for a Registration
     # Clears the specified setting from the registration.  This causes the setting to inherit a value from a higher level (e.g. course).  If the configuration setting was not set at the registration level it will continue to persist and will require deletion from the level it was set.
     # @param registration_id
@@ -300,6 +306,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Reset global data for a Registration
     # 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.
     # @param registration_id
@@ -353,6 +360,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Delete a Registration Instance
     # Deletes the specified instance of the registration.  If deleting the last remaining instance of the registration, the registration itself will be deleted along with any associated data.
     # @param registration_id
@@ -412,6 +420,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Delete a configuration setting explicitly set for a Registration Instance
     # Clears the specified setting from the registration instance.  This causes the setting to inherit a value from a higher level (e.g. course).  If the configuration setting was not set at the registration level it will continue to persist and will require deletion from the level it was set.
     # @param registration_id
@@ -477,6 +486,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Reset a Registration
     # 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.
     # @param registration_id
@@ -530,6 +540,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Delete tags from a Registration
     # Deletes the specified tags from the registration.  Deleting tags that do not exist will still result in a success.
     # @param registration_id
@@ -589,6 +600,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Check that a Registration exists
     # 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.
     # @param registration_id
@@ -642,6 +654,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get effective configuration settings for a Registration
     # Returns the effective configuration settings for the registration.  If not set at the registration level, the setting will inherit a value from a higher level (e.g. course).  Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
     # @param registration_id
@@ -699,6 +712,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get effective configuration settings for a Registration Instance
     # Returns the effective configuration settings for the registration instance.  If not set at the registration level, the setting will inherit a value from a higher level (e.g. course).  Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
     # @param registration_id
@@ -762,6 +776,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get launch history for a Registration Instance
     # Returns the launch history of the registration instance.  This includes completion status, time taken, and pass/fail status.
     # @param registration_id
@@ -825,6 +840,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get detailed information about a Registration Instance
     # Returns detailed information about the registration instance.  This includes completion status, time taken, score, and pass/fail status.
     # @param registration_id
@@ -894,6 +910,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get xAPI statements for a Registration Instance
     # Returns xAPI statements for the registration instance.
     # @param registration_id
@@ -963,6 +980,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get a list of a Registration's Instances
     # Returns information about all instances of the registration.  This can be useful to see information such as registration progress across versions of a course.
     # @param registration_id
@@ -1035,6 +1053,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get launch history for a Registration
     # Returns the launch history of the registration.  This includes completion status, time taken, and pass/fail status.
     # @param registration_id
@@ -1092,6 +1111,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get detailed information about a Registration
     # Returns detailed information about the registration.  This includes completion status, time taken, score, and pass/fail status.  >**Info:** >If you find yourself making multiple calls to this endpoint, it may be worthwhile to utilize our [postback mechanism](https://cloud.scorm.com/docs/v2/guides/postback/) instead.  The main premise is that you would set up an endpoint on your end, and when we detect a change to the registration progress: completion status, time taken, score, or pass/fail status, we would send a message to your system with the registration progress.
     # @param registration_id
@@ -1155,6 +1175,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get xAPI statements for a Registration
     # Returns xAPI statements for the registration.
     # @param registration_id
@@ -1218,6 +1239,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get tags for a Registration
     # Returns the tags for the registration.
     # @param registration_id
@@ -1272,6 +1294,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get a list of Registrations
     # Returns a list of registrations.  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:** >If you find yourself making multiple calls to this endpoint, it may be worthwhile to utilize our [postback mechanism](https://cloud.scorm.com/docs/v2/guides/postback/) instead.  The main premise is that you would set up an endpoint on your end, and when we detect a change to the registration progress: completion status, time taken, score, or pass/fail status, we would send a message to your system with the registration progress.
     # @param [Hash] opts the optional parameters
@@ -1288,6 +1311,7 @@ module RusticiSoftwareCloudV2
     # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
     # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
     # @option opts [BOOLEAN] :include_runtime Include runtime details in the results (default to false)
+    # @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 &#x60;more&#x60; token.  (default to false)
     # @return [RegistrationListSchema]
     def get_registrations(opts = {})
       data, _status_code, _headers = get_registrations_with_http_info(opts)
@@ -1310,6 +1334,7 @@ module RusticiSoftwareCloudV2
     # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
     # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
     # @option opts [BOOLEAN] :include_runtime Include runtime details in the results
+    # @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 &#x60;more&#x60; token.
     # @return [Array<(RegistrationListSchema, Fixnum, Hash)>] RegistrationListSchema data, response status code and response headers
     def get_registrations_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1333,6 +1358,7 @@ module RusticiSoftwareCloudV2
       query_params[:'includeChildResults'] = opts[:'include_child_results'] if !opts[:'include_child_results'].nil?
       query_params[:'includeInteractionsAndObjectives'] = opts[:'include_interactions_and_objectives'] if !opts[:'include_interactions_and_objectives'].nil?
       query_params[:'includeRuntime'] = opts[:'include_runtime'] if !opts[:'include_runtime'].nil?
+      query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
       # header parameters
       header_params = {}
@@ -1359,6 +1385,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Add tags to a Registration
     # Applies the provided tags to the registration.  Tags are used to easily identify resources.  Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetRegistrations).
     # @param registration_id
@@ -1418,6 +1445,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Add a group of tags to a group of Registrations
     # 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).
     # @param batch Array of ids, and array of tags for bulk tag operations
@@ -1471,6 +1499,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Update configuration settings for a Registration
     # Updates configuration settings at the registration level.  This will explicitly set a value at the registration level and override any settings from a higher level.  Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
     # @param registration_id
@@ -1530,6 +1559,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Update configuration settings for a Registration Instance
     # Updates configuration settings at the registration level.  This will explicitly set a value at the registration level and override any settings from a higher level.  Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
     # @param registration_id
@@ -1595,6 +1625,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Send a test postback with the provided configuration
     # 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.
     # @param post_back

data/lib/rustici_software_cloud_v2/api/reporting_api.rb CHANGED Viewed

@@ -6,7 +6,6 @@
 OpenAPI spec version: 2.0
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 =end
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    extend Gem::Deprecate
     # Get account information
     # Returns all of the account information for the specified application.
     # @param [Hash] opts the optional parameters
@@ -67,6 +69,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get a Reportage session authentication token
     # Returns a session authentication token to use when launching Reportage.
     # @param nav_permission The navigation permissions for this Reportage session
@@ -125,6 +128,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
     # Get a link to a page in Reportage with the given permissions
     # Returns the link to use for viewing Reportage.  In order to generate a link, GetReportageAuthToken will need to be called to generate an auth token with the necessary permissions.
     # @param auth The Reportage authentication token retrieved from a previous call to &#x60;GET reportageAuth&#x60;