flat_api 0.2.0 → 0.3.5

data/spec/api/organization_api_spec.rb

@@ -1,12 +1,12 @@
 =begin
 #Flat API
 
-#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following:  * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments.  The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/).  You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference).  Getting Started and learn more:  * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html) 
+#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following:  * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments.  The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/).  You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference).  Getting Started and learn more:  * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html) 
 
-OpenAPI spec version: 2.6.0
+The version of the OpenAPI document: 2.20.0
 Contact: developers@flat.io
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.0-SNAPSHOT
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.3.0
 
 =end
 
@@ -14,12 +14,12 @@ require 'spec_helper'
 require 'json'
 
 # Unit tests for FlatApi::OrganizationApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'OrganizationApi' do
   before do
     # run before each test
-    @instance = FlatApi::OrganizationApi.new
+    @api_instance = FlatApi::OrganizationApi.new
   end
 
   after do
@@ -28,7 +28,21 @@ describe 'OrganizationApi' do
 
   describe 'test an instance of OrganizationApi' do
     it 'should create an instance of OrganizationApi' do
-      expect(@instance).to be_instance_of(FlatApi::OrganizationApi)
+      expect(@api_instance).to be_instance_of(FlatApi::OrganizationApi)
+    end
+  end
+
+  # unit tests for count_orga_users
+  # Count the organization users using the provided filters
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :role Filter users by role
+  # @option opts [String] :q The query to search
+  # @option opts [Array<String>] :group Filter users by group
+  # @option opts [Boolean] :no_active_license Filter users who don&#39;t have an active license
+  # @return [Array<UserDetailsAdmin>]
+  describe 'count_orga_users test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -39,49 +53,71 @@ describe 'OrganizationApi' do
   # @param [Hash] opts the optional parameters
   # @return [LtiCredentials]
   describe 'create_lti_credentials test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for create_organization_invitation
   # Create a new invitation to join the organization
   # This method creates and sends invitation for teachers and admins.  Invitations can only be used by new Flat users or users who are not part of the organization yet.  If the email of the user is already associated to a user of your organization, the API will simply update the role of the existing user and won&#39;t send an invitation. In this case, the property &#x60;usedBy&#x60; will be directly filled with the uniquer identifier of the corresponding user. 
+  # @param body 
   # @param [Hash] opts the optional parameters
-  # @option opts [OrganizationInvitationCreation] :body 
   # @return [OrganizationInvitation]
   describe 'create_organization_invitation test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for create_organization_user
   # Create a new user account
-  # 
+  # @param body 
   # @param [Hash] opts the optional parameters
-  # @option opts [UserCreation] :body 
   # @return [UserDetailsAdmin]
   describe 'create_organization_user test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_organization_user_access_token
+  # Create a delegated API access token for an organization user
+  # This operation will create an API access token for a chosen organization user. This token will be valid for a limited time and can be used to access the API as the organization user. 
+  # @param user Unique identifier of the Flat account 
+  # @param organization_user_access_token_creation 
+  # @param [Hash] opts the optional parameters
+  # @return [ApiAccessToken]
+  describe 'create_organization_user_access_token test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_organization_user_signin_link
+  # Create a sign in link for an organization user
+  # @param user Unique identifier of the Flat account 
+  # @param user_signin_link_creation 
+  # @param [Hash] opts the optional parameters
+  # @return [UserSigninLink]
+  describe 'create_organization_user_signin_link test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for list_lti_credentials
   # List LTI 1.x credentials
-  # 
   # @param [Hash] opts the optional parameters
   # @return [Array<LtiCredentials>]
   describe 'list_lti_credentials test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for list_organization_invitations
   # List the organization invitations
-  # 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :role Filter users by role
   # @option opts [Integer] :limit This is the maximum number of objects that may be returned
@@ -89,35 +125,40 @@ describe 'OrganizationApi' do
   # @option opts [String] :previous An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the &#x60;Link&#x60; header when requesting the API. These URLs will contain a &#x60;next&#x60; and &#x60;previous&#x60; cursor based on the available data. 
   # @return [Array<OrganizationInvitation>]
   describe 'list_organization_invitations test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for list_organization_users
   # List the organization users
-  # 
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :role Filter users by role
-  # @option opts [Integer] :limit This is the maximum number of objects that may be returned
+  # @option opts [Array<String>] :sort The order to sort the user list
+  # @option opts [String] :direction Sort direction
   # @option opts [String] :_next An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the &#x60;Link&#x60; header when requesting the API. These URLs will contain a &#x60;next&#x60; and &#x60;previous&#x60; cursor based on the available data. 
   # @option opts [String] :previous An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the &#x60;Link&#x60; header when requesting the API. These URLs will contain a &#x60;next&#x60; and &#x60;previous&#x60; cursor based on the available data. 
+  # @option opts [Array<String>] :role Filter users by role
+  # @option opts [String] :q The query to search
+  # @option opts [Array<String>] :group Filter users by group
+  # @option opts [Boolean] :no_active_license Filter users who don&#39;t have an active license
+  # @option opts [Array<String>] :license_expiration_date Filter users by license expiration date or &#x60;active&#x60; / &#x60;notActive&#x60;
+  # @option opts [Boolean] :only_ids Return only user ids
+  # @option opts [Integer] :limit This is the maximum number of objects that may be returned
   # @return [Array<UserDetailsAdmin>]
   describe 'list_organization_users test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for remove_organization_invitation
   # Remove an organization invitation
-  # 
   # @param invitation Unique identifier of the invitation
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'remove_organization_invitation test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -126,36 +167,34 @@ describe 'OrganizationApi' do
   # 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) 
   # @param user Unique identifier of the Flat account 
   # @param [Hash] opts the optional parameters
-  # @option opts [BOOLEAN] :convert_to_individual 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. 
+  # @option opts [Boolean] :convert_to_individual 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. 
   # @return [nil]
   describe 'remove_organization_user test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for revoke_lti_credentials
   # Revoke LTI 1.x credentials
-  # 
   # @param credentials Credentials unique identifier 
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'revoke_lti_credentials test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for update_organization_user
   # Update account information
-  # 
   # @param user Unique identifier of the Flat account 
   # @param body 
   # @param [Hash] opts the optional parameters
   # @return [UserDetailsAdmin]
   describe 'update_organization_user test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end