Skip to content

Commit b90bb6a

Browse files
committed
Update library to v4.0.0 with recent V2 API changes
1 parent 30d474a commit b90bb6a

21 files changed

+470
-95
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ JavaScript client for @rusticisoftware/scormcloud-api-v2-client-javascript
55
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
66

77
- API version: 2.0
8-
- Package version: 3.0.0
8+
- Package version: 4.0.0
99
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
1010

1111
## Installation

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@rusticisoftware/scormcloud-api-v2-client-javascript",
3-
"version": "3.0.0",
3+
"version": "4.0.0",
44
"description": "Swagger Generated JavaScript Client for SCORM Cloud API v2",
55
"main": "src/rustici-software-cloud-v2/index.js",
66
"repository": {

src/rustici-software-cloud-v2/ApiClient.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

3333
/**
3434
* @module rustici-software-cloud-v2/ApiClient
35-
* @version 3.0.0
35+
* @version 4.0.0
3636
*/
3737

3838
/**

src/rustici-software-cloud-v2/index.js

+23-8
Large diffs are not rendered by default.

src/rustici-software-cloud-v2/rustici-software-cloud-v2-api/ApplicationManagementApi.js

+8-8
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,18 @@
1616
(function(root, factory) {
1717
if (typeof define === 'function' && define.amd) {
1818
// AMD. Register as an anonymous module.
19-
define(['rustici-software-cloud-v2/ApiClient', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/ApplicationInfoListSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/ApplicationInfoSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/ApplicationListSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/ApplicationRequestSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/ApplicationSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/CredentialCreatedSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/CredentialListSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/CredentialRequestSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/MessageSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/SettingListSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/SettingsPostSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/StringResultSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/TokenRequestSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/UpdateApplicationSchema'], factory);
19+
define(['rustici-software-cloud-v2/ApiClient', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/ApplicationInfoListSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/ApplicationInfoSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/ApplicationListSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/ApplicationRequestSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/ApplicationSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/CredentialListSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/CredentialRequestSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/CredentialSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/MessageSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/SettingListSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/SettingsPostSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/StringResultSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/TokenRequestSchema', 'rustici-software-cloud-v2/rustici-software-cloud-v2-model/UpdateApplicationSchema'], factory);
2020
} else if (typeof module === 'object' && module.exports) {
2121
// CommonJS-like environments that support module.exports, like Node.
22-
module.exports = factory(require('../ApiClient'), require('../rustici-software-cloud-v2-model/ApplicationInfoListSchema'), require('../rustici-software-cloud-v2-model/ApplicationInfoSchema'), require('../rustici-software-cloud-v2-model/ApplicationListSchema'), require('../rustici-software-cloud-v2-model/ApplicationRequestSchema'), require('../rustici-software-cloud-v2-model/ApplicationSchema'), require('../rustici-software-cloud-v2-model/CredentialCreatedSchema'), require('../rustici-software-cloud-v2-model/CredentialListSchema'), require('../rustici-software-cloud-v2-model/CredentialRequestSchema'), require('../rustici-software-cloud-v2-model/MessageSchema'), require('../rustici-software-cloud-v2-model/SettingListSchema'), require('../rustici-software-cloud-v2-model/SettingsPostSchema'), require('../rustici-software-cloud-v2-model/StringResultSchema'), require('../rustici-software-cloud-v2-model/TokenRequestSchema'), require('../rustici-software-cloud-v2-model/UpdateApplicationSchema'));
22+
module.exports = factory(require('../ApiClient'), require('../rustici-software-cloud-v2-model/ApplicationInfoListSchema'), require('../rustici-software-cloud-v2-model/ApplicationInfoSchema'), require('../rustici-software-cloud-v2-model/ApplicationListSchema'), require('../rustici-software-cloud-v2-model/ApplicationRequestSchema'), require('../rustici-software-cloud-v2-model/ApplicationSchema'), require('../rustici-software-cloud-v2-model/CredentialListSchema'), require('../rustici-software-cloud-v2-model/CredentialRequestSchema'), require('../rustici-software-cloud-v2-model/CredentialSchema'), require('../rustici-software-cloud-v2-model/MessageSchema'), require('../rustici-software-cloud-v2-model/SettingListSchema'), require('../rustici-software-cloud-v2-model/SettingsPostSchema'), require('../rustici-software-cloud-v2-model/StringResultSchema'), require('../rustici-software-cloud-v2-model/TokenRequestSchema'), require('../rustici-software-cloud-v2-model/UpdateApplicationSchema'));
2323
} else {
2424
// Browser globals (root is window)
2525
if (!root.RusticiSoftwareCloudV2) {
2626
root.RusticiSoftwareCloudV2 = {};
2727
}
28-
root.RusticiSoftwareCloudV2.ApplicationManagementApi = factory(root.RusticiSoftwareCloudV2.ApiClient, root.RusticiSoftwareCloudV2.ApplicationInfoListSchema, root.RusticiSoftwareCloudV2.ApplicationInfoSchema, root.RusticiSoftwareCloudV2.ApplicationListSchema, root.RusticiSoftwareCloudV2.ApplicationRequestSchema, root.RusticiSoftwareCloudV2.ApplicationSchema, root.RusticiSoftwareCloudV2.CredentialCreatedSchema, root.RusticiSoftwareCloudV2.CredentialListSchema, root.RusticiSoftwareCloudV2.CredentialRequestSchema, root.RusticiSoftwareCloudV2.MessageSchema, root.RusticiSoftwareCloudV2.SettingListSchema, root.RusticiSoftwareCloudV2.SettingsPostSchema, root.RusticiSoftwareCloudV2.StringResultSchema, root.RusticiSoftwareCloudV2.TokenRequestSchema, root.RusticiSoftwareCloudV2.UpdateApplicationSchema);
28+
root.RusticiSoftwareCloudV2.ApplicationManagementApi = factory(root.RusticiSoftwareCloudV2.ApiClient, root.RusticiSoftwareCloudV2.ApplicationInfoListSchema, root.RusticiSoftwareCloudV2.ApplicationInfoSchema, root.RusticiSoftwareCloudV2.ApplicationListSchema, root.RusticiSoftwareCloudV2.ApplicationRequestSchema, root.RusticiSoftwareCloudV2.ApplicationSchema, root.RusticiSoftwareCloudV2.CredentialListSchema, root.RusticiSoftwareCloudV2.CredentialRequestSchema, root.RusticiSoftwareCloudV2.CredentialSchema, root.RusticiSoftwareCloudV2.MessageSchema, root.RusticiSoftwareCloudV2.SettingListSchema, root.RusticiSoftwareCloudV2.SettingsPostSchema, root.RusticiSoftwareCloudV2.StringResultSchema, root.RusticiSoftwareCloudV2.TokenRequestSchema, root.RusticiSoftwareCloudV2.UpdateApplicationSchema);
2929
}
30-
}(this, function(ApiClient, ApplicationInfoListSchema, ApplicationInfoSchema, ApplicationListSchema, ApplicationRequestSchema, ApplicationSchema, CredentialCreatedSchema, CredentialListSchema, CredentialRequestSchema, MessageSchema, SettingListSchema, SettingsPostSchema, StringResultSchema, TokenRequestSchema, UpdateApplicationSchema) {
30+
}(this, function(ApiClient, ApplicationInfoListSchema, ApplicationInfoSchema, ApplicationListSchema, ApplicationRequestSchema, ApplicationSchema, CredentialListSchema, CredentialRequestSchema, CredentialSchema, MessageSchema, SettingListSchema, SettingsPostSchema, StringResultSchema, TokenRequestSchema, UpdateApplicationSchema) {
3131
'use strict';
3232

3333
/**
@@ -97,7 +97,7 @@
9797
* Callback function to receive the result of the createCredential operation.
9898
* @callback module:rustici-software-cloud-v2/rustici-software-cloud-v2-api/ApplicationManagementApi~createCredentialCallback
9999
* @param {String} error Error message, if any.
100-
* @param {module:rustici-software-cloud-v2/rustici-software-cloud-v2-model/CredentialCreatedSchema} data The data returned by the service call.
100+
* @param {module:rustici-software-cloud-v2/rustici-software-cloud-v2-model/CredentialSchema} data The data returned by the service call.
101101
* @param {String} response The complete HTTP response.
102102
*/
103103

@@ -107,7 +107,7 @@
107107
* @param {String} childAppId
108108
* @param {module:rustici-software-cloud-v2/rustici-software-cloud-v2-model/CredentialRequestSchema} credentialRequest
109109
* @param {module:rustici-software-cloud-v2/rustici-software-cloud-v2-api/ApplicationManagementApi~createCredentialCallback} callback The callback function, accepting three arguments: error, data, response
110-
* data is of type: {@link module:rustici-software-cloud-v2/rustici-software-cloud-v2-model/CredentialCreatedSchema}
110+
* data is of type: {@link module:rustici-software-cloud-v2/rustici-software-cloud-v2-model/CredentialSchema}
111111
*/
112112
this.createCredential = function(childAppId, credentialRequest, callback) {
113113
var postBody = credentialRequest;
@@ -138,7 +138,7 @@
138138
var authNames = ['APP_MANAGEMENT', 'OAUTH'];
139139
var contentTypes = ['application/json'];
140140
var accepts = ['application/json'];
141-
var returnType = CredentialCreatedSchema;
141+
var returnType = CredentialSchema;
142142

143143
return this.apiClient.callApi(
144144
'/appManagement/{childAppId}/credentials', 'POST',
@@ -503,7 +503,7 @@
503503

504504
/**
505505
* Use the Application Management App to get a detailed list of Applications
506-
* Returns a list of applications. Can be filtered using the request parameters to provide a subset of results. This endpoint caches the course and registration counts of an application for 24 hours if either `includeCourseCount` or `includeRegistrationCount` parameters, respectively, are set to `true`. Since these values are cached for an extended period, any changes made to the number of courses or registrations in an application will not be reflected in the results of this endpoint until the caching period has passed. >**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. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource. >**Info:** >If you want to get an up-to-date value of the course or registration count for a single application within the caching period, use the GetApplicationInfo endpoint with `includeCourseCount` and/or `includeRegistrationCount` set to `true`. GetApplicationInfo *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that application.
506+
* Returns a list of applications. 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. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource. >**Info:** >This endpoint caches the course and registration counts of an application for 24 hours if either `includeCourseCount` or `includeRegistrationCount` parameters, respectively, are set to `true`. Since these values are cached for an extended period, any changes made to the number of courses or registrations in an application 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 course or registration count for a single application within the caching period, use the GetApplicationInfo endpoint with `includeCourseCount` and/or `includeRegistrationCount` set to `true`. GetApplicationInfo *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that application.
507507
* @param {Object} opts Optional parameters
508508
* @param {Date} opts.since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
509509
* @param {Date} opts.until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

0 commit comments

Comments
 (0)