shcp-api-lib 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 (78) hide show
  1. package/README.md +74 -0
  2. package/dist/index.d.ts +5660 -0
  3. package/dist/index.esm.js +2954 -0
  4. package/dist/index.esm.js.map +1 -0
  5. package/dist/index.js +3038 -0
  6. package/dist/index.js.map +1 -0
  7. package/dist/types/src/api/app-client-api.d.ts +12 -0
  8. package/dist/types/src/api/app-client-page-config-api.d.ts +5 -0
  9. package/dist/types/src/api/app-client-setting-api.d.ts +5 -0
  10. package/dist/types/src/api/common-dict-api.d.ts +40 -0
  11. package/dist/types/src/api/common-file-api.d.ts +5 -0
  12. package/dist/types/src/api/common-right-api.d.ts +60 -0
  13. package/dist/types/src/api/consumer-api.d.ts +39 -0
  14. package/dist/types/src/api/consumer-bind-api.d.ts +15 -0
  15. package/dist/types/src/api/consumer-device-api.d.ts +24 -0
  16. package/dist/types/src/api/consumer-favorite-api.d.ts +8 -0
  17. package/dist/types/src/api/device-api.d.ts +19 -0
  18. package/dist/types/src/api/device-user-api.d.ts +29 -0
  19. package/dist/types/src/api/disease-care-right-api.d.ts +22 -0
  20. package/dist/types/src/api/health-common-api.d.ts +15 -0
  21. package/dist/types/src/api/health-metric-api.d.ts +9 -0
  22. package/dist/types/src/api/health-profile-api.d.ts +8 -0
  23. package/dist/types/src/api/health-self-assess-api.d.ts +8 -0
  24. package/dist/types/src/api/health-study-right-api.d.ts +23 -0
  25. package/dist/types/src/api/health-tool-api.d.ts +14 -0
  26. package/dist/types/src/api/help-center.d.ts +4 -0
  27. package/dist/types/src/api/im-user-api.d.ts +7 -0
  28. package/dist/types/src/api/index.d.ts +32 -0
  29. package/dist/types/src/api/km-article-api.d.ts +9 -0
  30. package/dist/types/src/api/km-form-api.d.ts +10 -0
  31. package/dist/types/src/api/km-form-rule-relation-api.d.ts +6 -0
  32. package/dist/types/src/api/login-api.d.ts +18 -0
  33. package/dist/types/src/api/marketing-api.d.ts +16 -0
  34. package/dist/types/src/api/message-record-api.d.ts +7 -0
  35. package/dist/types/src/api/mine-api.d.ts +8 -0
  36. package/dist/types/src/api/right-qrcode-api.d.ts +9 -0
  37. package/dist/types/src/api/right-service-config-api.d.ts +18 -0
  38. package/dist/types/src/api/system-right-api.d.ts +17 -0
  39. package/dist/types/src/api/user-group-api.d.ts +11 -0
  40. package/dist/types/src/constants/km-const.d.ts +59 -0
  41. package/dist/types/src/constants/metric.d.ts +17 -0
  42. package/dist/types/src/constants/qiniuUploader.d.ts +49 -0
  43. package/dist/types/src/constants/shcp-common.d.ts +428 -0
  44. package/dist/types/src/index.d.ts +4 -0
  45. package/dist/types/src/shcp-api-sdk.d.ts +26 -0
  46. package/dist/types/src/type/model/app-client-model.d.ts +138 -0
  47. package/dist/types/src/type/model/app-client-setting-model.d.ts +46 -0
  48. package/dist/types/src/type/model/blade-system-model.d.ts +34 -0
  49. package/dist/types/src/type/model/common-dict-model.d.ts +100 -0
  50. package/dist/types/src/type/model/common-file-model.d.ts +10 -0
  51. package/dist/types/src/type/model/common-model.d.ts +9 -0
  52. package/dist/types/src/type/model/common-right-model.d.ts +929 -0
  53. package/dist/types/src/type/model/consumer-bind-model.d.ts +175 -0
  54. package/dist/types/src/type/model/consumer-device-model.d.ts +114 -0
  55. package/dist/types/src/type/model/consumer-favorite-model.d.ts +105 -0
  56. package/dist/types/src/type/model/consumer-model.d.ts +214 -0
  57. package/dist/types/src/type/model/device-model.d.ts +295 -0
  58. package/dist/types/src/type/model/device-user-model.d.ts +53 -0
  59. package/dist/types/src/type/model/health-care-config-model.d.ts +301 -0
  60. package/dist/types/src/type/model/health-metric-model.d.ts +181 -0
  61. package/dist/types/src/type/model/health-profile-model.d.ts +83 -0
  62. package/dist/types/src/type/model/health-self-assess-model.d.ts +35 -0
  63. package/dist/types/src/type/model/health-tool-model.d.ts +105 -0
  64. package/dist/types/src/type/model/im-user-model.d.ts +44 -0
  65. package/dist/types/src/type/model/index.d.ts +30 -0
  66. package/dist/types/src/type/model/km-article-model.d.ts +275 -0
  67. package/dist/types/src/type/model/km-form-model.d.ts +745 -0
  68. package/dist/types/src/type/model/km-form-rule-relation-model.d.ts +31 -0
  69. package/dist/types/src/type/model/login-model.d.ts +90 -0
  70. package/dist/types/src/type/model/marketing-model.d.ts +142 -0
  71. package/dist/types/src/type/model/message-record-model.d.ts +59 -0
  72. package/dist/types/src/type/model/mine-model.d.ts +100 -0
  73. package/dist/types/src/type/model/right-qrcode-model.d.ts +143 -0
  74. package/dist/types/src/type/model/right-service-config-model.d.ts +2 -0
  75. package/dist/types/src/type/model/system-right-model.d.ts +134 -0
  76. package/dist/types/src/type/model/user-group-model.d.ts +45 -0
  77. package/dist/types/src/type/net-types.d.ts +37 -0
  78. package/package.json +47 -0
@@ -0,0 +1,275 @@
1
+ import { PageRequest } from './common-model';
2
+ /**
3
+ * 请求文章分类树请求入参
4
+ */
5
+ export interface ArticleCategoryTreeRequest {
6
+ /**
7
+ * 租户id
8
+ */
9
+ tenantId?: string;
10
+ /**
11
+ * 类型,1.业务类,2.标签类,3.系统类
12
+ */
13
+ type: number;
14
+ /**
15
+ * 根节点
16
+ */
17
+ rootId?: number | string;
18
+ }
19
+ /**
20
+ * 文章分类DTO
21
+ */
22
+ export interface ArticleCategoryDTO {
23
+ /**
24
+ * 分类id
25
+ */
26
+ id?: number;
27
+ /**
28
+ * 分类名称
29
+ */
30
+ name?: string;
31
+ /**
32
+ * 分类的类型,1.业务类,2.标签类,3系统类
33
+ */
34
+ type?: number;
35
+ /**
36
+ * 分类备注
37
+ */
38
+ remark?: string;
39
+ /**
40
+ * 父分类id
41
+ */
42
+ parentId?: number;
43
+ /**
44
+ * 是否有子分类,0.不存在,1.存在
45
+ */
46
+ hasChildren?: number;
47
+ /**
48
+ * 子分类
49
+ */
50
+ children?: ArticleCategoryDTO[];
51
+ /**
52
+ * 排序字段
53
+ */
54
+ sort?: number;
55
+ }
56
+ /**
57
+ * 文章查询参数
58
+ */
59
+ export interface ArticleQuery extends PageRequest {
60
+ /**
61
+ * 文章标题-模糊查询
62
+ */
63
+ title?: string;
64
+ /**
65
+ * 文章标题-精确查询
66
+ */
67
+ titleExact?: string;
68
+ /**
69
+ * 租户编码
70
+ */
71
+ tenantId?: string;
72
+ /**
73
+ * 文章类型
74
+ */
75
+ type?: number;
76
+ /**
77
+ * 创建人
78
+ */
79
+ createUser?: number;
80
+ /**
81
+ * 开始时间
82
+ */
83
+ startTime?: string;
84
+ /**
85
+ * 结束时间
86
+ */
87
+ endTime?: string;
88
+ /**
89
+ * 文章状态,1.草稿,2.已提交,3.已公开,4.已下架
90
+ */
91
+ status?: number;
92
+ /**
93
+ * 文章状态集合,1.草稿,2.已提交,3.已公开,4.已下架
94
+ */
95
+ statusList?: number[];
96
+ /**
97
+ * 文章可见性
98
+ */
99
+ visibility?: string;
100
+ /**
101
+ * 创建人名称
102
+ */
103
+ createUserName?: string;
104
+ /**
105
+ * 文章id集合
106
+ */
107
+ idList?: number[];
108
+ /**
109
+ * 标签ID列表
110
+ */
111
+ tagIdList?: number[];
112
+ /**
113
+ * 分类类型
114
+ */
115
+ categoryType?: number;
116
+ /**
117
+ * 分类ID列表
118
+ */
119
+ categoryIdList?: number[];
120
+ /**
121
+ * 是否草稿 0,否;1,是
122
+ */
123
+ isDraft?: number;
124
+ /**
125
+ * 是否获取内容,0.否,1.是
126
+ */
127
+ isContent?: number;
128
+ }
129
+ /**
130
+ * 文章DTO
131
+ */
132
+ export interface ArticleDTO {
133
+ /**
134
+ * 文章id
135
+ */
136
+ id?: number;
137
+ /**
138
+ * 租户id
139
+ */
140
+ tenantId?: string;
141
+ /**
142
+ * 文章标题
143
+ */
144
+ title?: string;
145
+ /**
146
+ * 文章副标题
147
+ */
148
+ subTitle?: string;
149
+ /**
150
+ * 文章内容
151
+ */
152
+ content?: string;
153
+ /**
154
+ * 文章摘要
155
+ */
156
+ remark?: string;
157
+ /**
158
+ * 文章封面图片URL
159
+ */
160
+ cover?: string;
161
+ /**
162
+ * 文章状态
163
+ */
164
+ status?: number;
165
+ /**
166
+ * 文章浏览量
167
+ */
168
+ viewCount?: number;
169
+ /**
170
+ * 文章引用量
171
+ */
172
+ referenceCount?: number;
173
+ /**
174
+ * 文章类型
175
+ */
176
+ type?: number;
177
+ /**
178
+ * 文章分类
179
+ */
180
+ categories?: ArticleCategoryDTO[];
181
+ /**
182
+ * 文章标签
183
+ */
184
+ tags?: ArticleTagDTO[];
185
+ /**
186
+ * 创建人id
187
+ */
188
+ createUser?: number;
189
+ /**
190
+ * 创建人名称
191
+ */
192
+ createUserName?: string;
193
+ /**
194
+ * 创建时间
195
+ */
196
+ createTime?: string;
197
+ /**
198
+ * 是否存在草稿,0.不存在,1.存在
199
+ */
200
+ hasDraft?: number;
201
+ }
202
+ /**
203
+ * 文章标签DTO
204
+ */
205
+ export interface ArticleTagDTO {
206
+ /**
207
+ * 标签id
208
+ */
209
+ id?: number;
210
+ /**
211
+ * 标签名称
212
+ */
213
+ name?: string;
214
+ /**
215
+ * 关联文章数量
216
+ */
217
+ relevancyArticleCount?: number;
218
+ /**
219
+ * 创建人
220
+ */
221
+ createUser?: number;
222
+ /**
223
+ * 创建人名称
224
+ */
225
+ createUserName?: string;
226
+ /**
227
+ * 分类列表
228
+ */
229
+ categories?: ArticleCategoryDTO[];
230
+ /**
231
+ * 创建时间
232
+ */
233
+ createTime?: string;
234
+ }
235
+ /**
236
+ * 文章标签查询参数
237
+ */
238
+ export interface ArticleTagQuery extends PageRequest {
239
+ /**
240
+ * 租户id
241
+ */
242
+ tenantId: string;
243
+ /**
244
+ * 标签名称-模糊查询
245
+ */
246
+ name?: string;
247
+ /**
248
+ * 标签名称-精确查询
249
+ */
250
+ nameExact?: string;
251
+ /**
252
+ * 创建人
253
+ */
254
+ createUser?: number;
255
+ /**
256
+ * 创建人名称
257
+ */
258
+ createUserName?: string;
259
+ /**
260
+ * 开始时间
261
+ */
262
+ startTime?: string;
263
+ /**
264
+ * 结束时间
265
+ */
266
+ endTime?: string;
267
+ /**
268
+ * 标签分类id集合
269
+ */
270
+ tagCategoryIdList?: number[];
271
+ /**
272
+ * 文章类型(影响标签绑定文章数量)-1.文章主体,2文章草稿
273
+ */
274
+ articleType?: number;
275
+ }