feat(client): Update to API specification v2.3

Author: gierschv

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.6.0
+
+* feat(user): Add profile theme and instruments played.
+* feat(edu): Add new cursor-based pagination for `GET /v2/organizations/users` and `GET /v2/organizations/invitations`.
+* feat(edu): Add new methods:
+  * `PUT /v2/organizations/users/{user}`: Admin endpoint to update managed accounts.
+  * `DELETE /v2/organizations/users/{user}`: Admin endpoint to delete or convert edu accounts to consumer accounts.
+* feat(edu): Classes have a new state `inactive` that can be activated using the new method `POST /v2/classes/{class}/activate`.
+* feat(edu): Assignments have a new state `draft` and can have a new attachment type `exercise`.
+* feat(edu): Return Canvas LMS Instance domain in classes details
+* feat(edu): Return Clever.com section information in classes details
+
 ## 0.5.0
 
 * feat(edu): Public release of the first education APIs:

README.md

@@ -83,6 +83,7 @@ All URIs are relative to *https://api.flat.io/v2*
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *AccountApi* | [**getAuthenticatedUser**](docs/Api/AccountApi.md#getauthenticateduser) | **GET** /me | Get current user profile
+*ClassApi* | [**activateClass**](docs/Api/ClassApi.md#activateclass) | **POST** /classes/{class}/activate | Activate the class
 *ClassApi* | [**addClassUser**](docs/Api/ClassApi.md#addclassuser) | **PUT** /classes/{class}/users/{user} | Add a user to the class
 *ClassApi* | [**archiveClass**](docs/Api/ClassApi.md#archiveclass) | **POST** /classes/{class}/archive | Archive the class
 *ClassApi* | [**copyAssignment**](docs/Api/ClassApi.md#copyassignment) | **POST** /classes/{class}/assignments/{assignment}/copy | Copy an assignment
@@ -111,7 +112,9 @@ Class | Method | HTTP request | Description
 *OrganizationApi* | [**listOrganizationInvitations**](docs/Api/OrganizationApi.md#listorganizationinvitations) | **GET** /organizations/invitations | List the organization invitations
 *OrganizationApi* | [**listOrganizationUsers**](docs/Api/OrganizationApi.md#listorganizationusers) | **GET** /organizations/users | List the organization users
 *OrganizationApi* | [**removeOrganizationInvitation**](docs/Api/OrganizationApi.md#removeorganizationinvitation) | **DELETE** /organizations/invitations/{invitation} | Remove an organization invitation
+*OrganizationApi* | [**removeOrganizationUser**](docs/Api/OrganizationApi.md#removeorganizationuser) | **DELETE** /organizations/users/{user} | Remove an account from Flat
 *OrganizationApi* | [**revokeLtiCredentials**](docs/Api/OrganizationApi.md#revokelticredentials) | **DELETE** /organizations/lti/credentials/{credentials} | Revoke LTI 1.x credentials
+*OrganizationApi* | [**updateOrganizationUser**](docs/Api/OrganizationApi.md#updateorganizationuser) | **PUT** /organizations/users/{user} | Update account information
 *ScoreApi* | [**addScoreCollaborator**](docs/Api/ScoreApi.md#addscorecollaborator) | **POST** /scores/{score}/collaborators | Add a new collaborator
 *ScoreApi* | [**createScore**](docs/Api/ScoreApi.md#createscore) | **POST** /scores | Create a new score
 *ScoreApi* | [**createScoreRevision**](docs/Api/ScoreApi.md#createscorerevision) | **POST** /scores/{score}/revisions | Create a new revision
@@ -151,12 +154,12 @@ Class | Method | HTTP request | Description
  - [ClassCreation](docs/Model/ClassCreation.md)
  - [ClassDetails](docs/Model/ClassDetails.md)
  - [ClassDetailsCanvas](docs/Model/ClassDetailsCanvas.md)
+ - [ClassDetailsClever](docs/Model/ClassDetailsClever.md)
  - [ClassDetailsGoogleClassroom](docs/Model/ClassDetailsGoogleClassroom.md)
  - [ClassDetailsGoogleDrive](docs/Model/ClassDetailsGoogleDrive.md)
  - [ClassDetailsLti](docs/Model/ClassDetailsLti.md)
  - [ClassRoles](docs/Model/ClassRoles.md)
  - [ClassState](docs/Model/ClassState.md)
- - [ClassStreamPostMode](docs/Model/ClassStreamPostMode.md)
  - [ClassUpdate](docs/Model/ClassUpdate.md)
  - [FlatErrorResponse](docs/Model/FlatErrorResponse.md)
  - [FlatLocales](docs/Model/FlatLocales.md)
@@ -196,9 +199,11 @@ Class | Method | HTTP request | Description
  - [ScoreSource](docs/Model/ScoreSource.md)
  - [ScoreSummary](docs/Model/ScoreSummary.md)
  - [ScoreViewsCounts](docs/Model/ScoreViewsCounts.md)
+ - [UserAdminUpdate](docs/Model/UserAdminUpdate.md)
  - [UserBasics](docs/Model/UserBasics.md)
  - [UserCreation](docs/Model/UserCreation.md)
  - [UserDetailsAdminLicense](docs/Model/UserDetailsAdminLicense.md)
+ - [UserInstruments](docs/Model/UserInstruments.md)
  - [ScoreDetails](docs/Model/ScoreDetails.md)
  - [UserPublicSummary](docs/Model/UserPublicSummary.md)
  - [UserDetailsAdmin](docs/Model/UserDetailsAdmin.md)

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "flat/api",
-    "version": "0.5.0",
+    "version": "0.6.0",
     "description": "PHP client for the Flat REST API",
     "keywords": [
         "Music",

docs/Api/ClassApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://api.flat.io/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**activateClass**](ClassApi.md#activateClass) | **POST** /classes/{class}/activate | Activate the class
 [**addClassUser**](ClassApi.md#addClassUser) | **PUT** /classes/{class}/users/{user} | Add a user to the class
 [**archiveClass**](ClassApi.md#archiveClass) | **POST** /classes/{class}/archive | Archive the class
 [**copyAssignment**](ClassApi.md#copyAssignment) | **POST** /classes/{class}/assignments/{assignment}/copy | Copy an assignment
@@ -24,6 +25,54 @@ Method | HTTP request | Description
 [**updateClass**](ClassApi.md#updateClass) | **PUT** /classes/{class} | Update the class
 
 
+# **activateClass**
+> \Flat\APIClient\Model\ClassDetails activateClass($class)
+
+Activate the class
+
+Mark the class as `active`. This is mainly used for classes synchronized from Clever that are initially with an `inactive` state and hidden in the UI.
+
+### Example
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure OAuth2 access token for authorization: OAuth2
+Flat\APIClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
+
+$api_instance = new Flat\APIClient\Api\ClassApi();
+$class = "class_example"; // string | Unique identifier of the class
+
+try {
+    $result = $api_instance->activateClass($class);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling ClassApi->activateClass: ', $e->getMessage(), PHP_EOL;
+}
+?>
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **class** | **string**| Unique identifier of the class |
+
+### Return type
+
+[**\Flat\APIClient\Model\ClassDetails**](../Model/ClassDetails.md)
+
+### Authorization
+
+[OAuth2](../../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
+
 # **addClassUser**
 > addClassUser($class, $user)
 

docs/Api/OrganizationApi.md

@@ -11,7 +11,9 @@ Method | HTTP request | Description
 [**listOrganizationInvitations**](OrganizationApi.md#listOrganizationInvitations) | **GET** /organizations/invitations | List the organization invitations
 [**listOrganizationUsers**](OrganizationApi.md#listOrganizationUsers) | **GET** /organizations/users | List the organization users
 [**removeOrganizationInvitation**](OrganizationApi.md#removeOrganizationInvitation) | **DELETE** /organizations/invitations/{invitation} | Remove an organization invitation
+[**removeOrganizationUser**](OrganizationApi.md#removeOrganizationUser) | **DELETE** /organizations/users/{user} | Remove an account from Flat
 [**revokeLtiCredentials**](OrganizationApi.md#revokeLtiCredentials) | **DELETE** /organizations/lti/credentials/{credentials} | Revoke LTI 1.x credentials
+[**updateOrganizationUser**](OrganizationApi.md#updateOrganizationUser) | **PUT** /organizations/users/{user} | Update account information
 
 
 # **createLtiCredentials**
@@ -199,7 +201,7 @@ This endpoint does not need any parameter.
 [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
 
 # **listOrganizationInvitations**
-> \Flat\APIClient\Model\OrganizationInvitation[] listOrganizationInvitations($role, $limit, $offset)
+> \Flat\APIClient\Model\OrganizationInvitation[] listOrganizationInvitations($role, $limit, $next, $previous)
 
 List the organization invitations
 
@@ -213,11 +215,12 @@ Flat\APIClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_AC
 
 $api_instance = new Flat\APIClient\Api\OrganizationApi();
 $role = "role_example"; // string | Filter users by role
-$limit = 100; // int | This is the maximum number of objects that may be returned
-$offset = 0; // int | This offsets the start of each page by the number specified
+$limit = 50; // int | This is the maximum number of objects that may be returned
+$next = "next_example"; // string | An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.
+$previous = "previous_example"; // string | An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.
 
 try {
-    $result = $api_instance->listOrganizationInvitations($role, $limit, $offset);
+    $result = $api_instance->listOrganizationInvitations($role, $limit, $next, $previous);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling OrganizationApi->listOrganizationInvitations: ', $e->getMessage(), PHP_EOL;
@@ -230,8 +233,9 @@ try {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **role** | **string**| Filter users by role | [optional]
- **limit** | **int**| This is the maximum number of objects that may be returned | [optional] [default to 100]
- **offset** | **int**| This offsets the start of each page by the number specified | [optional] [default to 0]
+ **limit** | **int**| This is the maximum number of objects that may be returned | [optional] [default to 50]
+ **next** | **string**| An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. | [optional]
+ **previous** | **string**| An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. | [optional]
 
 ### Return type
 
@@ -249,7 +253,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
 
 # **listOrganizationUsers**
-> \Flat\APIClient\Model\UserDetailsAdmin[] listOrganizationUsers($role, $limit, $offset)
+> \Flat\APIClient\Model\UserDetailsAdmin[] listOrganizationUsers($role, $limit, $next, $previous)
 
 List the organization users
 
@@ -263,11 +267,12 @@ Flat\APIClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_AC
 
 $api_instance = new Flat\APIClient\Api\OrganizationApi();
 $role = "role_example"; // string | Filter users by role
-$limit = 100; // int | This is the maximum number of objects that may be returned
-$offset = 0; // int | This offsets the start of each page by the number specified
+$limit = 50; // int | This is the maximum number of objects that may be returned
+$next = "next_example"; // string | An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.
+$previous = "previous_example"; // string | An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data.
 
 try {
-    $result = $api_instance->listOrganizationUsers($role, $limit, $offset);
+    $result = $api_instance->listOrganizationUsers($role, $limit, $next, $previous);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling OrganizationApi->listOrganizationUsers: ', $e->getMessage(), PHP_EOL;
@@ -280,8 +285,9 @@ try {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **role** | **string**| Filter users by role | [optional]
- **limit** | **int**| This is the maximum number of objects that may be returned | [optional] [default to 100]
- **offset** | **int**| This offsets the start of each page by the number specified | [optional] [default to 0]
+ **limit** | **int**| This is the maximum number of objects that may be returned | [optional] [default to 50]
+ **next** | **string**| An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. | [optional]
+ **previous** | **string**| An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. | [optional]
 
 ### Return type
 
@@ -343,6 +349,55 @@ void (empty response body)
 
 [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
 
+# **removeOrganizationUser**
+> removeOrganizationUser($user, $convertToIndividual)
+
+Remove an account from Flat
+
+This operation removes an account from Flat and its data, including: * The music scores created by this user (documents, history, comments, collaboration information) * Education related data (assignments and classroom information)
+
+### Example
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure OAuth2 access token for authorization: OAuth2
+Flat\APIClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
+
+$api_instance = new Flat\APIClient\Api\OrganizationApi();
+$user = "user_example"; // string | Unique identifier of the Flat account
+$convertToIndividual = true; // bool | If `true`, the account will be only removed from the organization and converted into an individual account on our public website, https://flat.io. This operation will remove the education-related data from the account. Before realizing this operation, you need to be sure that the user is at least 13 years old and that this one has read and agreed to the Individual Terms of Services of Flat available on https://flat.io/legal.
+
+try {
+    $api_instance->removeOrganizationUser($user, $convertToIndividual);
+} catch (Exception $e) {
+    echo 'Exception when calling OrganizationApi->removeOrganizationUser: ', $e->getMessage(), PHP_EOL;
+}
+?>
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user** | **string**| Unique identifier of the Flat account |
+ **convertToIndividual** | **bool**| If &#x60;true&#x60;, the account will be only removed from the organization and converted into an individual account on our public website, https://flat.io. This operation will remove the education-related data from the account. Before realizing this operation, you need to be sure that the user is at least 13 years old and that this one has read and agreed to the Individual Terms of Services of Flat available on https://flat.io/legal. | [optional]
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2](../../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
+
 # **revokeLtiCredentials**
 > revokeLtiCredentials($credentials)
 
@@ -388,3 +443,51 @@ void (empty response body)
 
 [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
 
+# **updateOrganizationUser**
+> \Flat\APIClient\Model\UserDetailsAdmin updateOrganizationUser($user, $body)
+
+Update account information
+
+### Example
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Configure OAuth2 access token for authorization: OAuth2
+Flat\APIClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
+
+$api_instance = new Flat\APIClient\Api\OrganizationApi();
+$user = "user_example"; // string | Unique identifier of the Flat account
+$body = new \Flat\APIClient\Model\UserAdminUpdate(); // \Flat\APIClient\Model\UserAdminUpdate | 
+
+try {
+    $result = $api_instance->updateOrganizationUser($user, $body);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling OrganizationApi->updateOrganizationUser: ', $e->getMessage(), PHP_EOL;
+}
+?>
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user** | **string**| Unique identifier of the Flat account |
+ **body** | [**\Flat\APIClient\Model\UserAdminUpdate**](../Model/UserAdminUpdate.md)|  |
+
+### Return type
+
+[**\Flat\APIClient\Model\UserDetailsAdmin**](../Model/UserDetailsAdmin.md)
+
+### Authorization
+
+[OAuth2](../../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
+

docs/Model/ClassDetails.md

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **googleDrive** | [**\Flat\APIClient\Model\ClassDetailsGoogleDrive**](ClassDetailsGoogleDrive.md) |  | [optional] 
 **lti** | [**\Flat\APIClient\Model\ClassDetailsLti**](ClassDetailsLti.md) |  | [optional] 
 **canvas** | [**\Flat\APIClient\Model\ClassDetailsCanvas**](ClassDetailsCanvas.md) |  | [optional] 
+**clever** | [**\Flat\APIClient\Model\ClassDetailsClever**](ClassDetailsClever.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/Model/ClassDetailsCanvas.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **string** | Unique identifier of the course on Canvas | [optional] 
+**domain** | **string** | Canvas instance domain (e.g. \"canvas.instructure.com\") | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)