featurebase-node 0.14.2 → 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 +16 -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 +6 -6
- package/resources/feedback/feedback.d.mts.map +1 -1
- package/resources/feedback/feedback.d.ts +6 -6
- package/resources/feedback/feedback.d.ts.map +1 -1
- package/resources/feedback/feedback.js.map +1 -1
- package/resources/feedback/feedback.mjs.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/index.js.map +1 -1
- package/resources/feedback/index.mjs.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/index.js.map +1 -1
- package/resources/feedback/posts/index.mjs.map +1 -1
- package/resources/feedback/posts/posts.d.mts +169 -102
- package/resources/feedback/posts/posts.d.mts.map +1 -1
- package/resources/feedback/posts/posts.d.ts +169 -102
- package/resources/feedback/posts/posts.d.ts.map +1 -1
- package/resources/feedback/posts/posts.js +144 -75
- package/resources/feedback/posts/posts.js.map +1 -1
- package/resources/feedback/posts/posts.mjs +144 -75
- 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 +347 -180
- package/resources/reports.d.mts.map +1 -1
- package/resources/reports.d.ts +347 -180
- package/resources/reports.d.ts.map +1 -1
- package/resources/reports.js +124 -99
- package/resources/reports.js.map +1 -1
- package/resources/reports.mjs +124 -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 +402 -351
- package/resources/support/conversations/conversations.d.mts.map +1 -1
- package/resources/support/conversations/conversations.d.ts +402 -351
- package/resources/support/conversations/conversations.d.ts.map +1 -1
- package/resources/support/conversations/conversations.js +340 -295
- package/resources/support/conversations/conversations.js.map +1 -1
- package/resources/support/conversations/conversations.mjs +340 -295
- 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 +9 -5
- package/src/resources/feedback/index.ts +7 -5
- package/src/resources/feedback/post-statuses.ts +33 -33
- package/src/resources/feedback/posts/index.ts +3 -1
- package/src/resources/feedback/posts/posts.ts +232 -128
- 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 +454 -232
- package/src/resources/support/conversation-tags.ts +62 -62
- package/src/resources/support/conversations/conversations.ts +489 -438
- 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
|
@@ -13,83 +13,6 @@ import { path } from '../../internal/utils/path';
|
|
|
13
13
|
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
14
14
|
*/
|
|
15
15
|
export class Articles extends APIResource {
|
|
16
|
-
/**
|
|
17
|
-
* Returns a paginated list of articles within your organization's help center.
|
|
18
|
-
*
|
|
19
|
-
* Articles are the main content pieces that contain documentation, guides, and
|
|
20
|
-
* FAQs.
|
|
21
|
-
*
|
|
22
|
-
* ### Query Parameters
|
|
23
|
-
*
|
|
24
|
-
* - `limit` - Number of items to return (1-100, default 10)
|
|
25
|
-
* - `cursor` - Cursor for pagination
|
|
26
|
-
* - `state` - Filter by article state: "live", "draft", or "all" (default "live")
|
|
27
|
-
* - `parentId` - Filter by parent collection ID
|
|
28
|
-
*
|
|
29
|
-
* ### Response Format
|
|
30
|
-
*
|
|
31
|
-
* Returns a list object with:
|
|
32
|
-
*
|
|
33
|
-
* - `object` - Always "list"
|
|
34
|
-
* - `data` - Array of article objects
|
|
35
|
-
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
36
|
-
*
|
|
37
|
-
* ### Article Object
|
|
38
|
-
*
|
|
39
|
-
* Each article includes:
|
|
40
|
-
*
|
|
41
|
-
* - `id` - Unique identifier
|
|
42
|
-
* - `title` - Article title
|
|
43
|
-
* - `description` - Article description
|
|
44
|
-
* - `body` - Article content (HTML)
|
|
45
|
-
* - `slug` - URL slug
|
|
46
|
-
* - `icon` - Article icon (emoji or custom)
|
|
47
|
-
* - `parentId` - Parent collection ID
|
|
48
|
-
* - `helpCenterId` - ID of the help center this article belongs to
|
|
49
|
-
* - `organization` - Organization ID
|
|
50
|
-
* - `state` - Article state (live or draft)
|
|
51
|
-
* - `defaultLocale` - Default locale for content
|
|
52
|
-
* - `locale` - Current locale
|
|
53
|
-
* - `availableLocales` - Array of available locales
|
|
54
|
-
* - `publishedLocales` - Array of locales where article is published
|
|
55
|
-
* - `featurebaseUrl` - Featurebase URL for the article
|
|
56
|
-
* - `externalUrl` - External URL if custom domain is configured
|
|
57
|
-
* - `author` - Author information (name, authorId, avatarUrl)
|
|
58
|
-
* - `order` - Display order
|
|
59
|
-
* - `isPublished` - Whether the article is published
|
|
60
|
-
* - `isDraftDiffersFromLive` - Whether draft differs from live version
|
|
61
|
-
* - `translations` - Translations for different locales
|
|
62
|
-
* - `createdAt` - ISO 8601 timestamp when created
|
|
63
|
-
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
64
|
-
* - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated
|
|
65
|
-
*
|
|
66
|
-
* @example
|
|
67
|
-
* ```ts
|
|
68
|
-
* // Automatically fetches more pages as needed.
|
|
69
|
-
* for await (const article of client.helpCenter.articles.list()) {
|
|
70
|
-
* // ...
|
|
71
|
-
* }
|
|
72
|
-
* ```
|
|
73
|
-
*/
|
|
74
|
-
list(
|
|
75
|
-
params: ArticleListParams | null | undefined = {},
|
|
76
|
-
options?: RequestOptions,
|
|
77
|
-
): PagePromise<ArticlesCursorPage, Article> {
|
|
78
|
-
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
79
|
-
return this._client.getAPIList('/v2/help_center/articles', CursorPage<Article>, {
|
|
80
|
-
query,
|
|
81
|
-
...options,
|
|
82
|
-
headers: buildHeaders([
|
|
83
|
-
{
|
|
84
|
-
...(featurebaseVersion?.toString() != null ?
|
|
85
|
-
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
86
|
-
: undefined),
|
|
87
|
-
},
|
|
88
|
-
options?.headers,
|
|
89
|
-
]),
|
|
90
|
-
});
|
|
91
|
-
}
|
|
92
|
-
|
|
93
16
|
/**
|
|
94
17
|
* Creates a new article in your organization's help center.
|
|
95
18
|
*
|
|
@@ -299,6 +222,83 @@ export class Articles extends APIResource {
|
|
|
299
222
|
});
|
|
300
223
|
}
|
|
301
224
|
|
|
225
|
+
/**
|
|
226
|
+
* Returns a paginated list of articles within your organization's help center.
|
|
227
|
+
*
|
|
228
|
+
* Articles are the main content pieces that contain documentation, guides, and
|
|
229
|
+
* FAQs.
|
|
230
|
+
*
|
|
231
|
+
* ### Query Parameters
|
|
232
|
+
*
|
|
233
|
+
* - `limit` - Number of items to return (1-100, default 10)
|
|
234
|
+
* - `cursor` - Cursor for pagination
|
|
235
|
+
* - `state` - Filter by article state: "live", "draft", or "all" (default "live")
|
|
236
|
+
* - `parentId` - Filter by parent collection ID
|
|
237
|
+
*
|
|
238
|
+
* ### Response Format
|
|
239
|
+
*
|
|
240
|
+
* Returns a list object with:
|
|
241
|
+
*
|
|
242
|
+
* - `object` - Always "list"
|
|
243
|
+
* - `data` - Array of article objects
|
|
244
|
+
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
245
|
+
*
|
|
246
|
+
* ### Article Object
|
|
247
|
+
*
|
|
248
|
+
* Each article includes:
|
|
249
|
+
*
|
|
250
|
+
* - `id` - Unique identifier
|
|
251
|
+
* - `title` - Article title
|
|
252
|
+
* - `description` - Article description
|
|
253
|
+
* - `body` - Article content (HTML)
|
|
254
|
+
* - `slug` - URL slug
|
|
255
|
+
* - `icon` - Article icon (emoji or custom)
|
|
256
|
+
* - `parentId` - Parent collection ID
|
|
257
|
+
* - `helpCenterId` - ID of the help center this article belongs to
|
|
258
|
+
* - `organization` - Organization ID
|
|
259
|
+
* - `state` - Article state (live or draft)
|
|
260
|
+
* - `defaultLocale` - Default locale for content
|
|
261
|
+
* - `locale` - Current locale
|
|
262
|
+
* - `availableLocales` - Array of available locales
|
|
263
|
+
* - `publishedLocales` - Array of locales where article is published
|
|
264
|
+
* - `featurebaseUrl` - Featurebase URL for the article
|
|
265
|
+
* - `externalUrl` - External URL if custom domain is configured
|
|
266
|
+
* - `author` - Author information (name, authorId, avatarUrl)
|
|
267
|
+
* - `order` - Display order
|
|
268
|
+
* - `isPublished` - Whether the article is published
|
|
269
|
+
* - `isDraftDiffersFromLive` - Whether draft differs from live version
|
|
270
|
+
* - `translations` - Translations for different locales
|
|
271
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
272
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
273
|
+
* - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated
|
|
274
|
+
*
|
|
275
|
+
* @example
|
|
276
|
+
* ```ts
|
|
277
|
+
* // Automatically fetches more pages as needed.
|
|
278
|
+
* for await (const article of client.helpCenter.articles.list()) {
|
|
279
|
+
* // ...
|
|
280
|
+
* }
|
|
281
|
+
* ```
|
|
282
|
+
*/
|
|
283
|
+
list(
|
|
284
|
+
params: ArticleListParams | null | undefined = {},
|
|
285
|
+
options?: RequestOptions,
|
|
286
|
+
): PagePromise<ArticlesCursorPage, Article> {
|
|
287
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
288
|
+
return this._client.getAPIList('/v2/help_center/articles', CursorPage<Article>, {
|
|
289
|
+
query,
|
|
290
|
+
...options,
|
|
291
|
+
headers: buildHeaders([
|
|
292
|
+
{
|
|
293
|
+
...(featurebaseVersion?.toString() != null ?
|
|
294
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
295
|
+
: undefined),
|
|
296
|
+
},
|
|
297
|
+
options?.headers,
|
|
298
|
+
]),
|
|
299
|
+
});
|
|
300
|
+
}
|
|
301
|
+
|
|
302
302
|
/**
|
|
303
303
|
* Deletes an existing article.
|
|
304
304
|
*
|
|
@@ -571,6 +571,35 @@ export interface Article {
|
|
|
571
571
|
* Available locales
|
|
572
572
|
*/
|
|
573
573
|
availableLocales: Array<
|
|
574
|
+
| 'ar'
|
|
575
|
+
| 'am'
|
|
576
|
+
| 'fa'
|
|
577
|
+
| 'ht'
|
|
578
|
+
| 'lo'
|
|
579
|
+
| 'my'
|
|
580
|
+
| 'pa'
|
|
581
|
+
| 'ps'
|
|
582
|
+
| 'so'
|
|
583
|
+
| 'tl'
|
|
584
|
+
| 'ur'
|
|
585
|
+
| 'he'
|
|
586
|
+
| 'ta'
|
|
587
|
+
| 'te'
|
|
588
|
+
| 'mr'
|
|
589
|
+
| 'gu'
|
|
590
|
+
| 'kn'
|
|
591
|
+
| 'ml'
|
|
592
|
+
| 'ha'
|
|
593
|
+
| 'jv'
|
|
594
|
+
| 'yo'
|
|
595
|
+
| 'ig'
|
|
596
|
+
| 'uz'
|
|
597
|
+
| 'ne'
|
|
598
|
+
| 'sd'
|
|
599
|
+
| 'az'
|
|
600
|
+
| 'si'
|
|
601
|
+
| 'km'
|
|
602
|
+
| 'kk'
|
|
574
603
|
| 'bn'
|
|
575
604
|
| 'bs'
|
|
576
605
|
| 'pt-BR'
|
|
@@ -629,6 +658,35 @@ export interface Article {
|
|
|
629
658
|
* Current locale
|
|
630
659
|
*/
|
|
631
660
|
locale:
|
|
661
|
+
| 'ar'
|
|
662
|
+
| 'am'
|
|
663
|
+
| 'fa'
|
|
664
|
+
| 'ht'
|
|
665
|
+
| 'lo'
|
|
666
|
+
| 'my'
|
|
667
|
+
| 'pa'
|
|
668
|
+
| 'ps'
|
|
669
|
+
| 'so'
|
|
670
|
+
| 'tl'
|
|
671
|
+
| 'ur'
|
|
672
|
+
| 'he'
|
|
673
|
+
| 'ta'
|
|
674
|
+
| 'te'
|
|
675
|
+
| 'mr'
|
|
676
|
+
| 'gu'
|
|
677
|
+
| 'kn'
|
|
678
|
+
| 'ml'
|
|
679
|
+
| 'ha'
|
|
680
|
+
| 'jv'
|
|
681
|
+
| 'yo'
|
|
682
|
+
| 'ig'
|
|
683
|
+
| 'uz'
|
|
684
|
+
| 'ne'
|
|
685
|
+
| 'sd'
|
|
686
|
+
| 'az'
|
|
687
|
+
| 'si'
|
|
688
|
+
| 'km'
|
|
689
|
+
| 'kk'
|
|
632
690
|
| 'bn'
|
|
633
691
|
| 'bs'
|
|
634
692
|
| 'pt-BR'
|
|
@@ -706,6 +764,35 @@ export interface Article {
|
|
|
706
764
|
* Default locale
|
|
707
765
|
*/
|
|
708
766
|
defaultLocale?:
|
|
767
|
+
| 'ar'
|
|
768
|
+
| 'am'
|
|
769
|
+
| 'fa'
|
|
770
|
+
| 'ht'
|
|
771
|
+
| 'lo'
|
|
772
|
+
| 'my'
|
|
773
|
+
| 'pa'
|
|
774
|
+
| 'ps'
|
|
775
|
+
| 'so'
|
|
776
|
+
| 'tl'
|
|
777
|
+
| 'ur'
|
|
778
|
+
| 'he'
|
|
779
|
+
| 'ta'
|
|
780
|
+
| 'te'
|
|
781
|
+
| 'mr'
|
|
782
|
+
| 'gu'
|
|
783
|
+
| 'kn'
|
|
784
|
+
| 'ml'
|
|
785
|
+
| 'ha'
|
|
786
|
+
| 'jv'
|
|
787
|
+
| 'yo'
|
|
788
|
+
| 'ig'
|
|
789
|
+
| 'uz'
|
|
790
|
+
| 'ne'
|
|
791
|
+
| 'sd'
|
|
792
|
+
| 'az'
|
|
793
|
+
| 'si'
|
|
794
|
+
| 'km'
|
|
795
|
+
| 'kk'
|
|
709
796
|
| 'bn'
|
|
710
797
|
| 'bs'
|
|
711
798
|
| 'pt-BR'
|
|
@@ -803,6 +890,35 @@ export interface Article {
|
|
|
803
890
|
* Published locales
|
|
804
891
|
*/
|
|
805
892
|
publishedLocales?: Array<
|
|
893
|
+
| 'ar'
|
|
894
|
+
| 'am'
|
|
895
|
+
| 'fa'
|
|
896
|
+
| 'ht'
|
|
897
|
+
| 'lo'
|
|
898
|
+
| 'my'
|
|
899
|
+
| 'pa'
|
|
900
|
+
| 'ps'
|
|
901
|
+
| 'so'
|
|
902
|
+
| 'tl'
|
|
903
|
+
| 'ur'
|
|
904
|
+
| 'he'
|
|
905
|
+
| 'ta'
|
|
906
|
+
| 'te'
|
|
907
|
+
| 'mr'
|
|
908
|
+
| 'gu'
|
|
909
|
+
| 'kn'
|
|
910
|
+
| 'ml'
|
|
911
|
+
| 'ha'
|
|
912
|
+
| 'jv'
|
|
913
|
+
| 'yo'
|
|
914
|
+
| 'ig'
|
|
915
|
+
| 'uz'
|
|
916
|
+
| 'ne'
|
|
917
|
+
| 'sd'
|
|
918
|
+
| 'az'
|
|
919
|
+
| 'si'
|
|
920
|
+
| 'km'
|
|
921
|
+
| 'kk'
|
|
806
922
|
| 'bn'
|
|
807
923
|
| 'bs'
|
|
808
924
|
| 'pt-BR'
|
|
@@ -890,6 +1006,12 @@ export namespace Article {
|
|
|
890
1006
|
export interface Translations {
|
|
891
1007
|
id?: ArticlesAPI.ArticleTranslation;
|
|
892
1008
|
|
|
1009
|
+
am?: ArticlesAPI.ArticleTranslation;
|
|
1010
|
+
|
|
1011
|
+
ar?: ArticlesAPI.ArticleTranslation;
|
|
1012
|
+
|
|
1013
|
+
az?: ArticlesAPI.ArticleTranslation;
|
|
1014
|
+
|
|
893
1015
|
bg?: ArticlesAPI.ArticleTranslation;
|
|
894
1016
|
|
|
895
1017
|
bn?: ArticlesAPI.ArticleTranslation;
|
|
@@ -912,36 +1034,70 @@ export namespace Article {
|
|
|
912
1034
|
|
|
913
1035
|
et?: ArticlesAPI.ArticleTranslation;
|
|
914
1036
|
|
|
1037
|
+
fa?: ArticlesAPI.ArticleTranslation;
|
|
1038
|
+
|
|
915
1039
|
fi?: ArticlesAPI.ArticleTranslation;
|
|
916
1040
|
|
|
917
1041
|
fr?: ArticlesAPI.ArticleTranslation;
|
|
918
1042
|
|
|
1043
|
+
gu?: ArticlesAPI.ArticleTranslation;
|
|
1044
|
+
|
|
1045
|
+
ha?: ArticlesAPI.ArticleTranslation;
|
|
1046
|
+
|
|
1047
|
+
he?: ArticlesAPI.ArticleTranslation;
|
|
1048
|
+
|
|
919
1049
|
hi?: ArticlesAPI.ArticleTranslation;
|
|
920
1050
|
|
|
921
1051
|
hr?: ArticlesAPI.ArticleTranslation;
|
|
922
1052
|
|
|
1053
|
+
ht?: ArticlesAPI.ArticleTranslation;
|
|
1054
|
+
|
|
923
1055
|
hu?: ArticlesAPI.ArticleTranslation;
|
|
924
1056
|
|
|
1057
|
+
ig?: ArticlesAPI.ArticleTranslation;
|
|
1058
|
+
|
|
925
1059
|
it?: ArticlesAPI.ArticleTranslation;
|
|
926
1060
|
|
|
927
1061
|
ja?: ArticlesAPI.ArticleTranslation;
|
|
928
1062
|
|
|
1063
|
+
jv?: ArticlesAPI.ArticleTranslation;
|
|
1064
|
+
|
|
1065
|
+
kk?: ArticlesAPI.ArticleTranslation;
|
|
1066
|
+
|
|
1067
|
+
km?: ArticlesAPI.ArticleTranslation;
|
|
1068
|
+
|
|
1069
|
+
kn?: ArticlesAPI.ArticleTranslation;
|
|
1070
|
+
|
|
929
1071
|
ko?: ArticlesAPI.ArticleTranslation;
|
|
930
1072
|
|
|
1073
|
+
lo?: ArticlesAPI.ArticleTranslation;
|
|
1074
|
+
|
|
931
1075
|
lt?: ArticlesAPI.ArticleTranslation;
|
|
932
1076
|
|
|
933
1077
|
lv?: ArticlesAPI.ArticleTranslation;
|
|
934
1078
|
|
|
1079
|
+
ml?: ArticlesAPI.ArticleTranslation;
|
|
1080
|
+
|
|
935
1081
|
mn?: ArticlesAPI.ArticleTranslation;
|
|
936
1082
|
|
|
1083
|
+
mr?: ArticlesAPI.ArticleTranslation;
|
|
1084
|
+
|
|
937
1085
|
ms?: ArticlesAPI.ArticleTranslation;
|
|
938
1086
|
|
|
1087
|
+
my?: ArticlesAPI.ArticleTranslation;
|
|
1088
|
+
|
|
939
1089
|
nb?: ArticlesAPI.ArticleTranslation;
|
|
940
1090
|
|
|
1091
|
+
ne?: ArticlesAPI.ArticleTranslation;
|
|
1092
|
+
|
|
941
1093
|
nl?: ArticlesAPI.ArticleTranslation;
|
|
942
1094
|
|
|
1095
|
+
pa?: ArticlesAPI.ArticleTranslation;
|
|
1096
|
+
|
|
943
1097
|
pl?: ArticlesAPI.ArticleTranslation;
|
|
944
1098
|
|
|
1099
|
+
ps?: ArticlesAPI.ArticleTranslation;
|
|
1100
|
+
|
|
945
1101
|
pt?: ArticlesAPI.ArticleTranslation;
|
|
946
1102
|
|
|
947
1103
|
'pt-BR'?: ArticlesAPI.ArticleTranslation;
|
|
@@ -950,24 +1106,42 @@ export namespace Article {
|
|
|
950
1106
|
|
|
951
1107
|
ru?: ArticlesAPI.ArticleTranslation;
|
|
952
1108
|
|
|
1109
|
+
sd?: ArticlesAPI.ArticleTranslation;
|
|
1110
|
+
|
|
1111
|
+
si?: ArticlesAPI.ArticleTranslation;
|
|
1112
|
+
|
|
953
1113
|
sk?: ArticlesAPI.ArticleTranslation;
|
|
954
1114
|
|
|
955
1115
|
sl?: ArticlesAPI.ArticleTranslation;
|
|
956
1116
|
|
|
1117
|
+
so?: ArticlesAPI.ArticleTranslation;
|
|
1118
|
+
|
|
957
1119
|
sr?: ArticlesAPI.ArticleTranslation;
|
|
958
1120
|
|
|
959
1121
|
sv?: ArticlesAPI.ArticleTranslation;
|
|
960
1122
|
|
|
961
1123
|
sw?: ArticlesAPI.ArticleTranslation;
|
|
962
1124
|
|
|
1125
|
+
ta?: ArticlesAPI.ArticleTranslation;
|
|
1126
|
+
|
|
1127
|
+
te?: ArticlesAPI.ArticleTranslation;
|
|
1128
|
+
|
|
963
1129
|
th?: ArticlesAPI.ArticleTranslation;
|
|
964
1130
|
|
|
1131
|
+
tl?: ArticlesAPI.ArticleTranslation;
|
|
1132
|
+
|
|
965
1133
|
tr?: ArticlesAPI.ArticleTranslation;
|
|
966
1134
|
|
|
967
1135
|
uk?: ArticlesAPI.ArticleTranslation;
|
|
968
1136
|
|
|
1137
|
+
ur?: ArticlesAPI.ArticleTranslation;
|
|
1138
|
+
|
|
1139
|
+
uz?: ArticlesAPI.ArticleTranslation;
|
|
1140
|
+
|
|
969
1141
|
vi?: ArticlesAPI.ArticleTranslation;
|
|
970
1142
|
|
|
1143
|
+
yo?: ArticlesAPI.ArticleTranslation;
|
|
1144
|
+
|
|
971
1145
|
'zh-CN'?: ArticlesAPI.ArticleTranslation;
|
|
972
1146
|
|
|
973
1147
|
'zh-TW'?: ArticlesAPI.ArticleTranslation;
|
|
@@ -1133,6 +1307,35 @@ export interface EditArticleBodyBody {
|
|
|
1133
1307
|
* Locale of the body to edit. Defaults to the help center's default locale.
|
|
1134
1308
|
*/
|
|
1135
1309
|
locale?:
|
|
1310
|
+
| 'ar'
|
|
1311
|
+
| 'am'
|
|
1312
|
+
| 'fa'
|
|
1313
|
+
| 'ht'
|
|
1314
|
+
| 'lo'
|
|
1315
|
+
| 'my'
|
|
1316
|
+
| 'pa'
|
|
1317
|
+
| 'ps'
|
|
1318
|
+
| 'so'
|
|
1319
|
+
| 'tl'
|
|
1320
|
+
| 'ur'
|
|
1321
|
+
| 'he'
|
|
1322
|
+
| 'ta'
|
|
1323
|
+
| 'te'
|
|
1324
|
+
| 'mr'
|
|
1325
|
+
| 'gu'
|
|
1326
|
+
| 'kn'
|
|
1327
|
+
| 'ml'
|
|
1328
|
+
| 'ha'
|
|
1329
|
+
| 'jv'
|
|
1330
|
+
| 'yo'
|
|
1331
|
+
| 'ig'
|
|
1332
|
+
| 'uz'
|
|
1333
|
+
| 'ne'
|
|
1334
|
+
| 'sd'
|
|
1335
|
+
| 'az'
|
|
1336
|
+
| 'si'
|
|
1337
|
+
| 'km'
|
|
1338
|
+
| 'kk'
|
|
1136
1339
|
| 'bn'
|
|
1137
1340
|
| 'bs'
|
|
1138
1341
|
| 'pt-BR'
|
|
@@ -1314,6 +1517,35 @@ export namespace ArticleSearchResponse {
|
|
|
1314
1517
|
* Available locales
|
|
1315
1518
|
*/
|
|
1316
1519
|
availableLocales: Array<
|
|
1520
|
+
| 'ar'
|
|
1521
|
+
| 'am'
|
|
1522
|
+
| 'fa'
|
|
1523
|
+
| 'ht'
|
|
1524
|
+
| 'lo'
|
|
1525
|
+
| 'my'
|
|
1526
|
+
| 'pa'
|
|
1527
|
+
| 'ps'
|
|
1528
|
+
| 'so'
|
|
1529
|
+
| 'tl'
|
|
1530
|
+
| 'ur'
|
|
1531
|
+
| 'he'
|
|
1532
|
+
| 'ta'
|
|
1533
|
+
| 'te'
|
|
1534
|
+
| 'mr'
|
|
1535
|
+
| 'gu'
|
|
1536
|
+
| 'kn'
|
|
1537
|
+
| 'ml'
|
|
1538
|
+
| 'ha'
|
|
1539
|
+
| 'jv'
|
|
1540
|
+
| 'yo'
|
|
1541
|
+
| 'ig'
|
|
1542
|
+
| 'uz'
|
|
1543
|
+
| 'ne'
|
|
1544
|
+
| 'sd'
|
|
1545
|
+
| 'az'
|
|
1546
|
+
| 'si'
|
|
1547
|
+
| 'km'
|
|
1548
|
+
| 'kk'
|
|
1317
1549
|
| 'bn'
|
|
1318
1550
|
| 'bs'
|
|
1319
1551
|
| 'pt-BR'
|
|
@@ -1372,6 +1604,35 @@ export namespace ArticleSearchResponse {
|
|
|
1372
1604
|
* Current locale
|
|
1373
1605
|
*/
|
|
1374
1606
|
locale:
|
|
1607
|
+
| 'ar'
|
|
1608
|
+
| 'am'
|
|
1609
|
+
| 'fa'
|
|
1610
|
+
| 'ht'
|
|
1611
|
+
| 'lo'
|
|
1612
|
+
| 'my'
|
|
1613
|
+
| 'pa'
|
|
1614
|
+
| 'ps'
|
|
1615
|
+
| 'so'
|
|
1616
|
+
| 'tl'
|
|
1617
|
+
| 'ur'
|
|
1618
|
+
| 'he'
|
|
1619
|
+
| 'ta'
|
|
1620
|
+
| 'te'
|
|
1621
|
+
| 'mr'
|
|
1622
|
+
| 'gu'
|
|
1623
|
+
| 'kn'
|
|
1624
|
+
| 'ml'
|
|
1625
|
+
| 'ha'
|
|
1626
|
+
| 'jv'
|
|
1627
|
+
| 'yo'
|
|
1628
|
+
| 'ig'
|
|
1629
|
+
| 'uz'
|
|
1630
|
+
| 'ne'
|
|
1631
|
+
| 'sd'
|
|
1632
|
+
| 'az'
|
|
1633
|
+
| 'si'
|
|
1634
|
+
| 'km'
|
|
1635
|
+
| 'kk'
|
|
1375
1636
|
| 'bn'
|
|
1376
1637
|
| 'bs'
|
|
1377
1638
|
| 'pt-BR'
|
|
@@ -1449,6 +1710,35 @@ export namespace ArticleSearchResponse {
|
|
|
1449
1710
|
* Default locale
|
|
1450
1711
|
*/
|
|
1451
1712
|
defaultLocale?:
|
|
1713
|
+
| 'ar'
|
|
1714
|
+
| 'am'
|
|
1715
|
+
| 'fa'
|
|
1716
|
+
| 'ht'
|
|
1717
|
+
| 'lo'
|
|
1718
|
+
| 'my'
|
|
1719
|
+
| 'pa'
|
|
1720
|
+
| 'ps'
|
|
1721
|
+
| 'so'
|
|
1722
|
+
| 'tl'
|
|
1723
|
+
| 'ur'
|
|
1724
|
+
| 'he'
|
|
1725
|
+
| 'ta'
|
|
1726
|
+
| 'te'
|
|
1727
|
+
| 'mr'
|
|
1728
|
+
| 'gu'
|
|
1729
|
+
| 'kn'
|
|
1730
|
+
| 'ml'
|
|
1731
|
+
| 'ha'
|
|
1732
|
+
| 'jv'
|
|
1733
|
+
| 'yo'
|
|
1734
|
+
| 'ig'
|
|
1735
|
+
| 'uz'
|
|
1736
|
+
| 'ne'
|
|
1737
|
+
| 'sd'
|
|
1738
|
+
| 'az'
|
|
1739
|
+
| 'si'
|
|
1740
|
+
| 'km'
|
|
1741
|
+
| 'kk'
|
|
1452
1742
|
| 'bn'
|
|
1453
1743
|
| 'bs'
|
|
1454
1744
|
| 'pt-BR'
|
|
@@ -1546,6 +1836,35 @@ export namespace ArticleSearchResponse {
|
|
|
1546
1836
|
* Published locales
|
|
1547
1837
|
*/
|
|
1548
1838
|
publishedLocales?: Array<
|
|
1839
|
+
| 'ar'
|
|
1840
|
+
| 'am'
|
|
1841
|
+
| 'fa'
|
|
1842
|
+
| 'ht'
|
|
1843
|
+
| 'lo'
|
|
1844
|
+
| 'my'
|
|
1845
|
+
| 'pa'
|
|
1846
|
+
| 'ps'
|
|
1847
|
+
| 'so'
|
|
1848
|
+
| 'tl'
|
|
1849
|
+
| 'ur'
|
|
1850
|
+
| 'he'
|
|
1851
|
+
| 'ta'
|
|
1852
|
+
| 'te'
|
|
1853
|
+
| 'mr'
|
|
1854
|
+
| 'gu'
|
|
1855
|
+
| 'kn'
|
|
1856
|
+
| 'ml'
|
|
1857
|
+
| 'ha'
|
|
1858
|
+
| 'jv'
|
|
1859
|
+
| 'yo'
|
|
1860
|
+
| 'ig'
|
|
1861
|
+
| 'uz'
|
|
1862
|
+
| 'ne'
|
|
1863
|
+
| 'sd'
|
|
1864
|
+
| 'az'
|
|
1865
|
+
| 'si'
|
|
1866
|
+
| 'km'
|
|
1867
|
+
| 'kk'
|
|
1549
1868
|
| 'bn'
|
|
1550
1869
|
| 'bs'
|
|
1551
1870
|
| 'pt-BR'
|
|
@@ -1633,6 +1952,12 @@ export namespace ArticleSearchResponse {
|
|
|
1633
1952
|
export interface Translations {
|
|
1634
1953
|
id?: ArticlesAPI.ArticleTranslation;
|
|
1635
1954
|
|
|
1955
|
+
am?: ArticlesAPI.ArticleTranslation;
|
|
1956
|
+
|
|
1957
|
+
ar?: ArticlesAPI.ArticleTranslation;
|
|
1958
|
+
|
|
1959
|
+
az?: ArticlesAPI.ArticleTranslation;
|
|
1960
|
+
|
|
1636
1961
|
bg?: ArticlesAPI.ArticleTranslation;
|
|
1637
1962
|
|
|
1638
1963
|
bn?: ArticlesAPI.ArticleTranslation;
|
|
@@ -1655,36 +1980,70 @@ export namespace ArticleSearchResponse {
|
|
|
1655
1980
|
|
|
1656
1981
|
et?: ArticlesAPI.ArticleTranslation;
|
|
1657
1982
|
|
|
1983
|
+
fa?: ArticlesAPI.ArticleTranslation;
|
|
1984
|
+
|
|
1658
1985
|
fi?: ArticlesAPI.ArticleTranslation;
|
|
1659
1986
|
|
|
1660
1987
|
fr?: ArticlesAPI.ArticleTranslation;
|
|
1661
1988
|
|
|
1989
|
+
gu?: ArticlesAPI.ArticleTranslation;
|
|
1990
|
+
|
|
1991
|
+
ha?: ArticlesAPI.ArticleTranslation;
|
|
1992
|
+
|
|
1993
|
+
he?: ArticlesAPI.ArticleTranslation;
|
|
1994
|
+
|
|
1662
1995
|
hi?: ArticlesAPI.ArticleTranslation;
|
|
1663
1996
|
|
|
1664
1997
|
hr?: ArticlesAPI.ArticleTranslation;
|
|
1665
1998
|
|
|
1999
|
+
ht?: ArticlesAPI.ArticleTranslation;
|
|
2000
|
+
|
|
1666
2001
|
hu?: ArticlesAPI.ArticleTranslation;
|
|
1667
2002
|
|
|
2003
|
+
ig?: ArticlesAPI.ArticleTranslation;
|
|
2004
|
+
|
|
1668
2005
|
it?: ArticlesAPI.ArticleTranslation;
|
|
1669
2006
|
|
|
1670
2007
|
ja?: ArticlesAPI.ArticleTranslation;
|
|
1671
2008
|
|
|
2009
|
+
jv?: ArticlesAPI.ArticleTranslation;
|
|
2010
|
+
|
|
2011
|
+
kk?: ArticlesAPI.ArticleTranslation;
|
|
2012
|
+
|
|
2013
|
+
km?: ArticlesAPI.ArticleTranslation;
|
|
2014
|
+
|
|
2015
|
+
kn?: ArticlesAPI.ArticleTranslation;
|
|
2016
|
+
|
|
1672
2017
|
ko?: ArticlesAPI.ArticleTranslation;
|
|
1673
2018
|
|
|
2019
|
+
lo?: ArticlesAPI.ArticleTranslation;
|
|
2020
|
+
|
|
1674
2021
|
lt?: ArticlesAPI.ArticleTranslation;
|
|
1675
2022
|
|
|
1676
2023
|
lv?: ArticlesAPI.ArticleTranslation;
|
|
1677
2024
|
|
|
2025
|
+
ml?: ArticlesAPI.ArticleTranslation;
|
|
2026
|
+
|
|
1678
2027
|
mn?: ArticlesAPI.ArticleTranslation;
|
|
1679
2028
|
|
|
2029
|
+
mr?: ArticlesAPI.ArticleTranslation;
|
|
2030
|
+
|
|
1680
2031
|
ms?: ArticlesAPI.ArticleTranslation;
|
|
1681
2032
|
|
|
2033
|
+
my?: ArticlesAPI.ArticleTranslation;
|
|
2034
|
+
|
|
1682
2035
|
nb?: ArticlesAPI.ArticleTranslation;
|
|
1683
2036
|
|
|
2037
|
+
ne?: ArticlesAPI.ArticleTranslation;
|
|
2038
|
+
|
|
1684
2039
|
nl?: ArticlesAPI.ArticleTranslation;
|
|
1685
2040
|
|
|
2041
|
+
pa?: ArticlesAPI.ArticleTranslation;
|
|
2042
|
+
|
|
1686
2043
|
pl?: ArticlesAPI.ArticleTranslation;
|
|
1687
2044
|
|
|
2045
|
+
ps?: ArticlesAPI.ArticleTranslation;
|
|
2046
|
+
|
|
1688
2047
|
pt?: ArticlesAPI.ArticleTranslation;
|
|
1689
2048
|
|
|
1690
2049
|
'pt-BR'?: ArticlesAPI.ArticleTranslation;
|
|
@@ -1693,24 +2052,42 @@ export namespace ArticleSearchResponse {
|
|
|
1693
2052
|
|
|
1694
2053
|
ru?: ArticlesAPI.ArticleTranslation;
|
|
1695
2054
|
|
|
2055
|
+
sd?: ArticlesAPI.ArticleTranslation;
|
|
2056
|
+
|
|
2057
|
+
si?: ArticlesAPI.ArticleTranslation;
|
|
2058
|
+
|
|
1696
2059
|
sk?: ArticlesAPI.ArticleTranslation;
|
|
1697
2060
|
|
|
1698
2061
|
sl?: ArticlesAPI.ArticleTranslation;
|
|
1699
2062
|
|
|
2063
|
+
so?: ArticlesAPI.ArticleTranslation;
|
|
2064
|
+
|
|
1700
2065
|
sr?: ArticlesAPI.ArticleTranslation;
|
|
1701
2066
|
|
|
1702
2067
|
sv?: ArticlesAPI.ArticleTranslation;
|
|
1703
2068
|
|
|
1704
2069
|
sw?: ArticlesAPI.ArticleTranslation;
|
|
1705
2070
|
|
|
2071
|
+
ta?: ArticlesAPI.ArticleTranslation;
|
|
2072
|
+
|
|
2073
|
+
te?: ArticlesAPI.ArticleTranslation;
|
|
2074
|
+
|
|
1706
2075
|
th?: ArticlesAPI.ArticleTranslation;
|
|
1707
2076
|
|
|
2077
|
+
tl?: ArticlesAPI.ArticleTranslation;
|
|
2078
|
+
|
|
1708
2079
|
tr?: ArticlesAPI.ArticleTranslation;
|
|
1709
2080
|
|
|
1710
2081
|
uk?: ArticlesAPI.ArticleTranslation;
|
|
1711
2082
|
|
|
2083
|
+
ur?: ArticlesAPI.ArticleTranslation;
|
|
2084
|
+
|
|
2085
|
+
uz?: ArticlesAPI.ArticleTranslation;
|
|
2086
|
+
|
|
1712
2087
|
vi?: ArticlesAPI.ArticleTranslation;
|
|
1713
2088
|
|
|
2089
|
+
yo?: ArticlesAPI.ArticleTranslation;
|
|
2090
|
+
|
|
1714
2091
|
'zh-CN'?: ArticlesAPI.ArticleTranslation;
|
|
1715
2092
|
|
|
1716
2093
|
'zh-TW'?: ArticlesAPI.ArticleTranslation;
|
|
@@ -1718,31 +2095,6 @@ export namespace ArticleSearchResponse {
|
|
|
1718
2095
|
}
|
|
1719
2096
|
}
|
|
1720
2097
|
|
|
1721
|
-
export interface ArticleListParams extends CursorPageParams {
|
|
1722
|
-
/**
|
|
1723
|
-
* Query param: Filter articles by help center ID. If omitted, returns articles
|
|
1724
|
-
* across all help centers.
|
|
1725
|
-
*/
|
|
1726
|
-
helpCenterId?: string;
|
|
1727
|
-
|
|
1728
|
-
/**
|
|
1729
|
-
* Query param: Filter articles by parent collection ID
|
|
1730
|
-
*/
|
|
1731
|
-
parentId?: string;
|
|
1732
|
-
|
|
1733
|
-
/**
|
|
1734
|
-
* Query param: Filter articles by state. Use "all" to get both draft and live
|
|
1735
|
-
* articles.
|
|
1736
|
-
*/
|
|
1737
|
-
state?: 'live' | 'draft' | 'all';
|
|
1738
|
-
|
|
1739
|
-
/**
|
|
1740
|
-
* Header param: API version for this request. Defaults to your organization's
|
|
1741
|
-
* configured API version if not specified.
|
|
1742
|
-
*/
|
|
1743
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1744
|
-
}
|
|
1745
|
-
|
|
1746
2098
|
export interface ArticleCreateParams {
|
|
1747
2099
|
/**
|
|
1748
2100
|
* Body param: The title of the article
|
|
@@ -1804,7 +2156,7 @@ export interface ArticleCreateParams {
|
|
|
1804
2156
|
* Header param: API version for this request. Defaults to your organization's
|
|
1805
2157
|
* configured API version if not specified.
|
|
1806
2158
|
*/
|
|
1807
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
2159
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1808
2160
|
}
|
|
1809
2161
|
|
|
1810
2162
|
export namespace ArticleCreateParams {
|
|
@@ -1814,6 +2166,12 @@ export namespace ArticleCreateParams {
|
|
|
1814
2166
|
export interface Translations {
|
|
1815
2167
|
id?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1816
2168
|
|
|
2169
|
+
am?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2170
|
+
|
|
2171
|
+
ar?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2172
|
+
|
|
2173
|
+
az?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2174
|
+
|
|
1817
2175
|
bg?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1818
2176
|
|
|
1819
2177
|
bn?: ArticlesAPI.ArticleTranslationInputNova;
|
|
@@ -1836,36 +2194,70 @@ export namespace ArticleCreateParams {
|
|
|
1836
2194
|
|
|
1837
2195
|
et?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1838
2196
|
|
|
2197
|
+
fa?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2198
|
+
|
|
1839
2199
|
fi?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1840
2200
|
|
|
1841
2201
|
fr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1842
2202
|
|
|
2203
|
+
gu?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2204
|
+
|
|
2205
|
+
ha?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2206
|
+
|
|
2207
|
+
he?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2208
|
+
|
|
1843
2209
|
hi?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1844
2210
|
|
|
1845
2211
|
hr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1846
2212
|
|
|
2213
|
+
ht?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2214
|
+
|
|
1847
2215
|
hu?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1848
2216
|
|
|
2217
|
+
ig?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2218
|
+
|
|
1849
2219
|
it?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1850
2220
|
|
|
1851
2221
|
ja?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1852
2222
|
|
|
2223
|
+
jv?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2224
|
+
|
|
2225
|
+
kk?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2226
|
+
|
|
2227
|
+
km?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2228
|
+
|
|
2229
|
+
kn?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2230
|
+
|
|
1853
2231
|
ko?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1854
2232
|
|
|
2233
|
+
lo?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2234
|
+
|
|
1855
2235
|
lt?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1856
2236
|
|
|
1857
2237
|
lv?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1858
2238
|
|
|
2239
|
+
ml?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2240
|
+
|
|
1859
2241
|
mn?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1860
2242
|
|
|
2243
|
+
mr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2244
|
+
|
|
1861
2245
|
ms?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1862
2246
|
|
|
2247
|
+
my?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2248
|
+
|
|
1863
2249
|
nb?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1864
2250
|
|
|
2251
|
+
ne?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2252
|
+
|
|
1865
2253
|
nl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1866
2254
|
|
|
2255
|
+
pa?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2256
|
+
|
|
1867
2257
|
pl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1868
2258
|
|
|
2259
|
+
ps?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2260
|
+
|
|
1869
2261
|
pt?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1870
2262
|
|
|
1871
2263
|
'pt-BR'?: ArticlesAPI.ArticleTranslationInputNova;
|
|
@@ -1874,24 +2266,42 @@ export namespace ArticleCreateParams {
|
|
|
1874
2266
|
|
|
1875
2267
|
ru?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1876
2268
|
|
|
2269
|
+
sd?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2270
|
+
|
|
2271
|
+
si?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2272
|
+
|
|
1877
2273
|
sk?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1878
2274
|
|
|
1879
2275
|
sl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1880
2276
|
|
|
2277
|
+
so?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2278
|
+
|
|
1881
2279
|
sr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1882
2280
|
|
|
1883
2281
|
sv?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1884
2282
|
|
|
1885
2283
|
sw?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1886
2284
|
|
|
2285
|
+
ta?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2286
|
+
|
|
2287
|
+
te?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2288
|
+
|
|
1887
2289
|
th?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1888
2290
|
|
|
2291
|
+
tl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2292
|
+
|
|
1889
2293
|
tr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1890
2294
|
|
|
1891
2295
|
uk?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1892
2296
|
|
|
2297
|
+
ur?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2298
|
+
|
|
2299
|
+
uz?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2300
|
+
|
|
1893
2301
|
vi?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1894
2302
|
|
|
2303
|
+
yo?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2304
|
+
|
|
1895
2305
|
'zh-CN'?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1896
2306
|
|
|
1897
2307
|
'zh-TW'?: ArticlesAPI.ArticleTranslationInputNova;
|
|
@@ -1908,7 +2318,7 @@ export interface ArticleRetrieveParams {
|
|
|
1908
2318
|
* Header param: API version for this request. Defaults to your organization's
|
|
1909
2319
|
* configured API version if not specified.
|
|
1910
2320
|
*/
|
|
1911
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
2321
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1912
2322
|
}
|
|
1913
2323
|
|
|
1914
2324
|
export interface ArticleUpdateParams {
|
|
@@ -1970,7 +2380,7 @@ export interface ArticleUpdateParams {
|
|
|
1970
2380
|
* Header param: API version for this request. Defaults to your organization's
|
|
1971
2381
|
* configured API version if not specified.
|
|
1972
2382
|
*/
|
|
1973
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
2383
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1974
2384
|
}
|
|
1975
2385
|
|
|
1976
2386
|
export namespace ArticleUpdateParams {
|
|
@@ -1980,6 +2390,12 @@ export namespace ArticleUpdateParams {
|
|
|
1980
2390
|
export interface Translations {
|
|
1981
2391
|
id?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1982
2392
|
|
|
2393
|
+
am?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2394
|
+
|
|
2395
|
+
ar?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2396
|
+
|
|
2397
|
+
az?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2398
|
+
|
|
1983
2399
|
bg?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1984
2400
|
|
|
1985
2401
|
bn?: ArticlesAPI.ArticleTranslationInputNova;
|
|
@@ -2002,36 +2418,70 @@ export namespace ArticleUpdateParams {
|
|
|
2002
2418
|
|
|
2003
2419
|
et?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2004
2420
|
|
|
2421
|
+
fa?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2422
|
+
|
|
2005
2423
|
fi?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2006
2424
|
|
|
2007
2425
|
fr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2008
2426
|
|
|
2427
|
+
gu?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2428
|
+
|
|
2429
|
+
ha?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2430
|
+
|
|
2431
|
+
he?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2432
|
+
|
|
2009
2433
|
hi?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2010
2434
|
|
|
2011
2435
|
hr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2012
2436
|
|
|
2437
|
+
ht?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2438
|
+
|
|
2013
2439
|
hu?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2014
2440
|
|
|
2441
|
+
ig?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2442
|
+
|
|
2015
2443
|
it?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2016
2444
|
|
|
2017
2445
|
ja?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2018
2446
|
|
|
2447
|
+
jv?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2448
|
+
|
|
2449
|
+
kk?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2450
|
+
|
|
2451
|
+
km?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2452
|
+
|
|
2453
|
+
kn?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2454
|
+
|
|
2019
2455
|
ko?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2020
2456
|
|
|
2457
|
+
lo?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2458
|
+
|
|
2021
2459
|
lt?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2022
2460
|
|
|
2023
2461
|
lv?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2024
2462
|
|
|
2463
|
+
ml?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2464
|
+
|
|
2025
2465
|
mn?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2026
2466
|
|
|
2467
|
+
mr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2468
|
+
|
|
2027
2469
|
ms?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2028
2470
|
|
|
2471
|
+
my?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2472
|
+
|
|
2029
2473
|
nb?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2030
2474
|
|
|
2475
|
+
ne?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2476
|
+
|
|
2031
2477
|
nl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2032
2478
|
|
|
2479
|
+
pa?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2480
|
+
|
|
2033
2481
|
pl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2034
2482
|
|
|
2483
|
+
ps?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2484
|
+
|
|
2035
2485
|
pt?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2036
2486
|
|
|
2037
2487
|
'pt-BR'?: ArticlesAPI.ArticleTranslationInputNova;
|
|
@@ -2040,36 +2490,79 @@ export namespace ArticleUpdateParams {
|
|
|
2040
2490
|
|
|
2041
2491
|
ru?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2042
2492
|
|
|
2493
|
+
sd?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2494
|
+
|
|
2495
|
+
si?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2496
|
+
|
|
2043
2497
|
sk?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2044
2498
|
|
|
2045
2499
|
sl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2046
2500
|
|
|
2501
|
+
so?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2502
|
+
|
|
2047
2503
|
sr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2048
2504
|
|
|
2049
2505
|
sv?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2050
2506
|
|
|
2051
2507
|
sw?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2052
2508
|
|
|
2509
|
+
ta?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2510
|
+
|
|
2511
|
+
te?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2512
|
+
|
|
2053
2513
|
th?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2054
2514
|
|
|
2515
|
+
tl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2516
|
+
|
|
2055
2517
|
tr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2056
2518
|
|
|
2057
2519
|
uk?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2058
2520
|
|
|
2521
|
+
ur?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2522
|
+
|
|
2523
|
+
uz?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2524
|
+
|
|
2059
2525
|
vi?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2060
2526
|
|
|
2527
|
+
yo?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2528
|
+
|
|
2061
2529
|
'zh-CN'?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2062
2530
|
|
|
2063
2531
|
'zh-TW'?: ArticlesAPI.ArticleTranslationInputNova;
|
|
2064
2532
|
}
|
|
2065
2533
|
}
|
|
2066
2534
|
|
|
2535
|
+
export interface ArticleListParams extends CursorPageParams {
|
|
2536
|
+
/**
|
|
2537
|
+
* Query param: Filter articles by help center ID. If omitted, returns articles
|
|
2538
|
+
* across all help centers.
|
|
2539
|
+
*/
|
|
2540
|
+
helpCenterId?: string;
|
|
2541
|
+
|
|
2542
|
+
/**
|
|
2543
|
+
* Query param: Filter articles by parent collection ID
|
|
2544
|
+
*/
|
|
2545
|
+
parentId?: string;
|
|
2546
|
+
|
|
2547
|
+
/**
|
|
2548
|
+
* Query param: Filter articles by state. Use "all" to get both draft and live
|
|
2549
|
+
* articles.
|
|
2550
|
+
*/
|
|
2551
|
+
state?: 'live' | 'draft' | 'all';
|
|
2552
|
+
|
|
2553
|
+
/**
|
|
2554
|
+
* Header param: API version for this request. Defaults to your organization's
|
|
2555
|
+
* configured API version if not specified.
|
|
2556
|
+
*/
|
|
2557
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
2558
|
+
}
|
|
2559
|
+
|
|
2067
2560
|
export interface ArticleDeleteParams {
|
|
2068
2561
|
/**
|
|
2069
2562
|
* API version for this request. Defaults to your organization's configured API
|
|
2070
2563
|
* version if not specified.
|
|
2071
2564
|
*/
|
|
2072
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
2565
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
2073
2566
|
}
|
|
2074
2567
|
|
|
2075
2568
|
export interface ArticleEditBodyParams {
|
|
@@ -2116,6 +2609,35 @@ export interface ArticleEditBodyParams {
|
|
|
2116
2609
|
* locale.
|
|
2117
2610
|
*/
|
|
2118
2611
|
locale?:
|
|
2612
|
+
| 'ar'
|
|
2613
|
+
| 'am'
|
|
2614
|
+
| 'fa'
|
|
2615
|
+
| 'ht'
|
|
2616
|
+
| 'lo'
|
|
2617
|
+
| 'my'
|
|
2618
|
+
| 'pa'
|
|
2619
|
+
| 'ps'
|
|
2620
|
+
| 'so'
|
|
2621
|
+
| 'tl'
|
|
2622
|
+
| 'ur'
|
|
2623
|
+
| 'he'
|
|
2624
|
+
| 'ta'
|
|
2625
|
+
| 'te'
|
|
2626
|
+
| 'mr'
|
|
2627
|
+
| 'gu'
|
|
2628
|
+
| 'kn'
|
|
2629
|
+
| 'ml'
|
|
2630
|
+
| 'ha'
|
|
2631
|
+
| 'jv'
|
|
2632
|
+
| 'yo'
|
|
2633
|
+
| 'ig'
|
|
2634
|
+
| 'uz'
|
|
2635
|
+
| 'ne'
|
|
2636
|
+
| 'sd'
|
|
2637
|
+
| 'az'
|
|
2638
|
+
| 'si'
|
|
2639
|
+
| 'km'
|
|
2640
|
+
| 'kk'
|
|
2119
2641
|
| 'bn'
|
|
2120
2642
|
| 'bs'
|
|
2121
2643
|
| 'pt-BR'
|
|
@@ -2178,7 +2700,7 @@ export interface ArticleEditBodyParams {
|
|
|
2178
2700
|
* Header param: API version for this request. Defaults to your organization's
|
|
2179
2701
|
* configured API version if not specified.
|
|
2180
2702
|
*/
|
|
2181
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
2703
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
2182
2704
|
}
|
|
2183
2705
|
|
|
2184
2706
|
export interface ArticleSearchParams {
|
|
@@ -2221,7 +2743,7 @@ export interface ArticleSearchParams {
|
|
|
2221
2743
|
* Header param: API version for this request. Defaults to your organization's
|
|
2222
2744
|
* configured API version if not specified.
|
|
2223
2745
|
*/
|
|
2224
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
2746
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
2225
2747
|
}
|
|
2226
2748
|
|
|
2227
2749
|
export declare namespace Articles {
|
|
@@ -2238,10 +2760,10 @@ export declare namespace Articles {
|
|
|
2238
2760
|
type ArticleDeleteResponse as ArticleDeleteResponse,
|
|
2239
2761
|
type ArticleSearchResponse as ArticleSearchResponse,
|
|
2240
2762
|
type ArticlesCursorPage as ArticlesCursorPage,
|
|
2241
|
-
type ArticleListParams as ArticleListParams,
|
|
2242
2763
|
type ArticleCreateParams as ArticleCreateParams,
|
|
2243
2764
|
type ArticleRetrieveParams as ArticleRetrieveParams,
|
|
2244
2765
|
type ArticleUpdateParams as ArticleUpdateParams,
|
|
2766
|
+
type ArticleListParams as ArticleListParams,
|
|
2245
2767
|
type ArticleDeleteParams as ArticleDeleteParams,
|
|
2246
2768
|
type ArticleEditBodyParams as ArticleEditBodyParams,
|
|
2247
2769
|
type ArticleSearchParams as ArticleSearchParams,
|