Module: JPSClient::API::LarkTask

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

Overview

LarkTask 相关 API 自动生成的模块，处理 lark_task 相关接口

Instance Method Summary collapse

Instance Method Details

#create_create(params: {}) ⇒ Hash

Create Create

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



50
51
52
53
54
55
56
57
 
# File 'lib/jpsclient/api/lark_task.rb', line 50

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

  path = config["url"]

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

#create_delete(params: {}) ⇒ Hash

Create Delete

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



37
38
39
40
41
42
43
44
 
# File 'lib/jpsclient/api/lark_task.rb', line 37

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

  path = config["url"]

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

#create_update(params: {}) ⇒ Hash

Create Update

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



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

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

  path = config["url"]

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

#get_apps(params: {}) ⇒ Hash

获取有飞书任务的 app 列表

Parameters:

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

    请求参数（LarkTaskAppsDto: keyword, larkUserId）

Returns:

  • (Hash) —

    API响应

Raises:



89
90
91
92
93
94
95
96
 
# File 'lib/jpsclient/api/lark_task.rb', line 89

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

  path = config["url"]

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

#get_completed_items(start_time: nil, end_time: nil, params: {}) ⇒ Hash

查询当前用户完成的任务和 Bug

spec 标注 startTime / endTime 均为 required（int64 毫秒时间戳）。

Returns:

  • (Hash) —

    API响应

Raises:



103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/jpsclient/api/lark_task.rb', line 103

def get_completed_items(start_time: nil, end_time: nil, params: {})
  config = @request_config && @request_config["lark_task_completed_items"]
  raise JPSClient::ExceptionError, "Missing config for lark_task_completed_items" unless config && config["url"]

  path = config["url"]

  # TODO(human): 决定如何把 start_time/end_time 与 params 合并成最终的 query
  # 候选策略见对话中的 Learn by Doing 说明，最终需要返回一个能直接交给
  # request_with_auth(:get, path, params: ...) 的 Hash。
  query = nil

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

#get_detail(params: {}) ⇒ Hash

Get Detail

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



76
77
78
79
80
81
82
83
 
# File 'lib/jpsclient/api/lark_task.rb', line 76

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

  path = config["url"]

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

#get_fields(params: {}) ⇒ Hash

任务字段列表

Parameters:

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

    请求参数（spec 未声明字段，预留以保持调用风格统一）

Returns:

  • (Hash) —

    API响应

Raises:



121
122
123
124
125
126
127
128
 
# File 'lib/jpsclient/api/lark_task.rb', line 121

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

  path = config["url"]

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

#get_filter_options(params: {}) ⇒ Hash

下发 task 列表筛选字段

Parameters:

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

    请求参数（FieldsOptionsDto: sourceId, sourceType）

Returns:

  • (Hash) —

    API响应

Raises:



134
135
136
137
138
139
140
141
 
# File 'lib/jpsclient/api/lark_task.rb', line 134

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

  path = config["url"]

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

#get_list(params: {}) ⇒ Hash

Get List

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



24
25
26
27
28
29
30
31
 
# File 'lib/jpsclient/api/lark_task.rb', line 24

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

  path = config["url"]

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

#get_statistics(params: {}) ⇒ Hash

个人任务统计

Parameters:

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

    请求参数（ProjectTaskStatisticDto: larkUserIds 等）

Returns:

  • (Hash) —

    API响应

Raises:



147
148
149
150
151
152
153
154
 
# File 'lib/jpsclient/api/lark_task.rb', line 147

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

  path = config["url"]

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

#get_type_info_list(params: {}) ⇒ Hash

Get Type Info List

Parameters:

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

    请求参数

Returns:

  • (Hash) —

    API响应

Raises:



63
64
65
66
67
68
69
70
 
# File 'lib/jpsclient/api/lark_task.rb', line 63

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

  path = config["url"]

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