Class: IndexeaClient::AppsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/indexea_client/api/apps_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AppsApi

Returns a new instance of AppsApi.



16
17
18
# File 'lib/indexea_client/api/apps_api.rb', line 16

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



14
15
16
# File 'lib/indexea_client/api/apps_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#app_add_mentor(app, account, scopes, opts = {}) ⇒ MentorForm

添加应用成员

Parameters:

  • app

    应用标识

  • account

    成员账号

  • scopes

    权限

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

    the optional parameters

Options Hash (opts):

  • :name (String)

    备注名称

Returns:



26
27
28
29
# File 'lib/indexea_client/api/apps_api.rb', line 26

def app_add_mentor(app, , scopes, opts = {})
  data, _status_code, _headers = app_add_mentor_with_http_info(app, , scopes, opts)
  data
end

#app_add_mentor_with_http_info(app, account, scopes, opts = {}) ⇒ Array<(MentorForm, Integer, Hash)>

添加应用成员

Parameters:

  • app

    应用标识

  • account

    成员账号

  • scopes

    权限

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

    the optional parameters

Options Hash (opts):

  • :name (String)

    备注名称

Returns:

  • (Array<(MentorForm, Integer, Hash)>)

    MentorForm data, response status code and response headers



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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/indexea_client/api/apps_api.rb', line 38

def app_add_mentor_with_http_info(app, , scopes, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_add_mentor ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_add_mentor"
  end
  # verify the required parameter 'account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account' when calling AppsApi.app_add_mentor"
  end
  # verify the required parameter 'scopes' is set
  if @api_client.config.client_side_validation && scopes.nil?
    fail ArgumentError, "Missing the required parameter 'scopes' when calling AppsApi.app_add_mentor"
  end
  # resource path
  local_var_path = '/apps/{app}/mentors'.sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account'] = 
  query_params[:'scopes'] = scopes
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].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[:body] 

  return_type = opts[:return_type] || 'MentorForm' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_add_mentor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_blacklist(app, opts = {}) ⇒ BlacklistBean

获取黑名单信息

Parameters:

  • app

    应用标识

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

    the optional parameters

Returns:



94
95
96
97
# File 'lib/indexea_client/api/apps_api.rb', line 94

def app_blacklist(app, opts = {})
  data, _status_code, _headers = app_blacklist_with_http_info(app, opts)
  data
end

#app_blacklist_with_http_info(app, opts = {}) ⇒ Array<(BlacklistBean, Integer, Hash)>

获取黑名单信息

Parameters:

  • app

    应用标识

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

    the optional parameters

Returns:

  • (Array<(BlacklistBean, Integer, Hash)>)

    BlacklistBean data, response status code and response headers



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
136
137
138
139
140
141
142
143
# File 'lib/indexea_client/api/apps_api.rb', line 103

def app_blacklist_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_blacklist ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_blacklist"
  end
  # resource path
  local_var_path = '/apps/{app}/blacklist'.sub('{' + 'app' + '}', app.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[:body] 

  return_type = opts[:return_type] || 'BlacklistBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_blacklist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_create(opts = {}) ⇒ AppBean

创建应用

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String)
  • :intro (String)

Returns:



149
150
151
152
# File 'lib/indexea_client/api/apps_api.rb', line 149

def app_create(opts = {})
  data, _status_code, _headers = app_create_with_http_info(opts)
  data
end

#app_create_access_token(body, app, opts = {}) ⇒ TokenBean

创建 Access Token

Parameters:

  • body
  • app

    应用标识

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

    the optional parameters

Returns:



205
206
207
208
# File 'lib/indexea_client/api/apps_api.rb', line 205

def app_create_access_token(body, app, opts = {})
  data, _status_code, _headers = app_create_access_token_with_http_info(body, app, opts)
  data
end

#app_create_access_token_with_http_info(body, app, opts = {}) ⇒ Array<(TokenBean, Integer, Hash)>

创建 Access Token

Parameters:

  • body
  • app

    应用标识

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

    the optional parameters

Returns:

  • (Array<(TokenBean, Integer, Hash)>)

    TokenBean data, response status code and response headers



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
252
253
254
255
256
257
258
259
260
261
# File 'lib/indexea_client/api/apps_api.rb', line 215

def app_create_access_token_with_http_info(body, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_create_access_token ...'
  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 AppsApi.app_create_access_token"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_create_access_token"
  end
  # resource path
  local_var_path = '/apps/{app}/tokens'.sub('{' + 'app' + '}', app.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'TokenBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_create_access_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_create_oauth_app(body, app, opts = {}) ⇒ OauthAppBean

创建第三方应用

Parameters:

  • body
  • app

    应用标识

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

    the optional parameters

Returns:



267
268
269
270
# File 'lib/indexea_client/api/apps_api.rb', line 267

def app_create_oauth_app(body, app, opts = {})
  data, _status_code, _headers = app_create_oauth_app_with_http_info(body, app, opts)
  data
end

#app_create_oauth_app_with_http_info(body, app, opts = {}) ⇒ Array<(OauthAppBean, Integer, Hash)>

创建第三方应用

Parameters:

  • body
  • app

    应用标识

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

    the optional parameters

Returns:

  • (Array<(OauthAppBean, Integer, Hash)>)

    OauthAppBean data, response status code and response headers



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
311
312
313
314
315
316
317
318
319
320
321
322
323
# File 'lib/indexea_client/api/apps_api.rb', line 277

def app_create_oauth_app_with_http_info(body, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_create_oauth_app ...'
  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 AppsApi.app_create_oauth_app"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_create_oauth_app"
  end
  # resource path
  local_var_path = '/apps/{app}/oauth'.sub('{' + 'app' + '}', app.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'OauthAppBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_create_oauth_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_create_with_http_info(opts = {}) ⇒ Array<(AppBean, Integer, Hash)>

创建应用

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String)
  • :intro (String)

Returns:

  • (Array<(AppBean, Integer, Hash)>)

    AppBean data, response status code and response headers



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
191
192
193
194
195
196
197
198
199
# File 'lib/indexea_client/api/apps_api.rb', line 159

def app_create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_create ...'
  end
  # resource path
  local_var_path = '/apps'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['intro'] = opts[:'intro'] if !opts[:'intro'].nil?

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'AppBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_delete(app, opts = {}) ⇒ BOOLEAN

删除应用

Parameters:

  • app

    应用标识

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

    the optional parameters

Returns:

  • (BOOLEAN)


328
329
330
331
# File 'lib/indexea_client/api/apps_api.rb', line 328

def app_delete(app, opts = {})
  data, _status_code, _headers = app_delete_with_http_info(app, opts)
  data
end

#app_delete_access_token(id, app, opts = {}) ⇒ BOOLEAN

删除 Access Token

Parameters:

  • id

    Access Token 编号

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :vcode (String)

Returns:

  • (BOOLEAN)


384
385
386
387
# File 'lib/indexea_client/api/apps_api.rb', line 384

def app_delete_access_token(id, app, opts = {})
  data, _status_code, _headers = app_delete_access_token_with_http_info(id, app, opts)
  data
end

#app_delete_access_token_with_http_info(id, app, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

删除 Access Token

Parameters:

  • id

    Access Token 编号

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :vcode (String)

Returns:

  • (Array<(BOOLEAN, Integer, Hash)>)

    BOOLEAN data, response status code and response headers



395
396
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
# File 'lib/indexea_client/api/apps_api.rb', line 395

def app_delete_access_token_with_http_info(id, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_delete_access_token ...'
  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 AppsApi.app_delete_access_token"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_delete_access_token"
  end
  # resource path
  local_var_path = '/apps/{app}/tokens'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  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/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['vcode'] = opts[:'vcode'] if !opts[:'vcode'].nil?

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_delete_access_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_delete_mentor(app, account, opts = {}) ⇒ BOOLEAN

删除应用成员

Parameters:

  • app

    应用标识

  • account

    成员编号

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

    the optional parameters

Returns:

  • (BOOLEAN)


449
450
451
452
# File 'lib/indexea_client/api/apps_api.rb', line 449

def app_delete_mentor(app, , opts = {})
  data, _status_code, _headers = app_delete_mentor_with_http_info(app, , opts)
  data
end

#app_delete_mentor_with_http_info(app, account, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

删除应用成员

Parameters:

  • app

    应用标识

  • account

    成员编号

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

    the optional parameters

Returns:

  • (Array<(BOOLEAN, Integer, Hash)>)

    BOOLEAN data, response status code and response headers



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
# File 'lib/indexea_client/api/apps_api.rb', line 459

def app_delete_mentor_with_http_info(app, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_delete_mentor ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_delete_mentor"
  end
  # verify the required parameter 'account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account' when calling AppsApi.app_delete_mentor"
  end
  # resource path
  local_var_path = '/apps/{app}/mentors'.sub('{' + 'app' + '}', app.to_s)

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

  # 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[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_delete_mentor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_delete_oauth_app(ident, app, opts = {}) ⇒ BOOLEAN

删除第三方应用

Parameters:

  • ident

    三方应用编号

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :vcode (String)

Returns:

  • (BOOLEAN)


511
512
513
514
# File 'lib/indexea_client/api/apps_api.rb', line 511

def app_delete_oauth_app(ident, app, opts = {})
  data, _status_code, _headers = app_delete_oauth_app_with_http_info(ident, app, opts)
  data
end

#app_delete_oauth_app_with_http_info(ident, app, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

删除第三方应用

Parameters:

  • ident

    三方应用编号

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :vcode (String)

Returns:

  • (Array<(BOOLEAN, Integer, Hash)>)

    BOOLEAN data, response status code and response headers



522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'lib/indexea_client/api/apps_api.rb', line 522

def app_delete_oauth_app_with_http_info(ident, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_delete_oauth_app ...'
  end
  # verify the required parameter 'ident' is set
  if @api_client.config.client_side_validation && ident.nil?
    fail ArgumentError, "Missing the required parameter 'ident' when calling AppsApi.app_delete_oauth_app"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_delete_oauth_app"
  end
  # resource path
  local_var_path = '/apps/{app}/oauth'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  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/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['vcode'] = opts[:'vcode'] if !opts[:'vcode'].nil?

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_delete_oauth_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_delete_with_http_info(app, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

删除应用

Parameters:

  • app

    应用标识

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

    the optional parameters

Returns:

  • (Array<(BOOLEAN, Integer, Hash)>)

    BOOLEAN data, response status code and response headers



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
# File 'lib/indexea_client/api/apps_api.rb', line 337

def app_delete_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_delete ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_delete"
  end
  # resource path
  local_var_path = '/apps/{app}'.sub('{' + 'app' + '}', app.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[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_excel_of_logs(app, opts = {}) ⇒ String

导出应用日志到 Excel

Parameters:

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :account (Integer)

    账号 (default to 0)

  • :indices (Array<Integer>)

    索引

  • :widget (Integer)

    组件 (default to 0)

  • :query (Integer)

    查询 (default to 0)

  • :type (Integer)

    类型 (default to 0)

  • :start_date (Date)

    起始日期

  • :end_date (Date)

    结束日期

Returns:

  • (String)


582
583
584
585
# File 'lib/indexea_client/api/apps_api.rb', line 582

def app_excel_of_logs(app, opts = {})
  data, _status_code, _headers = app_excel_of_logs_with_http_info(app, opts)
  data
end

#app_excel_of_logs_with_http_info(app, opts = {}) ⇒ Array<(String, Integer, Hash)>

导出应用日志到 Excel

Parameters:

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :account (Integer)

    账号

  • :indices (Array<Integer>)

    索引

  • :widget (Integer)

    组件

  • :query (Integer)

    查询

  • :type (Integer)

    类型

  • :start_date (Date)

    起始日期

  • :end_date (Date)

    结束日期

Returns:

  • (Array<(String, Integer, Hash)>)

    String data, response status code and response headers



598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
# File 'lib/indexea_client/api/apps_api.rb', line 598

def app_excel_of_logs_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_excel_of_logs ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_excel_of_logs"
  end
  # resource path
  local_var_path = '/apps/{app}/logs'.sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account'] = opts[:'account'] if !opts[:'account'].nil?
  query_params[:'indices'] = @api_client.build_collection_param(opts[:'indices'], :multi) if !opts[:'indices'].nil?
  query_params[:'widget'] = opts[:'widget'] if !opts[:'widget'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'String' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_excel_of_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_get(app, opts = {}) ⇒ AppBean

获取应用详情

Parameters:

  • app

    应用标识

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

    the optional parameters

Returns:



650
651
652
653
# File 'lib/indexea_client/api/apps_api.rb', line 650

def app_get(app, opts = {})
  data, _status_code, _headers = app_get_with_http_info(app, opts)
  data
end

#app_get_company(app, opts = {}) ⇒ CompanyBean

获取应用填写的公司信息

Parameters:

  • app

    应用标识

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

    the optional parameters

Returns:



704
705
706
707
# File 'lib/indexea_client/api/apps_api.rb', line 704

def app_get_company(app, opts = {})
  data, _status_code, _headers = app_get_company_with_http_info(app, opts)
  data
end

#app_get_company_pic(app, type, opts = {}) ⇒ String

获取公司营业执照或者一般纳税人证明

Parameters:

  • app

    应用标识

  • type

    获取图片的类型 [license,certificate]

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

    the optional parameters

Returns:

  • (String)


759
760
761
762
# File 'lib/indexea_client/api/apps_api.rb', line 759

def app_get_company_pic(app, type, opts = {})
  data, _status_code, _headers = app_get_company_pic_with_http_info(app, type, opts)
  data
end

#app_get_company_pic_with_http_info(app, type, opts = {}) ⇒ Array<(String, Integer, Hash)>

获取公司营业执照或者一般纳税人证明

Parameters:

  • app

    应用标识

  • type

    获取图片的类型 [license,certificate]

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>)

    String data, response status code and response headers



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
# File 'lib/indexea_client/api/apps_api.rb', line 769

def app_get_company_pic_with_http_info(app, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_get_company_pic ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_get_company_pic"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling AppsApi.app_get_company_pic"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['license', 'certificate'].include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of license, certificate"
  end
  # resource path
  local_var_path = '/apps/{app}/company'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['default'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'String' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_get_company_pic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_get_company_with_http_info(app, opts = {}) ⇒ Array<(CompanyBean, Integer, Hash)>

获取应用填写的公司信息

Parameters:

  • app

    应用标识

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

    the optional parameters

Returns:

  • (Array<(CompanyBean, Integer, Hash)>)

    CompanyBean data, response status code and response headers



713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
# File 'lib/indexea_client/api/apps_api.rb', line 713

def app_get_company_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_get_company ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_get_company"
  end
  # resource path
  local_var_path = '/apps/{app}/company'.sub('{' + 'app' + '}', app.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[:body] 

  return_type = opts[:return_type] || 'CompanyBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_get_company\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_get_with_http_info(app, opts = {}) ⇒ Array<(AppBean, Integer, Hash)>

获取应用详情

Parameters:

  • app

    应用标识

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

    the optional parameters

Returns:

  • (Array<(AppBean, Integer, Hash)>)

    AppBean data, response status code and response headers



659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'lib/indexea_client/api/apps_api.rb', line 659

def app_get_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_get ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_get"
  end
  # resource path
  local_var_path = '/apps/{app}'.sub('{' + 'app' + '}', app.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[:body] 

  return_type = opts[:return_type] || 'AppBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_list(opts = {}) ⇒ Array<AppBean>

获取应用列表

Parameters:

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

    the optional parameters

Returns:



822
823
824
825
# File 'lib/indexea_client/api/apps_api.rb', line 822

def app_list(opts = {})
  data, _status_code, _headers = app_list_with_http_info(opts)
  data
end

#app_list_mentors(app, opts = {}) ⇒ MentorForm

获取应用成员列表

Parameters:

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :from (Integer)

    开始位置 (default to 0)

  • :size (Integer)

    获取的数量 (default to 20)

Returns:



873
874
875
876
# File 'lib/indexea_client/api/apps_api.rb', line 873

def app_list_mentors(app, opts = {})
  data, _status_code, _headers = app_list_mentors_with_http_info(app, opts)
  data
end

#app_list_mentors_with_http_info(app, opts = {}) ⇒ Array<(MentorForm, Integer, Hash)>

获取应用成员列表

Parameters:

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :from (Integer)

    开始位置

  • :size (Integer)

    获取的数量

Returns:

  • (Array<(MentorForm, Integer, Hash)>)

    MentorForm data, response status code and response headers



884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
# File 'lib/indexea_client/api/apps_api.rb', line 884

def app_list_mentors_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_list_mentors ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_list_mentors"
  end
  # resource path
  local_var_path = '/apps/{app}/mentors'.sub('{' + 'app' + '}', app.to_s)

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

  return_type = opts[:return_type] || 'MentorForm' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_list_mentors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_list_oauth_apps(app, opts = {}) ⇒ Array<OauthAppBean>

获取第三方应用列表

Parameters:

  • app

    应用标识

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

    the optional parameters

Returns:



931
932
933
934
# File 'lib/indexea_client/api/apps_api.rb', line 931

def app_list_oauth_apps(app, opts = {})
  data, _status_code, _headers = app_list_oauth_apps_with_http_info(app, opts)
  data
end

#app_list_oauth_apps_with_http_info(app, opts = {}) ⇒ Array<(Array<OauthAppBean>, Integer, Hash)>

获取第三方应用列表

Parameters:

  • app

    应用标识

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

    the optional parameters

Returns:

  • (Array<(Array<OauthAppBean>, Integer, Hash)>)

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



940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
# File 'lib/indexea_client/api/apps_api.rb', line 940

def app_list_oauth_apps_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_list_oauth_apps ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_list_oauth_apps"
  end
  # resource path
  local_var_path = '/apps/{app}/oauth'.sub('{' + 'app' + '}', app.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[:body] 

  return_type = opts[:return_type] || 'Array<OauthAppBean>' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_list_oauth_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_list_with_http_info(opts = {}) ⇒ Array<(Array<AppBean>, Integer, Hash)>

获取应用列表

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<AppBean>, Integer, Hash)>)

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



830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
# File 'lib/indexea_client/api/apps_api.rb', line 830

def app_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_list ...'
  end
  # resource path
  local_var_path = '/apps'

  # 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[:body] 

  return_type = opts[:return_type] || 'Array<AppBean>' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_logs(app, opts = {}) ⇒ AppLogsBean

获取应用的日志列表

Parameters:

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :account (Integer)

    账号 (default to 0)

  • :indices (Array<Integer>)

    索引

  • :widget (Integer)

    组件 (default to 0)

  • :query (Integer)

    查询 (default to 0)

  • :type (Integer)

    类型 (default to 0)

  • :start_date (Date)

    起始日期

  • :end_date (Date)

    结束日期

  • :from (Integer)

    起始位置 (default to 0)

  • :size (Integer)

    数量 (default to 20)

Returns:



994
995
996
997
# File 'lib/indexea_client/api/apps_api.rb', line 994

def app_logs(app, opts = {})
  data, _status_code, _headers = app_logs_with_http_info(app, opts)
  data
end

#app_logs_with_http_info(app, opts = {}) ⇒ Array<(AppLogsBean, Integer, Hash)>

获取应用的日志列表

Parameters:

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :account (Integer)

    账号

  • :indices (Array<Integer>)

    索引

  • :widget (Integer)

    组件

  • :query (Integer)

    查询

  • :type (Integer)

    类型

  • :start_date (Date)

    起始日期

  • :end_date (Date)

    结束日期

  • :from (Integer)

    起始位置

  • :size (Integer)

    数量

Returns:

  • (Array<(AppLogsBean, Integer, Hash)>)

    AppLogsBean data, response status code and response headers



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
# File 'lib/indexea_client/api/apps_api.rb', line 1012

def app_logs_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_logs ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_logs"
  end
  # resource path
  local_var_path = '/apps/{app}/logs'.sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account'] = opts[:'account'] if !opts[:'account'].nil?
  query_params[:'indices'] = @api_client.build_collection_param(opts[:'indices'], :multi) if !opts[:'indices'].nil?
  query_params[:'widget'] = opts[:'widget'] if !opts[:'widget'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].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[:body] 

  return_type = opts[:return_type] || 'AppLogsBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_reset_access_token(id, app, opts = {}) ⇒ TokenBean

重置 Access Token

Parameters:

  • id

    Access Token 编号

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :vcode (String)

Returns:



1068
1069
1070
1071
# File 'lib/indexea_client/api/apps_api.rb', line 1068

def app_reset_access_token(id, app, opts = {})
  data, _status_code, _headers = app_reset_access_token_with_http_info(id, app, opts)
  data
end

#app_reset_access_token_with_http_info(id, app, opts = {}) ⇒ Array<(TokenBean, Integer, Hash)>

重置 Access Token

Parameters:

  • id

    Access Token 编号

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :vcode (String)

Returns:

  • (Array<(TokenBean, Integer, Hash)>)

    TokenBean data, response status code and response headers



1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
# File 'lib/indexea_client/api/apps_api.rb', line 1079

def app_reset_access_token_with_http_info(id, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_reset_access_token ...'
  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 AppsApi.app_reset_access_token"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_reset_access_token"
  end
  # resource path
  local_var_path = '/apps/{app}/tokens'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  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/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['vcode'] = opts[:'vcode'] if !opts[:'vcode'].nil?

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'TokenBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_reset_access_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_reset_oauth_app_secret(ident, app, opts = {}) ⇒ OauthAppBean

重新生成三方应用的密钥

Parameters:

  • ident

    三方应用标识

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :vcode (String)

Returns:



1134
1135
1136
1137
# File 'lib/indexea_client/api/apps_api.rb', line 1134

def app_reset_oauth_app_secret(ident, app, opts = {})
  data, _status_code, _headers = app_reset_oauth_app_secret_with_http_info(ident, app, opts)
  data
end

#app_reset_oauth_app_secret_with_http_info(ident, app, opts = {}) ⇒ Array<(OauthAppBean, Integer, Hash)>

重新生成三方应用的密钥

Parameters:

  • ident

    三方应用标识

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :vcode (String)

Returns:

  • (Array<(OauthAppBean, Integer, Hash)>)

    OauthAppBean data, response status code and response headers



1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
# File 'lib/indexea_client/api/apps_api.rb', line 1145

def app_reset_oauth_app_secret_with_http_info(ident, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_reset_oauth_app_secret ...'
  end
  # verify the required parameter 'ident' is set
  if @api_client.config.client_side_validation && ident.nil?
    fail ArgumentError, "Missing the required parameter 'ident' when calling AppsApi.app_reset_oauth_app_secret"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_reset_oauth_app_secret"
  end
  # resource path
  local_var_path = '/apps/{app}/oauth-reset-secret'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  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/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['vcode'] = opts[:'vcode'] if !opts[:'vcode'].nil?

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'OauthAppBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_reset_oauth_app_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_save_blacklist(body, app, opts = {}) ⇒ BOOLEAN

修改应用的黑名单信息

Parameters:

  • body
  • app

    应用标识

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

    the optional parameters

Returns:

  • (BOOLEAN)


1199
1200
1201
1202
# File 'lib/indexea_client/api/apps_api.rb', line 1199

def app_save_blacklist(body, app, opts = {})
  data, _status_code, _headers = app_save_blacklist_with_http_info(body, app, opts)
  data
end

#app_save_blacklist_with_http_info(body, app, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

修改应用的黑名单信息

Parameters:

  • body
  • app

    应用标识

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

    the optional parameters

Returns:

  • (Array<(BOOLEAN, Integer, Hash)>)

    BOOLEAN data, response status code and response headers



1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
# File 'lib/indexea_client/api/apps_api.rb', line 1209

def app_save_blacklist_with_http_info(body, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_save_blacklist ...'
  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 AppsApi.app_save_blacklist"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_save_blacklist"
  end
  # resource path
  local_var_path = '/apps/{app}/blacklist'.sub('{' + 'app' + '}', app.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_save_blacklist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_save_company(app, opts = {}) ⇒ CompanyBean

修改应用的公司信息

Parameters:

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :name (String)
  • :url (String)
  • :nation (String)
  • :province (String)
  • :city (String)
  • :taxpayer (String)
  • :bank (String)
  • :account (String)
  • :address (String)
  • :tel (String)
  • :license (String)
  • :certificate (String)
  • :post_addr (String)
  • :post_code (String)
  • :post_name (String)
  • :post_tel (String)

Returns:



1276
1277
1278
1279
# File 'lib/indexea_client/api/apps_api.rb', line 1276

def app_save_company(app, opts = {})
  data, _status_code, _headers = app_save_company_with_http_info(app, opts)
  data
end

#app_save_company_with_http_info(app, opts = {}) ⇒ Array<(CompanyBean, Integer, Hash)>

修改应用的公司信息

Parameters:

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :name (String)
  • :url (String)
  • :nation (String)
  • :province (String)
  • :city (String)
  • :taxpayer (String)
  • :bank (String)
  • :account (String)
  • :address (String)
  • :tel (String)
  • :license (String)
  • :certificate (String)
  • :post_addr (String)
  • :post_code (String)
  • :post_name (String)
  • :post_tel (String)

Returns:

  • (Array<(CompanyBean, Integer, Hash)>)

    CompanyBean data, response status code and response headers



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
# File 'lib/indexea_client/api/apps_api.rb', line 1301

def app_save_company_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_save_company ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_save_company"
  end
  # resource path
  local_var_path = '/apps/{app}/company'.sub('{' + 'app' + '}', app.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['url'] = opts[:'url'] if !opts[:'url'].nil?
  form_params['nation'] = opts[:'nation'] if !opts[:'nation'].nil?
  form_params['province'] = opts[:'province'] if !opts[:'province'].nil?
  form_params['city'] = opts[:'city'] if !opts[:'city'].nil?
  form_params['taxpayer'] = opts[:'taxpayer'] if !opts[:'taxpayer'].nil?
  form_params['bank'] = opts[:'bank'] if !opts[:'bank'].nil?
  form_params['account'] = opts[:'account'] if !opts[:'account'].nil?
  form_params['address'] = opts[:'address'] if !opts[:'address'].nil?
  form_params['tel'] = opts[:'tel'] if !opts[:'tel'].nil?
  form_params['license'] = opts[:'license'] if !opts[:'license'].nil?
  form_params['certificate'] = opts[:'certificate'] if !opts[:'certificate'].nil?
  form_params['post_addr'] = opts[:'post_addr'] if !opts[:'post_addr'].nil?
  form_params['post_code'] = opts[:'post_code'] if !opts[:'post_code'].nil?
  form_params['post_name'] = opts[:'post_name'] if !opts[:'post_name'].nil?
  form_params['post_tel'] = opts[:'post_tel'] if !opts[:'post_tel'].nil?

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'CompanyBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_save_company\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_searchs_estimate(app, days, opts = {}) ⇒ SearchEstimateResult

获取搜索流量包使用配额信息

Parameters:

  • app

    应用标识

  • days

    计算平均搜索数的最近天数

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

    the optional parameters

Returns:



1365
1366
1367
1368
# File 'lib/indexea_client/api/apps_api.rb', line 1365

def app_searchs_estimate(app, days, opts = {})
  data, _status_code, _headers = app_searchs_estimate_with_http_info(app, days, opts)
  data
end

#app_searchs_estimate_with_http_info(app, days, opts = {}) ⇒ Array<(SearchEstimateResult, Integer, Hash)>

获取搜索流量包使用配额信息

Parameters:

  • app

    应用标识

  • days

    计算平均搜索数的最近天数

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

    the optional parameters

Returns:

  • (Array<(SearchEstimateResult, Integer, Hash)>)

    SearchEstimateResult data, response status code and response headers



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
# File 'lib/indexea_client/api/apps_api.rb', line 1375

def app_searchs_estimate_with_http_info(app, days, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_searchs_estimate ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_searchs_estimate"
  end
  # verify the required parameter 'days' is set
  if @api_client.config.client_side_validation && days.nil?
    fail ArgumentError, "Missing the required parameter 'days' when calling AppsApi.app_searchs_estimate"
  end
  # resource path
  local_var_path = '/apps/{app}/searchs-estimate'.sub('{' + 'app' + '}', app.to_s)

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

  # 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[:body] 

  return_type = opts[:return_type] || 'SearchEstimateResult' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_searchs_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_set_trigger(body, app, opts = {}) ⇒ BOOLEAN

修改应用的触发器信息

Parameters:

  • body
  • app

    应用标识

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

    the optional parameters

Returns:

  • (BOOLEAN)


1426
1427
1428
1429
# File 'lib/indexea_client/api/apps_api.rb', line 1426

def app_set_trigger(body, app, opts = {})
  data, _status_code, _headers = app_set_trigger_with_http_info(body, app, opts)
  data
end

#app_set_trigger_with_http_info(body, app, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

修改应用的触发器信息

Parameters:

  • body
  • app

    应用标识

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

    the optional parameters

Returns:

  • (Array<(BOOLEAN, Integer, Hash)>)

    BOOLEAN data, response status code and response headers



1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
# File 'lib/indexea_client/api/apps_api.rb', line 1436

def app_set_trigger_with_http_info(body, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_set_trigger ...'
  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 AppsApi.app_set_trigger"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_set_trigger"
  end
  # resource path
  local_var_path = '/apps/{app}/trigger'.sub('{' + 'app' + '}', app.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_set_trigger\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_tokens(app, opts = {}) ⇒ Array<TokenBean>

获取 Access Token 列表

Parameters:

  • app

    应用标识

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

    the optional parameters

Returns:



1487
1488
1489
1490
# File 'lib/indexea_client/api/apps_api.rb', line 1487

def app_tokens(app, opts = {})
  data, _status_code, _headers = app_tokens_with_http_info(app, opts)
  data
end

#app_tokens_with_http_info(app, opts = {}) ⇒ Array<(Array<TokenBean>, Integer, Hash)>

获取 Access Token 列表

Parameters:

  • app

    应用标识

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

    the optional parameters

Returns:

  • (Array<(Array<TokenBean>, Integer, Hash)>)

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



1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'lib/indexea_client/api/apps_api.rb', line 1496

def app_tokens_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_tokens ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_tokens"
  end
  # resource path
  local_var_path = '/apps/{app}/tokens'.sub('{' + 'app' + '}', app.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[:body] 

  return_type = opts[:return_type] || 'Array<TokenBean>' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_transfer(app, vcode, account, opts = {}) ⇒ BOOLEAN

转让应用给他人

Parameters:

  • app

    应用标识

  • vcode

    验证码

  • account

    目标账号

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

    the optional parameters

Returns:

  • (BOOLEAN)


1543
1544
1545
1546
# File 'lib/indexea_client/api/apps_api.rb', line 1543

def app_transfer(app, vcode, , opts = {})
  data, _status_code, _headers = app_transfer_with_http_info(app, vcode, , opts)
  data
end

#app_transfer_with_http_info(app, vcode, account, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

转让应用给他人

Parameters:

  • app

    应用标识

  • vcode

    验证码

  • account

    目标账号

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

    the optional parameters

Returns:

  • (Array<(BOOLEAN, Integer, Hash)>)

    BOOLEAN data, response status code and response headers



1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
# File 'lib/indexea_client/api/apps_api.rb', line 1554

def app_transfer_with_http_info(app, vcode, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_transfer ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_transfer"
  end
  # verify the required parameter 'vcode' is set
  if @api_client.config.client_side_validation && vcode.nil?
    fail ArgumentError, "Missing the required parameter 'vcode' when calling AppsApi.app_transfer"
  end
  # verify the required parameter 'account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account' when calling AppsApi.app_transfer"
  end
  # resource path
  local_var_path = '/apps/{app}/transfer'.sub('{' + 'app' + '}', app.to_s)

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

  # 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[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_transfer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_trigger(app, opts = {}) ⇒ TriggerBean

获取应用触发器详情

Parameters:

  • app

    应用标识

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

    the optional parameters

Returns:



1609
1610
1611
1612
# File 'lib/indexea_client/api/apps_api.rb', line 1609

def app_trigger(app, opts = {})
  data, _status_code, _headers = app_trigger_with_http_info(app, opts)
  data
end

#app_trigger_logs(app, id, size, opts = {}) ⇒ Array<TriggerLogBean>

获取应用触发日志列表

Parameters:

  • app

    应用标识

  • id

    起始日志编号

  • size

    日志数

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

    the optional parameters

Returns:



1665
1666
1667
1668
# File 'lib/indexea_client/api/apps_api.rb', line 1665

def app_trigger_logs(app, id, size, opts = {})
  data, _status_code, _headers = app_trigger_logs_with_http_info(app, id, size, opts)
  data
end

#app_trigger_logs_with_http_info(app, id, size, opts = {}) ⇒ Array<(Array<TriggerLogBean>, Integer, Hash)>

获取应用触发日志列表

Parameters:

  • app

    应用标识

  • id

    起始日志编号

  • size

    日志数

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

    the optional parameters

Returns:

  • (Array<(Array<TriggerLogBean>, Integer, Hash)>)

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



1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
# File 'lib/indexea_client/api/apps_api.rb', line 1676

def app_trigger_logs_with_http_info(app, id, size, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_trigger_logs ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_trigger_logs"
  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 AppsApi.app_trigger_logs"
  end
  # verify the required parameter 'size' is set
  if @api_client.config.client_side_validation && size.nil?
    fail ArgumentError, "Missing the required parameter 'size' when calling AppsApi.app_trigger_logs"
  end
  # resource path
  local_var_path = '/apps/{app}/trigger-logs'.sub('{' + 'app' + '}', app.to_s)

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

  # 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[:body] 

  return_type = opts[:return_type] || 'Array<TriggerLogBean>' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_trigger_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_trigger_with_http_info(app, opts = {}) ⇒ Array<(TriggerBean, Integer, Hash)>

获取应用触发器详情

Parameters:

  • app

    应用标识

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

    the optional parameters

Returns:

  • (Array<(TriggerBean, Integer, Hash)>)

    TriggerBean data, response status code and response headers



1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
# File 'lib/indexea_client/api/apps_api.rb', line 1618

def app_trigger_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_trigger ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_trigger"
  end
  # resource path
  local_var_path = '/apps/{app}/trigger'.sub('{' + 'app' + '}', app.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[:body] 

  return_type = opts[:return_type] || 'TriggerBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_trigger\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_update(app, opts = {}) ⇒ AppBean

修改应用的基本信息

Parameters:

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :name (String)
  • :intro (String)

Returns:



1733
1734
1735
1736
# File 'lib/indexea_client/api/apps_api.rb', line 1733

def app_update(app, opts = {})
  data, _status_code, _headers = app_update_with_http_info(app, opts)
  data
end

#app_update_access_token(body, app, opts = {}) ⇒ TokenBean

修改 Access Token

Parameters:

  • body
  • app

    应用标识

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

    the optional parameters

Returns:



1794
1795
1796
1797
# File 'lib/indexea_client/api/apps_api.rb', line 1794

def app_update_access_token(body, app, opts = {})
  data, _status_code, _headers = app_update_access_token_with_http_info(body, app, opts)
  data
end

#app_update_access_token_with_http_info(body, app, opts = {}) ⇒ Array<(TokenBean, Integer, Hash)>

修改 Access Token

Parameters:

  • body
  • app

    应用标识

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

    the optional parameters

Returns:

  • (Array<(TokenBean, Integer, Hash)>)

    TokenBean data, response status code and response headers



1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'lib/indexea_client/api/apps_api.rb', line 1804

def app_update_access_token_with_http_info(body, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_update_access_token ...'
  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 AppsApi.app_update_access_token"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_update_access_token"
  end
  # resource path
  local_var_path = '/apps/{app}/tokens'.sub('{' + 'app' + '}', app.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'TokenBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_update_access_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_update_mentor(app, account, name, scopes, opts = {}) ⇒ BOOLEAN

修改成员备注和权限

Parameters:

  • app

    应用标识

  • account

    成员编号

  • name

    备注名称

  • scopes

    权限

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

    the optional parameters

Returns:

  • (BOOLEAN)


1858
1859
1860
1861
# File 'lib/indexea_client/api/apps_api.rb', line 1858

def app_update_mentor(app, , name, scopes, opts = {})
  data, _status_code, _headers = app_update_mentor_with_http_info(app, , name, scopes, opts)
  data
end

#app_update_mentor_options(app, opts = {}) ⇒ BOOLEAN

修改应用成员自身的设置(包括应用名备注,是否接收报告等)

Parameters:

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :name (String)

    应用备注名称,如果不填写则使用默认名称

  • :report (BOOLEAN)

    是否接收使用情况报告 (default to false)

Returns:

  • (BOOLEAN)


1932
1933
1934
1935
# File 'lib/indexea_client/api/apps_api.rb', line 1932

def app_update_mentor_options(app, opts = {})
  data, _status_code, _headers = app_update_mentor_options_with_http_info(app, opts)
  data
end

#app_update_mentor_options_with_http_info(app, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

修改应用成员自身的设置(包括应用名备注,是否接收报告等)

Parameters:

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :name (String)

    应用备注名称,如果不填写则使用默认名称

  • :report (BOOLEAN)

    是否接收使用情况报告

Returns:

  • (Array<(BOOLEAN, Integer, Hash)>)

    BOOLEAN data, response status code and response headers



1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
# File 'lib/indexea_client/api/apps_api.rb', line 1943

def app_update_mentor_options_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_update_mentor_options ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_update_mentor_options"
  end
  # resource path
  local_var_path = '/apps/{app}/mentors-options'.sub('{' + 'app' + '}', app.to_s)

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

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_update_mentor_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_update_mentor_report_options(key, type, value, vcode, app, opts = {}) ⇒ BOOLEAN

修改应用成员自身的通知设置

Parameters:

  • key
  • type
  • value
  • vcode
  • app

    应用标识

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

    the optional parameters

Returns:

  • (BOOLEAN)


1994
1995
1996
1997
# File 'lib/indexea_client/api/apps_api.rb', line 1994

def app_update_mentor_report_options(key, type, value, vcode, app, opts = {})
  data, _status_code, _headers = app_update_mentor_report_options_with_http_info(key, type, value, vcode, app, opts)
  data
end

#app_update_mentor_report_options_with_http_info(key, type, value, vcode, app, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

修改应用成员自身的通知设置

Parameters:

  • key
  • type
  • value
  • vcode
  • app

    应用标识

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

    the optional parameters

Returns:

  • (Array<(BOOLEAN, Integer, Hash)>)

    BOOLEAN data, response status code and response headers



2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
# File 'lib/indexea_client/api/apps_api.rb', line 2007

def app_update_mentor_report_options_with_http_info(key, type, value, vcode, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_update_mentor_report_options ...'
  end
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    fail ArgumentError, "Missing the required parameter 'key' when calling AppsApi.app_update_mentor_report_options"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling AppsApi.app_update_mentor_report_options"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['int', 'bool', 'string'].include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of int, bool, string"
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling AppsApi.app_update_mentor_report_options"
  end
  # verify the required parameter 'vcode' is set
  if @api_client.config.client_side_validation && vcode.nil?
    fail ArgumentError, "Missing the required parameter 'vcode' when calling AppsApi.app_update_mentor_report_options"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_update_mentor_report_options"
  end
  # resource path
  local_var_path = '/apps/{app}/mentors-options'.sub('{' + 'app' + '}', app.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['key'] = key
  form_params['type'] = type
  form_params['value'] = value
  form_params['vcode'] = vcode

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_update_mentor_report_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_update_mentor_with_http_info(app, account, name, scopes, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

修改成员备注和权限

Parameters:

  • app

    应用标识

  • account

    成员编号

  • name

    备注名称

  • scopes

    权限

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

    the optional parameters

Returns:

  • (Array<(BOOLEAN, Integer, Hash)>)

    BOOLEAN data, response status code and response headers



1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'lib/indexea_client/api/apps_api.rb', line 1870

def app_update_mentor_with_http_info(app, , name, scopes, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_update_mentor ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_update_mentor"
  end
  # verify the required parameter 'account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account' when calling AppsApi.app_update_mentor"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling AppsApi.app_update_mentor"
  end
  # verify the required parameter 'scopes' is set
  if @api_client.config.client_side_validation && scopes.nil?
    fail ArgumentError, "Missing the required parameter 'scopes' when calling AppsApi.app_update_mentor"
  end
  # resource path
  local_var_path = '/apps/{app}/mentors'.sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account'] = 
  query_params[:'name'] = name
  query_params[:'scopes'] = scopes

  # 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[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_update_mentor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_update_oauth_app(body, app, opts = {}) ⇒ OauthAppBean

修改第三方应用信息

Parameters:

  • body
  • app

    应用标识

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

    the optional parameters

Returns:



2079
2080
2081
2082
# File 'lib/indexea_client/api/apps_api.rb', line 2079

def app_update_oauth_app(body, app, opts = {})
  data, _status_code, _headers = app_update_oauth_app_with_http_info(body, app, opts)
  data
end

#app_update_oauth_app_logo(ident, app, opts = {}) ⇒ OauthAppBean

修改三方应用图标

Parameters:

  • ident

    三方应用标识

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :logo (String)

Returns:



2142
2143
2144
2145
# File 'lib/indexea_client/api/apps_api.rb', line 2142

def (ident, app, opts = {})
  data, _status_code, _headers = app_update_oauth_app_logo_with_http_info(ident, app, opts)
  data
end

#app_update_oauth_app_logo_with_http_info(ident, app, opts = {}) ⇒ Array<(OauthAppBean, Integer, Hash)>

修改三方应用图标

Parameters:

  • ident

    三方应用标识

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :logo (String)

Returns:

  • (Array<(OauthAppBean, Integer, Hash)>)

    OauthAppBean data, response status code and response headers



2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
# File 'lib/indexea_client/api/apps_api.rb', line 2153

def app_update_oauth_app_logo_with_http_info(ident, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_update_oauth_app_logo ...'
  end
  # verify the required parameter 'ident' is set
  if @api_client.config.client_side_validation && ident.nil?
    fail ArgumentError, "Missing the required parameter 'ident' when calling AppsApi.app_update_oauth_app_logo"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_update_oauth_app_logo"
  end
  # resource path
  local_var_path = '/apps/{app}/oauth'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  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(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['logo'] = opts[:'logo'] if !opts[:'logo'].nil?

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'OauthAppBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_update_oauth_app_logo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_update_oauth_app_with_http_info(body, app, opts = {}) ⇒ Array<(OauthAppBean, Integer, Hash)>

修改第三方应用信息

Parameters:

  • body
  • app

    应用标识

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

    the optional parameters

Returns:

  • (Array<(OauthAppBean, Integer, Hash)>)

    OauthAppBean data, response status code and response headers



2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
# File 'lib/indexea_client/api/apps_api.rb', line 2089

def app_update_oauth_app_with_http_info(body, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_update_oauth_app ...'
  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 AppsApi.app_update_oauth_app"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_update_oauth_app"
  end
  # resource path
  local_var_path = '/apps/{app}/oauth'.sub('{' + 'app' + '}', app.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'OauthAppBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_update_oauth_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_update_status(app, vcode, status, opts = {}) ⇒ BOOLEAN

修改应用的状态

Parameters:

  • app

    应用标识

  • vcode

    验证码

  • status

    新状态

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

    the optional parameters

Returns:

  • (BOOLEAN)


2208
2209
2210
2211
# File 'lib/indexea_client/api/apps_api.rb', line 2208

def app_update_status(app, vcode, status, opts = {})
  data, _status_code, _headers = app_update_status_with_http_info(app, vcode, status, opts)
  data
end

#app_update_status_with_http_info(app, vcode, status, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

修改应用的状态

Parameters:

  • app

    应用标识

  • vcode

    验证码

  • status

    新状态

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

    the optional parameters

Returns:

  • (Array<(BOOLEAN, Integer, Hash)>)

    BOOLEAN data, response status code and response headers



2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
# File 'lib/indexea_client/api/apps_api.rb', line 2219

def app_update_status_with_http_info(app, vcode, status, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_update_status ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_update_status"
  end
  # verify the required parameter 'vcode' is set
  if @api_client.config.client_side_validation && vcode.nil?
    fail ArgumentError, "Missing the required parameter 'vcode' when calling AppsApi.app_update_status"
  end
  # verify the required parameter 'status' is set
  if @api_client.config.client_side_validation && status.nil?
    fail ArgumentError, "Missing the required parameter 'status' when calling AppsApi.app_update_status"
  end
  # resource path
  local_var_path = '/apps/{app}'.sub('{' + 'app' + '}', app.to_s)

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

  # 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[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_update_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#app_update_with_http_info(app, opts = {}) ⇒ Array<(AppBean, Integer, Hash)>

修改应用的基本信息

Parameters:

  • app

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :name (String)
  • :intro (String)

Returns:

  • (Array<(AppBean, Integer, Hash)>)

    AppBean data, response status code and response headers



1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'lib/indexea_client/api/apps_api.rb', line 1744

def app_update_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.app_update ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.app_update"
  end
  # resource path
  local_var_path = '/apps/{app}'.sub('{' + 'app' + '}', app.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['intro'] = opts[:'intro'] if !opts[:'intro'].nil?

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'AppBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#app_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end