Skip to content

Commit 15b8c2e

Browse files
committed
Update library to v4.0.0 with recent V2 API changes
1 parent 980c956 commit 15b8c2e

24 files changed

+958
-285
lines changed

.swagger-codegen/VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.4.3
1+
2.4.27

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
SCORM Cloud Rest API
44
- API version: 2.0
5-
- Build date: 2023-04-03T17:42:11.759-05:00
5+
- Build date: 2023-12-14T11:28:58.809-06:00
66

77
REST API used for SCORM Cloud integrations.
88

@@ -42,7 +42,7 @@ Add this dependency to your project's POM:
4242
<dependency>
4343
<groupId>com.rusticisoftware.cloud.v2.client</groupId>
4444
<artifactId>scormcloud-api-v2-client</artifactId>
45-
<version>3.0.1</version>
45+
<version>4.0.0</version>
4646
<scope>compile</scope>
4747
</dependency>
4848
```
@@ -52,7 +52,7 @@ Add this dependency to your project's POM:
5252
Add this dependency to your project's build file:
5353

5454
```groovy
55-
compile "com.rusticisoftware.cloud.v2.client:scormcloud-api-v2-client:3.0.1"
55+
compile "com.rusticisoftware.cloud.v2.client:scormcloud-api-v2-client:4.0.0"
5656
```
5757

5858
#### Others
@@ -65,7 +65,7 @@ mvn clean package
6565

6666
Then manually install the following JARs:
6767

68-
* `target/scormcloud-api-v2-client-3.0.1.jar`
68+
* `target/scormcloud-api-v2-client-4.0.0.jar`
6969
* `target/lib/*.jar`
7070

7171
## Tips and Tricks

build.gradle

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apply plugin: 'idea'
22
apply plugin: 'eclipse'
33

44
group = 'com.rusticisoftware.cloud.v2.client'
5-
version = '3.0.1'
5+
version = '4.0.0'
66

77
buildscript {
88
repositories {
@@ -95,8 +95,8 @@ if(hasProperty('target') && target == 'android') {
9595

9696
ext {
9797
swagger_annotations_version = "1.5.24"
98-
jackson_version = "2.11.4"
99-
jersey_version = "2.29.1"
98+
jackson_version = "2.13.5"
99+
jersey_version = "2.34"
100100
}
101101

102102
dependencies {

build.sbt

+9-9
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@ lazy val root = (project in file(".")).
22
settings(
33
organization := "com.rusticisoftware.cloud.v2.client",
44
name := "scormcloud-api-v2-client",
5-
version := "3.0.1",
5+
version := "4.0.0",
66
scalaVersion := "2.11.4",
77
scalacOptions ++= Seq("-feature"),
88
javacOptions in compile ++= Seq("-Xlint:deprecation"),
99
publishArtifact in (Compile, packageDoc) := false,
1010
resolvers += Resolver.mavenLocal,
1111
libraryDependencies ++= Seq(
1212
"io.swagger" % "swagger-annotations" % "1.5.17",
13-
"org.glassfish.jersey.core" % "jersey-client" % "2.29.1",
14-
"org.glassfish.jersey.media" % "jersey-media-multipart" % "2.29.1",
15-
"org.glassfish.jersey.inject" % "jersey-hk2" % "2.29.1",
16-
"org.glassfish.jersey.media" % "jersey-media-json-jackson" % "2.29.1",
17-
"com.fasterxml.jackson.core" % "jackson-core" % "2.11.4" % "compile",
18-
"com.fasterxml.jackson.core" % "jackson-annotations" % "2.11.4" % "compile",
19-
"com.fasterxml.jackson.core" % "jackson-databind" % "2.11.4" % "compile",
20-
"com.fasterxml.jackson.datatype" % "jackson-datatype-jsr310" % "2.11.4" % "compile"
13+
"org.glassfish.jersey.core" % "jersey-client" % "2.34",
14+
"org.glassfish.jersey.media" % "jersey-media-multipart" % "2.34",
15+
"org.glassfish.jersey.inject" % "jersey-hk2" % "2.34",
16+
"org.glassfish.jersey.media" % "jersey-media-json-jackson" % "2.34",
17+
"com.fasterxml.jackson.core" % "jackson-core" % "2.13.5" % "compile",
18+
"com.fasterxml.jackson.core" % "jackson-annotations" % "2.13.5" % "compile",
19+
"com.fasterxml.jackson.core" % "jackson-databind" % "2.13.5" % "compile",
20+
"com.fasterxml.jackson.datatype" % "jackson-datatype-jsr310" % "2.13.5" % "compile"
2121
)
2222
)

pom.xml

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
<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">
1+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
23
<modelVersion>4.0.0</modelVersion>
34
<groupId>com.rusticisoftware.cloud.v2.client</groupId>
45
<artifactId>scormcloud-api-v2-client</artifactId>
56
<packaging>jar</packaging>
67
<name>scormcloud-api-v2-client</name>
7-
<version>3.0.2-SNAPSHOT</version>
8+
<version>4.0.0-SNAPSHOT</version>
89
<url>https://rusticisoftware.com/products/scorm-cloud/api/</url>
910
<description>Swagger Generated Java Client for SCORM Cloud API v2</description>
1011
<scm>
1112
<connection>scm:git:[email protected]:RusticiSoftware/scormcloud-api-v2-client-java.git</connection>
1213
<developerConnection>scm:git:[email protected]:RusticiSoftware/scormcloud-api-v2-client-java.git</developerConnection>
1314
<url>https://github.com/RusticiSoftware/scormcloud-api-v2-client-java</url>
14-
<tag>HEAD</tag>
15-
</scm>
15+
</scm>
1616

1717
<licenses>
1818
<license>
@@ -276,8 +276,8 @@
276276
<properties>
277277
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
278278
<swagger-core-version>1.5.24</swagger-core-version>
279-
<jersey-version>2.29.1</jersey-version>
280-
<jackson-version>2.13.4</jackson-version>
279+
<jersey-version>2.34</jersey-version>
280+
<jackson-version>2.13.5</jackson-version>
281281
<maven-plugin-version>1.0.0</maven-plugin-version>
282282
</properties>
283283
<distributionManagement>

src/main/java/com/rusticisoftware/cloud/v2/client/ApiClient.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public ApiClient() {
7373
this.dateFormat = new RFC3339DateFormat();
7474

7575
// Set default User-Agent.
76-
setUserAgent("Swagger-Codegen/3.0.1/java");
76+
setUserAgent("Swagger-Codegen/4.0.0/java");
7777

7878
// Setup authentications (key: authentication name, value: authentication).
7979
authentications = new HashMap<String, Authentication>();

src/main/java/com/rusticisoftware/cloud/v2/client/api/ApplicationManagementApi.java

+8-8
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
import com.rusticisoftware.cloud.v2.client.model.ApplicationListSchema;
1414
import com.rusticisoftware.cloud.v2.client.model.ApplicationRequestSchema;
1515
import com.rusticisoftware.cloud.v2.client.model.ApplicationSchema;
16-
import com.rusticisoftware.cloud.v2.client.model.CredentialCreatedSchema;
1716
import com.rusticisoftware.cloud.v2.client.model.CredentialListSchema;
1817
import com.rusticisoftware.cloud.v2.client.model.CredentialRequestSchema;
18+
import com.rusticisoftware.cloud.v2.client.model.CredentialSchema;
1919
import com.rusticisoftware.cloud.v2.client.model.MessageSchema;
2020
import java.time.OffsetDateTime;
2121
import com.rusticisoftware.cloud.v2.client.model.SettingListSchema;
@@ -105,10 +105,10 @@ public ApiResponse<ApplicationSchema> createApplicationWithHttpInfo(ApplicationR
105105
* Creates a new credential (aka secret key) for use with the child application. The credential will be used alongside the &#x60;childAppId&#x60; for basic auth requests. &gt;**Note:** &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;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&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
106106
* @param childAppId (required)
107107
* @param credentialRequest (required)
108-
* @return CredentialCreatedSchema
108+
* @return CredentialSchema
109109
* @throws ApiException if fails to make API call
110110
*/
111-
public CredentialCreatedSchema createCredential(String childAppId, CredentialRequestSchema credentialRequest) throws ApiException {
111+
public CredentialSchema createCredential(String childAppId, CredentialRequestSchema credentialRequest) throws ApiException {
112112
return createCredentialWithHttpInfo(childAppId, credentialRequest).getData();
113113
}
114114

@@ -117,10 +117,10 @@ public CredentialCreatedSchema createCredential(String childAppId, CredentialReq
117117
* Creates a new credential (aka secret key) for use with the child application. The credential will be used alongside the &#x60;childAppId&#x60; for basic auth requests. &gt;**Note:** &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;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&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.
118118
* @param childAppId (required)
119119
* @param credentialRequest (required)
120-
* @return ApiResponse&lt;CredentialCreatedSchema&gt;
120+
* @return ApiResponse&lt;CredentialSchema&gt;
121121
* @throws ApiException if fails to make API call
122122
*/
123-
public ApiResponse<CredentialCreatedSchema> createCredentialWithHttpInfo(String childAppId, CredentialRequestSchema credentialRequest) throws ApiException {
123+
public ApiResponse<CredentialSchema> createCredentialWithHttpInfo(String childAppId, CredentialRequestSchema credentialRequest) throws ApiException {
124124
Object localVarPostBody = credentialRequest;
125125

126126
// verify the required parameter 'childAppId' is set
@@ -157,7 +157,7 @@ public ApiResponse<CredentialCreatedSchema> createCredentialWithHttpInfo(String
157157

158158
String[] localVarAuthNames = new String[] { "APP_MANAGEMENT", "OAUTH" };
159159

160-
GenericType<CredentialCreatedSchema> localVarReturnType = new GenericType<CredentialCreatedSchema>() {};
160+
GenericType<CredentialSchema> localVarReturnType = new GenericType<CredentialSchema>() {};
161161
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
162162
}
163163
/**
@@ -546,7 +546,7 @@ public ApiResponse<ApplicationListSchema> getApplicationListWithHttpInfo() throw
546546
}
547547
/**
548548
* Use the Application Management App to get a detailed list of Applications
549-
* 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 &#x60;includeCourseCount&#x60; or &#x60;includeRegistrationCount&#x60; parameters, respectively, are set to &#x60;true&#x60;. 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. &gt;**Note:** &gt;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 &#x60;more&#x60; 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. &gt;**Note:** &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;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&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource. &gt;**Info:** &gt;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 &#x60;includeCourseCount&#x60; and/or &#x60;includeRegistrationCount&#x60; set to &#x60;true&#x60;. GetApplicationInfo *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that application.
549+
* Returns a list of applications. Can be filtered using the request parameters to provide a subset of results. &gt;**Note:** &gt;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 &#x60;more&#x60; 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. &gt;**Note:** &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;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&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource. &gt;**Info:** &gt;This endpoint caches the course and registration counts of an application for 24 hours if either &#x60;includeCourseCount&#x60; or &#x60;includeRegistrationCount&#x60; parameters, respectively, are set to &#x60;true&#x60;. 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. &gt;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 &#x60;includeCourseCount&#x60; and/or &#x60;includeRegistrationCount&#x60; set to &#x60;true&#x60;. GetApplicationInfo *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that application.
550550
* @param since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC) (optional)
551551
* @param until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC) (optional)
552552
* @param datetimeFilter Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against (optional, default to updated)
@@ -566,7 +566,7 @@ public ApplicationInfoListSchema getApplications(OffsetDateTime since, OffsetDat
566566

567567
/**
568568
* Use the Application Management App to get a detailed list of Applications
569-
* 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 &#x60;includeCourseCount&#x60; or &#x60;includeRegistrationCount&#x60; parameters, respectively, are set to &#x60;true&#x60;. 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. &gt;**Note:** &gt;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 &#x60;more&#x60; 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. &gt;**Note:** &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;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&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource. &gt;**Info:** &gt;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 &#x60;includeCourseCount&#x60; and/or &#x60;includeRegistrationCount&#x60; set to &#x60;true&#x60;. GetApplicationInfo *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that application.
569+
* Returns a list of applications. Can be filtered using the request parameters to provide a subset of results. &gt;**Note:** &gt;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 &#x60;more&#x60; 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. &gt;**Note:** &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;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&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource. &gt;**Info:** &gt;This endpoint caches the course and registration counts of an application for 24 hours if either &#x60;includeCourseCount&#x60; or &#x60;includeRegistrationCount&#x60; parameters, respectively, are set to &#x60;true&#x60;. 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. &gt;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 &#x60;includeCourseCount&#x60; and/or &#x60;includeRegistrationCount&#x60; set to &#x60;true&#x60;. GetApplicationInfo *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that application.
570570
* @param since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC) (optional)
571571
* @param until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC) (optional)
572572
* @param datetimeFilter Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against (optional, default to updated)

0 commit comments

Comments
 (0)