Class: OpenapiClient::AdminApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/admin_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AdminApi

Returns a new instance of AdminApi.



19
20
21
 
# File 'lib/openapi_client/api/admin_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/openapi_client/api/admin_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#admin_revenue_get(opts = {}) ⇒ Array<AdminRevenueGet200ResponseInner>

Revenue by month (admin)

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/openapi_client/api/admin_api.rb', line 25

def admin_revenue_get(opts = {})
  data, _status_code, _headers = admin_revenue_get_with_http_info(opts)
  data
end

#admin_revenue_get_with_http_info(opts = {}) ⇒ Array<(Array<AdminRevenueGet200ResponseInner>, Integer, Hash)>

Revenue by month (admin)

Parameters:

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

    the optional parameters

Returns:

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

    Array<AdminRevenueGet200ResponseInner> data, response status code and response headers



33
34
35
36
37
38
39
40
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
 
# File 'lib/openapi_client/api/admin_api.rb', line 33

def admin_revenue_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.admin_revenue_get ...'
  end
  # resource path
  local_var_path = '/admin/revenue'

  # 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<AdminRevenueGet200ResponseInner>'

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

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

#admin_sdk_update_post(opts = {}) ⇒ nil

Send SDK update notification to users

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


81
82
83
84
 
# File 'lib/openapi_client/api/admin_api.rb', line 81

def admin_sdk_update_post(opts = {})
  admin_sdk_update_post_with_http_info(opts)
  nil
end

#admin_sdk_update_post_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Send SDK update notification to users

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
 
# File 'lib/openapi_client/api/admin_api.rb', line 90

def admin_sdk_update_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.admin_sdk_update_post ...'
  end
  # resource path
  local_var_path = '/admin/sdk-update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  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(opts[:'admin_sdk_update_post_request'])

  # return_type
  return_type = opts[:debug_return_type]

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

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

#admin_stats_get(opts = {}) ⇒ SystemStats

System-wide statistics (admin)

Parameters:

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

    the optional parameters

Returns:



140
141
142
143
 
# File 'lib/openapi_client/api/admin_api.rb', line 140

def admin_stats_get(opts = {})
  data, _status_code, _headers = admin_stats_get_with_http_info(opts)
  data
end

#admin_stats_get_with_http_info(opts = {}) ⇒ Array<(SystemStats, Integer, Hash)>

System-wide statistics (admin)

Parameters:

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

    the optional parameters

Returns:

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

    SystemStats data, response status code and response headers



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/openapi_client/api/admin_api.rb', line 148

def admin_stats_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.admin_stats_get ...'
  end
  # resource path
  local_var_path = '/admin/stats'

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

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

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

#admin_users_get(opts = {}) ⇒ PaginatedUsers

List all users (admin)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)

Returns:



197
198
199
200
 
# File 'lib/openapi_client/api/admin_api.rb', line 197

def admin_users_get(opts = {})
  data, _status_code, _headers = admin_users_get_with_http_info(opts)
  data
end

#admin_users_get_with_http_info(opts = {}) ⇒ Array<(PaginatedUsers, Integer, Hash)>

List all users (admin)

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)

Returns:

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

    PaginatedUsers data, response status code and response headers



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/openapi_client/api/admin_api.rb', line 207

def admin_users_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.admin_users_get ...'
  end
  # resource path
  local_var_path = '/admin/users'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'PaginatedUsers'

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

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

#admin_users_id_get(id, opts = {}) ⇒ nil

Get user details (admin)

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


257
258
259
260
 
# File 'lib/openapi_client/api/admin_api.rb', line 257

def admin_users_id_get(id, opts = {})
  admin_users_id_get_with_http_info(id, opts)
  nil
end

#admin_users_id_get_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get user details (admin)

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/openapi_client/api/admin_api.rb', line 266

def admin_users_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.admin_users_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.admin_users_id_get"
  end
  # resource path
  local_var_path = '/admin/users/{id}'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['BearerAuth']

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

#admin_users_id_plan_put(id, admin_users_id_plan_put_request, opts = {}) ⇒ nil

Change user plan (admin)

Parameters:

  • id (String)
  • admin_users_id_plan_put_request (AdminUsersIdPlanPutRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


317
318
319
320
 
# File 'lib/openapi_client/api/admin_api.rb', line 317

def admin_users_id_plan_put(id, admin_users_id_plan_put_request, opts = {})
  admin_users_id_plan_put_with_http_info(id, admin_users_id_plan_put_request, opts)
  nil
end

#admin_users_id_plan_put_with_http_info(id, admin_users_id_plan_put_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Change user plan (admin)

Parameters:

  • id (String)
  • admin_users_id_plan_put_request (AdminUsersIdPlanPutRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/openapi_client/api/admin_api.rb', line 327

def admin_users_id_plan_put_with_http_info(id, admin_users_id_plan_put_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.admin_users_id_plan_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.admin_users_id_plan_put"
  end
  # verify the required parameter 'admin_users_id_plan_put_request' is set
  if @api_client.config.client_side_validation && admin_users_id_plan_put_request.nil?
    fail ArgumentError, "Missing the required parameter 'admin_users_id_plan_put_request' when calling AdminApi.admin_users_id_plan_put"
  end
  # resource path
  local_var_path = '/admin/users/{id}/plan'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  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(admin_users_id_plan_put_request)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"AdminApi.admin_users_id_plan_put",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#admin_users_id_plan_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#admin_users_id_status_put(id, admin_users_id_status_put_request, opts = {}) ⇒ nil

Change user status (admin)

Parameters:

Returns:

  • (nil) 


387
388
389
390
 
# File 'lib/openapi_client/api/admin_api.rb', line 387

def admin_users_id_status_put(id, admin_users_id_status_put_request, opts = {})
  admin_users_id_status_put_with_http_info(id, admin_users_id_status_put_request, opts)
  nil
end

#admin_users_id_status_put_with_http_info(id, admin_users_id_status_put_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Change user status (admin)

Parameters:

Returns:

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

    nil, response status code and response headers



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/openapi_client/api/admin_api.rb', line 397

def admin_users_id_status_put_with_http_info(id, admin_users_id_status_put_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.admin_users_id_status_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.admin_users_id_status_put"
  end
  # verify the required parameter 'admin_users_id_status_put_request' is set
  if @api_client.config.client_side_validation && admin_users_id_status_put_request.nil?
    fail ArgumentError, "Missing the required parameter 'admin_users_id_status_put_request' when calling AdminApi.admin_users_id_status_put"
  end
  # resource path
  local_var_path = '/admin/users/{id}/status'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  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(admin_users_id_status_put_request)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"AdminApi.admin_users_id_status_put",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#admin_users_id_status_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end