Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

SCORM Cloud Rest API
- API version: 2.0
- Build date: 2023-12-14T11:28:58.809-06:00
- Build date: 2026-04-28T16:00:00.126-05:00

REST API used for SCORM Cloud integrations.

Expand All @@ -12,7 +12,7 @@ REST API used for SCORM Cloud integrations.
## Requirements

Building the API client library requires:
1. Java 1.7+
1. Java 8+
2. Maven/Gradle

## Installation
Expand Down Expand Up @@ -42,7 +42,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>com.rusticisoftware.cloud.v2.client</groupId>
<artifactId>scormcloud-api-v2-client</artifactId>
<version>4.0.0</version>
<version>5.0.0</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -52,7 +52,7 @@ Add this dependency to your project's POM:
Add this dependency to your project's build file:

```groovy
compile "com.rusticisoftware.cloud.v2.client:scormcloud-api-v2-client:4.0.0"
compile "com.rusticisoftware.cloud.v2.client:scormcloud-api-v2-client:5.0.0"
```

#### Others
Expand All @@ -65,7 +65,7 @@ mvn clean package

Then manually install the following JARs:

* `target/scormcloud-api-v2-client-4.0.0.jar`
* `target/scormcloud-api-v2-client-5.0.0.jar`
* `target/lib/*.jar`

## Tips and Tricks
Expand Down Expand Up @@ -271,7 +271,7 @@ public class ScormCloud_Java_Sample {
// This call will use OAuth with the "write:course" scope
// if configured. Otherwise the basic auth credentials will be used
CourseApi courseApi = new CourseApi();
StringResultSchema jobId = courseApi.createUploadAndImportCourseJob(courseId, null, null, null, null, new File(coursePath));
StringResultSchema jobId = courseApi.createUploadAndImportCourseJob(courseId, null, null, null, null, null, new File(coursePath));

// This call will use OAuth with the "read:course" scope
// if configured. Otherwise the basic auth credentials will be used
Expand Down
4 changes: 2 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apply plugin: 'idea'
apply plugin: 'eclipse'

group = 'com.rusticisoftware.cloud.v2.client'
version = '4.0.0'
version = '5.0.0'

buildscript {
repositories {
Expand Down Expand Up @@ -95,7 +95,7 @@ if(hasProperty('target') && target == 'android') {

ext {
swagger_annotations_version = "1.5.24"
jackson_version = "2.13.5"
jackson_version = "2.18.6"
jersey_version = "2.34"
}

Expand Down
10 changes: 5 additions & 5 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
settings(
organization := "com.rusticisoftware.cloud.v2.client",
name := "scormcloud-api-v2-client",
version := "4.0.0",
version := "5.0.0",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
Expand All @@ -14,9 +14,9 @@ lazy val root = (project in file(".")).
"org.glassfish.jersey.media" % "jersey-media-multipart" % "2.34",
"org.glassfish.jersey.inject" % "jersey-hk2" % "2.34",
"org.glassfish.jersey.media" % "jersey-media-json-jackson" % "2.34",
"com.fasterxml.jackson.core" % "jackson-core" % "2.13.5" % "compile",
"com.fasterxml.jackson.core" % "jackson-annotations" % "2.13.5" % "compile",
"com.fasterxml.jackson.core" % "jackson-databind" % "2.13.5" % "compile",
"com.fasterxml.jackson.datatype" % "jackson-datatype-jsr310" % "2.13.5" % "compile"
"com.fasterxml.jackson.core" % "jackson-core" % "2.18.6" % "compile",
"com.fasterxml.jackson.core" % "jackson-annotations" % "2.18.6" % "compile",
"com.fasterxml.jackson.core" % "jackson-databind" % "2.18.6" % "compile",
"com.fasterxml.jackson.datatype" % "jackson-datatype-jsr310" % "2.18.6" % "compile"
)
)
10 changes: 5 additions & 5 deletions pom.xml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.rusticisoftware.cloud.v2.client</groupId>
<artifactId>scormcloud-api-v2-client</artifactId>
<packaging>jar</packaging>
<name>scormcloud-api-v2-client</name>
<version>4.0.1-SNAPSHOT</version>
<version>5.0.0-SNAPSHOT</version>
<url>https://rusticisoftware.com/products/scorm-cloud/api/</url>
<description>Swagger Generated Java Client for SCORM Cloud API v2</description>
<scm>
<connection>scm:git:git@github.com:RusticiSoftware/scormcloud-api-v2-client-java.git</connection>
<developerConnection>scm:git:git@github.com:RusticiSoftware/scormcloud-api-v2-client-java.git</developerConnection>
<url>https://github.com/RusticiSoftware/scormcloud-api-v2-client-java</url>
<tag>HEAD</tag>
</scm>
</scm>

<licenses>
<license>
Expand Down Expand Up @@ -277,7 +277,7 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<swagger-core-version>1.5.24</swagger-core-version>
<jersey-version>2.34</jersey-version>
<jackson-version>2.13.5</jackson-version>
<jackson-version>2.18.6</jackson-version>
<maven-plugin-version>1.0.0</maven-plugin-version>
</properties>
<distributionManagement>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public ApiClient() {
this.dateFormat = new RFC3339DateFormat();

// Set default User-Agent.
setUserAgent("Swagger-Codegen/4.0.0/java");
setUserAgent("Swagger-Codegen/5.0.0/java");

// Setup authentications (key: authentication name, value: authentication).
authentications = new HashMap<String, Authentication>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ public ApiResponse<StringResultSchema> createTokenWithHttpInfo(TokenRequestSchem
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);

String[] localVarAuthNames = new String[] { "APP_NORMAL" };
String[] localVarAuthNames = new String[] { "APP_MANAGEMENT", "APP_NORMAL" };

GenericType<StringResultSchema> localVarReturnType = new GenericType<StringResultSchema>() {};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ public ApiResponse<ApplicationToken> getAppTokenWithHttpInfo(String scope, Integ
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);

String[] localVarAuthNames = new String[] { "APP_NORMAL" };
String[] localVarAuthNames = new String[] { "APP_MANAGEMENT", "APP_NORMAL" };

GenericType<ApplicationToken> localVarReturnType = new GenericType<ApplicationToken>() {};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -190,11 +190,12 @@ public ApiResponse<LaunchLinkSchema> buildCoursePreviewLaunchLinkWithVersionWith
* @param importRequest (required)
* @param mayCreateNewVersion Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn&#39;t already exist. (optional, default to false)
* @param postbackUrl An optional parameter that specifies a URL to send a postback to when the course has finished uploading. (optional)
* @param tags A list of tags to apply, allowing for more refined filtering of resources (optional)
* @return StringResultSchema
* @throws ApiException if fails to make API call
*/
public StringResultSchema createFetchAndImportCourseJob(String courseId, ImportFetchRequestSchema importRequest, Boolean mayCreateNewVersion, String postbackUrl) throws ApiException {
return createFetchAndImportCourseJobWithHttpInfo(courseId, importRequest, mayCreateNewVersion, postbackUrl).getData();
public StringResultSchema createFetchAndImportCourseJob(String courseId, ImportFetchRequestSchema importRequest, Boolean mayCreateNewVersion, String postbackUrl, List<String> tags) throws ApiException {
return createFetchAndImportCourseJobWithHttpInfo(courseId, importRequest, mayCreateNewVersion, postbackUrl, tags).getData();
}

/**
Expand All @@ -204,10 +205,11 @@ public StringResultSchema createFetchAndImportCourseJob(String courseId, ImportF
* @param importRequest (required)
* @param mayCreateNewVersion Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn&#39;t already exist. (optional, default to false)
* @param postbackUrl An optional parameter that specifies a URL to send a postback to when the course has finished uploading. (optional)
* @param tags A list of tags to apply, allowing for more refined filtering of resources (optional)
* @return ApiResponse&lt;StringResultSchema&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<StringResultSchema> createFetchAndImportCourseJobWithHttpInfo(String courseId, ImportFetchRequestSchema importRequest, Boolean mayCreateNewVersion, String postbackUrl) throws ApiException {
public ApiResponse<StringResultSchema> createFetchAndImportCourseJobWithHttpInfo(String courseId, ImportFetchRequestSchema importRequest, Boolean mayCreateNewVersion, String postbackUrl, List<String> tags) throws ApiException {
Object localVarPostBody = importRequest;

// verify the required parameter 'courseId' is set
Expand All @@ -231,6 +233,7 @@ public ApiResponse<StringResultSchema> createFetchAndImportCourseJobWithHttpInfo
localVarQueryParams.addAll(apiClient.parameterToPairs("", "courseId", courseId));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "mayCreateNewVersion", mayCreateNewVersion));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "postbackUrl", postbackUrl));
localVarQueryParams.addAll(apiClient.parameterToPairs("csv", "tags", tags));



Expand All @@ -256,11 +259,12 @@ public ApiResponse<StringResultSchema> createFetchAndImportCourseJobWithHttpInfo
* @param importRequest (required)
* @param mayCreateNewVersion Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn&#39;t already exist. (optional, default to false)
* @param postbackUrl An optional parameter that specifies a URL to send a postback to when the course has finished uploading. (optional)
* @param tags A list of tags to apply, allowing for more refined filtering of resources (optional)
* @return StringResultSchema
* @throws ApiException if fails to make API call
*/
public StringResultSchema createNoUploadAndImportCourseJob(String courseId, ImportRequestSchema importRequest, Boolean mayCreateNewVersion, String postbackUrl) throws ApiException {
return createNoUploadAndImportCourseJobWithHttpInfo(courseId, importRequest, mayCreateNewVersion, postbackUrl).getData();
public StringResultSchema createNoUploadAndImportCourseJob(String courseId, ImportRequestSchema importRequest, Boolean mayCreateNewVersion, String postbackUrl, List<String> tags) throws ApiException {
return createNoUploadAndImportCourseJobWithHttpInfo(courseId, importRequest, mayCreateNewVersion, postbackUrl, tags).getData();
}

/**
Expand All @@ -270,10 +274,11 @@ public StringResultSchema createNoUploadAndImportCourseJob(String courseId, Impo
* @param importRequest (required)
* @param mayCreateNewVersion Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn&#39;t already exist. (optional, default to false)
* @param postbackUrl An optional parameter that specifies a URL to send a postback to when the course has finished uploading. (optional)
* @param tags A list of tags to apply, allowing for more refined filtering of resources (optional)
* @return ApiResponse&lt;StringResultSchema&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<StringResultSchema> createNoUploadAndImportCourseJobWithHttpInfo(String courseId, ImportRequestSchema importRequest, Boolean mayCreateNewVersion, String postbackUrl) throws ApiException {
public ApiResponse<StringResultSchema> createNoUploadAndImportCourseJobWithHttpInfo(String courseId, ImportRequestSchema importRequest, Boolean mayCreateNewVersion, String postbackUrl, List<String> tags) throws ApiException {
Object localVarPostBody = importRequest;

// verify the required parameter 'courseId' is set
Expand All @@ -297,6 +302,7 @@ public ApiResponse<StringResultSchema> createNoUploadAndImportCourseJobWithHttpI
localVarQueryParams.addAll(apiClient.parameterToPairs("", "courseId", courseId));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "mayCreateNewVersion", mayCreateNewVersion));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "postbackUrl", postbackUrl));
localVarQueryParams.addAll(apiClient.parameterToPairs("csv", "tags", tags));



Expand All @@ -321,14 +327,15 @@ public ApiResponse<StringResultSchema> createNoUploadAndImportCourseJobWithHttpI
* @param courseId A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use. (required)
* @param mayCreateNewVersion Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn&#39;t already exist. (optional, default to false)
* @param postbackUrl An optional parameter that specifies a URL to send a postback to when the course has finished uploading. (optional)
* @param tags A list of tags to apply, allowing for more refined filtering of resources (optional)
* @param uploadedContentType The MIME type identifier for the content to be uploaded. This is required if uploading a media file (.pdf, .mp3, or .mp4). (optional, default to application/zip)
* @param contentMetadata Serialized &#39;mediaFileMetadata&#39; schema. (optional)
* @param file The zip file of the course contents to import. (optional)
* @return StringResultSchema
* @throws ApiException if fails to make API call
*/
public StringResultSchema createUploadAndImportCourseJob(String courseId, Boolean mayCreateNewVersion, String postbackUrl, String uploadedContentType, String contentMetadata, File file) throws ApiException {
return createUploadAndImportCourseJobWithHttpInfo(courseId, mayCreateNewVersion, postbackUrl, uploadedContentType, contentMetadata, file).getData();
public StringResultSchema createUploadAndImportCourseJob(String courseId, Boolean mayCreateNewVersion, String postbackUrl, List<String> tags, String uploadedContentType, String contentMetadata, File file) throws ApiException {
return createUploadAndImportCourseJobWithHttpInfo(courseId, mayCreateNewVersion, postbackUrl, tags, uploadedContentType, contentMetadata, file).getData();
}

/**
Expand All @@ -337,13 +344,14 @@ public StringResultSchema createUploadAndImportCourseJob(String courseId, Boolea
* @param courseId A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use. (required)
* @param mayCreateNewVersion Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn&#39;t already exist. (optional, default to false)
* @param postbackUrl An optional parameter that specifies a URL to send a postback to when the course has finished uploading. (optional)
* @param tags A list of tags to apply, allowing for more refined filtering of resources (optional)
* @param uploadedContentType The MIME type identifier for the content to be uploaded. This is required if uploading a media file (.pdf, .mp3, or .mp4). (optional, default to application/zip)
* @param contentMetadata Serialized &#39;mediaFileMetadata&#39; schema. (optional)
* @param file The zip file of the course contents to import. (optional)
* @return ApiResponse&lt;StringResultSchema&gt;
* @throws ApiException if fails to make API call
*/
public ApiResponse<StringResultSchema> createUploadAndImportCourseJobWithHttpInfo(String courseId, Boolean mayCreateNewVersion, String postbackUrl, String uploadedContentType, String contentMetadata, File file) throws ApiException {
public ApiResponse<StringResultSchema> createUploadAndImportCourseJobWithHttpInfo(String courseId, Boolean mayCreateNewVersion, String postbackUrl, List<String> tags, String uploadedContentType, String contentMetadata, File file) throws ApiException {
Object localVarPostBody = null;

// verify the required parameter 'courseId' is set
Expand All @@ -362,6 +370,7 @@ public ApiResponse<StringResultSchema> createUploadAndImportCourseJobWithHttpInf
localVarQueryParams.addAll(apiClient.parameterToPairs("", "courseId", courseId));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "mayCreateNewVersion", mayCreateNewVersion));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "postbackUrl", postbackUrl));
localVarQueryParams.addAll(apiClient.parameterToPairs("csv", "tags", tags));

if (uploadedContentType != null)
localVarHeaderParams.put("uploadedContentType", apiClient.parameterToString(uploadedContentType));
Expand Down
Loading