flat_api 0.1.2 → 0.3.5

data/lib/flat_api/api/task_api.rb

@@ -0,0 +1,85 @@
+=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 version of the OpenAPI document: 2.20.0
+Contact: developers@flat.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.3.0
+
+=end
+
+require 'cgi'
+
+module FlatApi
+  class TaskApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get a task details
+    # This method can be used to follow a task progression, for example while a score is being exported. 
+    # @param task [String] Unique identifier for the task
+    # @param [Hash] opts the optional parameters
+    # @return [Task]
+    def get_task(task, opts = {})
+      data, _status_code, _headers = get_task_with_http_info(task, opts)
+      data
+    end
+
+    # Get a task details
+    # This method can be used to follow a task progression, for example while a score is being exported. 
+    # @param task [String] Unique identifier for the task
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Task, Integer, Hash)>] Task data, response status code and response headers
+    def get_task_with_http_info(task, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TaskApi.get_task ...'
+      end
+      # verify the required parameter 'task' is set
+      if @api_client.config.client_side_validation && task.nil?
+        fail ArgumentError, "Missing the required parameter 'task' when calling TaskApi.get_task"
+      end
+      # resource path
+      local_var_path = '/tasks/{task}'.sub('{' + 'task' + '}', CGI.escape(task.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Task'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"TaskApi.get_task",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TaskApi#get_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/flat_api/api/user_api.rb

@@ -1,16 +1,16 @@
 =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.5.2
+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
 
-require "uri"
+require 'cgi'
 
 module FlatApi
   class UserApi
@@ -19,172 +19,210 @@ module FlatApi
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-
-    # List liked scores
-    # 
-    # @param user Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. 
+    # Get a public user profile
+    # Get a profile of a Flat or Flat for Education User. 
+    # @param user [String] This route parameter is the unique identifier of the user. You can specify an email instead of an unique identifier. If you are executing this request authenticated, you can use `me` as a value instead of the current User unique identifier to work on the current authenticated user. 
     # @param [Hash] opts the optional parameters
-    # @option opts [BOOLEAN] :ids Return only the identifiers of the scores
-    # @return [Array<ScoreDetails>]
-    def ger_user_likes(user, opts = {})
-      data, _status_code, _headers = ger_user_likes_with_http_info(user, opts)
-      return data
+    # @return [UserPublic]
+    def get_user(user, opts = {})
+      data, _status_code, _headers = get_user_with_http_info(user, opts)
+      data
     end
 
-    # List liked scores
-    # 
-    # @param user Unique identifier of a Flat user. If you authenticated, you can use &#x60;me&#x60; to refer to the current user. 
+    # Get a public user profile
+    # Get a profile of a Flat or Flat for Education User. 
+    # @param user [String] This route parameter is the unique identifier of the user. You can specify an email instead of an unique identifier. If you are executing this request authenticated, you can use &#x60;me&#x60; as a value instead of the current User unique identifier to work on the current authenticated user. 
     # @param [Hash] opts the optional parameters
-    # @option opts [BOOLEAN] :ids Return only the identifiers of the scores
-    # @return [Array<(Array<ScoreDetails>, Fixnum, Hash)>] Array<ScoreDetails> data, response status code and response headers
-    def ger_user_likes_with_http_info(user, opts = {})
+    # @return [Array<(UserPublic, Integer, Hash)>] UserPublic data, response status code and response headers
+    def get_user_with_http_info(user, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: UserApi.ger_user_likes ..."
+        @api_client.config.logger.debug 'Calling API: UserApi.get_user ...'
       end
       # verify the required parameter 'user' is set
       if @api_client.config.client_side_validation && user.nil?
-        fail ArgumentError, "Missing the required parameter 'user' when calling UserApi.ger_user_likes"
+        fail ArgumentError, "Missing the required parameter 'user' when calling UserApi.get_user"
       end
       # resource path
-      local_var_path = "/users/{user}/likes".sub('{' + 'user' + '}', user.to_s)
+      local_var_path = '/users/{user}'.sub('{' + 'user' + '}', CGI.escape(user.to_s))
 
       # query parameters
-      query_params = {}
-      query_params[:'ids'] = opts[:'ids'] if !opts[:'ids'].nil?
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['OAuth2']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UserPublic'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"UserApi.get_user",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Array<ScoreDetails>')
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: UserApi#ger_user_likes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: UserApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get a public user profile
-    # Get a public profile of a Flat User. 
-    # @param user This route parameter is the unique identifier of the user. You can specify an email instead of an unique identifier. If you are executing this request authenticated, you can use &#x60;me&#x60; as a value instead of the current User unique identifier to work on the current authenticated user. 
+    # List liked scores
+    # @param user [String] Unique identifier of a Flat user. If you authenticated, you can use &#x60;me&#x60; to refer to the current user. 
     # @param [Hash] opts the optional parameters
-    # @return [UserPublic]
-    def get_user(user, opts = {})
-      data, _status_code, _headers = get_user_with_http_info(user, opts)
-      return data
+    # @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 [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
+    # @option opts [Boolean] :ids Return only the identifiers of the scores
+    # @return [Array<ScoreDetails>]
+    def get_user_likes(user, opts = {})
+      data, _status_code, _headers = get_user_likes_with_http_info(user, opts)
+      data
     end
 
-    # Get a public user profile
-    # Get a public profile of a Flat User. 
-    # @param user This route parameter is the unique identifier of the user. You can specify an email instead of an unique identifier. If you are executing this request authenticated, you can use &#x60;me&#x60; as a value instead of the current User unique identifier to work on the current authenticated user. 
+    # List liked scores
+    # @param user [String] Unique identifier of a Flat user. If you authenticated, you can use &#x60;me&#x60; to refer to the current user. 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(UserPublic, Fixnum, Hash)>] UserPublic data, response status code and response headers
-    def get_user_with_http_info(user, opts = {})
+    # @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 [Integer] :limit This is the maximum number of objects that may be returned (default to 25)
+    # @option opts [Boolean] :ids Return only the identifiers of the scores
+    # @return [Array<(Array<ScoreDetails>, Integer, Hash)>] Array<ScoreDetails> data, response status code and response headers
+    def get_user_likes_with_http_info(user, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: UserApi.get_user ..."
+        @api_client.config.logger.debug 'Calling API: UserApi.get_user_likes ...'
       end
       # verify the required parameter 'user' is set
       if @api_client.config.client_side_validation && user.nil?
-        fail ArgumentError, "Missing the required parameter 'user' when calling UserApi.get_user"
+        fail ArgumentError, "Missing the required parameter 'user' when calling UserApi.get_user_likes"
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UserApi.get_user_likes, must be smaller than or equal to 100.'
       end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UserApi.get_user_likes, must be greater than or equal to 1.'
+      end
+
       # resource path
-      local_var_path = "/users/{user}".sub('{' + 'user' + '}', user.to_s)
+      local_var_path = '/users/{user}/likes'.sub('{' + 'user' + '}', CGI.escape(user.to_s))
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
+      query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil?
+      query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'ids'] = opts[:'ids'] if !opts[:'ids'].nil?
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['OAuth2']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<ScoreDetails>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"UserApi.get_user_likes",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'UserPublic')
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: UserApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: UserApi#get_user_likes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # List user's scores
-    # Get the list of scores owned by the User 
-    # @param user Unique identifier of a Flat user. If you authenticated, you can use &#x60;me&#x60; to refer to the current user. 
+    # Get the list of public scores owned by a User.  **DEPRECATED**: Please note that the current behavior will be deprecrated on **2019-01-01**. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the [Collections API](#tag/Collection) instead. 
+    # @param user [String] Unique identifier of a Flat user. If you authenticated, you can use &#x60;me&#x60; to refer to the current user. 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :parent Filter the score forked from the score id &#x60;parent&#x60;
     # @return [Array<ScoreDetails>]
     def get_user_scores(user, opts = {})
       data, _status_code, _headers = get_user_scores_with_http_info(user, opts)
-      return data
+      data
     end
 
     # List user&#39;s scores
-    # Get the list of scores owned by the User 
-    # @param user Unique identifier of a Flat user. If you authenticated, you can use &#x60;me&#x60; to refer to the current user. 
+    # Get the list of public scores owned by a User.  **DEPRECATED**: Please note that the current behavior will be deprecrated on **2019-01-01**. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the [Collections API](#tag/Collection) instead. 
+    # @param user [String] Unique identifier of a Flat user. If you authenticated, you can use &#x60;me&#x60; to refer to the current user. 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :parent Filter the score forked from the score id &#x60;parent&#x60;
-    # @return [Array<(Array<ScoreDetails>, Fixnum, Hash)>] Array<ScoreDetails> data, response status code and response headers
+    # @return [Array<(Array<ScoreDetails>, Integer, Hash)>] Array<ScoreDetails> data, response status code and response headers
     def get_user_scores_with_http_info(user, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: UserApi.get_user_scores ..."
+        @api_client.config.logger.debug 'Calling API: UserApi.get_user_scores ...'
       end
       # verify the required parameter 'user' is set
       if @api_client.config.client_side_validation && user.nil?
         fail ArgumentError, "Missing the required parameter 'user' when calling UserApi.get_user_scores"
       end
       # resource path
-      local_var_path = "/users/{user}/scores".sub('{' + 'user' + '}', user.to_s)
+      local_var_path = '/users/{user}/scores'.sub('{' + 'user' + '}', CGI.escape(user.to_s))
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
       query_params[:'parent'] = opts[:'parent'] if !opts[:'parent'].nil?
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['OAuth2']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<ScoreDetails>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"UserApi.get_user_scores",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Array<ScoreDetails>')
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: UserApi#get_user_scores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end