Class: StormgateWorld::LeaderboardsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/stormgate_world/api/leaderboards_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LeaderboardsApi

Returns a new instance of LeaderboardsApi.



19
20
21
 
# File 'lib/stormgate_world/api/leaderboards_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/stormgate_world/api/leaderboards_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_leaderboard(opts = {}) ⇒ LeaderboardResponse

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



29
30
31
32
 
# File 'lib/stormgate_world/api/leaderboards_api.rb', line 29

def get_leaderboard(opts = {})
  data, _status_code, _headers = get_leaderboard_with_http_info(opts)
  data
end

#get_leaderboard_dump(opts = {}) ⇒ LeaderboardDumpResponse

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



101
102
103
104
 
# File 'lib/stormgate_world/api/leaderboards_api.rb', line 101

def get_leaderboard_dump(opts = {})
  data, _status_code, _headers = get_leaderboard_dump_with_http_info(opts)
  data
end

#get_leaderboard_dump_with_http_info(opts = {}) ⇒ Array<(LeaderboardDumpResponse, Integer, Hash)>

Returns LeaderboardDumpResponse data, response status code and response headers.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(LeaderboardDumpResponse, Integer, Hash)>) —

    LeaderboardDumpResponse data, response status code and response headers



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/stormgate_world/api/leaderboards_api.rb', line 109

def get_leaderboard_dump_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeaderboardsApi.get_leaderboard_dump ...'
  end
  # resource path
  local_var_path = '/v0/leaderboards/ranked_1v1/dump'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?

  # 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] || 'LeaderboardDumpResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"LeaderboardsApi.get_leaderboard_dump",
    :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: LeaderboardsApi#get_leaderboard_dump\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_leaderboard_with_http_info(opts = {}) ⇒ Array<(LeaderboardResponse, Integer, Hash)>

Returns LeaderboardResponse data, response status code and response headers.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(LeaderboardResponse, Integer, Hash)>) —

    LeaderboardResponse data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/stormgate_world/api/leaderboards_api.rb', line 41

def get_leaderboard_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LeaderboardsApi.get_leaderboard ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling LeaderboardsApi.get_leaderboard, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 0
    fail ArgumentError, 'invalid value for "opts[:"count"]" when calling LeaderboardsApi.get_leaderboard, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/v0/leaderboards/ranked_1v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'race'] = opts[:'race'] if !opts[:'race'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # 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] || 'LeaderboardResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"LeaderboardsApi.get_leaderboard",
    :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: LeaderboardsApi#get_leaderboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end