rustici_software_cloud_v2 2.1.0 → 3.0.0

data/lib/rustici_software_cloud_v2/api/dispatch_api.rb

@@ -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
+
     # Create a group of Destinations 
     # Creates a group of destinations.  A destination is a label used to identify an entity outside of SCORM Cloud, such as an LMS.  Used in conjunction with dispatches to provide access control mechanisms for the courses distributed to the destination. 
     # @param destinations_list 
@@ -72,6 +74,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Create a group of Dispatches 
     # Creates a group of dispatches.  Dispatches are the connection between a course and a destination.  A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud.  As an extension, dispatches allow for limiting access control even after the zip file has been given to the destination.  >**Caution:** >Only one dispatch can exist for a given course-destination combination.  If calling this method with the same course and destination supplied, the old one will be loaded for modification.  An exception to this is if a dispatchId is passed in the body, the request will fail with a 400 response warning that the dispatch already exists.  This is to prevent confusion over which dispatchId is to be used in future requests. 
     # @param dispatch_list 
@@ -125,6 +128,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete a Destination 
     # Deletes the specified destination.  >**Caution:** >This will also delete all dispatches belonging to the destination. 
     # @param destination_id Identifier for the destination
@@ -178,6 +182,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete a Destination's Dispatches 
     # Deletes all the dispatches from the destination.  >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable. 
     # @param destination_id Identifier for the destination
@@ -231,6 +236,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete tags from a Destination 
     # Deletes the specified tags from the destination.  Deleting tags that do not exist will still result in a success. 
     # @param destination_id Identifier for the destination
@@ -290,6 +296,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete a Dispatch 
     # Deletes the specified dispatch.  >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable. 
     # @param dispatch_id Identifier for the dispatch
@@ -343,6 +350,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete postback information from a Dispatch 
     # Clears the postback settings from the dispatch.  This causes the postback settings to inherit a value from a higher level (e.g. application).  If there is no setting at the application level, this will disable postbacks for the dispatch. 
     # @param dispatch_id Identifier for the dispatch
@@ -396,6 +404,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete tags from a Dispatch 
     # Deletes the specified tags from the dispatch.  Deleting tags that do not exist will still result in a success. 
     # @param dispatch_id Identifier for the dispatch
@@ -455,6 +464,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete a group of Dispatches 
     # Deletes the specified group of dispatches.  Can be filtered using the request parameters to provide a subset of results.  >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.  >**Note:** >One of the filter parameters (i.e. `courseId`, `since`/`until`, `tags`, or `filter`) needs to be provided.  This is to prevent accidental deletion of all dispatches.  If you do wish to update all dispatches, try setting the since parameter to a value prior to the creation of any dispatches.  >**Info:** >If using one of our client libraries, refer to its README for additional information on how to work with the `X-Total-Count` header. 
     # @param [Hash] opts the optional parameters
@@ -523,6 +533,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Update registration instancing status for a Destination's Dispatches 
     # Updates the restration instancing status for all dispatches distributed to the destination.  Registration instancing is the default for dispatches, in order to support versioning of dispatches.  A small portion of users may experience duplicate registrations with content dispatched to some LMS platforms.  If you happen to be dispatching content to an LMS with this issue, disabling registration instancing here will resolve the problems. However, dispatch versioning will also be disabled. 
     # @param destination_id Identifier for the destination
@@ -582,6 +593,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get detailed information about a Destination 
     # Returns detailed information about the destination.  This includes name, tags, and launchAuth information. 
     # @param destination_id Identifier for the destination
@@ -636,6 +648,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get registration count for a Destination's Dispatches 
     # Returns the registration count for all dispatches distributed to the destination.  >**Note:** >The count here is a convenience counter.  Since it has the capability of being reset, it may not match the actual billed registration count for a dispatch. 
     # @param destination_id Identifier for the destination
@@ -690,6 +703,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Download a zip file for a Destination's Dispatches 
     # Downloads a zip file containing all of the dispatch packages for the destination.  A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud. 
     # @param destination_id Identifier for the destination
@@ -753,6 +767,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get a list of a Destination's Dispatches 
     # Returns a list of dispatches belonging to the destination.  Can be filtered using the request parameters to provide a subset of results.  Using the `courseId` filter should only ever yield 0 or 1 results, as a dispatch is the intersection of a course and a destination.  This can be useful for identifying if a certain course is dispatched to the destination.  >**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 destination_id Identifier for the destination
@@ -766,6 +781,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.  (default to dispatch_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 `more` 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 `more` token.  (default to false)
     # @return [DispatchListSchema]
     def get_destination_dispatches(destination_id, opts = {})
       data, _status_code, _headers = get_destination_dispatches_with_http_info(destination_id, opts)
@@ -785,6 +801,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 `more` 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 `more` token. 
     # @return [Array<(DispatchListSchema, Fixnum, Hash)>] DispatchListSchema data, response status code and response headers
     def get_destination_dispatches_with_http_info(destination_id, opts = {})
       if @api_client.config.debugging
@@ -808,6 +825,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 = {}
@@ -834,6 +852,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get user PII hashing status for a Destination 
     # Returns whether or not user PII hashing is enabled for the destination.  Enabling it will cause all user PII to be hashed.  Hashing PII will anonymize the learner data from the dispatched course.  This will make looking up specific details about a learner difficult. 
     # @param destination_id Identifier for the destination
@@ -888,6 +907,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get tags for a Destination 
     # Returns the tags for the destination. 
     # @param destination_id Identifier for the destination
@@ -942,6 +962,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get a list of Destinations 
     # Returns a list of destinations.  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
@@ -954,6 +975,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.  (default to destination_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 [DestinationListSchema]
     def get_destinations(opts = {})
       data, _status_code, _headers = get_destinations_with_http_info(opts)
@@ -972,6 +994,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<(DestinationListSchema, Fixnum, Hash)>] DestinationListSchema data, response status code and response headers
     def get_destinations_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -991,6 +1014,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 = {}
@@ -1017,6 +1041,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get detailed information about a Dispatch 
     # Returns detailed information about the dispatch.  This includes destination and course IDs, as well as registration count. 
     # @param dispatch_id Identifier for the dispatch
@@ -1071,6 +1096,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get enabled status of a Dispatch 
     # Returns the enabled status for the dispatch.  This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off. 
     # @param dispatch_id Identifier for the dispatch
@@ -1125,6 +1151,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get user PII hashing status for a Dispatch 
     # Returns whether or not user PII hashing is enabled for the dispatch.  Enabling it will cause all user PII to be hashed.  Hashing PII will anonymize the learner data from the dispatched course.  This will make looking up specific details about a learner difficult. 
     # @param dispatch_id Identifier for the dispatch
@@ -1179,6 +1206,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get registration count for a Dispatch 
     # Returns the registration count for the dispatch, as well as the date and time of the last count reset, if any.  >**Note:** >The count here is a convenience counter.  Since it has the capability of being reset, it may not match the actual billed registration count for a dispatch. 
     # @param dispatch_id Identifier for the dispatch
@@ -1233,6 +1261,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get tags for a Dispatch 
     # Returns the tags for the dispatch. 
     # @param dispatch_id Identifier for the dispatch
@@ -1287,6 +1316,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Download a zip package for a Dispatch 
     # Downloads a zip package for the dispatch.  A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud. As an extension, dispatches allow for limiting access control even after the zip file has been given to the destination. 
     # @param dispatch_id Identifier for the dispatch
@@ -1347,6 +1377,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get a list of Dispatches 
     # Returns a list of dispatches.  Can be filtered using the request parameters to provide a subset of results.  Using the `courseId` filter will allow for viewing which destinations the course has been dispatched to.  >**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
@@ -1359,6 +1390,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.  (default to dispatch_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 [DispatchListSchema]
     def get_dispatches(opts = {})
       data, _status_code, _headers = get_dispatches_with_http_info(opts)
@@ -1377,6 +1409,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<(DispatchListSchema, Fixnum, Hash)>] DispatchListSchema data, response status code and response headers
     def get_dispatches_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1396,6 +1429,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 = {}
@@ -1422,6 +1456,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification. 
     # Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification. The information from this call will be provided to the platform during the configuration step. 
     # @param dispatch_id Identifier for the dispatch
@@ -1476,6 +1511,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Launch this dispatch using the IMS LTI 1.3 specification. 
     # Launch this dispatch using the IMS LTI 1.3 specification. This is the final step in the LTI 1.3 launch process, and is the request that redirects to the resource link (i.e. course). 
     # @param dispatch_id Identifier for the dispatch
@@ -1531,7 +1567,7 @@ module RusticiSoftwareCloudV2
 
       # http body (model)
       post_body = nil
-      auth_names = ['UNSECURED']
+      auth_names = []
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -1543,6 +1579,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get the information needed to configure a LTI 1.3 platform with the destination id `destinationId` 
     # @param destination_id Identifier for the destination
     # @param [Hash] opts the optional parameters
@@ -1595,6 +1632,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get the information necessary to launch this dispatch using the IMS LTI 1.1 specification. 
     # Retrieve the information needed to launch this dispatch using the IMS LTI 1.1 specification. This information is then provided to the platform so it can launch this dispatch. 
     # @param dispatch_id Identifier for the dispatch
@@ -1649,6 +1687,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Add tags to a Destination 
     # Applies the provided tags to the destination.  Tags are used to easily identify resources.  Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDestinations). 
     # @param destination_id Identifier for the destination
@@ -1708,6 +1747,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Add a group of tags to a group of Destinations 
     # Applies all of the provided tags on all of the provided destinations.  Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDestinations). 
     # @param batch Array of ids, and array of tags for bulk tag operations
@@ -1761,6 +1801,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Add tags to a Dispatch 
     # Applies the provided tags to the dispatch.  Tags are used to easily identify resources.  Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDispatches). 
     # @param dispatch_id Identifier for the dispatch
@@ -1820,6 +1861,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Add a group of tags to a group of Dispatches 
     # Applies all of the provided tags on all of the provided dispatches.  Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDispatches). 
     # @param batch Array of ids, and array of tags for bulk tag operations
@@ -1873,6 +1915,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Reset registration counts for a Destination's Dispatches 
     # Clears the registration count for all dispatches distributed to the destination.  This resets the registration counter on the dispatch itself, but has no effect on the existing registrations.  Can be used in situations where the license for the course material has been renewed. 
     # @param destination_id Identifier for the destination
@@ -1926,6 +1969,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Reset registration count for a Dispatch 
     # Clears the registration count for the dispatch.  This resets the registration counter on the dispatch itself, but has no effect on the existing registrations.  Can be used in situations where the license for the course material has been renewed. 
     # @param dispatch_id Identifier for the dispatch
@@ -1979,6 +2023,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Create or update a Destination 
     # Creates or updates information about the destination.  -If the destination is being created, a name should be provided in the DestinationSchema.  If one is not present in the request an error will be thrown. -If the destination is instead being updated, only non-null values that are provided will be updated.  You may also optionally supply the e-mail address of the user to be associated with this destination.  This e-mail address should correspond to a SCORM Cloud user account.  >**Note:** >While the \"updated\" and \"created\" values are present in the destination schema, any attempts to manually change those values with SetDestination will be ignored. 
     # @param destination_id Identifier for the destination
@@ -2038,6 +2083,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Update enabled status for a Destination's Dispatches 
     # Updates the enabled status for all dispatches distributed to the destination.  This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off. 
     # @param destination_id Identifier for the destination
@@ -2097,6 +2143,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Update enabled status for a Dispatch 
     # Updates the enabled status for the dispatch.  This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off. 
     # @param dispatch_id Identifier for the dispatch
@@ -2156,6 +2203,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Update user PII hashing status for a Destination
     # Updates user PII hashing status for the destination.  Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course.  This will make looking up specific details about a learner difficult. 
     # @param destination_id Identifier for the destination
@@ -2215,6 +2263,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Update information about a Dispatch 
     # Updates information about the dispatch, such as the expiration date and registration cap.  Only non-null values that are provided will be updated. 
     # @param dispatch_id Identifier for the dispatch
@@ -2274,6 +2323,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Update user PII hashing status for a Dispatch
     # Updates user PII hashing status for the dispatch.  Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course.  This will make looking up specific details about a learner difficult. 
     # @param dispatch_id Identifier for the dispatch
@@ -2333,6 +2383,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Update a group of Dispatches 
     # Updates information about a group of dispatches, such as registration cap, expiration date, and postback information. Can be filtered using the request parameters to provide a subset of results.  >**Note:** >One of the filter parameters (i.e. `courseId`, `since`/`until`, `tags`, or `filter`) needs to be provided.  This is to prevent accidental modification of all dispatches.  If you do wish to update all dispatches, try setting the since parameter to a value prior to the creation of any dispatches.  >**Info:** >If using one of our client libraries, refer to its README for additional information on how to work with the `X-Total-Count` header. 
     # @param dispatch_properties