flat_api 0.3.5 → 1.0.0

data/lib/flat_api/api/edu_resources_api.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, 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) 
+#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, MuseScore, ABC notation, and many other formats * 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) 
 
-The version of the OpenAPI document: 2.20.0
+The version of the OpenAPI document: 2.26.1
 Contact: developers@flat.io
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.24.0
 
 =end
 
@@ -47,7 +47,7 @@ module FlatApi
         fail ArgumentError, "Missing the required parameter 'edu_resource_copy' when calling EduResourcesApi.copy_edu_resource"
       end
       # resource path
-      local_var_path = '/eduResources/{resource}/copy'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
+      local_var_path = '/eduResources/{resource}/copy'.sub('{resource}', CGI.escape(resource.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -55,7 +55,7 @@ module FlatApi
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
       content_type = @api_client.select_header_content_type(['application/json'])
       if !content_type.nil?
@@ -115,7 +115,7 @@ module FlatApi
         fail ArgumentError, "Missing the required parameter 'resource' when calling EduResourcesApi.copy_edu_resource_to_demo_class"
       end
       # resource path
-      local_var_path = '/eduResources/{resource}/copyToDemoClass'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
+      local_var_path = '/eduResources/{resource}/copyToDemoClass'.sub('{resource}', CGI.escape(resource.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -123,7 +123,7 @@ module FlatApi
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -184,7 +184,7 @@ module FlatApi
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
       content_type = @api_client.select_header_content_type(['application/json'])
       if !content_type.nil?
@@ -244,7 +244,7 @@ module FlatApi
         fail ArgumentError, "Missing the required parameter 'resource' when calling EduResourcesApi.create_edu_resource_lti_link"
       end
       # resource path
-      local_var_path = '/eduResources/{resource}/createLtiLink'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
+      local_var_path = '/eduResources/{resource}/createLtiLink'.sub('{resource}', CGI.escape(resource.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -252,7 +252,7 @@ module FlatApi
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -305,7 +305,7 @@ module FlatApi
         fail ArgumentError, "Missing the required parameter 'resource' when calling EduResourcesApi.delete_edu_resource"
       end
       # resource path
-      local_var_path = '/eduResources/{resource}'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
+      local_var_path = '/eduResources/{resource}'.sub('{resource}', CGI.escape(resource.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -313,7 +313,7 @@ module FlatApi
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -366,7 +366,7 @@ module FlatApi
         fail ArgumentError, "Missing the required parameter 'resource' when calling EduResourcesApi.get_edu_resource"
       end
       # resource path
-      local_var_path = '/eduResources/{resource}'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
+      local_var_path = '/eduResources/{resource}'.sub('{resource}', CGI.escape(resource.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -374,7 +374,7 @@ module FlatApi
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -429,7 +429,7 @@ module FlatApi
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -462,8 +462,12 @@ module FlatApi
 
     # List education resources in a library or folder
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :parent List the resources contained in this `parent` library or folder  (default to 'root')
+    # @option opts [String] :parent List the resources contained in this `parent` library or folder.  Accepts a folder identifier, or the identifier of one of the libraries returned by [`listEduLibraries`](#tag/EduResources/operation/listEduLibraries). Which libraries are available depends on the account, so use the `id` values that endpoint returns rather than hardcoding this list:  * `root`: the user's own resources * `organization`: resources shared with the organization  (default to 'root')
+    # @option opts [Boolean] :without_subfolders_resources For the `parent` = `organization`, do not include resources from subfolders. By default in the Resource Library UI, we include resources from subfolders, but for example in a picker like LTI, we don't want to include them. 
     # @option opts [String] :type Filter the returned resources by type 
+    # @option opts [Array<TeachingTheme>] :subjects Filter the returned resources by subjects 
+    # @option opts [Array<AssignmentType>] :assignment_types Filter the returned resources by assignment types 
+    # @option opts [Array<Grade>] :grades Filter the returned resources by grades 
     # @option opts [String] :sort Sort (default to 'creationDate')
     # @option opts [String] :direction Sort direction
     # @option opts [Integer] :limit This is the maximum number of resources that may be returned (default to 25)
@@ -477,8 +481,12 @@ module FlatApi
 
     # List education resources in a library or folder
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :parent List the resources contained in this &#x60;parent&#x60; library or folder  (default to 'root')
+    # @option opts [String] :parent List the resources contained in this &#x60;parent&#x60; library or folder.  Accepts a folder identifier, or the identifier of one of the libraries returned by [&#x60;listEduLibraries&#x60;](#tag/EduResources/operation/listEduLibraries). Which libraries are available depends on the account, so use the &#x60;id&#x60; values that endpoint returns rather than hardcoding this list:  * &#x60;root&#x60;: the user&#39;s own resources * &#x60;organization&#x60;: resources shared with the organization  (default to 'root')
+    # @option opts [Boolean] :without_subfolders_resources For the &#x60;parent&#x60; &#x3D; &#x60;organization&#x60;, do not include resources from subfolders. By default in the Resource Library UI, we include resources from subfolders, but for example in a picker like LTI, we don&#39;t want to include them. 
     # @option opts [String] :type Filter the returned resources by type 
+    # @option opts [Array<TeachingTheme>] :subjects Filter the returned resources by subjects 
+    # @option opts [Array<AssignmentType>] :assignment_types Filter the returned resources by assignment types 
+    # @option opts [Array<Grade>] :grades Filter the returned resources by grades 
     # @option opts [String] :sort Sort (default to 'creationDate')
     # @option opts [String] :direction Sort direction
     # @option opts [Integer] :limit This is the maximum number of resources that may be returned (default to 25)
@@ -515,7 +523,11 @@ module FlatApi
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'parent'] = opts[:'parent'] if !opts[:'parent'].nil?
+      query_params[:'withoutSubfoldersResources'] = opts[:'without_subfolders_resources'] if !opts[:'without_subfolders_resources'].nil?
       query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+      query_params[:'subjects'] = @api_client.build_collection_param(opts[:'subjects'], :multi) if !opts[:'subjects'].nil?
+      query_params[:'assignmentTypes'] = @api_client.build_collection_param(opts[:'assignment_types'], :multi) if !opts[:'assignment_types'].nil?
+      query_params[:'grades'] = @api_client.build_collection_param(opts[:'grades'], :multi) if !opts[:'grades'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
       query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
@@ -525,7 +537,7 @@ module FlatApi
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -584,7 +596,7 @@ module FlatApi
         fail ArgumentError, "Missing the required parameter 'edu_resource_move' when calling EduResourcesApi.move_edu_resource"
       end
       # resource path
-      local_var_path = '/eduResources/{resource}/move'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
+      local_var_path = '/eduResources/{resource}/move'.sub('{resource}', CGI.escape(resource.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -592,7 +604,7 @@ module FlatApi
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
       content_type = @api_client.select_header_content_type(['application/json'])
       if !content_type.nil?
@@ -658,7 +670,7 @@ module FlatApi
         fail ArgumentError, "Missing the required parameter 'edu_resource_update' when calling EduResourcesApi.update_edu_resource"
       end
       # resource path
-      local_var_path = '/eduResources/{resource}'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
+      local_var_path = '/eduResources/{resource}'.sub('{resource}', CGI.escape(resource.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -666,7 +678,7 @@ module FlatApi
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
       content_type = @api_client.select_header_content_type(['application/json'])
       if !content_type.nil?
@@ -730,7 +742,7 @@ module FlatApi
         fail ArgumentError, "Missing the required parameter 'assignment_update' when calling EduResourcesApi.update_edu_resource_assignment"
       end
       # resource path
-      local_var_path = '/eduResources/{resource}/assignment'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
+      local_var_path = '/eduResources/{resource}/assignment'.sub('{resource}', CGI.escape(resource.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -738,7 +750,7 @@ module FlatApi
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
       content_type = @api_client.select_header_content_type(['application/json'])
       if !content_type.nil?
@@ -804,7 +816,7 @@ module FlatApi
         fail ArgumentError, "Missing the required parameter 'edu_resource_use_in_class' when calling EduResourcesApi.use_edu_resource_in_class"
       end
       # resource path
-      local_var_path = '/eduResources/{resource}/useInClass'.sub('{' + 'resource' + '}', CGI.escape(resource.to_s))
+      local_var_path = '/eduResources/{resource}/useInClass'.sub('{resource}', CGI.escape(resource.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -812,7 +824,7 @@ module FlatApi
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
       content_type = @api_client.select_header_content_type(['application/json'])
       if !content_type.nil?