lishogi 0.1.0

data/lib/lishogi/api/users_api.rb

@@ -0,0 +1,677 @@
+=begin
+#Lishogi.org API reference
+
+## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations.  Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](https://discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](https://github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](https://lishogi.org/developers)  ## Endpoint All requests go to `https://lishogi.org` (unless otherwise specified).  ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage.  ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. **nd-json**](http://ndjson.org/), with one JSON object per line.  Here's a [JavaScript utility function (for lichess)](https://gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses. 
+
+The version of the OpenAPI document: 2.0.0
+Contact: contact@lishogi.org
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'cgi'
+
+module Lishogi
+  class UsersApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get crosstable
+    # Get total number of games, and current score, of any two users.  If the `matchup` flag is provided, and the users are currently playing, also gets the current match game number and scores. 
+    # @param user1 [String] 
+    # @param user2 [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :matchup Whether to get the current match data, if any
+    # @return [Object]
+    def api_crosstable(user1, user2, opts = {})
+      data, _status_code, _headers = api_crosstable_with_http_info(user1, user2, opts)
+      data
+    end
+
+    # Get crosstable
+    # Get total number of games, and current score, of any two users.  If the `matchup` flag is provided, and the users are currently playing, also gets the current match game number and scores. 
+    # @param user1 [String] 
+    # @param user2 [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :matchup Whether to get the current match data, if any
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def api_crosstable_with_http_info(user1, user2, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.api_crosstable ...'
+      end
+      # verify the required parameter 'user1' is set
+      if @api_client.config.client_side_validation && user1.nil?
+        fail ArgumentError, "Missing the required parameter 'user1' when calling UsersApi.api_crosstable"
+      end
+      # verify the required parameter 'user2' is set
+      if @api_client.config.client_side_validation && user2.nil?
+        fail ArgumentError, "Missing the required parameter 'user2' when calling UsersApi.api_crosstable"
+      end
+      # resource path
+      local_var_path = '/api/crosstable/{user1}/{user2}'.sub('{' + 'user1' + '}', CGI.escape(user1.to_s)).sub('{' + 'user2' + '}', CGI.escape(user2.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'matchup'] = opts[:'matchup'] if !opts[:'matchup'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.api_crosstable",
+        :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: UsersApi#api_crosstable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get user public data
+    # Read public data of a user. 
+    # @param username [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [UserExtended]
+    def api_user(username, opts = {})
+      data, _status_code, _headers = api_user_with_http_info(username, opts)
+      data
+    end
+
+    # Get user public data
+    # Read public data of a user. 
+    # @param username [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserExtended, Integer, Hash)>] UserExtended data, response status code and response headers
+    def api_user_with_http_info(username, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.api_user ...'
+      end
+      # verify the required parameter 'username' is set
+      if @api_client.config.client_side_validation && username.nil?
+        fail ArgumentError, "Missing the required parameter 'username' when calling UsersApi.api_user"
+      end
+      # resource path
+      local_var_path = '/api/user/{username}'.sub('{' + 'username' + '}', CGI.escape(username.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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UserExtended'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.api_user",
+        :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: UsersApi#api_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get user activity
+    # Read data to generate the activity feed of a user. 
+    # @param username [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def api_user_activity(username, opts = {})
+      api_user_activity_with_http_info(username, opts)
+      nil
+    end
+
+    # Get user activity
+    # Read data to generate the activity feed of a user. 
+    # @param username [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def api_user_activity_with_http_info(username, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.api_user_activity ...'
+      end
+      # verify the required parameter 'username' is set
+      if @api_client.config.client_side_validation && username.nil?
+        fail ArgumentError, "Missing the required parameter 'username' when calling UsersApi.api_user_activity"
+      end
+      # resource path
+      local_var_path = '/api/user/{username}/activity'.sub('{' + 'username' + '}', CGI.escape(username.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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.api_user_activity",
+        :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: UsersApi#api_user_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get rating history of a user
+    # Read rating history of a user, for all perf types. There is at most one entry per day. Format of an entry is `[year, month, day, rating]`. `month` starts at zero (January). 
+    # @param username [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def api_user_rating_history(username, opts = {})
+      data, _status_code, _headers = api_user_rating_history_with_http_info(username, opts)
+      data
+    end
+
+    # Get rating history of a user
+    # Read rating history of a user, for all perf types. There is at most one entry per day. Format of an entry is &#x60;[year, month, day, rating]&#x60;. &#x60;month&#x60; starts at zero (January). 
+    # @param username [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def api_user_rating_history_with_http_info(username, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.api_user_rating_history ...'
+      end
+      # verify the required parameter 'username' is set
+      if @api_client.config.client_side_validation && username.nil?
+        fail ArgumentError, "Missing the required parameter 'username' when calling UsersApi.api_user_rating_history"
+      end
+      # resource path
+      local_var_path = '/api/user/{username}/rating-history'.sub('{' + 'username' + '}', CGI.escape(username.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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.api_user_rating_history",
+        :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: UsersApi#api_user_rating_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get users by ID
+    # Get up to 300 users by their IDs. Users are returned in the same order as the IDs.  The method is `POST` so a longer list of IDs can be sent in the request body. 
+    # @param body [String] User IDs separated by commas.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<User>]
+    def api_users(body, opts = {})
+      data, _status_code, _headers = api_users_with_http_info(body, opts)
+      data
+    end
+
+    # Get users by ID
+    # Get up to 300 users by their IDs. Users are returned in the same order as the IDs.  The method is &#x60;POST&#x60; so a longer list of IDs can be sent in the request body. 
+    # @param body [String] User IDs separated by commas.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<User>, Integer, Hash)>] Array<User> data, response status code and response headers
+    def api_users_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.api_users ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.api_users"
+      end
+      # resource path
+      local_var_path = '/api/users'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['text/plain'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<User>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.api_users",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#api_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get real-time users status
+    # Read the `online`, `playing` and `streaming` flags of several users.  This API is very fast and cheap on lishogi side. So you can call it quite often (like once every 5 seconds).  Use it to track players and know when they're connected on lishogi and playing games. 
+    # @param ids [String] User IDs separated by commas. Up to 100 IDs.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :with_game_ids Also return the ID of the game being played, if any, for each player, in a &#x60;playingId&#x60; field. Defaults to &#x60;false&#x60; to preserve server resources. 
+    # @return [Array<ApiUsersStatus200ResponseInner>]
+    def api_users_status(ids, opts = {})
+      data, _status_code, _headers = api_users_status_with_http_info(ids, opts)
+      data
+    end
+
+    # Get real-time users status
+    # Read the &#x60;online&#x60;, &#x60;playing&#x60; and &#x60;streaming&#x60; flags of several users.  This API is very fast and cheap on lishogi side. So you can call it quite often (like once every 5 seconds).  Use it to track players and know when they&#39;re connected on lishogi and playing games. 
+    # @param ids [String] User IDs separated by commas. Up to 100 IDs.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :with_game_ids Also return the ID of the game being played, if any, for each player, in a &#x60;playingId&#x60; field. Defaults to &#x60;false&#x60; to preserve server resources. 
+    # @return [Array<(Array<ApiUsersStatus200ResponseInner>, Integer, Hash)>] Array<ApiUsersStatus200ResponseInner> data, response status code and response headers
+    def api_users_status_with_http_info(ids, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.api_users_status ...'
+      end
+      # verify the required parameter 'ids' is set
+      if @api_client.config.client_side_validation && ids.nil?
+        fail ArgumentError, "Missing the required parameter 'ids' when calling UsersApi.api_users_status"
+      end
+      # resource path
+      local_var_path = '/api/users/status'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ids'] = ids
+      query_params[:'withGameIds'] = opts[:'with_game_ids'] if !opts[:'with_game_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<ApiUsersStatus200ResponseInner>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.api_users_status",
+        :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: UsersApi#api_users_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all top 10
+    # Get the top 10 players for each speed and variant.  See <https://lishogi.org/player>. 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def player(opts = {})
+      data, _status_code, _headers = player_with_http_info(opts)
+      data
+    end
+
+    # Get all top 10
+    # Get the top 10 players for each speed and variant.  See &lt;https://lishogi.org/player&gt;. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def player_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.player ...'
+      end
+      # resource path
+      local_var_path = '/player'
+
+      # 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/vnd.lishogi.v3+json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.player",
+        :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: UsersApi#player\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get one leaderboard
+    # Get the leaderboard for a single speed or variant (a.k.a. `perfType`). There is no leaderboard for correspondence or puzzles.  See <https://lishogi.org/player/top/200/bullet>. 
+    # @param nb [Integer] How many users to fetch
+    # @param perf_type [String] The speed or variant
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def player_top_nb_perf_type(nb, perf_type, opts = {})
+      data, _status_code, _headers = player_top_nb_perf_type_with_http_info(nb, perf_type, opts)
+      data
+    end
+
+    # Get one leaderboard
+    # Get the leaderboard for a single speed or variant (a.k.a. &#x60;perfType&#x60;). There is no leaderboard for correspondence or puzzles.  See &lt;https://lishogi.org/player/top/200/bullet&gt;. 
+    # @param nb [Integer] How many users to fetch
+    # @param perf_type [String] The speed or variant
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def player_top_nb_perf_type_with_http_info(nb, perf_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.player_top_nb_perf_type ...'
+      end
+      # verify the required parameter 'nb' is set
+      if @api_client.config.client_side_validation && nb.nil?
+        fail ArgumentError, "Missing the required parameter 'nb' when calling UsersApi.player_top_nb_perf_type"
+      end
+      if @api_client.config.client_side_validation && nb > 200
+        fail ArgumentError, 'invalid value for "nb" when calling UsersApi.player_top_nb_perf_type, must be smaller than or equal to 200.'
+      end
+
+      if @api_client.config.client_side_validation && nb < 1
+        fail ArgumentError, 'invalid value for "nb" when calling UsersApi.player_top_nb_perf_type, must be greater than or equal to 1.'
+      end
+
+      # verify the required parameter 'perf_type' is set
+      if @api_client.config.client_side_validation && perf_type.nil?
+        fail ArgumentError, "Missing the required parameter 'perf_type' when calling UsersApi.player_top_nb_perf_type"
+      end
+      # verify enum value
+      allowable_values = ["ultraBullet", "bullet", "blitz", "rapid", "classical", "minishogi", "chushogi", "annanshogi", "kyotoshogi", "checkshogi"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(perf_type)
+        fail ArgumentError, "invalid value for \"perf_type\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/player/top/{nb}/{perfType}'.sub('{' + 'nb' + '}', CGI.escape(nb.to_s)).sub('{' + 'perfType' + '}', CGI.escape(perf_type.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/vnd.lishogi.v3+json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.player_top_nb_perf_type",
+        :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: UsersApi#player_top_nb_perf_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get live streamers
+    # Get basic info about currently streaming users.  This API is very fast and cheap on lishogi side. So you can call it quite often (like once every 5 seconds). 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<LightUser>]
+    def streamer_live(opts = {})
+      data, _status_code, _headers = streamer_live_with_http_info(opts)
+      data
+    end
+
+    # Get live streamers
+    # Get basic info about currently streaming users.  This API is very fast and cheap on lishogi side. So you can call it quite often (like once every 5 seconds). 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<LightUser>, Integer, Hash)>] Array<LightUser> data, response status code and response headers
+    def streamer_live_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.streamer_live ...'
+      end
+      # resource path
+      local_var_path = '/streamer/live'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<LightUser>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.streamer_live",
+        :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: UsersApi#streamer_live\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get members of a team
+    # Members are sorted by reverse chronological order of joining the team (most recent first). OAuth only required if the list of members is private.  Members are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON). 
+    # @param team_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [UserExtended]
+    def team_id_users(team_id, opts = {})
+      data, _status_code, _headers = team_id_users_with_http_info(team_id, opts)
+      data
+    end
+
+    # Get members of a team
+    # Members are sorted by reverse chronological order of joining the team (most recent first). OAuth only required if the list of members is private.  Members are streamed as [ndjson](#section/Introduction/Streaming-with-ND-JSON). 
+    # @param team_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserExtended, Integer, Hash)>] UserExtended data, response status code and response headers
+    def team_id_users_with_http_info(team_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.team_id_users ...'
+      end
+      # verify the required parameter 'team_id' is set
+      if @api_client.config.client_side_validation && team_id.nil?
+        fail ArgumentError, "Missing the required parameter 'team_id' when calling UsersApi.team_id_users"
+      end
+      # resource path
+      local_var_path = '/api/team/{teamId}/users'.sub('{' + 'teamId' + '}', CGI.escape(team_id.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/x-ndjson']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UserExtended'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.team_id_users",
+        :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: UsersApi#team_id_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end