Module: JPSClient::API::Application

Included in:
Client
Defined in:
lib/jpsclient/api/application.rb

Overview

应用管理相关 API 处理 /api/application/* 路径的所有接口

Instance Method Summary collapse

Instance Method Details

#create_application(params: {}) ⇒ Hash

创建应用

Parameters:

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

    应用信息参数

Returns:

  • (Hash)

    API响应

Raises:



79
80
81
82
83
84
85
# File 'lib/jpsclient/api/application.rb', line 79

def create_application(params: {})
  config = @request_config && @request_config["application_create"]
  raise JPSClient::ExceptionError, "Missing config for application_create" unless config && config["url"]
  path = config["url"]

  return request_with_auth(:post, path, body: params)
end

#delete_application(applicationId:) ⇒ Hash

删除应用

Parameters:

  • applicationId (Integer)

    应用ID(必需)

Returns:

  • (Hash)

    API响应

Raises:



39
40
41
42
43
44
45
46
# File 'lib/jpsclient/api/application.rb', line 39

def delete_application(applicationId:)
  config = @request_config && @request_config["application_delete"]
  raise JPSClient::ExceptionError, "Missing config for application_delete" unless config && config["url"]

  path = config["url"].gsub("{applicationId}", applicationId.to_s)

  return request_with_auth(:delete, path)
end

#fast_bind_application(params: {}) ⇒ Hash

快速绑定应用

Parameters:

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

    绑定参数

Returns:

  • (Hash)

    API响应

Raises:



115
116
117
118
119
120
121
# File 'lib/jpsclient/api/application.rb', line 115

def fast_bind_application(params: {})
  config = @request_config && @request_config["application_fast_bind"]
  raise JPSClient::ExceptionError, "Missing config for application_fast_bind" unless config && config["url"]
  path = config["url"]

  return request_with_auth(:post, path, body: params)
end

#get_application_detail(applicationId:) ⇒ Hash

获取应用详情

Parameters:

  • applicationId (Integer)

    应用ID(必需)

Returns:

  • (Hash)

    API响应

Raises:



11
12
13
14
15
16
17
18
19
# File 'lib/jpsclient/api/application.rb', line 11

def get_application_detail(applicationId:)
  config = @request_config && @request_config["application_detail"]
  raise JPSClient::ExceptionError, "Missing config for application_detail" unless config && config["url"]

  # 构建路径,替换路径参数
  path = config["url"].gsub("{applicationId}", applicationId.to_s)

  return request_with_auth(:get, path)
end

#get_application_rankings(params: {}) ⇒ Hash

获取应用排名

Parameters:

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

    查询参数

Returns:

  • (Hash)

    API响应

Raises:



103
104
105
106
107
108
109
# File 'lib/jpsclient/api/application.rb', line 103

def get_application_rankings(params: {})
  config = @request_config && @request_config["application_rankings"]
  raise JPSClient::ExceptionError, "Missing config for application_rankings" unless config && config["url"]
  path = config["url"]

  return request_with_auth(:post, path, body: params)
end

#get_appstore_categoriesHash

获取应用商店分类

Returns:

  • (Hash)

    API响应

Raises:



149
150
151
152
153
154
155
# File 'lib/jpsclient/api/application.rb', line 149

def get_appstore_categories
  config = @request_config && @request_config["appstore_categories"]
  raise JPSClient::ExceptionError, "Missing config for appstore_categories" unless config && config["url"]
  path = config["url"]

  return request_with_auth(:get, path)
end

#get_category_applications(categoryIdStr:, params: {}) ⇒ Hash

获取分类下的应用列表

Parameters:

  • categoryIdStr (String)

    分类ID字符串(必需)

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

    查询参数

Returns:

  • (Hash)

    API响应

Raises:



66
67
68
69
70
71
72
73
# File 'lib/jpsclient/api/application.rb', line 66

def get_category_applications(categoryIdStr:, params: {})
  config = @request_config && @request_config["category_applications"]
  raise JPSClient::ExceptionError, "Missing config for category_applications" unless config && config["url"]

  path = config["url"].gsub("{categoryIdStr}", categoryIdStr.to_s)

  return request_with_auth(:post, path, body: params)
end

#get_designersHash

获取设计师列表

Returns:

  • (Hash)

    API响应

Raises:



138
139
140
141
142
143
144
# File 'lib/jpsclient/api/application.rb', line 138

def get_designers
  config = @request_config && @request_config["designers_list"]
  raise JPSClient::ExceptionError, "Missing config for designers_list" unless config && config["url"]
  path = config["url"]

  return request_with_auth(:get, path)
end

#get_lark_task_apps_list(params: {}) ⇒ Hash

获取 Lark 任务应用列表

Parameters:

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

    查询参数

Returns:

  • (Hash)

    API响应

Raises:



127
128
129
130
131
132
133
# File 'lib/jpsclient/api/application.rb', line 127

def get_lark_task_apps_list(params: {})
  config = @request_config && @request_config["lark_task_apps_list"]
  raise JPSClient::ExceptionError, "Missing config for lark_task_apps_list" unless config && config["url"]
  path = config["url"]

  return request_with_auth(:get, path, params: params)
end

#refresh_application(applicationId:) ⇒ Hash

刷新应用

Parameters:

  • applicationId (Integer)

    应用ID(必需)

Returns:

  • (Hash)

    API响应

Raises:



52
53
54
55
56
57
58
59
# File 'lib/jpsclient/api/application.rb', line 52

def refresh_application(applicationId:)
  config = @request_config && @request_config["application_refresh"]
  raise JPSClient::ExceptionError, "Missing config for application_refresh" unless config && config["url"]

  path = config["url"].gsub("{applicationId}", applicationId.to_s)

  return request_with_auth(:put, path)
end

#update_application(applicationId:, params: {}) ⇒ Hash

更新应用信息

Parameters:

  • applicationId (Integer)

    应用ID(必需)

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

    更新参数

Returns:

  • (Hash)

    API响应

Raises:



26
27
28
29
30
31
32
33
# File 'lib/jpsclient/api/application.rb', line 26

def update_application(applicationId:, params: {})
  config = @request_config && @request_config["application_update"]
  raise JPSClient::ExceptionError, "Missing config for application_update" unless config && config["url"]

  path = config["url"].gsub("{applicationId}", applicationId.to_s)

  return request_with_auth(:put, path, body: params)
end

#update_application_weights(params: {}) ⇒ Hash

更新应用权重

Parameters:

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

    权重更新参数

Returns:

  • (Hash)

    API响应

Raises:



91
92
93
94
95
96
97
# File 'lib/jpsclient/api/application.rb', line 91

def update_application_weights(params: {})
  config = @request_config && @request_config["application_weights"]
  raise JPSClient::ExceptionError, "Missing config for application_weights" unless config && config["url"]
  path = config["url"]

  return request_with_auth(:post, path, body: params)
end