@n8n-dev/n8n-nodes-chatwoot 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 (111) hide show
  1. package/README.md +26 -0
  2. package/dist/credentials/ChatwootApi.credentials.d.ts +10 -0
  3. package/dist/credentials/ChatwootApi.credentials.js +47 -0
  4. package/dist/credentials/ChatwootApi.credentials.js.map +1 -0
  5. package/dist/icons/chatwoot.dark.svg +4 -0
  6. package/dist/icons/chatwoot.svg +4 -0
  7. package/dist/nodes/Chatwoot/Chatwoot.node.d.ts +4 -0
  8. package/dist/nodes/Chatwoot/Chatwoot.node.js +264 -0
  9. package/dist/nodes/Chatwoot/Chatwoot.node.js.map +1 -0
  10. package/dist/nodes/Chatwoot/Chatwoot.node.json +20 -0
  11. package/dist/nodes/Chatwoot/chatwoot.dark.svg +4 -0
  12. package/dist/nodes/Chatwoot/chatwoot.svg +4 -0
  13. package/dist/nodes/Chatwoot/resources/account/index.d.ts +2 -0
  14. package/dist/nodes/Chatwoot/resources/account/index.js +370 -0
  15. package/dist/nodes/Chatwoot/resources/account/index.js.map +1 -0
  16. package/dist/nodes/Chatwoot/resources/account-agent-bots/index.d.ts +2 -0
  17. package/dist/nodes/Chatwoot/resources/account-agent-bots/index.js +527 -0
  18. package/dist/nodes/Chatwoot/resources/account-agent-bots/index.js.map +1 -0
  19. package/dist/nodes/Chatwoot/resources/account-users/index.d.ts +2 -0
  20. package/dist/nodes/Chatwoot/resources/account-users/index.js +167 -0
  21. package/dist/nodes/Chatwoot/resources/account-users/index.js.map +1 -0
  22. package/dist/nodes/Chatwoot/resources/accounts/index.d.ts +2 -0
  23. package/dist/nodes/Chatwoot/resources/accounts/index.js +516 -0
  24. package/dist/nodes/Chatwoot/resources/accounts/index.js.map +1 -0
  25. package/dist/nodes/Chatwoot/resources/agent-bots/index.d.ts +2 -0
  26. package/dist/nodes/Chatwoot/resources/agent-bots/index.js +477 -0
  27. package/dist/nodes/Chatwoot/resources/agent-bots/index.js.map +1 -0
  28. package/dist/nodes/Chatwoot/resources/agents/index.d.ts +2 -0
  29. package/dist/nodes/Chatwoot/resources/agents/index.js +434 -0
  30. package/dist/nodes/Chatwoot/resources/agents/index.js.map +1 -0
  31. package/dist/nodes/Chatwoot/resources/audit-logs/index.d.ts +2 -0
  32. package/dist/nodes/Chatwoot/resources/audit-logs/index.js +78 -0
  33. package/dist/nodes/Chatwoot/resources/audit-logs/index.js.map +1 -0
  34. package/dist/nodes/Chatwoot/resources/automation-rule/index.d.ts +2 -0
  35. package/dist/nodes/Chatwoot/resources/automation-rule/index.js +610 -0
  36. package/dist/nodes/Chatwoot/resources/automation-rule/index.js.map +1 -0
  37. package/dist/nodes/Chatwoot/resources/canned-responses/index.d.ts +2 -0
  38. package/dist/nodes/Chatwoot/resources/canned-responses/index.js +282 -0
  39. package/dist/nodes/Chatwoot/resources/canned-responses/index.js.map +1 -0
  40. package/dist/nodes/Chatwoot/resources/contact-labels/index.d.ts +2 -0
  41. package/dist/nodes/Chatwoot/resources/contact-labels/index.js +110 -0
  42. package/dist/nodes/Chatwoot/resources/contact-labels/index.js.map +1 -0
  43. package/dist/nodes/Chatwoot/resources/contacts/index.d.ts +2 -0
  44. package/dist/nodes/Chatwoot/resources/contacts/index.js +1345 -0
  45. package/dist/nodes/Chatwoot/resources/contacts/index.js.map +1 -0
  46. package/dist/nodes/Chatwoot/resources/contacts-api/index.d.ts +2 -0
  47. package/dist/nodes/Chatwoot/resources/contacts-api/index.js +465 -0
  48. package/dist/nodes/Chatwoot/resources/contacts-api/index.js.map +1 -0
  49. package/dist/nodes/Chatwoot/resources/conversation/index.d.ts +2 -0
  50. package/dist/nodes/Chatwoot/resources/conversation/index.js +53 -0
  51. package/dist/nodes/Chatwoot/resources/conversation/index.js.map +1 -0
  52. package/dist/nodes/Chatwoot/resources/conversation-assignments/index.d.ts +2 -0
  53. package/dist/nodes/Chatwoot/resources/conversation-assignments/index.js +103 -0
  54. package/dist/nodes/Chatwoot/resources/conversation-assignments/index.js.map +1 -0
  55. package/dist/nodes/Chatwoot/resources/conversations/index.d.ts +2 -0
  56. package/dist/nodes/Chatwoot/resources/conversations/index.js +1396 -0
  57. package/dist/nodes/Chatwoot/resources/conversations/index.js.map +1 -0
  58. package/dist/nodes/Chatwoot/resources/conversations-api/index.d.ts +2 -0
  59. package/dist/nodes/Chatwoot/resources/conversations-api/index.js +294 -0
  60. package/dist/nodes/Chatwoot/resources/conversations-api/index.js.map +1 -0
  61. package/dist/nodes/Chatwoot/resources/csat-survey-page/index.d.ts +2 -0
  62. package/dist/nodes/Chatwoot/resources/csat-survey-page/index.js +53 -0
  63. package/dist/nodes/Chatwoot/resources/csat-survey-page/index.js.map +1 -0
  64. package/dist/nodes/Chatwoot/resources/custom-attributes/index.d.ts +2 -0
  65. package/dist/nodes/Chatwoot/resources/custom-attributes/index.js +703 -0
  66. package/dist/nodes/Chatwoot/resources/custom-attributes/index.js.map +1 -0
  67. package/dist/nodes/Chatwoot/resources/custom-filters/index.d.ts +2 -0
  68. package/dist/nodes/Chatwoot/resources/custom-filters/index.js +373 -0
  69. package/dist/nodes/Chatwoot/resources/custom-filters/index.js.map +1 -0
  70. package/dist/nodes/Chatwoot/resources/help-center/index.d.ts +2 -0
  71. package/dist/nodes/Chatwoot/resources/help-center/index.js +1156 -0
  72. package/dist/nodes/Chatwoot/resources/help-center/index.js.map +1 -0
  73. package/dist/nodes/Chatwoot/resources/inbox-api/index.d.ts +2 -0
  74. package/dist/nodes/Chatwoot/resources/inbox-api/index.js +53 -0
  75. package/dist/nodes/Chatwoot/resources/inbox-api/index.js.map +1 -0
  76. package/dist/nodes/Chatwoot/resources/inboxes/index.d.ts +2 -0
  77. package/dist/nodes/Chatwoot/resources/inboxes/index.js +1580 -0
  78. package/dist/nodes/Chatwoot/resources/inboxes/index.js.map +1 -0
  79. package/dist/nodes/Chatwoot/resources/index.d.ts +31 -0
  80. package/dist/nodes/Chatwoot/resources/index.js +66 -0
  81. package/dist/nodes/Chatwoot/resources/index.js.map +1 -0
  82. package/dist/nodes/Chatwoot/resources/integrations/index.d.ts +2 -0
  83. package/dist/nodes/Chatwoot/resources/integrations/index.js +386 -0
  84. package/dist/nodes/Chatwoot/resources/integrations/index.js.map +1 -0
  85. package/dist/nodes/Chatwoot/resources/labels/index.d.ts +2 -0
  86. package/dist/nodes/Chatwoot/resources/labels/index.js +377 -0
  87. package/dist/nodes/Chatwoot/resources/labels/index.js.map +1 -0
  88. package/dist/nodes/Chatwoot/resources/messages/index.d.ts +2 -0
  89. package/dist/nodes/Chatwoot/resources/messages/index.js +377 -0
  90. package/dist/nodes/Chatwoot/resources/messages/index.js.map +1 -0
  91. package/dist/nodes/Chatwoot/resources/messages-api/index.d.ts +2 -0
  92. package/dist/nodes/Chatwoot/resources/messages-api/index.js +190 -0
  93. package/dist/nodes/Chatwoot/resources/messages-api/index.js.map +1 -0
  94. package/dist/nodes/Chatwoot/resources/profile/index.d.ts +2 -0
  95. package/dist/nodes/Chatwoot/resources/profile/index.js +109 -0
  96. package/dist/nodes/Chatwoot/resources/profile/index.js.map +1 -0
  97. package/dist/nodes/Chatwoot/resources/reports/index.d.ts +2 -0
  98. package/dist/nodes/Chatwoot/resources/reports/index.js +588 -0
  99. package/dist/nodes/Chatwoot/resources/reports/index.js.map +1 -0
  100. package/dist/nodes/Chatwoot/resources/teams/index.d.ts +2 -0
  101. package/dist/nodes/Chatwoot/resources/teams/index.js +583 -0
  102. package/dist/nodes/Chatwoot/resources/teams/index.js.map +1 -0
  103. package/dist/nodes/Chatwoot/resources/users/index.d.ts +2 -0
  104. package/dist/nodes/Chatwoot/resources/users/index.js +427 -0
  105. package/dist/nodes/Chatwoot/resources/users/index.js.map +1 -0
  106. package/dist/nodes/Chatwoot/resources/webhooks/index.d.ts +2 -0
  107. package/dist/nodes/Chatwoot/resources/webhooks/index.js +332 -0
  108. package/dist/nodes/Chatwoot/resources/webhooks/index.js.map +1 -0
  109. package/dist/package.json +53 -0
  110. package/dist/tsconfig.tsbuildinfo +1 -0
  111. package/package.json +53 -0
@@ -0,0 +1,1156 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.helpCenterDescription = void 0;
4
+ exports.helpCenterDescription = [
5
+ {
6
+ "displayName": "Operation",
7
+ "name": "operation",
8
+ "type": "options",
9
+ "noDataExpression": true,
10
+ "displayOptions": {
11
+ "show": {
12
+ "resource": [
13
+ "Help Center"
14
+ ]
15
+ }
16
+ },
17
+ "options": [
18
+ {
19
+ "name": "Add New Portal To Account",
20
+ "value": "Add New Portal To Account",
21
+ "action": "Add a new portal",
22
+ "description": "Add a new portal to account",
23
+ "routing": {
24
+ "request": {
25
+ "method": "POST",
26
+ "url": "=/api/v1/accounts/{{$parameter[\"account_id\"]}}/portals"
27
+ }
28
+ }
29
+ },
30
+ {
31
+ "name": "Get Portal",
32
+ "value": "Get Portal",
33
+ "action": "List all portals in an account",
34
+ "description": "Get details of portals in an Account",
35
+ "routing": {
36
+ "request": {
37
+ "method": "GET",
38
+ "url": "=/api/v1/accounts/{{$parameter[\"account_id\"]}}/portals"
39
+ }
40
+ }
41
+ },
42
+ {
43
+ "name": "Update Portal To Account",
44
+ "value": "Update Portal To Account",
45
+ "action": "Update a portal",
46
+ "description": "Update a portal to account",
47
+ "routing": {
48
+ "request": {
49
+ "method": "PATCH",
50
+ "url": "=/api/v1/accounts/{{$parameter[\"account_id\"]}}/portals/{{$parameter[\"id\"]}}"
51
+ }
52
+ }
53
+ },
54
+ {
55
+ "name": "Add New Category To Account",
56
+ "value": "Add New Category To Account",
57
+ "action": "Add a new category",
58
+ "description": "Add a new category to portal",
59
+ "routing": {
60
+ "request": {
61
+ "method": "POST",
62
+ "url": "=/api/v1/accounts/{{$parameter[\"account_id\"]}}/portals/{{$parameter[\"id\"]}}/categories"
63
+ }
64
+ }
65
+ },
66
+ {
67
+ "name": "Add New Article To Account",
68
+ "value": "Add New Article To Account",
69
+ "action": "Add a new article",
70
+ "description": "Add a new article to portal",
71
+ "routing": {
72
+ "request": {
73
+ "method": "POST",
74
+ "url": "=/api/v1/accounts/{{$parameter[\"account_id\"]}}/portals/{{$parameter[\"id\"]}}/articles"
75
+ }
76
+ }
77
+ }
78
+ ],
79
+ "default": ""
80
+ },
81
+ {
82
+ "displayName": "POST /api/v1/accounts/{account_id}/portals",
83
+ "name": "operation",
84
+ "type": "notice",
85
+ "typeOptions": {
86
+ "theme": "info"
87
+ },
88
+ "default": "",
89
+ "displayOptions": {
90
+ "show": {
91
+ "resource": [
92
+ "Help Center"
93
+ ],
94
+ "operation": [
95
+ "Add New Portal To Account"
96
+ ]
97
+ }
98
+ }
99
+ },
100
+ {
101
+ "displayName": "Color",
102
+ "name": "color",
103
+ "type": "string",
104
+ "default": "#FFFFFF",
105
+ "description": "Header color for help-center in hex format",
106
+ "routing": {
107
+ "send": {
108
+ "property": "color",
109
+ "propertyInDotNotation": false,
110
+ "type": "body",
111
+ "value": "={{ $value }}"
112
+ }
113
+ },
114
+ "displayOptions": {
115
+ "show": {
116
+ "resource": [
117
+ "Help Center"
118
+ ],
119
+ "operation": [
120
+ "Add New Portal To Account"
121
+ ]
122
+ }
123
+ }
124
+ },
125
+ {
126
+ "displayName": "Custom Domain",
127
+ "name": "custom_domain",
128
+ "type": "string",
129
+ "default": "chatwoot.help",
130
+ "description": "Custom domain to display help center.",
131
+ "routing": {
132
+ "send": {
133
+ "property": "custom_domain",
134
+ "propertyInDotNotation": false,
135
+ "type": "body",
136
+ "value": "={{ $value }}"
137
+ }
138
+ },
139
+ "displayOptions": {
140
+ "show": {
141
+ "resource": [
142
+ "Help Center"
143
+ ],
144
+ "operation": [
145
+ "Add New Portal To Account"
146
+ ]
147
+ }
148
+ }
149
+ },
150
+ {
151
+ "displayName": "Header Text",
152
+ "name": "header_text",
153
+ "type": "string",
154
+ "default": "Handbook",
155
+ "description": "Help center header",
156
+ "routing": {
157
+ "send": {
158
+ "property": "header_text",
159
+ "propertyInDotNotation": false,
160
+ "type": "body",
161
+ "value": "={{ $value }}"
162
+ }
163
+ },
164
+ "displayOptions": {
165
+ "show": {
166
+ "resource": [
167
+ "Help Center"
168
+ ],
169
+ "operation": [
170
+ "Add New Portal To Account"
171
+ ]
172
+ }
173
+ }
174
+ },
175
+ {
176
+ "displayName": "Homepage Link",
177
+ "name": "homepage_link",
178
+ "type": "string",
179
+ "default": "https://www.chatwoot.com/",
180
+ "description": "link to main dashboard",
181
+ "routing": {
182
+ "send": {
183
+ "property": "homepage_link",
184
+ "propertyInDotNotation": false,
185
+ "type": "body",
186
+ "value": "={{ $value }}"
187
+ }
188
+ },
189
+ "displayOptions": {
190
+ "show": {
191
+ "resource": [
192
+ "Help Center"
193
+ ],
194
+ "operation": [
195
+ "Add New Portal To Account"
196
+ ]
197
+ }
198
+ }
199
+ },
200
+ {
201
+ "displayName": "Name",
202
+ "name": "name",
203
+ "type": "string",
204
+ "default": "Handbook",
205
+ "description": "Name for the portal",
206
+ "routing": {
207
+ "send": {
208
+ "property": "name",
209
+ "propertyInDotNotation": false,
210
+ "type": "body",
211
+ "value": "={{ $value }}"
212
+ }
213
+ },
214
+ "displayOptions": {
215
+ "show": {
216
+ "resource": [
217
+ "Help Center"
218
+ ],
219
+ "operation": [
220
+ "Add New Portal To Account"
221
+ ]
222
+ }
223
+ }
224
+ },
225
+ {
226
+ "displayName": "Page Title",
227
+ "name": "page_title",
228
+ "type": "string",
229
+ "default": "Handbook",
230
+ "description": "Page title for the portal",
231
+ "routing": {
232
+ "send": {
233
+ "property": "page_title",
234
+ "propertyInDotNotation": false,
235
+ "type": "body",
236
+ "value": "={{ $value }}"
237
+ }
238
+ },
239
+ "displayOptions": {
240
+ "show": {
241
+ "resource": [
242
+ "Help Center"
243
+ ],
244
+ "operation": [
245
+ "Add New Portal To Account"
246
+ ]
247
+ }
248
+ }
249
+ },
250
+ {
251
+ "displayName": "Slug",
252
+ "name": "slug",
253
+ "type": "string",
254
+ "default": "handbook",
255
+ "description": "Slug for the portal to display in link",
256
+ "routing": {
257
+ "send": {
258
+ "property": "slug",
259
+ "propertyInDotNotation": false,
260
+ "type": "body",
261
+ "value": "={{ $value }}"
262
+ }
263
+ },
264
+ "displayOptions": {
265
+ "show": {
266
+ "resource": [
267
+ "Help Center"
268
+ ],
269
+ "operation": [
270
+ "Add New Portal To Account"
271
+ ]
272
+ }
273
+ }
274
+ },
275
+ {
276
+ "displayName": "Archived",
277
+ "name": "archived",
278
+ "type": "boolean",
279
+ "default": false,
280
+ "description": "Status to check if portal is live",
281
+ "routing": {
282
+ "send": {
283
+ "property": "archived",
284
+ "propertyInDotNotation": false,
285
+ "type": "body",
286
+ "value": "={{ $value }}"
287
+ }
288
+ },
289
+ "displayOptions": {
290
+ "show": {
291
+ "resource": [
292
+ "Help Center"
293
+ ],
294
+ "operation": [
295
+ "Add New Portal To Account"
296
+ ]
297
+ }
298
+ }
299
+ },
300
+ {
301
+ "displayName": "Config",
302
+ "name": "config",
303
+ "type": "json",
304
+ "default": "{\n \"allowed_locales\": [\n \"en\",\n \"es\"\n ],\n \"default_locale\": \"en\"\n}",
305
+ "description": "Configuration about supporting locales",
306
+ "routing": {
307
+ "send": {
308
+ "property": "config",
309
+ "propertyInDotNotation": false,
310
+ "type": "body",
311
+ "value": "={{ JSON.parse($value) }}"
312
+ }
313
+ },
314
+ "displayOptions": {
315
+ "show": {
316
+ "resource": [
317
+ "Help Center"
318
+ ],
319
+ "operation": [
320
+ "Add New Portal To Account"
321
+ ]
322
+ }
323
+ }
324
+ },
325
+ {
326
+ "displayName": "GET /api/v1/accounts/{account_id}/portals",
327
+ "name": "operation",
328
+ "type": "notice",
329
+ "typeOptions": {
330
+ "theme": "info"
331
+ },
332
+ "default": "",
333
+ "displayOptions": {
334
+ "show": {
335
+ "resource": [
336
+ "Help Center"
337
+ ],
338
+ "operation": [
339
+ "Get Portal"
340
+ ]
341
+ }
342
+ }
343
+ },
344
+ {
345
+ "displayName": "Account Id",
346
+ "name": "account_id",
347
+ "required": true,
348
+ "description": "The numeric ID of the account",
349
+ "default": 0,
350
+ "type": "number",
351
+ "displayOptions": {
352
+ "show": {
353
+ "resource": [
354
+ "Help Center"
355
+ ],
356
+ "operation": [
357
+ "Get Portal"
358
+ ]
359
+ }
360
+ }
361
+ },
362
+ {
363
+ "displayName": "PATCH /api/v1/accounts/{account_id}/portals/{id}",
364
+ "name": "operation",
365
+ "type": "notice",
366
+ "typeOptions": {
367
+ "theme": "info"
368
+ },
369
+ "default": "",
370
+ "displayOptions": {
371
+ "show": {
372
+ "resource": [
373
+ "Help Center"
374
+ ],
375
+ "operation": [
376
+ "Update Portal To Account"
377
+ ]
378
+ }
379
+ }
380
+ },
381
+ {
382
+ "displayName": "Account Id",
383
+ "name": "account_id",
384
+ "required": true,
385
+ "description": "The numeric ID of the account",
386
+ "default": 0,
387
+ "type": "number",
388
+ "displayOptions": {
389
+ "show": {
390
+ "resource": [
391
+ "Help Center"
392
+ ],
393
+ "operation": [
394
+ "Update Portal To Account"
395
+ ]
396
+ }
397
+ }
398
+ },
399
+ {
400
+ "displayName": "Id",
401
+ "name": "id",
402
+ "required": true,
403
+ "description": "The slug identifier of the portal",
404
+ "default": "",
405
+ "type": "string",
406
+ "displayOptions": {
407
+ "show": {
408
+ "resource": [
409
+ "Help Center"
410
+ ],
411
+ "operation": [
412
+ "Update Portal To Account"
413
+ ]
414
+ }
415
+ }
416
+ },
417
+ {
418
+ "displayName": "Color",
419
+ "name": "color",
420
+ "type": "string",
421
+ "default": "#FFFFFF",
422
+ "description": "Header color for help-center in hex format",
423
+ "routing": {
424
+ "send": {
425
+ "property": "color",
426
+ "propertyInDotNotation": false,
427
+ "type": "body",
428
+ "value": "={{ $value }}"
429
+ }
430
+ },
431
+ "displayOptions": {
432
+ "show": {
433
+ "resource": [
434
+ "Help Center"
435
+ ],
436
+ "operation": [
437
+ "Update Portal To Account"
438
+ ]
439
+ }
440
+ }
441
+ },
442
+ {
443
+ "displayName": "Custom Domain",
444
+ "name": "custom_domain",
445
+ "type": "string",
446
+ "default": "chatwoot.help",
447
+ "description": "Custom domain to display help center.",
448
+ "routing": {
449
+ "send": {
450
+ "property": "custom_domain",
451
+ "propertyInDotNotation": false,
452
+ "type": "body",
453
+ "value": "={{ $value }}"
454
+ }
455
+ },
456
+ "displayOptions": {
457
+ "show": {
458
+ "resource": [
459
+ "Help Center"
460
+ ],
461
+ "operation": [
462
+ "Update Portal To Account"
463
+ ]
464
+ }
465
+ }
466
+ },
467
+ {
468
+ "displayName": "Header Text",
469
+ "name": "header_text",
470
+ "type": "string",
471
+ "default": "Handbook",
472
+ "description": "Help center header",
473
+ "routing": {
474
+ "send": {
475
+ "property": "header_text",
476
+ "propertyInDotNotation": false,
477
+ "type": "body",
478
+ "value": "={{ $value }}"
479
+ }
480
+ },
481
+ "displayOptions": {
482
+ "show": {
483
+ "resource": [
484
+ "Help Center"
485
+ ],
486
+ "operation": [
487
+ "Update Portal To Account"
488
+ ]
489
+ }
490
+ }
491
+ },
492
+ {
493
+ "displayName": "Homepage Link",
494
+ "name": "homepage_link",
495
+ "type": "string",
496
+ "default": "https://www.chatwoot.com/",
497
+ "description": "link to main dashboard",
498
+ "routing": {
499
+ "send": {
500
+ "property": "homepage_link",
501
+ "propertyInDotNotation": false,
502
+ "type": "body",
503
+ "value": "={{ $value }}"
504
+ }
505
+ },
506
+ "displayOptions": {
507
+ "show": {
508
+ "resource": [
509
+ "Help Center"
510
+ ],
511
+ "operation": [
512
+ "Update Portal To Account"
513
+ ]
514
+ }
515
+ }
516
+ },
517
+ {
518
+ "displayName": "Name",
519
+ "name": "name",
520
+ "type": "string",
521
+ "default": "Handbook",
522
+ "description": "Name for the portal",
523
+ "routing": {
524
+ "send": {
525
+ "property": "name",
526
+ "propertyInDotNotation": false,
527
+ "type": "body",
528
+ "value": "={{ $value }}"
529
+ }
530
+ },
531
+ "displayOptions": {
532
+ "show": {
533
+ "resource": [
534
+ "Help Center"
535
+ ],
536
+ "operation": [
537
+ "Update Portal To Account"
538
+ ]
539
+ }
540
+ }
541
+ },
542
+ {
543
+ "displayName": "Page Title",
544
+ "name": "page_title",
545
+ "type": "string",
546
+ "default": "Handbook",
547
+ "description": "Page title for the portal",
548
+ "routing": {
549
+ "send": {
550
+ "property": "page_title",
551
+ "propertyInDotNotation": false,
552
+ "type": "body",
553
+ "value": "={{ $value }}"
554
+ }
555
+ },
556
+ "displayOptions": {
557
+ "show": {
558
+ "resource": [
559
+ "Help Center"
560
+ ],
561
+ "operation": [
562
+ "Update Portal To Account"
563
+ ]
564
+ }
565
+ }
566
+ },
567
+ {
568
+ "displayName": "Slug",
569
+ "name": "slug",
570
+ "type": "string",
571
+ "default": "handbook",
572
+ "description": "Slug for the portal to display in link",
573
+ "routing": {
574
+ "send": {
575
+ "property": "slug",
576
+ "propertyInDotNotation": false,
577
+ "type": "body",
578
+ "value": "={{ $value }}"
579
+ }
580
+ },
581
+ "displayOptions": {
582
+ "show": {
583
+ "resource": [
584
+ "Help Center"
585
+ ],
586
+ "operation": [
587
+ "Update Portal To Account"
588
+ ]
589
+ }
590
+ }
591
+ },
592
+ {
593
+ "displayName": "Archived",
594
+ "name": "archived",
595
+ "type": "boolean",
596
+ "default": false,
597
+ "description": "Status to check if portal is live",
598
+ "routing": {
599
+ "send": {
600
+ "property": "archived",
601
+ "propertyInDotNotation": false,
602
+ "type": "body",
603
+ "value": "={{ $value }}"
604
+ }
605
+ },
606
+ "displayOptions": {
607
+ "show": {
608
+ "resource": [
609
+ "Help Center"
610
+ ],
611
+ "operation": [
612
+ "Update Portal To Account"
613
+ ]
614
+ }
615
+ }
616
+ },
617
+ {
618
+ "displayName": "Config",
619
+ "name": "config",
620
+ "type": "json",
621
+ "default": "{\n \"allowed_locales\": [\n \"en\",\n \"es\"\n ],\n \"default_locale\": \"en\"\n}",
622
+ "description": "Configuration about supporting locales",
623
+ "routing": {
624
+ "send": {
625
+ "property": "config",
626
+ "propertyInDotNotation": false,
627
+ "type": "body",
628
+ "value": "={{ JSON.parse($value) }}"
629
+ }
630
+ },
631
+ "displayOptions": {
632
+ "show": {
633
+ "resource": [
634
+ "Help Center"
635
+ ],
636
+ "operation": [
637
+ "Update Portal To Account"
638
+ ]
639
+ }
640
+ }
641
+ },
642
+ {
643
+ "displayName": "POST /api/v1/accounts/{account_id}/portals/{id}/categories",
644
+ "name": "operation",
645
+ "type": "notice",
646
+ "typeOptions": {
647
+ "theme": "info"
648
+ },
649
+ "default": "",
650
+ "displayOptions": {
651
+ "show": {
652
+ "resource": [
653
+ "Help Center"
654
+ ],
655
+ "operation": [
656
+ "Add New Category To Account"
657
+ ]
658
+ }
659
+ }
660
+ },
661
+ {
662
+ "displayName": "Name",
663
+ "name": "name",
664
+ "type": "string",
665
+ "default": "Category Name",
666
+ "description": "The name of the category",
667
+ "routing": {
668
+ "send": {
669
+ "property": "name",
670
+ "propertyInDotNotation": false,
671
+ "type": "body",
672
+ "value": "={{ $value }}"
673
+ }
674
+ },
675
+ "displayOptions": {
676
+ "show": {
677
+ "resource": [
678
+ "Help Center"
679
+ ],
680
+ "operation": [
681
+ "Add New Category To Account"
682
+ ]
683
+ }
684
+ }
685
+ },
686
+ {
687
+ "displayName": "Description",
688
+ "name": "description",
689
+ "type": "string",
690
+ "default": "Category description",
691
+ "description": "A description for the category",
692
+ "routing": {
693
+ "send": {
694
+ "property": "description",
695
+ "propertyInDotNotation": false,
696
+ "type": "body",
697
+ "value": "={{ $value }}"
698
+ }
699
+ },
700
+ "displayOptions": {
701
+ "show": {
702
+ "resource": [
703
+ "Help Center"
704
+ ],
705
+ "operation": [
706
+ "Add New Category To Account"
707
+ ]
708
+ }
709
+ }
710
+ },
711
+ {
712
+ "displayName": "Position",
713
+ "name": "position",
714
+ "type": "number",
715
+ "default": 1,
716
+ "description": "Category position in the portal list to sort",
717
+ "routing": {
718
+ "send": {
719
+ "property": "position",
720
+ "propertyInDotNotation": false,
721
+ "type": "body",
722
+ "value": "={{ $value }}"
723
+ }
724
+ },
725
+ "displayOptions": {
726
+ "show": {
727
+ "resource": [
728
+ "Help Center"
729
+ ],
730
+ "operation": [
731
+ "Add New Category To Account"
732
+ ]
733
+ }
734
+ }
735
+ },
736
+ {
737
+ "displayName": "Slug",
738
+ "name": "slug",
739
+ "type": "string",
740
+ "default": "category-name",
741
+ "description": "The category slug used in the URL",
742
+ "routing": {
743
+ "send": {
744
+ "property": "slug",
745
+ "propertyInDotNotation": false,
746
+ "type": "body",
747
+ "value": "={{ $value }}"
748
+ }
749
+ },
750
+ "displayOptions": {
751
+ "show": {
752
+ "resource": [
753
+ "Help Center"
754
+ ],
755
+ "operation": [
756
+ "Add New Category To Account"
757
+ ]
758
+ }
759
+ }
760
+ },
761
+ {
762
+ "displayName": "Locale",
763
+ "name": "locale",
764
+ "type": "string",
765
+ "default": "en",
766
+ "description": "The locale of the category",
767
+ "routing": {
768
+ "send": {
769
+ "property": "locale",
770
+ "propertyInDotNotation": false,
771
+ "type": "body",
772
+ "value": "={{ $value }}"
773
+ }
774
+ },
775
+ "displayOptions": {
776
+ "show": {
777
+ "resource": [
778
+ "Help Center"
779
+ ],
780
+ "operation": [
781
+ "Add New Category To Account"
782
+ ]
783
+ }
784
+ }
785
+ },
786
+ {
787
+ "displayName": "Icon",
788
+ "name": "icon",
789
+ "type": "string",
790
+ "default": "📚",
791
+ "description": "The icon of the category as a string (emoji)",
792
+ "routing": {
793
+ "send": {
794
+ "property": "icon",
795
+ "propertyInDotNotation": false,
796
+ "type": "body",
797
+ "value": "={{ $value }}"
798
+ }
799
+ },
800
+ "displayOptions": {
801
+ "show": {
802
+ "resource": [
803
+ "Help Center"
804
+ ],
805
+ "operation": [
806
+ "Add New Category To Account"
807
+ ]
808
+ }
809
+ }
810
+ },
811
+ {
812
+ "displayName": "Parent Category Id",
813
+ "name": "parent_category_id",
814
+ "type": "number",
815
+ "default": 1,
816
+ "description": "To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.",
817
+ "routing": {
818
+ "send": {
819
+ "property": "parent_category_id",
820
+ "propertyInDotNotation": false,
821
+ "type": "body",
822
+ "value": "={{ $value }}"
823
+ }
824
+ },
825
+ "displayOptions": {
826
+ "show": {
827
+ "resource": [
828
+ "Help Center"
829
+ ],
830
+ "operation": [
831
+ "Add New Category To Account"
832
+ ]
833
+ }
834
+ }
835
+ },
836
+ {
837
+ "displayName": "Associated Category Id",
838
+ "name": "associated_category_id",
839
+ "type": "number",
840
+ "default": 2,
841
+ "description": "To associate similar categories to each other, e.g same category of product documentation in different languages",
842
+ "routing": {
843
+ "send": {
844
+ "property": "associated_category_id",
845
+ "propertyInDotNotation": false,
846
+ "type": "body",
847
+ "value": "={{ $value }}"
848
+ }
849
+ },
850
+ "displayOptions": {
851
+ "show": {
852
+ "resource": [
853
+ "Help Center"
854
+ ],
855
+ "operation": [
856
+ "Add New Category To Account"
857
+ ]
858
+ }
859
+ }
860
+ },
861
+ {
862
+ "displayName": "POST /api/v1/accounts/{account_id}/portals/{id}/articles",
863
+ "name": "operation",
864
+ "type": "notice",
865
+ "typeOptions": {
866
+ "theme": "info"
867
+ },
868
+ "default": "",
869
+ "displayOptions": {
870
+ "show": {
871
+ "resource": [
872
+ "Help Center"
873
+ ],
874
+ "operation": [
875
+ "Add New Article To Account"
876
+ ]
877
+ }
878
+ }
879
+ },
880
+ {
881
+ "displayName": "Title",
882
+ "name": "title",
883
+ "type": "string",
884
+ "default": "Article Title",
885
+ "description": "The title of the article",
886
+ "routing": {
887
+ "send": {
888
+ "property": "title",
889
+ "propertyInDotNotation": false,
890
+ "type": "body",
891
+ "value": "={{ $value }}"
892
+ }
893
+ },
894
+ "displayOptions": {
895
+ "show": {
896
+ "resource": [
897
+ "Help Center"
898
+ ],
899
+ "operation": [
900
+ "Add New Article To Account"
901
+ ]
902
+ }
903
+ }
904
+ },
905
+ {
906
+ "displayName": "Slug",
907
+ "name": "slug",
908
+ "type": "string",
909
+ "default": "article-title",
910
+ "description": "The slug of the article",
911
+ "routing": {
912
+ "send": {
913
+ "property": "slug",
914
+ "propertyInDotNotation": false,
915
+ "type": "body",
916
+ "value": "={{ $value }}"
917
+ }
918
+ },
919
+ "displayOptions": {
920
+ "show": {
921
+ "resource": [
922
+ "Help Center"
923
+ ],
924
+ "operation": [
925
+ "Add New Article To Account"
926
+ ]
927
+ }
928
+ }
929
+ },
930
+ {
931
+ "displayName": "Position",
932
+ "name": "position",
933
+ "type": "number",
934
+ "default": 1,
935
+ "description": "article position in category",
936
+ "routing": {
937
+ "send": {
938
+ "property": "position",
939
+ "propertyInDotNotation": false,
940
+ "type": "body",
941
+ "value": "={{ $value }}"
942
+ }
943
+ },
944
+ "displayOptions": {
945
+ "show": {
946
+ "resource": [
947
+ "Help Center"
948
+ ],
949
+ "operation": [
950
+ "Add New Article To Account"
951
+ ]
952
+ }
953
+ }
954
+ },
955
+ {
956
+ "displayName": "Content",
957
+ "name": "content",
958
+ "type": "string",
959
+ "default": "This is the content of the article",
960
+ "description": "The text content.",
961
+ "routing": {
962
+ "send": {
963
+ "property": "content",
964
+ "propertyInDotNotation": false,
965
+ "type": "body",
966
+ "value": "={{ $value }}"
967
+ }
968
+ },
969
+ "displayOptions": {
970
+ "show": {
971
+ "resource": [
972
+ "Help Center"
973
+ ],
974
+ "operation": [
975
+ "Add New Article To Account"
976
+ ]
977
+ }
978
+ }
979
+ },
980
+ {
981
+ "displayName": "Description",
982
+ "name": "description",
983
+ "type": "string",
984
+ "default": "This is the description of the article",
985
+ "description": "The description of the article",
986
+ "routing": {
987
+ "send": {
988
+ "property": "description",
989
+ "propertyInDotNotation": false,
990
+ "type": "body",
991
+ "value": "={{ $value }}"
992
+ }
993
+ },
994
+ "displayOptions": {
995
+ "show": {
996
+ "resource": [
997
+ "Help Center"
998
+ ],
999
+ "operation": [
1000
+ "Add New Article To Account"
1001
+ ]
1002
+ }
1003
+ }
1004
+ },
1005
+ {
1006
+ "displayName": "Category Id",
1007
+ "name": "category_id",
1008
+ "type": "number",
1009
+ "default": 1,
1010
+ "description": "The category id of the article",
1011
+ "routing": {
1012
+ "send": {
1013
+ "property": "category_id",
1014
+ "propertyInDotNotation": false,
1015
+ "type": "body",
1016
+ "value": "={{ $value }}"
1017
+ }
1018
+ },
1019
+ "displayOptions": {
1020
+ "show": {
1021
+ "resource": [
1022
+ "Help Center"
1023
+ ],
1024
+ "operation": [
1025
+ "Add New Article To Account"
1026
+ ]
1027
+ }
1028
+ }
1029
+ },
1030
+ {
1031
+ "displayName": "Author Id",
1032
+ "name": "author_id",
1033
+ "type": "number",
1034
+ "default": 1,
1035
+ "description": "The author agent id of the article",
1036
+ "routing": {
1037
+ "send": {
1038
+ "property": "author_id",
1039
+ "propertyInDotNotation": false,
1040
+ "type": "body",
1041
+ "value": "={{ $value }}"
1042
+ }
1043
+ },
1044
+ "displayOptions": {
1045
+ "show": {
1046
+ "resource": [
1047
+ "Help Center"
1048
+ ],
1049
+ "operation": [
1050
+ "Add New Article To Account"
1051
+ ]
1052
+ }
1053
+ }
1054
+ },
1055
+ {
1056
+ "displayName": "Associated Article Id",
1057
+ "name": "associated_article_id",
1058
+ "type": "number",
1059
+ "default": 2,
1060
+ "description": "To associate similar articles to each other, e.g to provide the link for the reference.",
1061
+ "routing": {
1062
+ "send": {
1063
+ "property": "associated_article_id",
1064
+ "propertyInDotNotation": false,
1065
+ "type": "body",
1066
+ "value": "={{ $value }}"
1067
+ }
1068
+ },
1069
+ "displayOptions": {
1070
+ "show": {
1071
+ "resource": [
1072
+ "Help Center"
1073
+ ],
1074
+ "operation": [
1075
+ "Add New Article To Account"
1076
+ ]
1077
+ }
1078
+ }
1079
+ },
1080
+ {
1081
+ "displayName": "Status",
1082
+ "name": "status",
1083
+ "type": "number",
1084
+ "default": 1,
1085
+ "description": "The status of the article. 0 for draft, 1 for published, 2 for archived",
1086
+ "routing": {
1087
+ "send": {
1088
+ "property": "status",
1089
+ "propertyInDotNotation": false,
1090
+ "type": "body",
1091
+ "value": "={{ $value }}"
1092
+ }
1093
+ },
1094
+ "displayOptions": {
1095
+ "show": {
1096
+ "resource": [
1097
+ "Help Center"
1098
+ ],
1099
+ "operation": [
1100
+ "Add New Article To Account"
1101
+ ]
1102
+ }
1103
+ }
1104
+ },
1105
+ {
1106
+ "displayName": "Locale",
1107
+ "name": "locale",
1108
+ "type": "string",
1109
+ "default": "en",
1110
+ "description": "The locale of the article",
1111
+ "routing": {
1112
+ "send": {
1113
+ "property": "locale",
1114
+ "propertyInDotNotation": false,
1115
+ "type": "body",
1116
+ "value": "={{ $value }}"
1117
+ }
1118
+ },
1119
+ "displayOptions": {
1120
+ "show": {
1121
+ "resource": [
1122
+ "Help Center"
1123
+ ],
1124
+ "operation": [
1125
+ "Add New Article To Account"
1126
+ ]
1127
+ }
1128
+ }
1129
+ },
1130
+ {
1131
+ "displayName": "Meta",
1132
+ "name": "meta",
1133
+ "type": "json",
1134
+ "default": "{\n \"tags\": [\n \"article_name\"\n ],\n \"title\": \"article title\",\n \"description\": \"article description\"\n}",
1135
+ "description": "Use for search",
1136
+ "routing": {
1137
+ "send": {
1138
+ "property": "meta",
1139
+ "propertyInDotNotation": false,
1140
+ "type": "body",
1141
+ "value": "={{ JSON.parse($value) }}"
1142
+ }
1143
+ },
1144
+ "displayOptions": {
1145
+ "show": {
1146
+ "resource": [
1147
+ "Help Center"
1148
+ ],
1149
+ "operation": [
1150
+ "Add New Article To Account"
1151
+ ]
1152
+ }
1153
+ }
1154
+ },
1155
+ ];
1156
+ //# sourceMappingURL=index.js.map