Skip to content

Commit d0e35a3

Browse files
committed
Updates for beta release
1 parent 6e55795 commit d0e35a3

File tree

135 files changed

+32530
-7946
lines changed

Some content is hidden

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

135 files changed

+32530
-7946
lines changed

.php_cs

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?php
2+
3+
return PhpCsFixer\Config::create()
4+
->setUsingCache(true)
5+
->setRules([
6+
'@PSR2' => true,
7+
'ordered_imports' => true,
8+
'phpdoc_order' => true,
9+
'array_syntax' => [ 'syntax' => 'short' ],
10+
'strict_comparison' => true,
11+
'strict_param' => true,
12+
'no_trailing_whitespace' => false,
13+
'no_trailing_whitespace_in_comment' => false,
14+
'braces' => false,
15+
'single_blank_line_at_eof' => false,
16+
'blank_line_after_namespace' => false,
17+
])
18+
->setFinder(
19+
PhpCsFixer\Finder::create()
20+
->exclude('test')
21+
->exclude('tests')
22+
->in(__DIR__)
23+
);

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ php:
77
- 7.0
88
- hhvm
99
before_install: "composer install"
10-
script: "phpunit lib/Tests"
10+
script: "vendor/bin/phpunit"

README.md

Lines changed: 51 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
1-
# ./
1+
# scormcloud-api-v2-client-php
22
REST API used for SCORM Cloud integrations.
33

44
This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
55

66
- API version: 2.0 beta
77
- Package version: 1.0.0-beta
8-
- Build date: 2019-03-24T08:51:39.073-05:00
9-
- Build package: class io.swagger.codegen.languages.PhpClientCodegen
8+
- Build package: io.swagger.codegen.languages.PhpClientCodegen
109

1110
## Requirements
1211

13-
PHP 5.4.0 and later
12+
PHP 5.5 and later
1413

1514
## Installation & Usage
1615
### Composer
@@ -38,7 +37,7 @@ Then run `composer install`
3837
Download the files and include `autoload.php`:
3938

4039
```php
41-
require_once('/path/to/.//autoload.php');
40+
require_once('/path/to/scormcloud-api-v2-client-php/vendor/autoload.php');
4241
```
4342

4443
## Tests
@@ -47,7 +46,7 @@ To run the unit tests:
4746

4847
```
4948
composer install
50-
./vendor/bin/phpunit lib/Tests
49+
./vendor/bin/phpunit
5150
```
5251

5352
## Getting Started
@@ -59,16 +58,22 @@ Please follow the [installation procedure](#installation--usage) and then run th
5958
require_once(__DIR__ . '/vendor/autoload.php');
6059

6160
// Configure HTTP basic authorization: APP_NORMAL
62-
RusticiSoftware\Cloud\V2\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
63-
RusticiSoftware\Cloud\V2\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
61+
$config = RusticiSoftware\Cloud\V2\Configuration::getDefaultConfiguration()
62+
->setUsername('YOUR_USERNAME')
63+
->setPassword('YOUR_PASSWORD');
6464
// Configure OAuth2 access token for authorization: OAUTH
65-
RusticiSoftware\Cloud\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
66-
67-
$api_instance = new RusticiSoftware\Cloud\V2\Api\ApplicationManagementApi();
65+
$config = RusticiSoftware\Cloud\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
66+
67+
$apiInstance = new RusticiSoftware\Cloud\V2\Api\ApplicationManagementApi(
68+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
69+
// This is optional, `GuzzleHttp\Client` will be used as default.
70+
new GuzzleHttp\Client(),
71+
$config
72+
);
6873
$application_name = "application_name_example"; // string |
6974

7075
try {
71-
$result = $api_instance->createApplication($application_name);
76+
$result = $apiInstance->createApplication($application_name);
7277
print_r($result);
7378
} catch (Exception $e) {
7479
echo 'Exception when calling ApplicationManagementApi->createApplication: ', $e->getMessage(), PHP_EOL;
@@ -79,7 +84,7 @@ try {
7984

8085
## Documentation for API Endpoints
8186

82-
All URIs are relative to *https://dev.cloud.scorm.com/api/v2/*
87+
All URIs are relative to *https://cloud.scorm.com/api/v2/*
8388

8489
Class | Method | HTTP request | Description
8590
------------ | ------------- | ------------- | -------------
@@ -100,17 +105,21 @@ Class | Method | HTTP request | Description
100105
*CourseApi* | [**createUploadAndImportCourseJob**](docs/Api/CourseApi.md#createuploadandimportcoursejob) | **POST** /courses/importJobs/upload | Upload a course and start an import job for it.
101106
*CourseApi* | [**deleteCourse**](docs/Api/CourseApi.md#deletecourse) | **DELETE** /courses/{courseId} | Delete &#x60;courseId&#x60;
102107
*CourseApi* | [**deleteCourseConfigurationSetting**](docs/Api/CourseApi.md#deletecourseconfigurationsetting) | **DELETE** /courses/{courseId}/configuration/{settingId} | Clears the &#x60;settingId&#x60; value for this course
108+
*CourseApi* | [**deleteCourseTags**](docs/Api/CourseApi.md#deletecoursetags) | **DELETE** /courses/{courseId}/tags | Delete tags for this course
103109
*CourseApi* | [**deleteCourseVersion**](docs/Api/CourseApi.md#deletecourseversion) | **DELETE** /courses/{courseId}/versions/{versionId} | Delete version &#x60;versionId&#x60; of &#x60;courseId&#x60;
104110
*CourseApi* | [**deleteCourseVersionConfigurationSetting**](docs/Api/CourseApi.md#deletecourseversionconfigurationsetting) | **DELETE** /courses/{courseId}/versions/{versionId}/configuration/{settingId} | Clears the &#x60;settingId&#x60; value for this course and version.
105111
*CourseApi* | [**getCourse**](docs/Api/CourseApi.md#getcourse) | **GET** /courses/{courseId} | Get information about &#x60;courseId&#x60;
106112
*CourseApi* | [**getCourseConfiguration**](docs/Api/CourseApi.md#getcourseconfiguration) | **GET** /courses/{courseId}/configuration | Returns all configuration settings for this course
107113
*CourseApi* | [**getCourseStatements**](docs/Api/CourseApi.md#getcoursestatements) | **GET** /courses/{courseId}/xAPIStatements | Get xAPI statements for &#x60;courseId&#x60;
114+
*CourseApi* | [**getCourseTags**](docs/Api/CourseApi.md#getcoursetags) | **GET** /courses/{courseId}/tags | Get the tags for this course
108115
*CourseApi* | [**getCourseVersionConfiguration**](docs/Api/CourseApi.md#getcourseversionconfiguration) | **GET** /courses/{courseId}/versions/{versionId}/configuration | Returns all configuration settings for this course and version.
109116
*CourseApi* | [**getCourseVersionInfo**](docs/Api/CourseApi.md#getcourseversioninfo) | **GET** /courses/{courseId}/versions/{versionId} | Get version &#x60;versionId&#x60; of &#x60;courseId&#x60;
110117
*CourseApi* | [**getCourseVersionStatements**](docs/Api/CourseApi.md#getcourseversionstatements) | **GET** /courses/{courseId}/versions/{versionId}/xAPIStatements | Get xAPI statements for version &#x60;versionId&#x60; of &#x60;courseId&#x60;
111118
*CourseApi* | [**getCourseVersions**](docs/Api/CourseApi.md#getcourseversions) | **GET** /courses/{courseId}/versions | Get all versions of &#x60;courseId&#x60;
112119
*CourseApi* | [**getCourses**](docs/Api/CourseApi.md#getcourses) | **GET** /courses | Get all courses for &#x60;appId&#x60;
113120
*CourseApi* | [**getImportJobStatus**](docs/Api/CourseApi.md#getimportjobstatus) | **GET** /courses/importJobs/{importJobId} | Check the status of an import job.
121+
*CourseApi* | [**putCourseTags**](docs/Api/CourseApi.md#putcoursetags) | **PUT** /courses/{courseId}/tags | Set the tags for this course
122+
*CourseApi* | [**putCourseTagsBatch**](docs/Api/CourseApi.md#putcoursetagsbatch) | **PUT** /courses/tags | Sets all of the provided tags on all of the provided courses
114123
*CourseApi* | [**setCourseConfiguration**](docs/Api/CourseApi.md#setcourseconfiguration) | **POST** /courses/{courseId}/configuration | Set configuration settings for this course.
115124
*CourseApi* | [**setCourseTitle**](docs/Api/CourseApi.md#setcoursetitle) | **PUT** /courses/{courseId}/title | Sets the course title for &#x60;courseId&#x60;
116125
*CourseApi* | [**setCourseVersionConfiguration**](docs/Api/CourseApi.md#setcourseversionconfiguration) | **POST** /courses/{courseId}/versions/{versionId}/configuration | Set configuration settings for this course and version.
@@ -121,6 +130,7 @@ Class | Method | HTTP request | Description
121130
*RegistrationApi* | [**deleteRegistrationConfigurationSetting**](docs/Api/RegistrationApi.md#deleteregistrationconfigurationsetting) | **DELETE** /registrations/{registrationId}/configuration/{settingId} | Clears the &#x60;settingId&#x60; value for this registration
122131
*RegistrationApi* | [**deleteRegistrationInstanceConfigurationSetting**](docs/Api/RegistrationApi.md#deleteregistrationinstanceconfigurationsetting) | **DELETE** /registrations/{registrationId}/instances/{instanceId}/configuration/{settingId} | Clears the &#x60;settingId&#x60; value for this registration instance
123132
*RegistrationApi* | [**deleteRegistrationProgress**](docs/Api/RegistrationApi.md#deleteregistrationprogress) | **DELETE** /registrations/{registrationId}/progress | Delete registration progress (clear registration)
133+
*RegistrationApi* | [**deleteRegistrationTags**](docs/Api/RegistrationApi.md#deleteregistrationtags) | **DELETE** /registrations/{registrationId}/tags | Delete tags for this registration
124134
*RegistrationApi* | [**deleteRegistrationsGlobalData**](docs/Api/RegistrationApi.md#deleteregistrationsglobaldata) | **DELETE** /registrations/{registrationId}/globalData | Delete global data associated with &#x60;registrationId&#x60;
125135
*RegistrationApi* | [**getRegistrationConfiguration**](docs/Api/RegistrationApi.md#getregistrationconfiguration) | **GET** /registrations/{registrationId}/configuration | Returns all configuration settings for this registration
126136
*RegistrationApi* | [**getRegistrationInstanceConfiguration**](docs/Api/RegistrationApi.md#getregistrationinstanceconfiguration) | **GET** /registrations/{registrationId}/instances/{instanceId}/configuration | Returns all configuration settings for this registration instance
@@ -132,7 +142,10 @@ Class | Method | HTTP request | Description
132142
*RegistrationApi* | [**getRegistrationLaunchLink**](docs/Api/RegistrationApi.md#getregistrationlaunchlink) | **POST** /registrations/{registrationId}/launchLink | Returns the link to use to launch this registration
133143
*RegistrationApi* | [**getRegistrationProgress**](docs/Api/RegistrationApi.md#getregistrationprogress) | **GET** /registrations/{registrationId} | Get registration progress for &#x60;registrationId&#x60;
134144
*RegistrationApi* | [**getRegistrationStatements**](docs/Api/RegistrationApi.md#getregistrationstatements) | **GET** /registrations/{registrationId}/xAPIStatements | Get xAPI statements for &#x60;registrationId&#x60;
145+
*RegistrationApi* | [**getRegistrationTags**](docs/Api/RegistrationApi.md#getregistrationtags) | **GET** /registrations/{registrationId}/tags | Get the tags for this registration
135146
*RegistrationApi* | [**getRegistrations**](docs/Api/RegistrationApi.md#getregistrations) | **GET** /registrations | Gets a list of registrations including a summary of the status of each registration.
147+
*RegistrationApi* | [**putRegistrationTags**](docs/Api/RegistrationApi.md#putregistrationtags) | **PUT** /registrations/{registrationId}/tags | Set the tags for this registration
148+
*RegistrationApi* | [**putRegistrationTagsBatch**](docs/Api/RegistrationApi.md#putregistrationtagsbatch) | **PUT** /registrations/tags | Sets all of the provided tags on all of the provided registrations
136149
*RegistrationApi* | [**registrationExists**](docs/Api/RegistrationApi.md#registrationexists) | **HEAD** /registrations/{registrationId} | Does this registration exist?
137150
*RegistrationApi* | [**setRegistrationConfiguration**](docs/Api/RegistrationApi.md#setregistrationconfiguration) | **POST** /registrations/{registrationId}/configuration | Set configuration settings for this registration.
138151
*RegistrationApi* | [**setRegistrationInstanceConfiguration**](docs/Api/RegistrationApi.md#setregistrationinstanceconfiguration) | **POST** /registrations/{registrationId}/instances/{instanceId}/configuration | Set configuration settings for this registration instance.
@@ -151,6 +164,7 @@ Class | Method | HTTP request | Description
151164
- [CourseListSchema](docs/Model/CourseListSchema.md)
152165
- [CourseReferenceSchema](docs/Model/CourseReferenceSchema.md)
153166
- [CourseSchema](docs/Model/CourseSchema.md)
167+
- [CourseTagsBatchSchema](docs/Model/CourseTagsBatchSchema.md)
154168
- [CreateRegistrationSchema](docs/Model/CreateRegistrationSchema.md)
155169
- [CredentialCreatedSchema](docs/Model/CredentialCreatedSchema.md)
156170
- [CredentialListSchema](docs/Model/CredentialListSchema.md)
@@ -178,6 +192,7 @@ Class | Method | HTTP request | Description
178192
- [RegistrationListSchema](docs/Model/RegistrationListSchema.md)
179193
- [RegistrationSchema](docs/Model/RegistrationSchema.md)
180194
- [RegistrationSuccess](docs/Model/RegistrationSuccess.md)
195+
- [RegistrationTagsBatchSchema](docs/Model/RegistrationTagsBatchSchema.md)
181196
- [ResponseError](docs/Model/ResponseError.md)
182197
- [RuntimeInteractionSchema](docs/Model/RuntimeInteractionSchema.md)
183198
- [RuntimeObjectiveSchema](docs/Model/RuntimeObjectiveSchema.md)
@@ -186,14 +201,30 @@ Class | Method | HTTP request | Description
186201
- [SettingItem](docs/Model/SettingItem.md)
187202
- [SettingListSchema](docs/Model/SettingListSchema.md)
188203
- [SettingMetadata](docs/Model/SettingMetadata.md)
189-
- [SettingMetadataValidValues](docs/Model/SettingMetadataValidValues.md)
204+
- [SettingValidValue](docs/Model/SettingValidValue.md)
190205
- [SettingsIndividualSchema](docs/Model/SettingsIndividualSchema.md)
191206
- [SettingsPostSchema](docs/Model/SettingsPostSchema.md)
192207
- [SharedDataEntrySchema](docs/Model/SharedDataEntrySchema.md)
193208
- [StaticPropertiesSchema](docs/Model/StaticPropertiesSchema.md)
194209
- [StringResultSchema](docs/Model/StringResultSchema.md)
210+
- [TagListSchema](docs/Model/TagListSchema.md)
211+
- [TagPostSchema](docs/Model/TagPostSchema.md)
195212
- [TitleSchema](docs/Model/TitleSchema.md)
196213
- [TokenRequestSchema](docs/Model/TokenRequestSchema.md)
214+
- [XapiAccount](docs/Model/XapiAccount.md)
215+
- [XapiActivity](docs/Model/XapiActivity.md)
216+
- [XapiActivityDefinition](docs/Model/XapiActivityDefinition.md)
217+
- [XapiAgentGroup](docs/Model/XapiAgentGroup.md)
218+
- [XapiAttachment](docs/Model/XapiAttachment.md)
219+
- [XapiContext](docs/Model/XapiContext.md)
220+
- [XapiContextActivity](docs/Model/XapiContextActivity.md)
221+
- [XapiInteractionComponent](docs/Model/XapiInteractionComponent.md)
222+
- [XapiResult](docs/Model/XapiResult.md)
223+
- [XapiScore](docs/Model/XapiScore.md)
224+
- [XapiStatement](docs/Model/XapiStatement.md)
225+
- [XapiStatementReference](docs/Model/XapiStatementReference.md)
226+
- [XapiStatementResult](docs/Model/XapiStatementResult.md)
227+
- [XapiVerb](docs/Model/XapiVerb.md)
197228

198229

199230
## Documentation For Authorization
@@ -213,12 +244,6 @@ Class | Method | HTTP request | Description
213244
- **API key parameter name**: launchToken
214245
- **Location**: URL query string
215246

216-
## URL_TOKEN
217-
218-
- **Type**: API key
219-
- **API key parameter name**: authtoken
220-
- **Location**: URL query string
221-
222247
## OAUTH
223248

224249
- **Type**: OAuth
@@ -253,6 +278,12 @@ Class | Method | HTTP request | Description
253278
- **write:appmgmt**: Grants write access to app management methods
254279
- **delete:appmgmt**: Grants deletion access to app management methods
255280

281+
## URL_TOKEN
282+
283+
- **Type**: API key
284+
- **API key parameter name**: authtoken
285+
- **Location**: URL query string
286+
256287

257288
## Author
258289

composer.json

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,24 @@
99
"api"
1010
],
1111
"homepage": "http://swagger.io",
12-
"license": "Apache v2",
12+
"license": "proprietary",
1313
"authors": [
1414
{
1515
"name": "Swagger and contributors",
1616
"homepage": "https://github.com/swagger-api/swagger-codegen"
1717
}
1818
],
1919
"require": {
20-
"php": ">=5.4",
20+
"php": ">=5.5",
2121
"ext-curl": "*",
2222
"ext-json": "*",
23-
"ext-mbstring": "*"
23+
"ext-mbstring": "*",
24+
"guzzlehttp/guzzle": "^6.2"
2425
},
2526
"require-dev": {
26-
"phpunit/phpunit": "~4.8",
27-
"satooshi/php-coveralls": "~1.0",
28-
"squizlabs/php_codesniffer": "~2.6"
27+
"phpunit/phpunit": "^4.8",
28+
"squizlabs/php_codesniffer": "~2.6",
29+
"friendsofphp/php-cs-fixer": "~2.12"
2930
},
3031
"autoload": {
3132
"psr-4": { "RusticiSoftware\\Cloud\\V2\\" : "src/" }

0 commit comments

Comments
 (0)