featurebase-node 0.14.3 → 0.15.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.
- package/CHANGELOG.md +12 -0
- package/client.d.mts +5 -5
- package/client.d.mts.map +1 -1
- package/client.d.ts +5 -5
- package/client.d.ts.map +1 -1
- package/package.json +1 -1
- package/resources/audit-logs.d.mts +3 -3
- package/resources/audit-logs.d.mts.map +1 -1
- package/resources/audit-logs.d.ts +3 -3
- package/resources/audit-logs.d.ts.map +1 -1
- package/resources/changelogs/changelogs.d.mts +116 -116
- package/resources/changelogs/changelogs.d.mts.map +1 -1
- package/resources/changelogs/changelogs.d.ts +116 -116
- package/resources/changelogs/changelogs.d.ts.map +1 -1
- package/resources/changelogs/changelogs.js +74 -74
- package/resources/changelogs/changelogs.js.map +1 -1
- package/resources/changelogs/changelogs.mjs +74 -74
- package/resources/changelogs/changelogs.mjs.map +1 -1
- package/resources/changelogs/index.d.mts +1 -1
- package/resources/changelogs/index.d.mts.map +1 -1
- package/resources/changelogs/index.d.ts +1 -1
- package/resources/changelogs/index.d.ts.map +1 -1
- package/resources/changelogs/subscribers.d.mts +3 -3
- package/resources/changelogs/subscribers.d.mts.map +1 -1
- package/resources/changelogs/subscribers.d.ts +3 -3
- package/resources/changelogs/subscribers.d.ts.map +1 -1
- package/resources/conversation-attributes.d.mts +17 -17
- package/resources/conversation-attributes.d.mts.map +1 -1
- package/resources/conversation-attributes.d.ts +17 -17
- package/resources/conversation-attributes.d.ts.map +1 -1
- package/resources/conversation-attributes.js +19 -19
- package/resources/conversation-attributes.js.map +1 -1
- package/resources/conversation-attributes.mjs +19 -19
- package/resources/conversation-attributes.mjs.map +1 -1
- package/resources/feedback/boards.d.mts +19 -19
- package/resources/feedback/boards.d.mts.map +1 -1
- package/resources/feedback/boards.d.ts +19 -19
- package/resources/feedback/boards.d.ts.map +1 -1
- package/resources/feedback/boards.js +20 -20
- package/resources/feedback/boards.js.map +1 -1
- package/resources/feedback/boards.mjs +20 -20
- package/resources/feedback/boards.mjs.map +1 -1
- package/resources/feedback/comments.d.mts +113 -113
- package/resources/feedback/comments.d.mts.map +1 -1
- package/resources/feedback/comments.d.ts +113 -113
- package/resources/feedback/comments.d.ts.map +1 -1
- package/resources/feedback/comments.js +93 -93
- package/resources/feedback/comments.js.map +1 -1
- package/resources/feedback/comments.mjs +93 -93
- package/resources/feedback/comments.mjs.map +1 -1
- package/resources/feedback/custom-fields.d.mts +36 -36
- package/resources/feedback/custom-fields.d.mts.map +1 -1
- package/resources/feedback/custom-fields.d.ts +36 -36
- package/resources/feedback/custom-fields.d.ts.map +1 -1
- package/resources/feedback/custom-fields.js +36 -36
- package/resources/feedback/custom-fields.js.map +1 -1
- package/resources/feedback/custom-fields.mjs +36 -36
- package/resources/feedback/custom-fields.mjs.map +1 -1
- package/resources/feedback/feedback.d.mts +5 -5
- package/resources/feedback/feedback.d.mts.map +1 -1
- package/resources/feedback/feedback.d.ts +5 -5
- package/resources/feedback/feedback.d.ts.map +1 -1
- package/resources/feedback/index.d.mts +5 -5
- package/resources/feedback/index.d.mts.map +1 -1
- package/resources/feedback/index.d.ts +5 -5
- package/resources/feedback/index.d.ts.map +1 -1
- package/resources/feedback/post-statuses.d.mts +20 -20
- package/resources/feedback/post-statuses.d.mts.map +1 -1
- package/resources/feedback/post-statuses.d.ts +20 -20
- package/resources/feedback/post-statuses.d.ts.map +1 -1
- package/resources/feedback/post-statuses.js +23 -23
- package/resources/feedback/post-statuses.js.map +1 -1
- package/resources/feedback/post-statuses.mjs +23 -23
- package/resources/feedback/post-statuses.mjs.map +1 -1
- package/resources/feedback/posts/index.d.mts +1 -1
- package/resources/feedback/posts/index.d.mts.map +1 -1
- package/resources/feedback/posts/index.d.ts +1 -1
- package/resources/feedback/posts/index.d.ts.map +1 -1
- package/resources/feedback/posts/posts.d.mts +132 -132
- package/resources/feedback/posts/posts.d.mts.map +1 -1
- package/resources/feedback/posts/posts.d.ts +132 -132
- package/resources/feedback/posts/posts.d.ts.map +1 -1
- package/resources/feedback/posts/posts.js +107 -107
- package/resources/feedback/posts/posts.js.map +1 -1
- package/resources/feedback/posts/posts.mjs +107 -107
- package/resources/feedback/posts/posts.mjs.map +1 -1
- package/resources/feedback/posts/voters.d.mts +3 -3
- package/resources/feedback/posts/voters.d.mts.map +1 -1
- package/resources/feedback/posts/voters.d.ts +3 -3
- package/resources/feedback/posts/voters.d.ts.map +1 -1
- package/resources/help-center/articles.d.mts +213 -97
- package/resources/help-center/articles.d.mts.map +1 -1
- package/resources/help-center/articles.d.ts +213 -97
- package/resources/help-center/articles.d.ts.map +1 -1
- package/resources/help-center/articles.js +73 -73
- package/resources/help-center/articles.js.map +1 -1
- package/resources/help-center/articles.mjs +73 -73
- package/resources/help-center/articles.mjs.map +1 -1
- package/resources/help-center/collections.d.mts +158 -71
- package/resources/help-center/collections.d.mts.map +1 -1
- package/resources/help-center/collections.d.ts +158 -71
- package/resources/help-center/collections.d.ts.map +1 -1
- package/resources/help-center/collections.js +65 -65
- package/resources/help-center/collections.js.map +1 -1
- package/resources/help-center/collections.mjs +65 -65
- package/resources/help-center/collections.mjs.map +1 -1
- package/resources/help-center/help-center.d.mts +4 -4
- package/resources/help-center/help-center.d.mts.map +1 -1
- package/resources/help-center/help-center.d.ts +4 -4
- package/resources/help-center/help-center.d.ts.map +1 -1
- package/resources/help-center/help-centers.d.mts +77 -48
- package/resources/help-center/help-centers.d.mts.map +1 -1
- package/resources/help-center/help-centers.d.ts +77 -48
- package/resources/help-center/help-centers.d.ts.map +1 -1
- package/resources/help-center/help-centers.js +43 -43
- package/resources/help-center/help-centers.js.map +1 -1
- package/resources/help-center/help-centers.mjs +43 -43
- package/resources/help-center/help-centers.mjs.map +1 -1
- package/resources/help-center/index.d.mts +4 -4
- package/resources/help-center/index.d.mts.map +1 -1
- package/resources/help-center/index.d.ts +4 -4
- package/resources/help-center/index.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.d.mts +124 -124
- package/resources/help-center/redirect-rules.d.mts.map +1 -1
- package/resources/help-center/redirect-rules.d.ts +124 -124
- package/resources/help-center/redirect-rules.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.js +112 -112
- package/resources/help-center/redirect-rules.js.map +1 -1
- package/resources/help-center/redirect-rules.mjs +112 -112
- package/resources/help-center/redirect-rules.mjs.map +1 -1
- package/resources/index.d.mts +5 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +5 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/organization/admins.d.mts +26 -26
- package/resources/organization/admins.d.mts.map +1 -1
- package/resources/organization/admins.d.ts +26 -26
- package/resources/organization/admins.d.ts.map +1 -1
- package/resources/organization/admins.js +25 -25
- package/resources/organization/admins.js.map +1 -1
- package/resources/organization/admins.mjs +25 -25
- package/resources/organization/admins.mjs.map +1 -1
- package/resources/organization/brands.d.mts +52 -52
- package/resources/organization/brands.d.mts.map +1 -1
- package/resources/organization/brands.d.ts +52 -52
- package/resources/organization/brands.d.ts.map +1 -1
- package/resources/organization/brands.js +54 -54
- package/resources/organization/brands.js.map +1 -1
- package/resources/organization/brands.mjs +54 -54
- package/resources/organization/brands.mjs.map +1 -1
- package/resources/organization/index.d.mts +3 -3
- package/resources/organization/index.d.mts.map +1 -1
- package/resources/organization/index.d.ts +3 -3
- package/resources/organization/index.d.ts.map +1 -1
- package/resources/organization/organization.d.mts +3 -3
- package/resources/organization/organization.d.mts.map +1 -1
- package/resources/organization/organization.d.ts +3 -3
- package/resources/organization/organization.d.ts.map +1 -1
- package/resources/organization/teams.d.mts +47 -47
- package/resources/organization/teams.d.mts.map +1 -1
- package/resources/organization/teams.d.ts +47 -47
- package/resources/organization/teams.d.ts.map +1 -1
- package/resources/organization/teams.js +44 -44
- package/resources/organization/teams.js.map +1 -1
- package/resources/organization/teams.mjs +44 -44
- package/resources/organization/teams.mjs.map +1 -1
- package/resources/reports.d.mts +249 -215
- package/resources/reports.d.mts.map +1 -1
- package/resources/reports.d.ts +249 -215
- package/resources/reports.d.ts.map +1 -1
- package/resources/reports.js +99 -99
- package/resources/reports.js.map +1 -1
- package/resources/reports.mjs +99 -99
- package/resources/reports.mjs.map +1 -1
- package/resources/support/conversation-tags.d.mts +43 -43
- package/resources/support/conversation-tags.d.mts.map +1 -1
- package/resources/support/conversation-tags.d.ts +43 -43
- package/resources/support/conversation-tags.d.ts.map +1 -1
- package/resources/support/conversation-tags.js +32 -32
- package/resources/support/conversation-tags.js.map +1 -1
- package/resources/support/conversation-tags.mjs +32 -32
- package/resources/support/conversation-tags.mjs.map +1 -1
- package/resources/support/conversations/conversations.d.mts +337 -327
- package/resources/support/conversations/conversations.d.mts.map +1 -1
- package/resources/support/conversations/conversations.d.ts +337 -327
- package/resources/support/conversations/conversations.d.ts.map +1 -1
- package/resources/support/conversations/conversations.js +293 -283
- package/resources/support/conversations/conversations.js.map +1 -1
- package/resources/support/conversations/conversations.mjs +293 -283
- package/resources/support/conversations/conversations.mjs.map +1 -1
- package/resources/support/conversations/index.d.mts +1 -1
- package/resources/support/conversations/index.d.mts.map +1 -1
- package/resources/support/conversations/index.d.ts +1 -1
- package/resources/support/conversations/index.d.ts.map +1 -1
- package/resources/support/conversations/participants.d.mts +2 -2
- package/resources/support/conversations/participants.d.mts.map +1 -1
- package/resources/support/conversations/participants.d.ts +2 -2
- package/resources/support/conversations/participants.d.ts.map +1 -1
- package/resources/support/index.d.mts +3 -3
- package/resources/support/index.d.mts.map +1 -1
- package/resources/support/index.d.ts +3 -3
- package/resources/support/index.d.ts.map +1 -1
- package/resources/support/support.d.mts +3 -3
- package/resources/support/support.d.mts.map +1 -1
- package/resources/support/support.d.ts +3 -3
- package/resources/support/support.d.ts.map +1 -1
- package/resources/support/tickets/categories.d.mts +20 -20
- package/resources/support/tickets/categories.d.mts.map +1 -1
- package/resources/support/tickets/categories.d.ts +20 -20
- package/resources/support/tickets/categories.d.ts.map +1 -1
- package/resources/support/tickets/categories.js +25 -25
- package/resources/support/tickets/categories.js.map +1 -1
- package/resources/support/tickets/categories.mjs +25 -25
- package/resources/support/tickets/categories.mjs.map +1 -1
- package/resources/support/tickets/custom-fields.d.mts +22 -22
- package/resources/support/tickets/custom-fields.d.mts.map +1 -1
- package/resources/support/tickets/custom-fields.d.ts +22 -22
- package/resources/support/tickets/custom-fields.d.ts.map +1 -1
- package/resources/support/tickets/custom-fields.js +19 -19
- package/resources/support/tickets/custom-fields.js.map +1 -1
- package/resources/support/tickets/custom-fields.mjs +19 -19
- package/resources/support/tickets/custom-fields.mjs.map +1 -1
- package/resources/support/tickets/index.d.mts +4 -4
- package/resources/support/tickets/index.d.mts.map +1 -1
- package/resources/support/tickets/index.d.ts +4 -4
- package/resources/support/tickets/index.d.ts.map +1 -1
- package/resources/support/tickets/statuses.d.mts +19 -19
- package/resources/support/tickets/statuses.d.mts.map +1 -1
- package/resources/support/tickets/statuses.d.ts +19 -19
- package/resources/support/tickets/statuses.d.ts.map +1 -1
- package/resources/support/tickets/statuses.js +21 -21
- package/resources/support/tickets/statuses.js.map +1 -1
- package/resources/support/tickets/statuses.mjs +21 -21
- package/resources/support/tickets/statuses.mjs.map +1 -1
- package/resources/support/tickets/tickets.d.mts +75 -75
- package/resources/support/tickets/tickets.d.mts.map +1 -1
- package/resources/support/tickets/tickets.d.ts +75 -75
- package/resources/support/tickets/tickets.d.ts.map +1 -1
- package/resources/support/tickets/tickets.js +44 -44
- package/resources/support/tickets/tickets.js.map +1 -1
- package/resources/support/tickets/tickets.mjs +44 -44
- package/resources/support/tickets/tickets.mjs.map +1 -1
- package/resources/surveys.d.mts +43 -43
- package/resources/surveys.d.mts.map +1 -1
- package/resources/surveys.d.ts +43 -43
- package/resources/surveys.d.ts.map +1 -1
- package/resources/surveys.js +44 -44
- package/resources/surveys.js.map +1 -1
- package/resources/surveys.mjs +44 -44
- package/resources/surveys.mjs.map +1 -1
- package/resources/users/companies/companies.d.mts +121 -130
- package/resources/users/companies/companies.d.mts.map +1 -1
- package/resources/users/companies/companies.d.ts +121 -130
- package/resources/users/companies/companies.d.ts.map +1 -1
- package/resources/users/companies/companies.js +125 -125
- package/resources/users/companies/companies.js.map +1 -1
- package/resources/users/companies/companies.mjs +125 -125
- package/resources/users/companies/companies.mjs.map +1 -1
- package/resources/users/companies/contacts.d.mts +3 -3
- package/resources/users/companies/contacts.d.mts.map +1 -1
- package/resources/users/companies/contacts.d.ts +3 -3
- package/resources/users/companies/contacts.d.ts.map +1 -1
- package/resources/users/companies/index.d.mts +1 -1
- package/resources/users/companies/index.d.mts.map +1 -1
- package/resources/users/companies/index.d.ts +1 -1
- package/resources/users/companies/index.d.ts.map +1 -1
- package/resources/users/contacts/by-user-id/by-user-id.d.mts +2 -2
- package/resources/users/contacts/by-user-id/by-user-id.d.mts.map +1 -1
- package/resources/users/contacts/by-user-id/by-user-id.d.ts +2 -2
- package/resources/users/contacts/by-user-id/by-user-id.d.ts.map +1 -1
- package/resources/users/contacts/by-user-id/email-preferences.d.mts +2 -2
- package/resources/users/contacts/by-user-id/email-preferences.d.mts.map +1 -1
- package/resources/users/contacts/by-user-id/email-preferences.d.ts +2 -2
- package/resources/users/contacts/by-user-id/email-preferences.d.ts.map +1 -1
- package/resources/users/contacts/contacts.d.mts +249 -235
- package/resources/users/contacts/contacts.d.mts.map +1 -1
- package/resources/users/contacts/contacts.d.ts +249 -235
- package/resources/users/contacts/contacts.d.ts.map +1 -1
- package/resources/users/contacts/contacts.js +211 -184
- package/resources/users/contacts/contacts.js.map +1 -1
- package/resources/users/contacts/contacts.mjs +211 -184
- package/resources/users/contacts/contacts.mjs.map +1 -1
- package/resources/users/contacts/email-preferences.d.mts +2 -2
- package/resources/users/contacts/email-preferences.d.mts.map +1 -1
- package/resources/users/contacts/email-preferences.d.ts +2 -2
- package/resources/users/contacts/email-preferences.d.ts.map +1 -1
- package/resources/users/contacts/index.d.mts +1 -1
- package/resources/users/contacts/index.d.mts.map +1 -1
- package/resources/users/contacts/index.d.ts +1 -1
- package/resources/users/contacts/index.d.ts.map +1 -1
- package/resources/users/index.d.mts +2 -2
- package/resources/users/index.d.mts.map +1 -1
- package/resources/users/index.d.ts +2 -2
- package/resources/users/index.d.ts.map +1 -1
- package/resources/users/users.d.mts +2 -2
- package/resources/users/users.d.mts.map +1 -1
- package/resources/users/users.d.ts +2 -2
- package/resources/users/users.d.ts.map +1 -1
- package/resources/webhooks.d.mts +83 -83
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +83 -83
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +77 -77
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +77 -77
- package/resources/webhooks.mjs.map +1 -1
- package/src/client.ts +6 -6
- package/src/resources/audit-logs.ts +7 -1
- package/src/resources/changelogs/changelogs.ts +320 -175
- package/src/resources/changelogs/index.ts +1 -1
- package/src/resources/changelogs/subscribers.ts +31 -2
- package/src/resources/conversation-attributes.ts +34 -34
- package/src/resources/feedback/boards.ts +30 -30
- package/src/resources/feedback/comments.ts +137 -137
- package/src/resources/feedback/custom-fields.ts +46 -46
- package/src/resources/feedback/feedback.ts +6 -6
- package/src/resources/feedback/index.ts +6 -6
- package/src/resources/feedback/post-statuses.ts +33 -33
- package/src/resources/feedback/posts/index.ts +2 -2
- package/src/resources/feedback/posts/posts.ts +176 -176
- package/src/resources/feedback/posts/voters.ts +3 -3
- package/src/resources/help-center/articles.ts +631 -109
- package/src/resources/help-center/collections.ts +349 -88
- package/src/resources/help-center/help-center.ts +5 -5
- package/src/resources/help-center/help-centers.ts +202 -57
- package/src/resources/help-center/index.ts +5 -5
- package/src/resources/help-center/redirect-rules.ts +294 -178
- package/src/resources/index.ts +6 -6
- package/src/resources/organization/admins.ts +36 -36
- package/src/resources/organization/brands.ts +68 -68
- package/src/resources/organization/index.ts +3 -3
- package/src/resources/organization/organization.ts +3 -3
- package/src/resources/organization/teams.ts +54 -54
- package/src/resources/reports.ts +311 -262
- package/src/resources/support/conversation-tags.ts +62 -62
- package/src/resources/support/conversations/conversations.ts +429 -419
- package/src/resources/support/conversations/index.ts +4 -4
- package/src/resources/support/conversations/participants.ts +2 -2
- package/src/resources/support/index.ts +7 -7
- package/src/resources/support/support.ts +7 -7
- package/src/resources/support/tickets/categories.ts +35 -35
- package/src/resources/support/tickets/custom-fields.ts +29 -29
- package/src/resources/support/tickets/index.ts +4 -4
- package/src/resources/support/tickets/statuses.ts +31 -31
- package/src/resources/support/tickets/tickets.ts +101 -101
- package/src/resources/surveys.ts +60 -60
- package/src/resources/users/companies/companies.ts +158 -172
- package/src/resources/users/companies/contacts.ts +3 -3
- package/src/resources/users/companies/index.ts +2 -2
- package/src/resources/users/contacts/by-user-id/by-user-id.ts +2 -2
- package/src/resources/users/contacts/by-user-id/email-preferences.ts +2 -2
- package/src/resources/users/contacts/contacts.ts +284 -280
- package/src/resources/users/contacts/email-preferences.ts +2 -2
- package/src/resources/users/contacts/index.ts +3 -3
- package/src/resources/users/index.ts +5 -5
- package/src/resources/users/users.ts +5 -5
- package/src/resources/webhooks.ts +106 -100
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -6,57 +6,57 @@ import { RequestOptions } from "../../internal/request-options.mjs";
|
|
|
6
6
|
*/
|
|
7
7
|
export declare class ConversationTags extends APIResource {
|
|
8
8
|
/**
|
|
9
|
-
* Returns
|
|
10
|
-
*
|
|
11
|
-
* mutation endpoints.
|
|
9
|
+
* Returns a single conversation tag by its Featurebase tag ID. Archived tags can
|
|
10
|
+
* still be retrieved directly by ID, while permanently deleted tags return `404`.
|
|
12
11
|
*
|
|
13
12
|
* @example
|
|
14
13
|
* ```ts
|
|
15
|
-
* const
|
|
16
|
-
* await client.support.conversationTags.
|
|
14
|
+
* const conversationTag =
|
|
15
|
+
* await client.support.conversationTags.retrieve(
|
|
16
|
+
* '67ec1234abcd5678ef901234',
|
|
17
|
+
* );
|
|
17
18
|
* ```
|
|
18
19
|
*/
|
|
19
|
-
|
|
20
|
+
retrieve(id: string, params?: ConversationTagRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ConversationTag>;
|
|
20
21
|
/**
|
|
21
|
-
*
|
|
22
|
-
*
|
|
22
|
+
* Returns the live conversation tags available in the workspace tag catalog. These
|
|
23
|
+
* are the canonical tags that power conversation payloads, filters, and tag
|
|
24
|
+
* mutation endpoints.
|
|
23
25
|
*
|
|
24
26
|
* @example
|
|
25
27
|
* ```ts
|
|
26
|
-
* const
|
|
27
|
-
* await client.support.conversationTags.
|
|
28
|
-
* name: 'Churn',
|
|
29
|
-
* });
|
|
28
|
+
* const conversationTags =
|
|
29
|
+
* await client.support.conversationTags.list();
|
|
30
30
|
* ```
|
|
31
31
|
*/
|
|
32
|
-
|
|
32
|
+
list(params?: ConversationTagListParams | null | undefined, options?: RequestOptions): APIPromise<ConversationTagListResponse>;
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
35
|
-
*
|
|
34
|
+
* Deletes a conversation tag from the workspace catalog and removes it from
|
|
35
|
+
* aggregate conversation tag state. Archived and historical part applications
|
|
36
|
+
* remain part of the audit trail where applicable.
|
|
36
37
|
*
|
|
37
38
|
* @example
|
|
38
39
|
* ```ts
|
|
39
40
|
* const conversationTag =
|
|
40
|
-
* await client.support.conversationTags.
|
|
41
|
+
* await client.support.conversationTags.delete(
|
|
41
42
|
* '67ec1234abcd5678ef901234',
|
|
42
43
|
* );
|
|
43
44
|
* ```
|
|
44
45
|
*/
|
|
45
|
-
|
|
46
|
+
delete(id: string, params?: ConversationTagDeleteParams | null | undefined, options?: RequestOptions): APIPromise<ConversationTagDeleteResponse>;
|
|
46
47
|
/**
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
* remain part of the audit trail where applicable.
|
|
48
|
+
* Creates a new workspace conversation tag when only `name` is provided. If `id`
|
|
49
|
+
* is also provided, the existing tag is renamed instead.
|
|
50
50
|
*
|
|
51
51
|
* @example
|
|
52
52
|
* ```ts
|
|
53
53
|
* const conversationTag =
|
|
54
|
-
* await client.support.conversationTags.
|
|
55
|
-
* '
|
|
56
|
-
* );
|
|
54
|
+
* await client.support.conversationTags.createOrRename({
|
|
55
|
+
* name: 'Churn',
|
|
56
|
+
* });
|
|
57
57
|
* ```
|
|
58
58
|
*/
|
|
59
|
-
|
|
59
|
+
createOrRename(params: ConversationTagCreateOrRenameParams, options?: RequestOptions): APIPromise<ConversationTag>;
|
|
60
60
|
}
|
|
61
61
|
export interface ConversationTag {
|
|
62
62
|
/**
|
|
@@ -100,23 +100,21 @@ export interface ConversationTagDeleteResponse {
|
|
|
100
100
|
*/
|
|
101
101
|
object: 'tag';
|
|
102
102
|
}
|
|
103
|
-
export interface
|
|
103
|
+
export interface ConversationTagRetrieveParams {
|
|
104
104
|
/**
|
|
105
105
|
* API version for this request. Defaults to your organization's configured API
|
|
106
106
|
* version if not specified.
|
|
107
107
|
*/
|
|
108
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
108
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
109
109
|
}
|
|
110
|
-
export interface
|
|
111
|
-
/**
|
|
112
|
-
* Body param: Tag name
|
|
113
|
-
*/
|
|
114
|
-
name: string;
|
|
110
|
+
export interface ConversationTagListParams {
|
|
115
111
|
/**
|
|
116
|
-
*
|
|
117
|
-
*
|
|
112
|
+
* API version for this request. Defaults to your organization's configured API
|
|
113
|
+
* version if not specified.
|
|
118
114
|
*/
|
|
119
|
-
|
|
115
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
116
|
+
}
|
|
117
|
+
export interface ConversationTagDeleteParams {
|
|
120
118
|
/**
|
|
121
119
|
* Body param: Optional admin ID for actor attribution and permission checks.
|
|
122
120
|
*/
|
|
@@ -125,16 +123,18 @@ export interface ConversationTagCreateOrRenameParams {
|
|
|
125
123
|
* Header param: API version for this request. Defaults to your organization's
|
|
126
124
|
* configured API version if not specified.
|
|
127
125
|
*/
|
|
128
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
126
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
129
127
|
}
|
|
130
|
-
export interface
|
|
128
|
+
export interface ConversationTagCreateOrRenameParams {
|
|
131
129
|
/**
|
|
132
|
-
*
|
|
133
|
-
* version if not specified.
|
|
130
|
+
* Body param: Tag name
|
|
134
131
|
*/
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
132
|
+
name: string;
|
|
133
|
+
/**
|
|
134
|
+
* Body param: Optional existing tag ID. Provide this to rename an existing tag
|
|
135
|
+
* instead of creating a new one.
|
|
136
|
+
*/
|
|
137
|
+
id?: string;
|
|
138
138
|
/**
|
|
139
139
|
* Body param: Optional admin ID for actor attribution and permission checks.
|
|
140
140
|
*/
|
|
@@ -143,9 +143,9 @@ export interface ConversationTagDeleteParams {
|
|
|
143
143
|
* Header param: API version for this request. Defaults to your organization's
|
|
144
144
|
* configured API version if not specified.
|
|
145
145
|
*/
|
|
146
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
146
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
147
147
|
}
|
|
148
148
|
export declare namespace ConversationTags {
|
|
149
|
-
export { type ConversationTag as ConversationTag, type ConversationTagListResponse as ConversationTagListResponse, type ConversationTagDeleteResponse as ConversationTagDeleteResponse, type
|
|
149
|
+
export { type ConversationTag as ConversationTag, type ConversationTagListResponse as ConversationTagListResponse, type ConversationTagDeleteResponse as ConversationTagDeleteResponse, type ConversationTagRetrieveParams as ConversationTagRetrieveParams, type ConversationTagListParams as ConversationTagListParams, type ConversationTagDeleteParams as ConversationTagDeleteParams, type ConversationTagCreateOrRenameParams as ConversationTagCreateOrRenameParams, };
|
|
150
150
|
}
|
|
151
151
|
//# sourceMappingURL=conversation-tags.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conversation-tags.d.mts","sourceRoot":"","sources":["../../src/resources/support/conversation-tags.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C
|
|
1
|
+
{"version":3,"file":"conversation-tags.d.mts","sourceRoot":"","sources":["../../src/resources/support/conversation-tags.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAe9B;;;;;;;;;;OAUG;IACH,IAAI,CACF,MAAM,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAe1C;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAgB5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAAM,EAAE,mCAAmC,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;CAe/B;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}
|
|
@@ -6,57 +6,57 @@ import { RequestOptions } from "../../internal/request-options.js";
|
|
|
6
6
|
*/
|
|
7
7
|
export declare class ConversationTags extends APIResource {
|
|
8
8
|
/**
|
|
9
|
-
* Returns
|
|
10
|
-
*
|
|
11
|
-
* mutation endpoints.
|
|
9
|
+
* Returns a single conversation tag by its Featurebase tag ID. Archived tags can
|
|
10
|
+
* still be retrieved directly by ID, while permanently deleted tags return `404`.
|
|
12
11
|
*
|
|
13
12
|
* @example
|
|
14
13
|
* ```ts
|
|
15
|
-
* const
|
|
16
|
-
* await client.support.conversationTags.
|
|
14
|
+
* const conversationTag =
|
|
15
|
+
* await client.support.conversationTags.retrieve(
|
|
16
|
+
* '67ec1234abcd5678ef901234',
|
|
17
|
+
* );
|
|
17
18
|
* ```
|
|
18
19
|
*/
|
|
19
|
-
|
|
20
|
+
retrieve(id: string, params?: ConversationTagRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ConversationTag>;
|
|
20
21
|
/**
|
|
21
|
-
*
|
|
22
|
-
*
|
|
22
|
+
* Returns the live conversation tags available in the workspace tag catalog. These
|
|
23
|
+
* are the canonical tags that power conversation payloads, filters, and tag
|
|
24
|
+
* mutation endpoints.
|
|
23
25
|
*
|
|
24
26
|
* @example
|
|
25
27
|
* ```ts
|
|
26
|
-
* const
|
|
27
|
-
* await client.support.conversationTags.
|
|
28
|
-
* name: 'Churn',
|
|
29
|
-
* });
|
|
28
|
+
* const conversationTags =
|
|
29
|
+
* await client.support.conversationTags.list();
|
|
30
30
|
* ```
|
|
31
31
|
*/
|
|
32
|
-
|
|
32
|
+
list(params?: ConversationTagListParams | null | undefined, options?: RequestOptions): APIPromise<ConversationTagListResponse>;
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
35
|
-
*
|
|
34
|
+
* Deletes a conversation tag from the workspace catalog and removes it from
|
|
35
|
+
* aggregate conversation tag state. Archived and historical part applications
|
|
36
|
+
* remain part of the audit trail where applicable.
|
|
36
37
|
*
|
|
37
38
|
* @example
|
|
38
39
|
* ```ts
|
|
39
40
|
* const conversationTag =
|
|
40
|
-
* await client.support.conversationTags.
|
|
41
|
+
* await client.support.conversationTags.delete(
|
|
41
42
|
* '67ec1234abcd5678ef901234',
|
|
42
43
|
* );
|
|
43
44
|
* ```
|
|
44
45
|
*/
|
|
45
|
-
|
|
46
|
+
delete(id: string, params?: ConversationTagDeleteParams | null | undefined, options?: RequestOptions): APIPromise<ConversationTagDeleteResponse>;
|
|
46
47
|
/**
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
* remain part of the audit trail where applicable.
|
|
48
|
+
* Creates a new workspace conversation tag when only `name` is provided. If `id`
|
|
49
|
+
* is also provided, the existing tag is renamed instead.
|
|
50
50
|
*
|
|
51
51
|
* @example
|
|
52
52
|
* ```ts
|
|
53
53
|
* const conversationTag =
|
|
54
|
-
* await client.support.conversationTags.
|
|
55
|
-
* '
|
|
56
|
-
* );
|
|
54
|
+
* await client.support.conversationTags.createOrRename({
|
|
55
|
+
* name: 'Churn',
|
|
56
|
+
* });
|
|
57
57
|
* ```
|
|
58
58
|
*/
|
|
59
|
-
|
|
59
|
+
createOrRename(params: ConversationTagCreateOrRenameParams, options?: RequestOptions): APIPromise<ConversationTag>;
|
|
60
60
|
}
|
|
61
61
|
export interface ConversationTag {
|
|
62
62
|
/**
|
|
@@ -100,23 +100,21 @@ export interface ConversationTagDeleteResponse {
|
|
|
100
100
|
*/
|
|
101
101
|
object: 'tag';
|
|
102
102
|
}
|
|
103
|
-
export interface
|
|
103
|
+
export interface ConversationTagRetrieveParams {
|
|
104
104
|
/**
|
|
105
105
|
* API version for this request. Defaults to your organization's configured API
|
|
106
106
|
* version if not specified.
|
|
107
107
|
*/
|
|
108
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
108
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
109
109
|
}
|
|
110
|
-
export interface
|
|
111
|
-
/**
|
|
112
|
-
* Body param: Tag name
|
|
113
|
-
*/
|
|
114
|
-
name: string;
|
|
110
|
+
export interface ConversationTagListParams {
|
|
115
111
|
/**
|
|
116
|
-
*
|
|
117
|
-
*
|
|
112
|
+
* API version for this request. Defaults to your organization's configured API
|
|
113
|
+
* version if not specified.
|
|
118
114
|
*/
|
|
119
|
-
|
|
115
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
116
|
+
}
|
|
117
|
+
export interface ConversationTagDeleteParams {
|
|
120
118
|
/**
|
|
121
119
|
* Body param: Optional admin ID for actor attribution and permission checks.
|
|
122
120
|
*/
|
|
@@ -125,16 +123,18 @@ export interface ConversationTagCreateOrRenameParams {
|
|
|
125
123
|
* Header param: API version for this request. Defaults to your organization's
|
|
126
124
|
* configured API version if not specified.
|
|
127
125
|
*/
|
|
128
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
126
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
129
127
|
}
|
|
130
|
-
export interface
|
|
128
|
+
export interface ConversationTagCreateOrRenameParams {
|
|
131
129
|
/**
|
|
132
|
-
*
|
|
133
|
-
* version if not specified.
|
|
130
|
+
* Body param: Tag name
|
|
134
131
|
*/
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
132
|
+
name: string;
|
|
133
|
+
/**
|
|
134
|
+
* Body param: Optional existing tag ID. Provide this to rename an existing tag
|
|
135
|
+
* instead of creating a new one.
|
|
136
|
+
*/
|
|
137
|
+
id?: string;
|
|
138
138
|
/**
|
|
139
139
|
* Body param: Optional admin ID for actor attribution and permission checks.
|
|
140
140
|
*/
|
|
@@ -143,9 +143,9 @@ export interface ConversationTagDeleteParams {
|
|
|
143
143
|
* Header param: API version for this request. Defaults to your organization's
|
|
144
144
|
* configured API version if not specified.
|
|
145
145
|
*/
|
|
146
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
146
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
147
147
|
}
|
|
148
148
|
export declare namespace ConversationTags {
|
|
149
|
-
export { type ConversationTag as ConversationTag, type ConversationTagListResponse as ConversationTagListResponse, type ConversationTagDeleteResponse as ConversationTagDeleteResponse, type
|
|
149
|
+
export { type ConversationTag as ConversationTag, type ConversationTagListResponse as ConversationTagListResponse, type ConversationTagDeleteResponse as ConversationTagDeleteResponse, type ConversationTagRetrieveParams as ConversationTagRetrieveParams, type ConversationTagListParams as ConversationTagListParams, type ConversationTagDeleteParams as ConversationTagDeleteParams, type ConversationTagCreateOrRenameParams as ConversationTagCreateOrRenameParams, };
|
|
150
150
|
}
|
|
151
151
|
//# sourceMappingURL=conversation-tags.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conversation-tags.d.ts","sourceRoot":"","sources":["../../src/resources/support/conversation-tags.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C
|
|
1
|
+
{"version":3,"file":"conversation-tags.d.ts","sourceRoot":"","sources":["../../src/resources/support/conversation-tags.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAe9B;;;;;;;;;;OAUG;IACH,IAAI,CACF,MAAM,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAe1C;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAgB5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAAM,EAAE,mCAAmC,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;CAe/B;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}
|
|
@@ -10,19 +10,20 @@ const path_1 = require("../../internal/utils/path.js");
|
|
|
10
10
|
*/
|
|
11
11
|
class ConversationTags extends resource_1.APIResource {
|
|
12
12
|
/**
|
|
13
|
-
* Returns
|
|
14
|
-
*
|
|
15
|
-
* mutation endpoints.
|
|
13
|
+
* Returns a single conversation tag by its Featurebase tag ID. Archived tags can
|
|
14
|
+
* still be retrieved directly by ID, while permanently deleted tags return `404`.
|
|
16
15
|
*
|
|
17
16
|
* @example
|
|
18
17
|
* ```ts
|
|
19
|
-
* const
|
|
20
|
-
* await client.support.conversationTags.
|
|
18
|
+
* const conversationTag =
|
|
19
|
+
* await client.support.conversationTags.retrieve(
|
|
20
|
+
* '67ec1234abcd5678ef901234',
|
|
21
|
+
* );
|
|
21
22
|
* ```
|
|
22
23
|
*/
|
|
23
|
-
|
|
24
|
+
retrieve(id, params = {}, options) {
|
|
24
25
|
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
25
|
-
return this._client.get(
|
|
26
|
+
return this._client.get((0, path_1.path) `/v2/tags/${id}`, {
|
|
26
27
|
...options,
|
|
27
28
|
headers: (0, headers_1.buildHeaders)([
|
|
28
29
|
{
|
|
@@ -35,21 +36,19 @@ class ConversationTags extends resource_1.APIResource {
|
|
|
35
36
|
});
|
|
36
37
|
}
|
|
37
38
|
/**
|
|
38
|
-
*
|
|
39
|
-
*
|
|
39
|
+
* Returns the live conversation tags available in the workspace tag catalog. These
|
|
40
|
+
* are the canonical tags that power conversation payloads, filters, and tag
|
|
41
|
+
* mutation endpoints.
|
|
40
42
|
*
|
|
41
43
|
* @example
|
|
42
44
|
* ```ts
|
|
43
|
-
* const
|
|
44
|
-
* await client.support.conversationTags.
|
|
45
|
-
* name: 'Churn',
|
|
46
|
-
* });
|
|
45
|
+
* const conversationTags =
|
|
46
|
+
* await client.support.conversationTags.list();
|
|
47
47
|
* ```
|
|
48
48
|
*/
|
|
49
|
-
|
|
50
|
-
const { 'Featurebase-Version': featurebaseVersion
|
|
51
|
-
return this._client.
|
|
52
|
-
body,
|
|
49
|
+
list(params = {}, options) {
|
|
50
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
51
|
+
return this._client.get('/v2/tags', {
|
|
53
52
|
...options,
|
|
54
53
|
headers: (0, headers_1.buildHeaders)([
|
|
55
54
|
{
|
|
@@ -62,20 +61,22 @@ class ConversationTags extends resource_1.APIResource {
|
|
|
62
61
|
});
|
|
63
62
|
}
|
|
64
63
|
/**
|
|
65
|
-
*
|
|
66
|
-
*
|
|
64
|
+
* Deletes a conversation tag from the workspace catalog and removes it from
|
|
65
|
+
* aggregate conversation tag state. Archived and historical part applications
|
|
66
|
+
* remain part of the audit trail where applicable.
|
|
67
67
|
*
|
|
68
68
|
* @example
|
|
69
69
|
* ```ts
|
|
70
70
|
* const conversationTag =
|
|
71
|
-
* await client.support.conversationTags.
|
|
71
|
+
* await client.support.conversationTags.delete(
|
|
72
72
|
* '67ec1234abcd5678ef901234',
|
|
73
73
|
* );
|
|
74
74
|
* ```
|
|
75
75
|
*/
|
|
76
|
-
|
|
77
|
-
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
78
|
-
return this._client.
|
|
76
|
+
delete(id, params = {}, options) {
|
|
77
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params ?? {};
|
|
78
|
+
return this._client.delete((0, path_1.path) `/v2/tags/${id}`, {
|
|
79
|
+
body,
|
|
79
80
|
...options,
|
|
80
81
|
headers: (0, headers_1.buildHeaders)([
|
|
81
82
|
{
|
|
@@ -88,21 +89,20 @@ class ConversationTags extends resource_1.APIResource {
|
|
|
88
89
|
});
|
|
89
90
|
}
|
|
90
91
|
/**
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
* remain part of the audit trail where applicable.
|
|
92
|
+
* Creates a new workspace conversation tag when only `name` is provided. If `id`
|
|
93
|
+
* is also provided, the existing tag is renamed instead.
|
|
94
94
|
*
|
|
95
95
|
* @example
|
|
96
96
|
* ```ts
|
|
97
97
|
* const conversationTag =
|
|
98
|
-
* await client.support.conversationTags.
|
|
99
|
-
* '
|
|
100
|
-
* );
|
|
98
|
+
* await client.support.conversationTags.createOrRename({
|
|
99
|
+
* name: 'Churn',
|
|
100
|
+
* });
|
|
101
101
|
* ```
|
|
102
102
|
*/
|
|
103
|
-
|
|
104
|
-
const { 'Featurebase-Version': featurebaseVersion, ...body } = params
|
|
105
|
-
return this._client.
|
|
103
|
+
createOrRename(params, options) {
|
|
104
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
105
|
+
return this._client.post('/v2/tags', {
|
|
106
106
|
body,
|
|
107
107
|
...options,
|
|
108
108
|
headers: (0, headers_1.buildHeaders)([
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conversation-tags.js","sourceRoot":"","sources":["../../src/resources/support/conversation-tags.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C
|
|
1
|
+
{"version":3,"file":"conversation-tags.js","sourceRoot":"","sources":["../../src/resources/support/conversation-tags.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,SAA2D,EAAE,EAC7D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,EAAE,EAAE;YAC5C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAuD,EAAE,EACzD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE;YAClC,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,SAAyD,EAAE,EAC3D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,EAAE,EAAE;YAC/C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAA2C,EAC3C,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE;YACnC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA5HD,4CA4HC"}
|
|
@@ -7,19 +7,20 @@ import { path } from "../../internal/utils/path.mjs";
|
|
|
7
7
|
*/
|
|
8
8
|
export class ConversationTags extends APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* Returns
|
|
11
|
-
*
|
|
12
|
-
* mutation endpoints.
|
|
10
|
+
* Returns a single conversation tag by its Featurebase tag ID. Archived tags can
|
|
11
|
+
* still be retrieved directly by ID, while permanently deleted tags return `404`.
|
|
13
12
|
*
|
|
14
13
|
* @example
|
|
15
14
|
* ```ts
|
|
16
|
-
* const
|
|
17
|
-
* await client.support.conversationTags.
|
|
15
|
+
* const conversationTag =
|
|
16
|
+
* await client.support.conversationTags.retrieve(
|
|
17
|
+
* '67ec1234abcd5678ef901234',
|
|
18
|
+
* );
|
|
18
19
|
* ```
|
|
19
20
|
*/
|
|
20
|
-
|
|
21
|
+
retrieve(id, params = {}, options) {
|
|
21
22
|
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
22
|
-
return this._client.get(
|
|
23
|
+
return this._client.get(path `/v2/tags/${id}`, {
|
|
23
24
|
...options,
|
|
24
25
|
headers: buildHeaders([
|
|
25
26
|
{
|
|
@@ -32,21 +33,19 @@ export class ConversationTags extends APIResource {
|
|
|
32
33
|
});
|
|
33
34
|
}
|
|
34
35
|
/**
|
|
35
|
-
*
|
|
36
|
-
*
|
|
36
|
+
* Returns the live conversation tags available in the workspace tag catalog. These
|
|
37
|
+
* are the canonical tags that power conversation payloads, filters, and tag
|
|
38
|
+
* mutation endpoints.
|
|
37
39
|
*
|
|
38
40
|
* @example
|
|
39
41
|
* ```ts
|
|
40
|
-
* const
|
|
41
|
-
* await client.support.conversationTags.
|
|
42
|
-
* name: 'Churn',
|
|
43
|
-
* });
|
|
42
|
+
* const conversationTags =
|
|
43
|
+
* await client.support.conversationTags.list();
|
|
44
44
|
* ```
|
|
45
45
|
*/
|
|
46
|
-
|
|
47
|
-
const { 'Featurebase-Version': featurebaseVersion
|
|
48
|
-
return this._client.
|
|
49
|
-
body,
|
|
46
|
+
list(params = {}, options) {
|
|
47
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
48
|
+
return this._client.get('/v2/tags', {
|
|
50
49
|
...options,
|
|
51
50
|
headers: buildHeaders([
|
|
52
51
|
{
|
|
@@ -59,20 +58,22 @@ export class ConversationTags extends APIResource {
|
|
|
59
58
|
});
|
|
60
59
|
}
|
|
61
60
|
/**
|
|
62
|
-
*
|
|
63
|
-
*
|
|
61
|
+
* Deletes a conversation tag from the workspace catalog and removes it from
|
|
62
|
+
* aggregate conversation tag state. Archived and historical part applications
|
|
63
|
+
* remain part of the audit trail where applicable.
|
|
64
64
|
*
|
|
65
65
|
* @example
|
|
66
66
|
* ```ts
|
|
67
67
|
* const conversationTag =
|
|
68
|
-
* await client.support.conversationTags.
|
|
68
|
+
* await client.support.conversationTags.delete(
|
|
69
69
|
* '67ec1234abcd5678ef901234',
|
|
70
70
|
* );
|
|
71
71
|
* ```
|
|
72
72
|
*/
|
|
73
|
-
|
|
74
|
-
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
75
|
-
return this._client.
|
|
73
|
+
delete(id, params = {}, options) {
|
|
74
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params ?? {};
|
|
75
|
+
return this._client.delete(path `/v2/tags/${id}`, {
|
|
76
|
+
body,
|
|
76
77
|
...options,
|
|
77
78
|
headers: buildHeaders([
|
|
78
79
|
{
|
|
@@ -85,21 +86,20 @@ export class ConversationTags extends APIResource {
|
|
|
85
86
|
});
|
|
86
87
|
}
|
|
87
88
|
/**
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
* remain part of the audit trail where applicable.
|
|
89
|
+
* Creates a new workspace conversation tag when only `name` is provided. If `id`
|
|
90
|
+
* is also provided, the existing tag is renamed instead.
|
|
91
91
|
*
|
|
92
92
|
* @example
|
|
93
93
|
* ```ts
|
|
94
94
|
* const conversationTag =
|
|
95
|
-
* await client.support.conversationTags.
|
|
96
|
-
* '
|
|
97
|
-
* );
|
|
95
|
+
* await client.support.conversationTags.createOrRename({
|
|
96
|
+
* name: 'Churn',
|
|
97
|
+
* });
|
|
98
98
|
* ```
|
|
99
99
|
*/
|
|
100
|
-
|
|
101
|
-
const { 'Featurebase-Version': featurebaseVersion, ...body } = params
|
|
102
|
-
return this._client.
|
|
100
|
+
createOrRename(params, options) {
|
|
101
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
102
|
+
return this._client.post('/v2/tags', {
|
|
103
103
|
body,
|
|
104
104
|
...options,
|
|
105
105
|
headers: buildHeaders([
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conversation-tags.mjs","sourceRoot":"","sources":["../../src/resources/support/conversation-tags.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C
|
|
1
|
+
{"version":3,"file":"conversation-tags.mjs","sourceRoot":"","sources":["../../src/resources/support/conversation-tags.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAU,EACV,SAA2D,EAAE,EAC7D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,EAAE,EAAE;YAC5C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAuD,EAAE,EACzD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE;YAClC,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,SAAyD,EAAE,EAC3D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,EAAE,EAAE,EAAE;YAC/C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,MAA2C,EAC3C,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE;YACnC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
|