@satorijs/adapter-dingtalk 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/lib/api/alitrip.d.ts +396 -0
  2. package/lib/api/attendance.d.ts +62 -0
  3. package/lib/api/badge.d.ts +232 -0
  4. package/lib/api/blackboard.d.ts +16 -0
  5. package/lib/api/calendar.d.ts +620 -0
  6. package/lib/api/card.d.ts +184 -0
  7. package/lib/api/conference.d.ts +403 -0
  8. package/lib/api/connector.d.ts +78 -0
  9. package/lib/api/contact.d.ts +39 -0
  10. package/lib/api/convFile.d.ts +134 -0
  11. package/lib/api/crm.d.ts +661 -0
  12. package/lib/api/customerService.d.ts +127 -0
  13. package/lib/api/datacenter.d.ts +505 -0
  14. package/lib/api/devicemng.d.ts +160 -0
  15. package/lib/api/diot.d.ts +12 -0
  16. package/lib/api/doc.d.ts +140 -0
  17. package/lib/api/drive.d.ts +87 -0
  18. package/lib/api/edu.d.ts +22 -0
  19. package/lib/api/esign.d.ts +33 -0
  20. package/lib/api/exclusive.d.ts +303 -0
  21. package/lib/api/h3yun.d.ts +437 -0
  22. package/lib/api/hrm.d.ts +214 -0
  23. package/lib/api/im.d.ts +772 -0
  24. package/lib/api/industry.d.ts +117 -0
  25. package/lib/api/jzcrm.d.ts +254 -0
  26. package/lib/api/link.d.ts +72 -0
  27. package/lib/api/live.d.ts +131 -0
  28. package/lib/api/microApp.d.ts +239 -0
  29. package/lib/api/oapi.d.ts +3361 -0
  30. package/lib/api/oauth2.d.ts +114 -0
  31. package/lib/api/pedia.d.ts +185 -0
  32. package/lib/api/project.d.ts +1118 -0
  33. package/lib/api/resident.d.ts +106 -0
  34. package/lib/api/robot.d.ts +255 -0
  35. package/lib/api/rooms.d.ts +255 -0
  36. package/lib/api/serviceGroup.d.ts +175 -0
  37. package/lib/api/storage.d.ts +1240 -0
  38. package/lib/api/swform.d.ts +70 -0
  39. package/lib/api/todo.d.ts +168 -0
  40. package/lib/api/wiki.d.ts +194 -0
  41. package/lib/api/workbench.d.ts +45 -0
  42. package/lib/api/yida.d.ts +1837 -0
  43. package/lib/bot.d.ts +30 -0
  44. package/lib/http.d.ts +7 -0
  45. package/lib/index.d.ts +7 -0
  46. package/lib/index.js +1814 -0
  47. package/lib/index.js.map +7 -0
  48. package/lib/internal.d.ts +7 -0
  49. package/lib/message.d.ts +17 -0
  50. package/lib/types/index.d.ts +133 -0
  51. package/lib/utils.d.ts +4 -0
  52. package/lib/ws.d.ts +12 -0
  53. package/package.json +31 -0
@@ -0,0 +1,396 @@
1
+ export interface BillSettementBtripTrainQuery {
2
+ /** 企业id。 */
3
+ corpId?: string;
4
+ /** 类目:机酒火车: */
5
+ category?: number;
6
+ /** 每页数据量,默认100,最高100。 */
7
+ pageSize?: number;
8
+ /** 记账更新开始日期。 */
9
+ periodStart?: string;
10
+ /** 页数,从1开始。 */
11
+ pageNumber?: number;
12
+ /** 记账更新结束日期。 */
13
+ periodEnd?: string;
14
+ }
15
+ export interface BillSettementBtripTrainResponse {
16
+ resultMsg?: string;
17
+ module?: {
18
+ category?: number;
19
+ corpId?: string;
20
+ dataList?: number;
21
+ periodEnd?: string;
22
+ periodStart?: string;
23
+ totalNum?: number;
24
+ };
25
+ success?: unknown;
26
+ resultCode?: number;
27
+ }
28
+ export interface BillSettementHotelQuery {
29
+ /** 第三方企业。 */
30
+ corpId?: string;
31
+ /** 类目:机酒火车: */
32
+ category?: number;
33
+ /** 每页数据量,默认100,最高500。 */
34
+ pageSize?: number;
35
+ /** 记账更新开始日期。 */
36
+ periodStart?: string;
37
+ /** 页数,从1开始。 */
38
+ pageNumber?: number;
39
+ /** 记账更新结束日期。 */
40
+ periodEnd?: string;
41
+ }
42
+ export interface BillSettementHotelResponse {
43
+ resultMsg?: string;
44
+ module?: {
45
+ category?: number;
46
+ corpId?: string;
47
+ dataList?: number;
48
+ periodEnd?: string;
49
+ periodStart?: string;
50
+ totalNum?: number;
51
+ };
52
+ success?: unknown;
53
+ resultCode?: number;
54
+ }
55
+ export interface BillSettementCarQuery {
56
+ /** 企业id。 */
57
+ corpId?: string;
58
+ /** 类目:机酒火车: */
59
+ category?: number;
60
+ /** 每页数据量,默认100,最高100。 */
61
+ pageSize?: number;
62
+ /** 记账更新开始日期。 */
63
+ periodStart?: string;
64
+ /** 记账更新结束日期。 */
65
+ periodEnd?: string;
66
+ /** 页数,从1开始。 */
67
+ pageNumber?: number;
68
+ }
69
+ export interface BillSettementCarResponse {
70
+ resultMsg?: string;
71
+ module?: {
72
+ category?: number;
73
+ corpId?: string;
74
+ dataList?: number;
75
+ periodEnd?: string;
76
+ periodStart?: string;
77
+ totalNum?: number;
78
+ };
79
+ success?: unknown;
80
+ resultCode?: number;
81
+ }
82
+ export interface BillSettementFlightQuery {
83
+ /** 第三方企业的CorpId。 */
84
+ corpId?: string;
85
+ /** 类目,取值: */
86
+ category?: number;
87
+ /** 分页参数,每页数据量。默认值100,最大值500。 */
88
+ pageSize?: number;
89
+ /** 记账更新开始日期。 */
90
+ periodStart?: string;
91
+ /** 分页参数,页码,从1开始。 */
92
+ pageNumber?: number;
93
+ /** 记账更新结束日期。 */
94
+ periodEnd?: string;
95
+ }
96
+ export interface BillSettementFlightResponse {
97
+ resultMsg?: string;
98
+ module?: {
99
+ category?: number;
100
+ corpId?: string;
101
+ dataList?: number;
102
+ periodEnd?: string;
103
+ periodStart?: string;
104
+ totalNum?: number;
105
+ };
106
+ success?: unknown;
107
+ resultCode?: number;
108
+ }
109
+ export interface GetFlightExceedApplyQuery {
110
+ /** 第三方企业的corpId。 */
111
+ corpId: string;
112
+ /** 商旅超标审批单ID。 */
113
+ applyId: string;
114
+ }
115
+ export interface GetFlightExceedApplyResponse {
116
+ corpId: string;
117
+ applyId: number;
118
+ status: number;
119
+ btripCause: string;
120
+ exceedType: number;
121
+ exceedReason: string;
122
+ originStandard: string;
123
+ submitTime: string;
124
+ userId: string;
125
+ applyIntentionInfoDO: {
126
+ arrCity: string;
127
+ arrCityName: string;
128
+ arrTime: string;
129
+ cabin: string;
130
+ cabinClass: number;
131
+ cabinClassStr: string;
132
+ depCity: string;
133
+ depCityName: string;
134
+ depTime: string;
135
+ discount: number;
136
+ flightNo: string;
137
+ price: number;
138
+ type: number;
139
+ };
140
+ thirdpartApplyId: string;
141
+ }
142
+ export interface QueryUnionOrderQuery {
143
+ /** 第三方企业corpId。 */
144
+ corpId: string;
145
+ /** 第三方申请单ID。 */
146
+ thirdPartApplyId?: string;
147
+ /** 关联单号ID。 */
148
+ unionNo?: string;
149
+ }
150
+ export interface QueryUnionOrderResponse {
151
+ flightList?: {
152
+ flightOrderId?: number;
153
+ flightOrderStatus?: number;
154
+ }[];
155
+ corpId?: string;
156
+ trainList?: {
157
+ trainOrderId?: number;
158
+ trainOrderstatus?: number;
159
+ }[];
160
+ hotelList?: {
161
+ hotelOrderId?: number;
162
+ hotelOrderStatus?: number;
163
+ }[];
164
+ vehicleList?: {
165
+ vehicleOrderId?: number;
166
+ vehicleOrderStatus?: number;
167
+ }[];
168
+ }
169
+ export interface GetTrainExceedApplyQuery {
170
+ /** 第三方企业的corpId。 */
171
+ corpId: string;
172
+ /** 商旅审批单ID。 */
173
+ applyId: string;
174
+ }
175
+ export interface GetTrainExceedApplyResponse {
176
+ corpId: string;
177
+ applyId: number;
178
+ status: number;
179
+ btripCause: string;
180
+ exceedType: number;
181
+ exceedReason: string;
182
+ originStandard: string;
183
+ submitTime: string;
184
+ userId: string;
185
+ applyIntentionInfoDO: {
186
+ price: number;
187
+ depCityName: string;
188
+ arrCityName: string;
189
+ depCity: string;
190
+ arrCity: string;
191
+ depTime: string;
192
+ arrTime: string;
193
+ arrStation: string;
194
+ depStation: string;
195
+ trainNo: string;
196
+ trainTypeDesc: string;
197
+ seatName: string;
198
+ };
199
+ thirdpartApplyId: string;
200
+ }
201
+ export interface GetHotelExceedApplyQuery {
202
+ /** 第三方企业的corpId。 */
203
+ corpId: string;
204
+ /** 商旅审批单ID。 */
205
+ applyId: string;
206
+ }
207
+ export interface GetHotelExceedApplyResponse {
208
+ corpId: string;
209
+ applyId: number;
210
+ status: number;
211
+ btripCause: string;
212
+ exceedType: number;
213
+ exceedReason: string;
214
+ originStandard: string;
215
+ submitTime: string;
216
+ userId: string;
217
+ applyIntentionInfoDO: {
218
+ checkIn: string;
219
+ checkOut: string;
220
+ cityCode: string;
221
+ cityName: string;
222
+ price: number;
223
+ together: number;
224
+ type: number;
225
+ };
226
+ thirdpartApplyId: string;
227
+ }
228
+ export interface SyncExceedApplyQuery {
229
+ /** 审批意见。 */
230
+ remark: string;
231
+ /** 商旅超标审批单号。 */
232
+ applyId: string;
233
+ /** 企业的corpId。 */
234
+ corpId: string;
235
+ /** 第三方流程实例ID。 */
236
+ thirdpartyFlowId: string;
237
+ /** 员工的userid。 */
238
+ userId: string;
239
+ /** 审批单状态,取值: */
240
+ status: number;
241
+ }
242
+ export interface SyncExceedApplyResponse {
243
+ module: unknown;
244
+ }
245
+ export interface QueryCityCarApplyQuery {
246
+ /** 企业的CorpId。 */
247
+ corpId: string;
248
+ /** 审批单创建时间小于值,例如2021-03-18 20:26:50。 */
249
+ createdEndAt?: string;
250
+ /** 审批单创建时间大于或等于的时间,例如2021-03-18 20:26:56。 */
251
+ createdStartAt?: string;
252
+ /** 页码,要求大于等于1,默认1。 */
253
+ pageNumber?: number;
254
+ /** 每页数据量,要求大于等于1,默认20。 */
255
+ pageSize?: number;
256
+ /** 三方审批单ID。 */
257
+ thirdPartApplyId?: string;
258
+ /** 第三方员工ID。 */
259
+ userId?: string;
260
+ }
261
+ export interface QueryCityCarApplyResponse {
262
+ applyList?: {
263
+ approverList?: number;
264
+ departId?: string;
265
+ departName?: string;
266
+ gmtCreate?: string;
267
+ gmtModified?: string;
268
+ itineraryList?: number;
269
+ status?: number;
270
+ statusDesc?: string;
271
+ thirdPartApplyId?: string;
272
+ tripCause?: string;
273
+ tripTitle?: string;
274
+ userId?: string;
275
+ userName?: string;
276
+ }[];
277
+ total?: number;
278
+ }
279
+ export interface ApproveCityCarApplyParams {
280
+ /** 第三方企业的corpid。 */
281
+ corpId: string;
282
+ /** 审批时间,例如2021-03-18 20:26:56。 */
283
+ operateTime?: string;
284
+ /** 审批备注。 */
285
+ remark?: string;
286
+ /** 审批结果: */
287
+ status: number;
288
+ /** 第三方审批单ID。 */
289
+ thirdPartApplyId: string;
290
+ /** 审批的第三方员工ID。 */
291
+ userId: string;
292
+ }
293
+ export interface ApproveCityCarApplyResponse {
294
+ approveResult?: unknown;
295
+ }
296
+ export interface AddCityCarApplyParams {
297
+ /** 出差事由。 */
298
+ cause: string;
299
+ /** 用车城市。 */
300
+ city: string;
301
+ /** 第三方企业的corpid。 */
302
+ corpId: string;
303
+ /** 用车时间,按天管控,比如传值2021-03-18 20:26:56表示2021-03-18当天可用车,跨天情况配合finishedDate参数使用 */
304
+ date: string;
305
+ /** 审批单关联的项目code。 */
306
+ projectCode?: string;
307
+ /** 审批单关联的项目名。 */
308
+ projectName?: string;
309
+ /** 审批单状态: */
310
+ status: number;
311
+ /** 三方审批单ID。 */
312
+ thirdPartApplyId: string;
313
+ /** 审批单关联的三方成本中心ID。 */
314
+ thirdPartCostCenterId: string;
315
+ /** 审批单关联的三方发票抬头ID。 */
316
+ thirdPartInvoiceId: string;
317
+ /** 审批单可用总次数。 */
318
+ timesTotal: number;
319
+ /** 审批单可用次数类型: */
320
+ timesType: number;
321
+ /** 审批单已用次数。 */
322
+ timesUsed: number;
323
+ /** 审批单标题。 */
324
+ title: string;
325
+ /** 发起审批的第三方员工ID。 */
326
+ userId: string;
327
+ /** 用车截止时间,按天管控,比如date传值2021-03-18 20:26:56、finishedDate传值2021-03-30 20:26:56表示2021-03-18(含)到2021-03-30(含)之间可用车,该参数不传值情况使用date作为用车截止时间; */
328
+ finishedDate?: string;
329
+ }
330
+ export interface AddCityCarApplyResponse {
331
+ applyId?: number;
332
+ }
333
+ declare module '../internal' {
334
+ interface Internal {
335
+ /**
336
+ * 查询商旅火车票结算记账数据
337
+ * @see https://developers.dingtalk.com/document/isvapp/business-travel-train-ticket-settlement-bookkeeping-query-interface
338
+ */
339
+ billSettementBtripTrain(query: BillSettementBtripTrainQuery): Promise<BillSettementBtripTrainResponse>;
340
+ /**
341
+ * 查询酒店结算记账数据
342
+ * @see https://developers.dingtalk.com/document/isvapp/hotel-settlement-bookkeeping-query-interface
343
+ */
344
+ billSettementHotel(query: BillSettementHotelQuery): Promise<BillSettementHotelResponse>;
345
+ /**
346
+ * 查询用车结算记账记录
347
+ * @see https://developers.dingtalk.com/document/isvapp/query-interface-for-vehicle-settlement-and-bookkeeping
348
+ */
349
+ billSettementCar(query: BillSettementCarQuery): Promise<BillSettementCarResponse>;
350
+ /**
351
+ * 查询机票结算记账数据
352
+ * @see https://developers.dingtalk.com/document/isvapp/ticket-settlement-bookkeeping-query-interface
353
+ */
354
+ billSettementFlight(query: BillSettementFlightQuery): Promise<BillSettementFlightResponse>;
355
+ /**
356
+ * 搜索第三方机票超标审批单
357
+ * @see https://developers.dingtalk.com/document/isvapp/dingtalk-oapi-alitrip-btrip-exceedapply-flight-get
358
+ */
359
+ getFlightExceedApply(query: GetFlightExceedApplyQuery): Promise<GetFlightExceedApplyResponse>;
360
+ /**
361
+ * 关联单号查询相关订单信息列表
362
+ * @see https://developers.dingtalk.com/document/isvapp/link-no-to-query-the-list-of-related-order-information
363
+ */
364
+ queryUnionOrder(query: QueryUnionOrderQuery): Promise<QueryUnionOrderResponse>;
365
+ /**
366
+ * 搜索第三方火车票超标审批单
367
+ * @see https://developers.dingtalk.com/document/isvapp/dingtalk-oapi-alitrip-btrip-exceedapply-train-get
368
+ */
369
+ getTrainExceedApply(query: GetTrainExceedApplyQuery): Promise<GetTrainExceedApplyResponse>;
370
+ /**
371
+ * 搜索第三方酒店超标审批单
372
+ * @see https://developers.dingtalk.com/document/isvapp/dingtalk-oapi-alitrip-btrip-exceedapply-hotel-get
373
+ */
374
+ getHotelExceedApply(query: GetHotelExceedApplyQuery): Promise<GetHotelExceedApplyResponse>;
375
+ /**
376
+ * 同步超标审批结果
377
+ * @see https://developers.dingtalk.com/document/isvapp/dingtalk-oapi-alitrip-btrip-exceedapply-sync
378
+ */
379
+ syncExceedApply(query: SyncExceedApplyQuery): Promise<SyncExceedApplyResponse>;
380
+ /**
381
+ * 查询市内用车申请单
382
+ * @see https://developers.dingtalk.com/document/isvapp/query-the-application-form-for-third-party-vehicles-in-the-city
383
+ */
384
+ queryCityCarApply(query: QueryCityCarApplyQuery): Promise<QueryCityCarApplyResponse>;
385
+ /**
386
+ * 审批市内用车申请单
387
+ * @see https://developers.dingtalk.com/document/isvapp/approval-of-third-party-city-car-application-form
388
+ */
389
+ approveCityCarApply(params: ApproveCityCarApplyParams): Promise<ApproveCityCarApplyResponse>;
390
+ /**
391
+ * 同步市内用车申请单
392
+ * @see https://developers.dingtalk.com/document/isvapp/synchronize-third-party-city-vehicle-approval-form
393
+ */
394
+ addCityCarApply(params: AddCityCarApplyParams): Promise<AddCityCarApplyResponse>;
395
+ }
396
+ }
@@ -0,0 +1,62 @@
1
+ export interface GetAdjustmentsQuery {
2
+ /** 分页起始页。 */
3
+ pageNumber: number;
4
+ /** 分页大小。 */
5
+ pageSize: number;
6
+ }
7
+ export interface GetAdjustmentsResponse {
8
+ result?: {
9
+ pageNumber?: number;
10
+ totalPage?: number;
11
+ items?: number;
12
+ };
13
+ }
14
+ export interface GetSimpleOvertimeSettingQuery {
15
+ /** 分页起始页。 */
16
+ pageNumber: number;
17
+ /** 分页大小。 */
18
+ pageSize: number;
19
+ }
20
+ export interface GetSimpleOvertimeSettingResponse {
21
+ result?: {
22
+ pageNumber?: number;
23
+ totalPage?: number;
24
+ items?: number;
25
+ };
26
+ }
27
+ export interface GetOvertimeSettingParams {
28
+ overtimeSettingIds?: number[];
29
+ }
30
+ export interface GetOvertimeSettingResponse {
31
+ result: {
32
+ settingId?: number;
33
+ name?: string;
34
+ default?: number;
35
+ durationSettings?: number;
36
+ warningSettings?: number;
37
+ stepType?: number;
38
+ stepValue?: number;
39
+ workMinutesPerDay?: number;
40
+ overtimeDivisions?: number;
41
+ id: number;
42
+ }[];
43
+ }
44
+ declare module '../internal' {
45
+ interface Internal {
46
+ /**
47
+ * 获取补卡规则列表
48
+ * @see https://developers.dingtalk.com/document/isvapp/retrieve-a-list-of-replenishment-rules-by-page
49
+ */
50
+ getAdjustments(query: GetAdjustmentsQuery): Promise<GetAdjustmentsResponse>;
51
+ /**
52
+ * 加班规则列表
53
+ * @see https://developers.dingtalk.com/document/isvapp/retrieve-a-list-of-overtime-rules-by-page
54
+ */
55
+ getSimpleOvertimeSetting(query: GetSimpleOvertimeSettingQuery): Promise<GetSimpleOvertimeSettingResponse>;
56
+ /**
57
+ * 批量获取加班规则设置
58
+ * @see https://developers.dingtalk.com/document/isvapp/batch-retrieve-overtime-rules
59
+ */
60
+ getOvertimeSetting(params: GetOvertimeSettingParams): Promise<GetOvertimeSettingResponse>;
61
+ }
62
+ }
@@ -0,0 +1,232 @@
1
+ export interface CreateBadgeNotifyParams {
2
+ /** 用户userid。 */
3
+ userId: string;
4
+ /** 消息传入,调用方传入,唯一标识消息。 */
5
+ msgId: string;
6
+ /** 消息类型,取值: */
7
+ msgType: string;
8
+ /** 通知内容 */
9
+ content: string;
10
+ }
11
+ export interface CreateBadgeNotifyResponse {
12
+ result: unknown;
13
+ }
14
+ export interface NotifyBadgeCodeVerifyResultParams {
15
+ /** 码值,接入方硬件设备扫描钉工牌二维码获取的码值。 */
16
+ payCode: string;
17
+ /** 企业corpId。 */
18
+ corpId: string;
19
+ /** 用户和企业的关系类型,用于区分内部员工,外部联系人,无关系普通用户。 */
20
+ userCorpRelationType: string;
21
+ /** 用户身份标识。 */
22
+ userIdentity: string;
23
+ /** 验证时间。 */
24
+ verifyTime: string;
25
+ /** 验证结果。 */
26
+ verifyResult: unknown;
27
+ /** 验证地点。 */
28
+ verifyLocation?: string;
29
+ /** 验证流水号,可随机生成,确保用户下唯一 */
30
+ verifyNo?: string;
31
+ /** 验证事件。8个汉字以内,如门禁验证、班车登记、餐盘绑定等。 */
32
+ verifyEvent?: string;
33
+ /** 备注信息。 */
34
+ remark?: string;
35
+ }
36
+ export interface NotifyBadgeCodeVerifyResultResponse {
37
+ result: string;
38
+ }
39
+ export interface SaveBadgeCodeCorpInstanceParams {
40
+ /** 码标识,取值: */
41
+ codeIdentity: string;
42
+ /** 开通的企业corpId。 */
43
+ corpId: string;
44
+ /** 状态,传入关闭状态需要用户手动开启后才会渲染二维码。 */
45
+ status: string;
46
+ /** 扩展参数,是否关联支付宝。 */
47
+ extInfo?: unknown;
48
+ }
49
+ export interface SaveBadgeCodeCorpInstanceResponse {
50
+ codeIdentity?: string;
51
+ corpId?: string;
52
+ status?: string;
53
+ extInfo?: unknown;
54
+ }
55
+ export interface NotifyBadgeCodePayResultParams {
56
+ /** 码值,接入方硬件设备扫描钉工牌二维码获取的码值。 */
57
+ payCode: string;
58
+ /** 企业corpId。 */
59
+ corpId: string;
60
+ /** 用户userid,需要与生成码时传入的**userid**保持一致。 */
61
+ userId: string;
62
+ /** 交易开始时间。 */
63
+ gmtTradeCreate: string;
64
+ /** 交易结束时间。 */
65
+ gmtTradeFinish: string;
66
+ /** 交易号,接入方自身系统针对交易生成的唯一订单号。 */
67
+ tradeNo: string;
68
+ /** 交易状态,取值: */
69
+ tradeStatus: string;
70
+ /** 订单标题。 */
71
+ title: string;
72
+ /** 备注。 */
73
+ remark: string;
74
+ /** 订单金额。 */
75
+ amount: string;
76
+ /** 订单优惠金额。 */
77
+ promotionAmount: string;
78
+ /** 收费金额。 */
79
+ chargeAmount: string;
80
+ /** 支付渠道明细信息。 */
81
+ payChannelDetailList: object[];
82
+ /** 支付失败错误码,当**tradeStatus**为**FAIL**时必须传入。 */
83
+ tradeErrorCode?: string;
84
+ /** 支付失败信息,当**tradeStatus**为**FAIL**时必须传入。 */
85
+ tradeErrorMsg?: string;
86
+ /** 扩展信息。 */
87
+ extInfo?: string;
88
+ /** 商户名称。 */
89
+ merchantName: string;
90
+ }
91
+ export interface NotifyBadgeCodePayResultResponse {
92
+ result: string;
93
+ }
94
+ export interface CreateBadgeCodeUserInstanceParams {
95
+ /** 业务幂等ID,由调用方随机生成。 */
96
+ requestId: string;
97
+ /** 码标识,取值: */
98
+ codeIdentity: string;
99
+ /** 码值,由调用方生成。 */
100
+ codeValue?: string;
101
+ /** 码值类型,可不传,默认为DING_STATIC */
102
+ codeValueType?: string;
103
+ /** 状态,传入关闭状态需要用户手动开启后才会渲染二维码。 */
104
+ status: string;
105
+ /** 企业corpId。 */
106
+ corpId: string;
107
+ /** 用户和企业的关系类型,用于区分内部员工,外部联系人,无关系普通用户。 */
108
+ userCorpRelationType: string;
109
+ /** 用户身份标识。 */
110
+ userIdentity: string;
111
+ /** 临时码过期时间,格式:yyyy-MM-dd HH:mm:ss。 */
112
+ gmtExpired: string;
113
+ /** 有效时间列表,对于连续时间段,只需传入一个对象即可。 */
114
+ availableTimes: object[];
115
+ /** 扩展参数。 */
116
+ extInfo: unknown;
117
+ }
118
+ export interface CreateBadgeCodeUserInstanceResponse {
119
+ codeId: string;
120
+ codeDetailUrl?: string;
121
+ }
122
+ export interface NotifyBadgeCodeRefundResultParams {
123
+ /** 企业的corpId。 */
124
+ corpId: string;
125
+ /** 用户userid,需要与生成码时使用的**userid**保持一致。 */
126
+ userId: string;
127
+ /** 交易订单号,自定义,接入方针对交易生成的唯一订单号。 */
128
+ tradeNo: string;
129
+ /** 本次退款订单号,自定义,接入方针对交易生成的唯一退款订单号。 */
130
+ refundOrderNo: string;
131
+ /** 备注。 */
132
+ remark: string;
133
+ /** 退款金额。 */
134
+ refundAmount: string;
135
+ /** 退款的优惠金额。 */
136
+ refundPromotionAmount: string;
137
+ /** 退款时间。 */
138
+ gmtRefund: string;
139
+ /** 支付渠道明细信息。 */
140
+ payChannelDetailList: object[];
141
+ /** 支付时使用的付款码。 */
142
+ payCode: string;
143
+ }
144
+ export interface NotifyBadgeCodeRefundResultResponse {
145
+ result: string;
146
+ }
147
+ export interface UpdateBadgeCodeUserInstanceParams {
148
+ /** 用户码ID。 */
149
+ codeId: string;
150
+ /** 码标识,取值: */
151
+ codeIdentity: string;
152
+ /** 码值,由调用方生成。 */
153
+ codeValue?: string;
154
+ /** 状态,传入关闭状态需要用户手动开启后才会渲染二维码。 */
155
+ status?: string;
156
+ /** 企业corpId。 */
157
+ corpId: string;
158
+ /** 用户和企业的关系类型,用于区分内部员工,外部联系人,无关系普通用户。 */
159
+ userCorpRelationType: string;
160
+ /** 用户身份标识。 */
161
+ userIdentity: string;
162
+ /** 临时码过期时间,格式:yyyy-MM-dd HH:mm:ss。 */
163
+ gmtExpired: string;
164
+ /** 有效时间列表,对于连续时间段,只需传入一个对象即可。 */
165
+ availableTimes: object[];
166
+ /** 扩展参数。 */
167
+ extInfo: unknown;
168
+ }
169
+ export interface UpdateBadgeCodeUserInstanceResponse {
170
+ codeId?: string;
171
+ }
172
+ export interface DecodeBadgeCodeParams {
173
+ /** 码值,解码接口仅支持钉钉侧生成的码值。 */
174
+ payCode: string;
175
+ /** 请求ID,由调用方随机生成幂等字符串。 */
176
+ requestId: string;
177
+ }
178
+ export interface DecodeBadgeCodeResponse {
179
+ corpId: string;
180
+ userId?: string;
181
+ codeType: string;
182
+ alipayCode: string;
183
+ userCorpRelationType: string;
184
+ codeIdentity?: string;
185
+ codeId?: string;
186
+ outBizId?: string;
187
+ extInfo?: string;
188
+ }
189
+ declare module '../internal' {
190
+ interface Internal {
191
+ /**
192
+ * 钉工牌通知消息
193
+ * @see https://developers.dingtalk.com/document/isvapp/dingtalk-badge-notification-message
194
+ */
195
+ createBadgeNotify(params: CreateBadgeNotifyParams): Promise<CreateBadgeNotifyResponse>;
196
+ /**
197
+ * 通知钉工牌码验证结果
198
+ * @see https://developers.dingtalk.com/document/isvapp/notification-dingtalk-badge-verification-result
199
+ */
200
+ notifyBadgeCodeVerifyResult(params: NotifyBadgeCodeVerifyResultParams): Promise<NotifyBadgeCodeVerifyResultResponse>;
201
+ /**
202
+ * 配置企业钉工牌
203
+ * @see https://developers.dingtalk.com/document/isvapp/save-dingtalk-enterprise-instance
204
+ */
205
+ saveBadgeCodeCorpInstance(params: SaveBadgeCodeCorpInstanceParams): Promise<SaveBadgeCodeCorpInstanceResponse>;
206
+ /**
207
+ * 通知支付结果
208
+ * @see https://developers.dingtalk.com/document/isvapp/sync-dingtalk-badge-code-payment-result
209
+ */
210
+ notifyBadgeCodePayResult(params: NotifyBadgeCodePayResultParams): Promise<NotifyBadgeCodePayResultResponse>;
211
+ /**
212
+ * 创建钉工牌电子码
213
+ * @see https://developers.dingtalk.com/document/isvapp/create-a-badge-user-instance
214
+ */
215
+ createBadgeCodeUserInstance(params: CreateBadgeCodeUserInstanceParams): Promise<CreateBadgeCodeUserInstanceResponse>;
216
+ /**
217
+ * 通知退款结果
218
+ * @see https://developers.dingtalk.com/document/isvapp/notification-dingtalk-badge-code-refund-result
219
+ */
220
+ notifyBadgeCodeRefundResult(params: NotifyBadgeCodeRefundResultParams): Promise<NotifyBadgeCodeRefundResultResponse>;
221
+ /**
222
+ * 更新钉工牌电子码
223
+ * @see https://developers.dingtalk.com/document/isvapp/update-dingtalk-user-instance
224
+ */
225
+ updateBadgeCodeUserInstance(params: UpdateBadgeCodeUserInstanceParams): Promise<UpdateBadgeCodeUserInstanceResponse>;
226
+ /**
227
+ * 解码钉工牌电子码
228
+ * @see https://developers.dingtalk.com/document/isvapp/stack-dingtalk-badge
229
+ */
230
+ decodeBadgeCode(params: DecodeBadgeCodeParams): Promise<DecodeBadgeCodeResponse>;
231
+ }
232
+ }
@@ -0,0 +1,16 @@
1
+ export interface QueryBlackboardSpaceQuery {
2
+ /** 操作人userId。 */
3
+ operationUserId: string;
4
+ }
5
+ export interface QueryBlackboardSpaceResponse {
6
+ spaceId?: string;
7
+ }
8
+ declare module '../internal' {
9
+ interface Internal {
10
+ /**
11
+ * 获取公告钉盘空间信息
12
+ * @see https://developers.dingtalk.com/document/app/obtain-bulletin-nail-disk-space-information
13
+ */
14
+ queryBlackboardSpace(query: QueryBlackboardSpaceQuery): Promise<QueryBlackboardSpaceResponse>;
15
+ }
16
+ }