Skip to content

Commit b857a7d

Browse files
luancazarinejcortes
luancazarine
authored and
jcortes
committed
19164 action zendesk helpcenter (#19280)
* Update Zendesk component versions and add new actions - Bump version of @pipedream/zendesk to 0.11.0 - Add new actions: Get Article, Get Macro, List Active Macros, and List Articles - Update existing action versions: Add Ticket Tags (0.0.7), Create Ticket (0.1.11), Delete Ticket (0.1.11), Get Ticket Info (0.0.9), Get User Info (0.0.6), List Locales (0.0.6), List Macros (0.0.6), List Ticket Comments (0.0.6), List Tickets (0.0.9), Remove Ticket Tags (0.0.7), Set Custom Ticket Fields (0.0.4), Set Ticket Tags (0.0.7), Update Ticket (0.2.4), and others. - Introduce new constants for ACCESS_OPTIONS and INCLUDE_OPTIONS in common/constants.mjs. - Enhance locale handling in existing actions and sources. * Bump version of Zendesk ticket-updated source to 0.2.10 * Remove helpCenter option from locale path preparation in Zendesk component * Refactor Zendesk request handling and fix article description typo - Simplified URL construction in makeRequest by removing unnecessary locale handling. - Corrected typo in the description of the Get Article action.
1 parent 82750e7 commit b857a7d

File tree

29 files changed

+534
-31
lines changed

29 files changed

+534
-31
lines changed

‎components/zendesk/actions/add-ticket-tags/add-ticket-tags.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ export default {
55
name: "Add Ticket Tags",
66
description: "Add tags to a ticket (appends to existing tags). [See the documentation](https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/#add-tags).",
77
type: "action",
8-
version: "0.0.6",
8+
version: "0.0.7",
99
annotations: {
1010
destructiveHint: false,
1111
openWorldHint: true,

‎components/zendesk/actions/create-ticket/create-ticket.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ export default {
55
name: "Create Ticket",
66
description: "Creates a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#create-ticket).",
77
type: "action",
8-
version: "0.1.10",
8+
version: "0.1.11",
99
annotations: {
1010
destructiveHint: false,
1111
openWorldHint: true,

‎components/zendesk/actions/delete-ticket/delete-ticket.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ export default {
55
name: "Delete Ticket",
66
description: "Deletes a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#delete-ticket).",
77
type: "action",
8-
version: "0.1.10",
8+
version: "0.1.11",
99
annotations: {
1010
destructiveHint: true,
1111
openWorldHint: true,

‎components/zendesk/actions/get-article/get-article.mjs‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
import zendesk from "../../zendesk.app.mjs";
2+
3+
export default {
4+
key: "zendesk-get-article",
5+
name: "Get Article",
6+
description: "Retrieves an article by its ID. [See the documentation](https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#show-article).",
7+
type: "action",
8+
version: "0.0.1",
9+
annotations: {
10+
destructiveHint: false,
11+
openWorldHint: true,
12+
readOnlyHint: true,
13+
},
14+
props: {
15+
zendesk,
16+
locale: {
17+
propDefinition: [
18+
zendesk,
19+
"locale",
20+
],
21+
optional: true,
22+
},
23+
articleId: {
24+
propDefinition: [
25+
zendesk,
26+
"articleId",
27+
({ locale }) => ({
28+
locale,
29+
}),
30+
],
31+
},
32+
},
33+
async run({ $ }) {
34+
const article = await this.zendesk.getArticle({
35+
$,
36+
locale: this.locale,
37+
articleId: this.articleId,
38+
});
39+
40+
$.export("$summary", `Successfully retrieved article ${this.articleId}`);
41+
return article;
42+
},
43+
};

‎components/zendesk/actions/get-macro/get-macro.mjs‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
import zendesk from "../../zendesk.app.mjs";
2+
3+
export default {
4+
key: "zendesk-get-macro",
5+
name: "Get Macro",
6+
description: "Retrieves a macro by its ID. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#show-macro).",
7+
type: "action",
8+
version: "0.0.1",
9+
annotations: {
10+
destructiveHint: false,
11+
openWorldHint: true,
12+
readOnlyHint: true,
13+
},
14+
props: {
15+
zendesk,
16+
macroId: {
17+
propDefinition: [
18+
zendesk,
19+
"macroId",
20+
],
21+
},
22+
},
23+
async run({ $ }) {
24+
const macro = await this.zendesk.getMacro({
25+
$,
26+
macroId: this.macroId,
27+
});
28+
29+
$.export("$summary", `Successfully retrieved macro with ID ${this.macroId}`);
30+
return macro;
31+
},
32+
};

‎components/zendesk/actions/get-ticket-info/get-ticket-info.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ export default {
55
name: "Get Ticket Info",
66
description: "Retrieves information about a specific ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#show-ticket).",
77
type: "action",
8-
version: "0.0.8",
8+
version: "0.0.9",
99
annotations: {
1010
destructiveHint: false,
1111
openWorldHint: true,

‎components/zendesk/actions/get-user-info/get-user-info.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export default {
44
key: "zendesk-get-user-info",
55
name: "Get User Info",
66
description: "Retrieves information about a specific user. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/users/users/#show-user).",
7-
version: "0.0.5",
7+
version: "0.0.6",
88
annotations: {
99
destructiveHint: false,
1010
openWorldHint: true,

‎components/zendesk/actions/list-active-macros/list-active-macros.mjs‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
import constants from "../../common/constants.mjs";
2+
import zendesk from "../../zendesk.app.mjs";
3+
4+
export default {
5+
key: "zendesk-list-active-macros",
6+
name: "List Active Macros",
7+
description: "Lists all active shared and personal macros available to the current user. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#list-active-macros).",
8+
type: "action",
9+
version: "0.0.1",
10+
annotations: {
11+
destructiveHint: false,
12+
openWorldHint: true,
13+
readOnlyHint: true,
14+
},
15+
props: {
16+
zendesk,
17+
access: {
18+
type: "string",
19+
label: "Access",
20+
description: "Filter macros by access. The \"agents\" value returns all personal macros for the account's agents and is only available to admins.",
21+
options: constants.ACCESS_OPTIONS,
22+
optional: true,
23+
},
24+
categoryId: {
25+
propDefinition: [
26+
zendesk,
27+
"macroCategory",
28+
],
29+
optional: true,
30+
},
31+
groupId: {
32+
propDefinition: [
33+
zendesk,
34+
"groupId",
35+
],
36+
optional: true,
37+
},
38+
include: {
39+
type: "string",
40+
label: "Include",
41+
description: "Additional fields to include in the response",
42+
options: constants.INCLUDE_OPTIONS,
43+
optional: true,
44+
},
45+
sortBy: {
46+
type: "string",
47+
label: "Sort By",
48+
description: "The field to sort the results by",
49+
options: constants.SORT_BY_OPTIONS,
50+
optional: true,
51+
},
52+
sortOrder: {
53+
propDefinition: [
54+
zendesk,
55+
"sortOrder",
56+
],
57+
},
58+
},
59+
async run({ $ }) {
60+
const { macros } = await this.zendesk.listActiveMacros({
61+
$,
62+
params: {
63+
access: this.access,
64+
category: this.categoryId,
65+
group_id: this.groupId,
66+
include: this.include,
67+
sort_by: this.sortBy,
68+
sort_order: this.sortOrder,
69+
},
70+
});
71+
72+
$.export("$summary", `Successfully retrieved ${macros.length} macro${macros.length === 1
73+
? ""
74+
: "s"}`);
75+
return macros;
76+
},
77+
};

‎components/zendesk/actions/list-articles/list-articles.mjs‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
import { ConfigurationError } from "@pipedream/platform";
2+
import zendesk from "../../zendesk.app.mjs";
3+
4+
export default {
5+
key: "zendesk-list-articles",
6+
name: "List Articles",
7+
description: "Retrieves a list of articles. [See the documentation](https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#list-articles).",
8+
type: "action",
9+
version: "0.0.1",
10+
annotations: {
11+
destructiveHint: false,
12+
openWorldHint: true,
13+
readOnlyHint: true,
14+
},
15+
props: {
16+
zendesk,
17+
locale: {
18+
propDefinition: [
19+
zendesk,
20+
"locale",
21+
],
22+
optional: true,
23+
},
24+
categoryId: {
25+
propDefinition: [
26+
zendesk,
27+
"articleCategoryId",
28+
({ locale }) => ({
29+
locale,
30+
}),
31+
],
32+
optional: true,
33+
},
34+
sectionId: {
35+
propDefinition: [
36+
zendesk,
37+
"sectionId",
38+
({
39+
locale, categoryId,
40+
}) => ({
41+
locale,
42+
categoryId,
43+
}),
44+
],
45+
optional: true,
46+
},
47+
userId: {
48+
propDefinition: [
49+
zendesk,
50+
"userId",
51+
],
52+
optional: true,
53+
reloadProps: true,
54+
},
55+
limit: {
56+
propDefinition: [
57+
zendesk,
58+
"limit",
59+
],
60+
description: "Maximum number of articles to return",
61+
},
62+
},
63+
async additionalProps(props) {
64+
props.locale.hidden = false;
65+
props.categoryId.hidden = false;
66+
props.sectionId.hidden = false;
67+
if (this.userId) {
68+
props.locale.hidden = true;
69+
props.categoryId.hidden = true;
70+
props.sectionId.hidden = true;
71+
}
72+
return {};
73+
},
74+
async run({ $ }) {
75+
if ((this.categoryId && this.userId) || (this.sectionId && this.userId)) {
76+
throw new ConfigurationError("Providing a User ID, you cannot provide a Category ID or Section ID.");
77+
}
78+
79+
const results = this.zendesk.paginate({
80+
fn: this.zendesk.listArticles,
81+
args: {
82+
$,
83+
categoryId: this.categoryId,
84+
sectionId: this.sectionId,
85+
userId: this.userId,
86+
locale: this.userId
87+
? null
88+
: this.locale,
89+
},
90+
resourceKey: "articles",
91+
max: this.limit,
92+
});
93+
94+
const articles = [];
95+
for await (const article of results) {
96+
articles.push(article);
97+
}
98+
99+
$.export("$summary", `Successfully retrieved ${articles.length} article${articles.length === 1
100+
? ""
101+
: "s"}`);
102+
103+
return articles;
104+
},
105+
};

‎components/zendesk/actions/list-locales/list-locales.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export default {
44
key: "zendesk-list-locales",
55
name: "List Locales",
66
description: "Retrieves all locales. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/).",
7-
version: "0.0.5",
7+
version: "0.0.6",
88
annotations: {
99
destructiveHint: false,
1010
openWorldHint: true,

0 commit comments

Comments
 (0)