Skip to content

Commit

Permalink
chore: initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
gierschv committed Jan 15, 2018
0 parents commit d03565b
Show file tree
Hide file tree
Showing 334 changed files with 49,828 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Generated by: https://github.com/swagger-api/swagger-codegen.git
#

*.gem
*.rbc
/.config
/coverage/
/InstalledFiles
/pkg/
/spec/reports/
/spec/examples.txt
/test/tmp/
/test/version_tmp/
/tmp/
git_push.sh

## Specific to RubyMotion:
.dat*
.repl_history
build/

## Documentation cache and generated files:
/.yardoc/
/_yardoc/
/doc/
/rdoc/

## Environment normalization:
/.bundle/
/vendor/bundle
/lib/bundler/man/

# for a library or gem, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# Gemfile.lock
# .ruby-version
# .ruby-gemset

# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
.rvmrc
2 changes: 2 additions & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
--color
--require spec_helper
23 changes: 23 additions & 0 deletions .swagger-codegen-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Swagger Codegen Ignore
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
1 change: 1 addition & 0 deletions .swagger-codegen/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2.2.3-SNAPSHOT
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

## 0.1.0

Initial release
7 changes: 7 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
source 'https://rubygems.org'

gemspec

group :development, :test do
gem 'rake', '~> 12.0.0'
end
248 changes: 248 additions & 0 deletions README.md

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
begin
require 'rspec/core/rake_task'

RSpec::Core::RakeTask.new(:spec)
task default: :spec
rescue LoadError
# no rspec available
end
55 changes: 55 additions & 0 deletions docs/AccountApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# FlatApi::AccountApi

All URIs are relative to *https://api.flat.io/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_authenticated_user**](AccountApi.md#get_authenticated_user) | **GET** /me | Get current user profile


# **get_authenticated_user**
> UserDetails get_authenticated_user
Get current user profile

Get details about the current authenticated User.

### Example
```ruby
# load the gem
require 'flat_api'
# setup authorization
FlatApi.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2
config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = FlatApi::AccountApi.new

begin
#Get current user profile
result = api_instance.get_authenticated_user
p result
rescue FlatApi::ApiError => e
puts "Exception when calling AccountApi->get_authenticated_user: #{e}"
end
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**UserDetails**](UserDetails.md)

### Authorization

[OAuth2](../README.md#OAuth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json



18 changes: 18 additions & 0 deletions docs/Assignment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# FlatApi::Assignment

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**state** | **String** | State of the assignment | [optional]
**title** | **String** | Title of the assignment | [optional]
**classroom** | **String** | The unique identifier of the class where this assignment was posted | [optional]
**description** | **String** | Description and content of the assignment | [optional]
**attachments** | [**Array&lt;MediaAttachment&gt;**](MediaAttachment.md) | | [optional]
**submissions** | [**Array&lt;AssignmentSubmission&gt;**](AssignmentSubmission.md) | | [optional]
**creator** | **String** | The User unique identifier of the creator of this assignment | [optional]
**creation_date** | **DateTime** | The creation date of this assignment | [optional]
**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]
**due_date** | **DateTime** | The due date of this assignment, late submissions will be marked as paste due. | [optional]
**google_classroom** | [**GoogleClassroomCoursework**](GoogleClassroomCoursework.md) | | [optional]


8 changes: 8 additions & 0 deletions docs/AssignmentCopy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# FlatApi::AssignmentCopy

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**classroom** | **String** | The destination classroom where the assignment will be copied |


12 changes: 12 additions & 0 deletions docs/AssignmentCreation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# FlatApi::AssignmentCreation

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **String** | Title of the assignment | [optional]
**description** | **String** | Description and content of the assignment | [optional]
**attachments** | [**Array&lt;ClassAttachmentCreation&gt;**](ClassAttachmentCreation.md) | | [optional]
**due_date** | **DateTime** | The due date of this assignment, late submissions will be marked as paste due. If not set, the assignment won&#39;t have a due date. | [optional]
**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]


19 changes: 19 additions & 0 deletions docs/AssignmentSubmission.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# FlatApi::AssignmentSubmission

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | Unique identifier of the submission | [optional]
**classroom** | **String** | Unique identifier of the classroom where the assignment was posted | [optional]
**assignment** | **String** | Unique identifier of the assignment | [optional]
**creator** | **String** | The User identifier of the student who created the submission | [optional]
**creation_date** | **String** | The date when the submission was created | [optional]
**attachments** | [**Array&lt;MediaAttachment&gt;**](MediaAttachment.md) | | [optional]
**submission_date** | **String** | The date when the student submitted his work | [optional]
**student_comment** | **String** | An optionnal comment sent by the student when submitting his work | [optional]
**return_date** | **String** | The date when the teacher returned the work | [optional]
**return_feedback** | **String** | The feedback associated with the return | [optional]
**return_creator** | **String** | The User unique identifier of the teacher who returned the submission | [optional]
**google_classroom** | [**GoogleClassroomSubmission**](GoogleClassroomSubmission.md) | | [optional]


11 changes: 11 additions & 0 deletions docs/AssignmentSubmissionUpdate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# FlatApi::AssignmentSubmissionUpdate

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attachments** | [**Array&lt;ClassAttachmentCreation&gt;**](ClassAttachmentCreation.md) | | [optional]
**student_comment** | **String** | An optionnal comment sent by the student when submitting his work | [optional]
**submit** | **BOOLEAN** | If &#x60;true&#x60;, the submission will be marked as done | [optional]
**return_feedback** | **String** | The feedback associated with the return | [optional]


Loading

0 comments on commit d03565b

Please sign in to comment.