Skip to content

Commit b258112

Browse files
committed
Build beta release
1 parent dda4601 commit b258112

File tree

104 files changed

+2856
-2163
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+2856
-2163
lines changed

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ target
2020
.gradle
2121
build
2222

23-
.idea/
24-
scormcloud-api-v2-client.iml
23+
.idea
24+
scormcloud-api-v2-client.iml

.swagger-codegen-ignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,4 @@
2121
#docs/*.md
2222
# Then explicitly reverse the ignore rule for a single file:
2323
#!docs/README.md
24+
.gitignore

.swagger-codegen/VERSION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2.4.3

.travis.yml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,6 @@
11
#
22
# Generated by: https://github.com/swagger-api/swagger-codegen.git
33
#
4-
# Licensed under the Apache License, Version 2.0 (the "License");
5-
# you may not use this file except in compliance with the License.
6-
# You may obtain a copy of the License at
7-
#
8-
# http://www.apache.org/licenses/LICENSE-2.0
9-
#
10-
# Unless required by applicable law or agreed to in writing, software
11-
# distributed under the License is distributed on an "AS IS" BASIS,
12-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13-
# See the License for the specific language governing permissions and
14-
# limitations under the License.
15-
#
164
language: java
175
jdk:
186
- oraclejdk8

README.md

Lines changed: 48 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,47 @@
11
# scormcloud-api-v2-client
22

3+
SCORM Cloud Rest API
4+
- API version: 2.0 beta
5+
- Build date: 2019-03-26T00:55:07.262-05:00
6+
7+
REST API used for SCORM Cloud integrations.
8+
9+
10+
*Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)*
11+
12+
313
## Requirements
414

5-
Building the API client library requires [Maven](https://maven.apache.org/) to be installed.
15+
Building the API client library requires:
16+
1. Java 1.7+
17+
2. Maven/Gradle
618

719
## Installation
820

921
To install the API client library to your local Maven repository, simply execute:
1022

1123
```shell
12-
mvn install
24+
mvn clean install
1325
```
1426

1527
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
1628

1729
```shell
18-
mvn deploy
30+
mvn clean deploy
1931
```
2032

21-
Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.
33+
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
2234

2335
### Maven users
2436

2537
Add this dependency to your project's POM:
2638

2739
```xml
2840
<dependency>
29-
<groupId>com.rusticisoftware.cloud.v2.client</groupId>
30-
<artifactId>scormcloud-api-v2-client</artifactId>
31-
<version>1.0.0-beta</version>
32-
<scope>compile</scope>
41+
<groupId>com.rusticisoftware.cloud.v2.client</groupId>
42+
<artifactId>scormcloud-api-v2-client</artifactId>
43+
<version>1.0.0-beta</version>
44+
<scope>compile</scope>
3345
</dependency>
3446
```
3547

@@ -45,12 +57,14 @@ compile "com.rusticisoftware.cloud.v2.client:scormcloud-api-v2-client:1.0.0-beta
4557

4658
At first generate the JAR by executing:
4759

48-
mvn package
60+
```shell
61+
mvn clean package
62+
```
4963

5064
Then manually install the following JARs:
5165

52-
* target/scormcloud-api-v2-client-1.0.0-beta.jar
53-
* target/lib/*.jar
66+
* `target/scormcloud-api-v2-client-1.0.0-beta.jar`
67+
* `target/lib/*.jar`
5468

5569
## Getting Started
5670

@@ -213,7 +227,7 @@ Class | Method | HTTP request | Description
213227
- [SettingItem](docs/SettingItem.md)
214228
- [SettingListSchema](docs/SettingListSchema.md)
215229
- [SettingMetadata](docs/SettingMetadata.md)
216-
- [SettingMetadataValidValues](docs/SettingMetadataValidValues.md)
230+
- [SettingValidValue](docs/SettingValidValue.md)
217231
- [SettingsIndividualSchema](docs/SettingsIndividualSchema.md)
218232
- [SettingsPostSchema](docs/SettingsPostSchema.md)
219233
- [SharedDataEntrySchema](docs/SharedDataEntrySchema.md)
@@ -223,6 +237,20 @@ Class | Method | HTTP request | Description
223237
- [TagPostSchema](docs/TagPostSchema.md)
224238
- [TitleSchema](docs/TitleSchema.md)
225239
- [TokenRequestSchema](docs/TokenRequestSchema.md)
240+
- [XapiAccount](docs/XapiAccount.md)
241+
- [XapiActivity](docs/XapiActivity.md)
242+
- [XapiActivityDefinition](docs/XapiActivityDefinition.md)
243+
- [XapiAgentGroup](docs/XapiAgentGroup.md)
244+
- [XapiAttachment](docs/XapiAttachment.md)
245+
- [XapiContext](docs/XapiContext.md)
246+
- [XapiContextActivity](docs/XapiContextActivity.md)
247+
- [XapiInteractionComponent](docs/XapiInteractionComponent.md)
248+
- [XapiResult](docs/XapiResult.md)
249+
- [XapiScore](docs/XapiScore.md)
250+
- [XapiStatement](docs/XapiStatement.md)
251+
- [XapiStatementReference](docs/XapiStatementReference.md)
252+
- [XapiStatementResult](docs/XapiStatementResult.md)
253+
- [XapiVerb](docs/XapiVerb.md)
226254

227255

228256
## Documentation for Authorization
@@ -242,17 +270,11 @@ Authentication schemes defined for the API:
242270
- **API key parameter name**: launchToken
243271
- **Location**: URL query string
244272

245-
### URL_TOKEN
246-
247-
- **Type**: API key
248-
- **API key parameter name**: authtoken
249-
- **Location**: URL query string
250-
251273
### OAUTH
252274

253275
- **Type**: OAuth
254276
- **Flow**: application
255-
- **Authorizatoin URL**:
277+
- **Authorization URL**:
256278
- **Scopes**:
257279
- read: Grants read access
258280
- write: Grants write access
@@ -282,10 +304,16 @@ Authentication schemes defined for the API:
282304
- write:appmgmt: Grants write access to app management methods
283305
- delete:appmgmt: Grants deletion access to app management methods
284306

307+
### URL_TOKEN
308+
309+
- **Type**: API key
310+
- **API key parameter name**: authtoken
311+
- **Location**: URL query string
312+
285313

286314
## Recommendation
287315

288-
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issue.
316+
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
289317

290318
## Author
291319

docs/ApplicationManagementApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ApplicationManagementApi
22

3-
All URIs are relative to *https://dev.cloud.scorm.com/api/v2/*
3+
All URIs are relative to *https://cloud.scorm.com/api/v2/*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------

docs/AuthenticationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AuthenticationApi
22

3-
All URIs are relative to *https://dev.cloud.scorm.com/api/v2/*
3+
All URIs are relative to *https://cloud.scorm.com/api/v2/*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------

docs/CourseApi.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CourseApi
22

3-
All URIs are relative to *https://dev.cloud.scorm.com/api/v2/*
3+
All URIs are relative to *https://cloud.scorm.com/api/v2/*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
@@ -710,8 +710,8 @@ OAUTH.setAccessToken("YOUR ACCESS TOKEN");
710710
CourseApi apiInstance = new CourseApi();
711711
String courseId = "courseId_example"; // String |
712712
String learnerId = "learnerId_example"; // String | Only entries for the specified learner id will be included.
713-
OffsetDateTime since = new OffsetDateTime(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
714-
OffsetDateTime until = new OffsetDateTime(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
713+
OffsetDateTime since = OffsetDateTime.now(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
714+
OffsetDateTime until = OffsetDateTime.now(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
715715
String more = "more_example"; // String | Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
716716
try {
717717
XapiStatementResult result = apiInstance.getCourseStatements(courseId, learnerId, since, until, more);
@@ -953,8 +953,8 @@ CourseApi apiInstance = new CourseApi();
953953
String courseId = "courseId_example"; // String |
954954
Integer versionId = 56; // Integer | The course version
955955
String learnerId = "learnerId_example"; // String | Only entries for the specified learner id will be included.
956-
OffsetDateTime since = new OffsetDateTime(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
957-
OffsetDateTime until = new OffsetDateTime(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
956+
OffsetDateTime since = OffsetDateTime.now(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
957+
OffsetDateTime until = OffsetDateTime.now(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
958958
String more = "more_example"; // String | Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
959959
try {
960960
XapiStatementResult result = apiInstance.getCourseVersionStatements(courseId, versionId, learnerId, since, until, more);
@@ -1017,8 +1017,8 @@ OAUTH.setAccessToken("YOUR ACCESS TOKEN");
10171017

10181018
CourseApi apiInstance = new CourseApi();
10191019
String courseId = "courseId_example"; // String |
1020-
OffsetDateTime since = new OffsetDateTime(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1021-
OffsetDateTime until = new OffsetDateTime(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1020+
OffsetDateTime since = OffsetDateTime.now(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1021+
OffsetDateTime until = OffsetDateTime.now(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
10221022
Boolean includeRegistrationCount = false; // Boolean | Include the registration count in the results
10231023
Boolean includeCourseMetadata = false; // Boolean | Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.
10241024
try {
@@ -1081,8 +1081,8 @@ OAUTH.setAccessToken("YOUR ACCESS TOKEN");
10811081

10821082
CourseApi apiInstance = new CourseApi();
10831083
String more = "more_example"; // String | Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1084-
OffsetDateTime since = new OffsetDateTime(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1085-
OffsetDateTime until = new OffsetDateTime(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1084+
OffsetDateTime since = OffsetDateTime.now(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1085+
OffsetDateTime until = OffsetDateTime.now(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
10861086
String filter = "filter_example"; // String | Optional string which filters results by a specified field (described by filterBy).
10871087
String filterBy = "filterBy_example"; // String | Optional enum parameter for specifying the field on which to run the filter. Defaults to course_id.
10881088
String orderBy = "orderBy_example"; // String | Optional enum parameter for specifying the field and order by which to sort the results. Defaults to creation_date_desc.

docs/PingApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PingApi
22

3-
All URIs are relative to *https://dev.cloud.scorm.com/api/v2/*
3+
All URIs are relative to *https://cloud.scorm.com/api/v2/*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------

docs/RegistrationApi.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RegistrationApi
22

3-
All URIs are relative to *https://dev.cloud.scorm.com/api/v2/*
3+
All URIs are relative to *https://cloud.scorm.com/api/v2/*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
@@ -752,8 +752,8 @@ OAUTH.setAccessToken("YOUR ACCESS TOKEN");
752752
RegistrationApi apiInstance = new RegistrationApi();
753753
String registrationId = "registrationId_example"; // String | id for this registration
754754
Integer instanceId = 56; // Integer | The instance of this registration
755-
OffsetDateTime since = new OffsetDateTime(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
756-
OffsetDateTime until = new OffsetDateTime(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
755+
OffsetDateTime since = OffsetDateTime.now(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
756+
OffsetDateTime until = OffsetDateTime.now(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
757757
String more = "more_example"; // String | Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
758758
try {
759759
XapiStatementResult result = apiInstance.getRegistrationInstanceStatements(registrationId, instanceId, since, until, more);
@@ -815,8 +815,8 @@ OAUTH.setAccessToken("YOUR ACCESS TOKEN");
815815

816816
RegistrationApi apiInstance = new RegistrationApi();
817817
String registrationId = "registrationId_example"; // String | id for this registration
818-
OffsetDateTime until = new OffsetDateTime(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
819-
OffsetDateTime since = new OffsetDateTime(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
818+
OffsetDateTime until = OffsetDateTime.now(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
819+
OffsetDateTime since = OffsetDateTime.now(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
820820
String more = "more_example"; // String | Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
821821
Boolean includeChildResults = false; // Boolean | Include information about each learning object, not just the top level in the results
822822
Boolean includeInteractionsAndObjectives = false; // Boolean | Include interactions and objectives in the results
@@ -1061,8 +1061,8 @@ OAUTH.setAccessToken("YOUR ACCESS TOKEN");
10611061

10621062
RegistrationApi apiInstance = new RegistrationApi();
10631063
String registrationId = "registrationId_example"; // String | id for this registration
1064-
OffsetDateTime since = new OffsetDateTime(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1065-
OffsetDateTime until = new OffsetDateTime(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1064+
OffsetDateTime since = OffsetDateTime.now(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1065+
OffsetDateTime until = OffsetDateTime.now(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
10661066
String more = "more_example"; // String | Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
10671067
try {
10681068
XapiStatementResult result = apiInstance.getRegistrationStatements(registrationId, since, until, more);
@@ -1180,8 +1180,8 @@ OAUTH.setAccessToken("YOUR ACCESS TOKEN");
11801180
RegistrationApi apiInstance = new RegistrationApi();
11811181
String courseId = "courseId_example"; // String | Only registrations for the specified course id will be included.
11821182
String learnerId = "learnerId_example"; // String | Only registrations for the specified learner id will be included.
1183-
OffsetDateTime since = new OffsetDateTime(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1184-
OffsetDateTime until = new OffsetDateTime(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1183+
OffsetDateTime since = OffsetDateTime.now(); // OffsetDateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1184+
OffsetDateTime until = OffsetDateTime.now(); // OffsetDateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
11851185
String more = "more_example"; // String | Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
11861186
Boolean includeChildResults = false; // Boolean | Include information about each learning object, not just the top level in the results
11871187
Boolean includeInteractionsAndObjectives = false; // Boolean | Include interactions and objectives in the results

0 commit comments

Comments
 (0)