Skip to content

Commit ac6e2cf

Browse files
gierschvgierschv
committed
feat(client): Update to API specification v2.3
1 parent 0ad8c69 commit ac6e2cf

File tree

149 files changed

+15381
-1017
lines changed

Some content is hidden

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

149 files changed

+15381
-1017
lines changed

‎.swagger-codegen-ignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Swagger Codegen Ignore
2-
README.md
32
.gitignore
43
.travis.yml
54
git_push.sh
5+
setup.py

‎CHANGELOG.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
# Changelog
22

3+
## 0.3.0
4+
5+
* feat(edu): Public release of the first education APIs:
6+
* `/v2/classes`: Classes management
7+
* `/v2/classes/{class}/assignments`: Flat Assignments and Submissions
8+
* `/v2/organizations/users`: Organization accounts management
9+
* `/v2/organizations/invitations`: Organization invitations for admins and teachers
10+
* `/v2/organizations/lti/credentials`: LTI credentials management
11+
* `/v2/groups/{group}` and `/groups/{group}/users`: List of groups and users part of groups
12+
* `/scores/{score}/submissions`: Submissions linked to a score
13+
* feat(edu): New OAuth2 scopes:
14+
* `edu.classes`: Full, permissive scope to manage the classes.
15+
* `edu.classes.readonly`: Read-only access to the classes.
16+
* `edu.assignments`: Read-write access to the assignments and submissions.
17+
* `edu.assignments.readonly`: Read-only access to the assignments and submissions.
18+
* `edu.admin`: Full, permissive scope to manage all the admin of an organization.
19+
* `edu.admin.lti`: Access and manage the LTI Credentials for an organization.
20+
* `edu.admin.lti.readonly`: Read-only access to the LTI Credentials of an organization.
21+
* `edu.admin.users`: Access and manage the users and invitations of the organization.
22+
* `edu.admin.users.readonly`: Read-only access to the users and invitations of the organization.
23+
* fix(spec): Add missing scopes in specification for `GET /scores/{score}/revisions/{revision}` and `GET /scores/{score}/revisions/{revision}/{format}`
24+
325
## 0.2.0
426

527
* feat(scores): add support of private links sharing with `sharingKey`.

‎README.md‎

Lines changed: 70 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,35 @@ All URIs are relative to *https://api.flat.io/v2*
7979
Class | Method | HTTP request | Description
8080
------------ | ------------- | ------------- | -------------
8181
*AccountApi* | [**get_authenticated_user**](docs/AccountApi.md#get_authenticated_user) | **GET** /me | Get current user profile
82+
*ClassApi* | [**add_class_user**](docs/ClassApi.md#add_class_user) | **PUT** /classes/{class}/users/{user} | Add a user to the class
83+
*ClassApi* | [**archive_class**](docs/ClassApi.md#archive_class) | **POST** /classes/{class}/archive | Archive the class
84+
*ClassApi* | [**copy_assignment**](docs/ClassApi.md#copy_assignment) | **POST** /classes/{class}/assignments/{assignment}/copy | Copy an assignment
85+
*ClassApi* | [**create_assignment**](docs/ClassApi.md#create_assignment) | **POST** /classes/{class}/assignments | Assignment creation
86+
*ClassApi* | [**create_class**](docs/ClassApi.md#create_class) | **POST** /classes | Create a new class
87+
*ClassApi* | [**create_submission**](docs/ClassApi.md#create_submission) | **PUT** /classes/{class}/assignments/{assignment}/submissions | Create or edit a submission
88+
*ClassApi* | [**delete_class_user**](docs/ClassApi.md#delete_class_user) | **DELETE** /classes/{class}/users/{user} | Remove a user from the class
89+
*ClassApi* | [**edit_submission**](docs/ClassApi.md#edit_submission) | **PUT** /classes/{class}/assignments/{assignment}/submissions/{submission} | Edit a submission
90+
*ClassApi* | [**enroll_class**](docs/ClassApi.md#enroll_class) | **POST** /classes/enroll/{enrollmentCode} | Join a class
91+
*ClassApi* | [**get_class**](docs/ClassApi.md#get_class) | **GET** /classes/{class} | Get the details of a single class
92+
*ClassApi* | [**get_score_submissions**](docs/ClassApi.md#get_score_submissions) | **GET** /scores/{score}/submissions | List submissions related to the score
93+
*ClassApi* | [**get_submission**](docs/ClassApi.md#get_submission) | **GET** /classes/{class}/assignments/{assignment}/submissions/{submission} | Get a student submission
94+
*ClassApi* | [**get_submissions**](docs/ClassApi.md#get_submissions) | **GET** /classes/{class}/assignments/{assignment}/submissions | List the students' submissions
95+
*ClassApi* | [**list_assignments**](docs/ClassApi.md#list_assignments) | **GET** /classes/{class}/assignments | Assignments listing
96+
*ClassApi* | [**list_class_student_submissions**](docs/ClassApi.md#list_class_student_submissions) | **GET** /classes/{class}/students/{user}/submissions | List the submissions for a student
97+
*ClassApi* | [**list_classes**](docs/ClassApi.md#list_classes) | **GET** /classes | List the classes available for the current user
98+
*ClassApi* | [**unarchive_class**](docs/ClassApi.md#unarchive_class) | **DELETE** /classes/{class}/archive | Unarchive the class
99+
*ClassApi* | [**update_class**](docs/ClassApi.md#update_class) | **PUT** /classes/{class} | Update the class
100+
*GroupApi* | [**get_group_details**](docs/GroupApi.md#get_group_details) | **GET** /groups/{group} | Get group information
82101
*GroupApi* | [**get_group_scores**](docs/GroupApi.md#get_group_scores) | **GET** /groups/{group}/scores | List group's scores
102+
*GroupApi* | [**list_group_users**](docs/GroupApi.md#list_group_users) | **GET** /groups/{group}/users | List group's users
103+
*OrganizationApi* | [**create_lti_credentials**](docs/OrganizationApi.md#create_lti_credentials) | **POST** /organizations/lti/credentials | Create a new couple of LTI 1.x credentials
104+
*OrganizationApi* | [**create_organization_invitation**](docs/OrganizationApi.md#create_organization_invitation) | **POST** /organizations/invitations | Create a new invitation to join the organization
105+
*OrganizationApi* | [**create_organization_user**](docs/OrganizationApi.md#create_organization_user) | **POST** /organizations/users | Create a new user account
106+
*OrganizationApi* | [**list_lti_credentials**](docs/OrganizationApi.md#list_lti_credentials) | **GET** /organizations/lti/credentials | List LTI 1.x credentials
107+
*OrganizationApi* | [**list_organization_invitations**](docs/OrganizationApi.md#list_organization_invitations) | **GET** /organizations/invitations | List the organization invitations
108+
*OrganizationApi* | [**list_organization_users**](docs/OrganizationApi.md#list_organization_users) | **GET** /organizations/users | List the organization users
109+
*OrganizationApi* | [**remove_organization_invitation**](docs/OrganizationApi.md#remove_organization_invitation) | **DELETE** /organizations/invitations/{invitation} | Remove an organization invitation
110+
*OrganizationApi* | [**revoke_lti_credentials**](docs/OrganizationApi.md#revoke_lti_credentials) | **DELETE** /organizations/lti/credentials/{credentials} | Revoke LTI 1.x credentials
83111
*ScoreApi* | [**add_score_collaborator**](docs/ScoreApi.md#add_score_collaborator) | **POST** /scores/{score}/collaborators | Add a new collaborator
84112
*ScoreApi* | [**create_score**](docs/ScoreApi.md#create_score) | **POST** /scores | Create a new score
85113
*ScoreApi* | [**create_score_revision**](docs/ScoreApi.md#create_score_revision) | **POST** /scores/{score}/revisions | Create a new revision
@@ -96,6 +124,7 @@ Class | Method | HTTP request | Description
96124
*ScoreApi* | [**get_score_revision**](docs/ScoreApi.md#get_score_revision) | **GET** /scores/{score}/revisions/{revision} | Get a score revision
97125
*ScoreApi* | [**get_score_revision_data**](docs/ScoreApi.md#get_score_revision_data) | **GET** /scores/{score}/revisions/{revision}/{format} | Get a score revision data
98126
*ScoreApi* | [**get_score_revisions**](docs/ScoreApi.md#get_score_revisions) | **GET** /scores/{score}/revisions | List the revisions
127+
*ScoreApi* | [**get_score_submissions**](docs/ScoreApi.md#get_score_submissions) | **GET** /scores/{score}/submissions | List submissions related to the score
99128
*ScoreApi* | [**get_user_scores**](docs/ScoreApi.md#get_user_scores) | **GET** /users/{user}/scores | List user's scores
100129
*ScoreApi* | [**mark_score_comment_resolved**](docs/ScoreApi.md#mark_score_comment_resolved) | **PUT** /scores/{score}/comments/{comment}/resolved | Mark the comment as resolved
101130
*ScoreApi* | [**mark_score_comment_unresolved**](docs/ScoreApi.md#mark_score_comment_unresolved) | **DELETE** /scores/{score}/comments/{comment}/resolved | Mark the comment as unresolved
@@ -109,10 +138,38 @@ Class | Method | HTTP request | Description
109138

110139
## Documentation For Models
111140

141+
- [Assignment](docs/Assignment.md)
142+
- [AssignmentCopy](docs/AssignmentCopy.md)
143+
- [AssignmentCreation](docs/AssignmentCreation.md)
144+
- [AssignmentSubmission](docs/AssignmentSubmission.md)
145+
- [AssignmentSubmissionUpdate](docs/AssignmentSubmissionUpdate.md)
146+
- [ClassAttachmentCreation](docs/ClassAttachmentCreation.md)
147+
- [ClassCreation](docs/ClassCreation.md)
148+
- [ClassDetails](docs/ClassDetails.md)
149+
- [ClassDetailsCanvas](docs/ClassDetailsCanvas.md)
150+
- [ClassDetailsGoogleClassroom](docs/ClassDetailsGoogleClassroom.md)
151+
- [ClassDetailsGoogleDrive](docs/ClassDetailsGoogleDrive.md)
152+
- [ClassDetailsLti](docs/ClassDetailsLti.md)
112153
- [ClassRoles](docs/ClassRoles.md)
154+
- [ClassState](docs/ClassState.md)
155+
- [ClassStreamPostMode](docs/ClassStreamPostMode.md)
156+
- [ClassUpdate](docs/ClassUpdate.md)
113157
- [FlatErrorResponse](docs/FlatErrorResponse.md)
114158
- [FlatLocales](docs/FlatLocales.md)
159+
- [GoogleClassroomCoursework](docs/GoogleClassroomCoursework.md)
160+
- [GoogleClassroomSubmission](docs/GoogleClassroomSubmission.md)
115161
- [Group](docs/Group.md)
162+
- [GroupDetails](docs/GroupDetails.md)
163+
- [GroupType](docs/GroupType.md)
164+
- [LicenseMode](docs/LicenseMode.md)
165+
- [LicenseSources](docs/LicenseSources.md)
166+
- [LmsName](docs/LmsName.md)
167+
- [LtiCredentials](docs/LtiCredentials.md)
168+
- [LtiCredentialsCreation](docs/LtiCredentialsCreation.md)
169+
- [MediaAttachment](docs/MediaAttachment.md)
170+
- [MediaScoreSharingMode](docs/MediaScoreSharingMode.md)
171+
- [OrganizationInvitation](docs/OrganizationInvitation.md)
172+
- [OrganizationInvitationCreation](docs/OrganizationInvitationCreation.md)
116173
- [OrganizationRoles](docs/OrganizationRoles.md)
117174
- [ScoreCollaborator](docs/ScoreCollaborator.md)
118175
- [ScoreCollaboratorCreation](docs/ScoreCollaboratorCreation.md)
@@ -137,11 +194,13 @@ Class | Method | HTTP request | Description
137194
- [ScoreSummary](docs/ScoreSummary.md)
138195
- [ScoreViewsCounts](docs/ScoreViewsCounts.md)
139196
- [UserBasics](docs/UserBasics.md)
197+
- [UserCreation](docs/UserCreation.md)
140198
- [UserDetails](docs/UserDetails.md)
199+
- [UserDetailsAdmin](docs/UserDetailsAdmin.md)
200+
- [UserDetailsAdminLicense](docs/UserDetailsAdminLicense.md)
141201
- [UserPublic](docs/UserPublic.md)
142202
- [UserPublicSummary](docs/UserPublicSummary.md)
143203

144-
145204
## OAuth2
146205

147206
- **Type**: OAuth
@@ -153,8 +212,17 @@ Class | Method | HTTP request | Description
153212
- **scores.readonly**: Allows read-only access to all a user's scores. You won't need this scope to read public scores.
154213
- **scores.social**: Allow to post comments and like scores
155214
- **scores**: Full, permissive scope to access all of a user's scores.
215+
- **edu.classes**: Full, permissive scope to manage the classes.
216+
- **edu.classes.readonly**: Read-only access to the classes.
217+
- **edu.assignments**: Read-write access to the assignments and submissions.
218+
- **edu.assignments.readonly**: Read-only access to the assignments and submissions.
219+
- **edu.admin**: Full, permissive scope to manage all the admin of an organization.
220+
- **edu.admin.lti**: Access and manage the LTI Credentials for an organization.
221+
- **edu.admin.lti.readonly**: Read-only access to the LTI Credentials of an organization.
222+
- **edu.admin.users**: Access and manage the users and invitations of the organization.
223+
- **edu.admin.users.readonly**: Read-only access to the users and invitations of the organization.
156224

157225

158226
## Author
159227

160-
Flat - developers@flat.io
228+
developers@flat.io

‎docs/AccountApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Get details about the current authenticated User.
1616

1717
### Example
1818
```python
19-
from __future__ import print_statement
19+
from __future__ import print_function
2020
import time
2121
import flat_api
2222
from flat_api.rest import ApiException

‎docs/Assignment.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Assignment
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**state** | **str** | State of the assignment | [optional]
7+
**title** | **str** | Title of the assignment | [optional]
8+
**classroom** | **str** | The unique identifier of the class where this assignment was posted | [optional]
9+
**description** | **str** | Description and content of the assignment | [optional]
10+
**attachments** | [**list[MediaAttachment]**](MediaAttachment.md) | | [optional]
11+
**submissions** | [**list[AssignmentSubmission]**](AssignmentSubmission.md) | | [optional]
12+
**creator** | **str** | The User unique identifier of the creator of this assignment | [optional]
13+
**creation_date** | **datetime** | The creation date of this assignment | [optional]
14+
**scheduled_date** | **datetime** | The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class. | [optional]
15+
**due_date** | **datetime** | The due date of this assignment, late submissions will be marked as paste due. | [optional]
16+
**google_classroom** | [**GoogleClassroomCoursework**](GoogleClassroomCoursework.md) | | [optional]
17+
18+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
19+
20+

‎docs/AssignmentCopy.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# AssignmentCopy
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**classroom** | **str** | The destination classroom where the assignment will be copied |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/AssignmentCreation.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# AssignmentCreation
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**title** | **str** | Title of the assignment | [optional]
7+
**description** | **str** | Description and content of the assignment | [optional]
8+
**attachments** | [**list[ClassAttachmentCreation]**](ClassAttachmentCreation.md) | | [optional]
9+
**due_date** | **datetime** | The due date of this assignment, late submissions will be marked as paste due. If not set, the assignment won't have a due date. | [optional]
10+
**scheduled_date** | **datetime** | The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class. | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

‎docs/AssignmentSubmission.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# AssignmentSubmission
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **str** | Unique identifier of the submission | [optional]
7+
**classroom** | **str** | Unique identifier of the classroom where the assignment was posted | [optional]
8+
**assignment** | **str** | Unique identifier of the assignment | [optional]
9+
**creator** | **str** | The User identifier of the student who created the submission | [optional]
10+
**creation_date** | **str** | The date when the submission was created | [optional]
11+
**attachments** | [**list[MediaAttachment]**](MediaAttachment.md) | | [optional]
12+
**submission_date** | **str** | The date when the student submitted his work | [optional]
13+
**student_comment** | **str** | An optionnal comment sent by the student when submitting his work | [optional]
14+
**return_date** | **str** | The date when the teacher returned the work | [optional]
15+
**return_feedback** | **str** | The feedback associated with the return | [optional]
16+
**return_creator** | **str** | The User unique identifier of the teacher who returned the submission | [optional]
17+
**google_classroom** | [**GoogleClassroomSubmission**](GoogleClassroomSubmission.md) | | [optional]
18+
19+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
20+
21+

‎docs/AssignmentSubmissionUpdate.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# AssignmentSubmissionUpdate
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**attachments** | [**list[ClassAttachmentCreation]**](ClassAttachmentCreation.md) | | [optional]
7+
**student_comment** | **str** | An optionnal comment sent by the student when submitting his work | [optional]
8+
**submit** | **bool** | If `true`, the submission will be marked as done | [optional]
9+
**return_feedback** | **str** | The feedback associated with the return | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

0 commit comments

Comments
 (0)