featurebase-node 0.14.3 → 0.15.1
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 +11 -5
- package/client.d.mts.map +1 -1
- package/client.d.ts +11 -5
- package/client.d.ts.map +1 -1
- package/client.js +6 -0
- package/client.js.map +1 -1
- package/client.mjs +6 -0
- package/client.mjs.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 +22 -17
- package/resources/conversation-attributes.d.mts.map +1 -1
- package/resources/conversation-attributes.d.ts +22 -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 +6 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +6 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.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 +339 -223
- package/resources/reports.d.mts.map +1 -1
- package/resources/reports.d.ts +339 -223
- package/resources/reports.d.ts.map +1 -1
- package/resources/reports.js +114 -107
- package/resources/reports.js.map +1 -1
- package/resources/reports.mjs +114 -107
- 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 +363 -332
- package/resources/support/conversations/conversations.d.mts.map +1 -1
- package/resources/support/conversations/conversations.d.ts +363 -332
- 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/training-data/files.d.mts +292 -0
- package/resources/training-data/files.d.mts.map +1 -0
- package/resources/training-data/files.d.ts +292 -0
- package/resources/training-data/files.d.ts.map +1 -0
- package/resources/training-data/files.js +171 -0
- package/resources/training-data/files.js.map +1 -0
- package/resources/training-data/files.mjs +167 -0
- package/resources/training-data/files.mjs.map +1 -0
- package/resources/training-data/index.d.mts +4 -0
- package/resources/training-data/index.d.mts.map +1 -0
- package/resources/training-data/index.d.ts +4 -0
- package/resources/training-data/index.d.ts.map +1 -0
- package/resources/training-data/index.js +11 -0
- package/resources/training-data/index.js.map +1 -0
- package/resources/training-data/index.mjs +5 -0
- package/resources/training-data/index.mjs.map +1 -0
- package/resources/training-data/qna.d.mts +370 -0
- package/resources/training-data/qna.d.mts.map +1 -0
- package/resources/training-data/qna.d.ts +370 -0
- package/resources/training-data/qna.d.ts.map +1 -0
- package/resources/training-data/qna.js +177 -0
- package/resources/training-data/qna.js.map +1 -0
- package/resources/training-data/qna.mjs +173 -0
- package/resources/training-data/qna.mjs.map +1 -0
- package/resources/training-data/training-data.d.mts +442 -0
- package/resources/training-data/training-data.d.mts.map +1 -0
- package/resources/training-data/training-data.d.ts +442 -0
- package/resources/training-data/training-data.d.ts.map +1 -0
- package/resources/training-data/training-data.js +105 -0
- package/resources/training-data/training-data.js.map +1 -0
- package/resources/training-data/training-data.mjs +100 -0
- package/resources/training-data/training-data.mjs.map +1 -0
- package/resources/training-data.d.mts +2 -0
- package/resources/training-data.d.mts.map +1 -0
- package/resources/training-data.d.ts +2 -0
- package/resources/training-data.d.ts.map +1 -0
- package/resources/training-data.js +6 -0
- package/resources/training-data.js.map +1 -0
- package/resources/training-data.mjs +3 -0
- package/resources/training-data.mjs.map +1 -0
- 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 +26 -6
- package/src/resources/audit-logs.ts +19 -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 +40 -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 +13 -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 +462 -272
- package/src/resources/support/conversation-tags.ts +62 -62
- package/src/resources/support/conversations/conversations.ts +453 -417
- 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/training-data/files.ts +431 -0
- package/src/resources/training-data/index.ts +31 -0
- package/src/resources/training-data/qna.ts +514 -0
- package/src/resources/training-data/training-data.ts +603 -0
- package/src/resources/training-data.ts +3 -0
- 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
|
@@ -8,65 +8,6 @@ import { RequestOptions } from "../../internal/request-options.mjs";
|
|
|
8
8
|
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
9
9
|
*/
|
|
10
10
|
export declare class Articles extends APIResource {
|
|
11
|
-
/**
|
|
12
|
-
* Returns a paginated list of articles within your organization's help center.
|
|
13
|
-
*
|
|
14
|
-
* Articles are the main content pieces that contain documentation, guides, and
|
|
15
|
-
* FAQs.
|
|
16
|
-
*
|
|
17
|
-
* ### Query Parameters
|
|
18
|
-
*
|
|
19
|
-
* - `limit` - Number of items to return (1-100, default 10)
|
|
20
|
-
* - `cursor` - Cursor for pagination
|
|
21
|
-
* - `state` - Filter by article state: "live", "draft", or "all" (default "live")
|
|
22
|
-
* - `parentId` - Filter by parent collection ID
|
|
23
|
-
*
|
|
24
|
-
* ### Response Format
|
|
25
|
-
*
|
|
26
|
-
* Returns a list object with:
|
|
27
|
-
*
|
|
28
|
-
* - `object` - Always "list"
|
|
29
|
-
* - `data` - Array of article objects
|
|
30
|
-
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
31
|
-
*
|
|
32
|
-
* ### Article Object
|
|
33
|
-
*
|
|
34
|
-
* Each article includes:
|
|
35
|
-
*
|
|
36
|
-
* - `id` - Unique identifier
|
|
37
|
-
* - `title` - Article title
|
|
38
|
-
* - `description` - Article description
|
|
39
|
-
* - `body` - Article content (HTML)
|
|
40
|
-
* - `slug` - URL slug
|
|
41
|
-
* - `icon` - Article icon (emoji or custom)
|
|
42
|
-
* - `parentId` - Parent collection ID
|
|
43
|
-
* - `helpCenterId` - ID of the help center this article belongs to
|
|
44
|
-
* - `organization` - Organization ID
|
|
45
|
-
* - `state` - Article state (live or draft)
|
|
46
|
-
* - `defaultLocale` - Default locale for content
|
|
47
|
-
* - `locale` - Current locale
|
|
48
|
-
* - `availableLocales` - Array of available locales
|
|
49
|
-
* - `publishedLocales` - Array of locales where article is published
|
|
50
|
-
* - `featurebaseUrl` - Featurebase URL for the article
|
|
51
|
-
* - `externalUrl` - External URL if custom domain is configured
|
|
52
|
-
* - `author` - Author information (name, authorId, avatarUrl)
|
|
53
|
-
* - `order` - Display order
|
|
54
|
-
* - `isPublished` - Whether the article is published
|
|
55
|
-
* - `isDraftDiffersFromLive` - Whether draft differs from live version
|
|
56
|
-
* - `translations` - Translations for different locales
|
|
57
|
-
* - `createdAt` - ISO 8601 timestamp when created
|
|
58
|
-
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
59
|
-
* - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated
|
|
60
|
-
*
|
|
61
|
-
* @example
|
|
62
|
-
* ```ts
|
|
63
|
-
* // Automatically fetches more pages as needed.
|
|
64
|
-
* for await (const article of client.helpCenter.articles.list()) {
|
|
65
|
-
* // ...
|
|
66
|
-
* }
|
|
67
|
-
* ```
|
|
68
|
-
*/
|
|
69
|
-
list(params?: ArticleListParams | null | undefined, options?: RequestOptions): PagePromise<ArticlesCursorPage, Article>;
|
|
70
11
|
/**
|
|
71
12
|
* Creates a new article in your organization's help center.
|
|
72
13
|
*
|
|
@@ -227,6 +168,65 @@ export declare class Articles extends APIResource {
|
|
|
227
168
|
* ```
|
|
228
169
|
*/
|
|
229
170
|
update(id: string, params: ArticleUpdateParams, options?: RequestOptions): APIPromise<Article>;
|
|
171
|
+
/**
|
|
172
|
+
* Returns a paginated list of articles within your organization's help center.
|
|
173
|
+
*
|
|
174
|
+
* Articles are the main content pieces that contain documentation, guides, and
|
|
175
|
+
* FAQs.
|
|
176
|
+
*
|
|
177
|
+
* ### Query Parameters
|
|
178
|
+
*
|
|
179
|
+
* - `limit` - Number of items to return (1-100, default 10)
|
|
180
|
+
* - `cursor` - Cursor for pagination
|
|
181
|
+
* - `state` - Filter by article state: "live", "draft", or "all" (default "live")
|
|
182
|
+
* - `parentId` - Filter by parent collection ID
|
|
183
|
+
*
|
|
184
|
+
* ### Response Format
|
|
185
|
+
*
|
|
186
|
+
* Returns a list object with:
|
|
187
|
+
*
|
|
188
|
+
* - `object` - Always "list"
|
|
189
|
+
* - `data` - Array of article objects
|
|
190
|
+
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
191
|
+
*
|
|
192
|
+
* ### Article Object
|
|
193
|
+
*
|
|
194
|
+
* Each article includes:
|
|
195
|
+
*
|
|
196
|
+
* - `id` - Unique identifier
|
|
197
|
+
* - `title` - Article title
|
|
198
|
+
* - `description` - Article description
|
|
199
|
+
* - `body` - Article content (HTML)
|
|
200
|
+
* - `slug` - URL slug
|
|
201
|
+
* - `icon` - Article icon (emoji or custom)
|
|
202
|
+
* - `parentId` - Parent collection ID
|
|
203
|
+
* - `helpCenterId` - ID of the help center this article belongs to
|
|
204
|
+
* - `organization` - Organization ID
|
|
205
|
+
* - `state` - Article state (live or draft)
|
|
206
|
+
* - `defaultLocale` - Default locale for content
|
|
207
|
+
* - `locale` - Current locale
|
|
208
|
+
* - `availableLocales` - Array of available locales
|
|
209
|
+
* - `publishedLocales` - Array of locales where article is published
|
|
210
|
+
* - `featurebaseUrl` - Featurebase URL for the article
|
|
211
|
+
* - `externalUrl` - External URL if custom domain is configured
|
|
212
|
+
* - `author` - Author information (name, authorId, avatarUrl)
|
|
213
|
+
* - `order` - Display order
|
|
214
|
+
* - `isPublished` - Whether the article is published
|
|
215
|
+
* - `isDraftDiffersFromLive` - Whether draft differs from live version
|
|
216
|
+
* - `translations` - Translations for different locales
|
|
217
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
218
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
219
|
+
* - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated
|
|
220
|
+
*
|
|
221
|
+
* @example
|
|
222
|
+
* ```ts
|
|
223
|
+
* // Automatically fetches more pages as needed.
|
|
224
|
+
* for await (const article of client.helpCenter.articles.list()) {
|
|
225
|
+
* // ...
|
|
226
|
+
* }
|
|
227
|
+
* ```
|
|
228
|
+
*/
|
|
229
|
+
list(params?: ArticleListParams | null | undefined, options?: RequestOptions): PagePromise<ArticlesCursorPage, Article>;
|
|
230
230
|
/**
|
|
231
231
|
* Deletes an existing article.
|
|
232
232
|
*
|
|
@@ -444,7 +444,7 @@ export interface Article {
|
|
|
444
444
|
/**
|
|
445
445
|
* Available locales
|
|
446
446
|
*/
|
|
447
|
-
availableLocales: Array<'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi'>;
|
|
447
|
+
availableLocales: Array<'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi'>;
|
|
448
448
|
/**
|
|
449
449
|
* ISO 8601 timestamp when created
|
|
450
450
|
*/
|
|
@@ -456,7 +456,7 @@ export interface Article {
|
|
|
456
456
|
/**
|
|
457
457
|
* Current locale
|
|
458
458
|
*/
|
|
459
|
-
locale: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
459
|
+
locale: 'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
460
460
|
/**
|
|
461
461
|
* Object type identifier
|
|
462
462
|
*/
|
|
@@ -484,7 +484,7 @@ export interface Article {
|
|
|
484
484
|
/**
|
|
485
485
|
* Default locale
|
|
486
486
|
*/
|
|
487
|
-
defaultLocale?: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
487
|
+
defaultLocale?: 'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
488
488
|
/**
|
|
489
489
|
* Article description
|
|
490
490
|
*/
|
|
@@ -528,7 +528,7 @@ export interface Article {
|
|
|
528
528
|
/**
|
|
529
529
|
* Published locales
|
|
530
530
|
*/
|
|
531
|
-
publishedLocales?: Array<'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi'>;
|
|
531
|
+
publishedLocales?: Array<'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi'>;
|
|
532
532
|
/**
|
|
533
533
|
* URL slug
|
|
534
534
|
*/
|
|
@@ -564,6 +564,9 @@ export declare namespace Article {
|
|
|
564
564
|
*/
|
|
565
565
|
interface Translations {
|
|
566
566
|
id?: ArticlesAPI.ArticleTranslation;
|
|
567
|
+
am?: ArticlesAPI.ArticleTranslation;
|
|
568
|
+
ar?: ArticlesAPI.ArticleTranslation;
|
|
569
|
+
az?: ArticlesAPI.ArticleTranslation;
|
|
567
570
|
bg?: ArticlesAPI.ArticleTranslation;
|
|
568
571
|
bn?: ArticlesAPI.ArticleTranslation;
|
|
569
572
|
bs?: ArticlesAPI.ArticleTranslation;
|
|
@@ -575,34 +578,60 @@ export declare namespace Article {
|
|
|
575
578
|
en?: ArticlesAPI.ArticleTranslation;
|
|
576
579
|
es?: ArticlesAPI.ArticleTranslation;
|
|
577
580
|
et?: ArticlesAPI.ArticleTranslation;
|
|
581
|
+
fa?: ArticlesAPI.ArticleTranslation;
|
|
578
582
|
fi?: ArticlesAPI.ArticleTranslation;
|
|
579
583
|
fr?: ArticlesAPI.ArticleTranslation;
|
|
584
|
+
gu?: ArticlesAPI.ArticleTranslation;
|
|
585
|
+
ha?: ArticlesAPI.ArticleTranslation;
|
|
586
|
+
he?: ArticlesAPI.ArticleTranslation;
|
|
580
587
|
hi?: ArticlesAPI.ArticleTranslation;
|
|
581
588
|
hr?: ArticlesAPI.ArticleTranslation;
|
|
589
|
+
ht?: ArticlesAPI.ArticleTranslation;
|
|
582
590
|
hu?: ArticlesAPI.ArticleTranslation;
|
|
591
|
+
ig?: ArticlesAPI.ArticleTranslation;
|
|
583
592
|
it?: ArticlesAPI.ArticleTranslation;
|
|
584
593
|
ja?: ArticlesAPI.ArticleTranslation;
|
|
594
|
+
jv?: ArticlesAPI.ArticleTranslation;
|
|
595
|
+
kk?: ArticlesAPI.ArticleTranslation;
|
|
596
|
+
km?: ArticlesAPI.ArticleTranslation;
|
|
597
|
+
kn?: ArticlesAPI.ArticleTranslation;
|
|
585
598
|
ko?: ArticlesAPI.ArticleTranslation;
|
|
599
|
+
lo?: ArticlesAPI.ArticleTranslation;
|
|
586
600
|
lt?: ArticlesAPI.ArticleTranslation;
|
|
587
601
|
lv?: ArticlesAPI.ArticleTranslation;
|
|
602
|
+
ml?: ArticlesAPI.ArticleTranslation;
|
|
588
603
|
mn?: ArticlesAPI.ArticleTranslation;
|
|
604
|
+
mr?: ArticlesAPI.ArticleTranslation;
|
|
589
605
|
ms?: ArticlesAPI.ArticleTranslation;
|
|
606
|
+
my?: ArticlesAPI.ArticleTranslation;
|
|
590
607
|
nb?: ArticlesAPI.ArticleTranslation;
|
|
608
|
+
ne?: ArticlesAPI.ArticleTranslation;
|
|
591
609
|
nl?: ArticlesAPI.ArticleTranslation;
|
|
610
|
+
pa?: ArticlesAPI.ArticleTranslation;
|
|
592
611
|
pl?: ArticlesAPI.ArticleTranslation;
|
|
612
|
+
ps?: ArticlesAPI.ArticleTranslation;
|
|
593
613
|
pt?: ArticlesAPI.ArticleTranslation;
|
|
594
614
|
'pt-BR'?: ArticlesAPI.ArticleTranslation;
|
|
595
615
|
ro?: ArticlesAPI.ArticleTranslation;
|
|
596
616
|
ru?: ArticlesAPI.ArticleTranslation;
|
|
617
|
+
sd?: ArticlesAPI.ArticleTranslation;
|
|
618
|
+
si?: ArticlesAPI.ArticleTranslation;
|
|
597
619
|
sk?: ArticlesAPI.ArticleTranslation;
|
|
598
620
|
sl?: ArticlesAPI.ArticleTranslation;
|
|
621
|
+
so?: ArticlesAPI.ArticleTranslation;
|
|
599
622
|
sr?: ArticlesAPI.ArticleTranslation;
|
|
600
623
|
sv?: ArticlesAPI.ArticleTranslation;
|
|
601
624
|
sw?: ArticlesAPI.ArticleTranslation;
|
|
625
|
+
ta?: ArticlesAPI.ArticleTranslation;
|
|
626
|
+
te?: ArticlesAPI.ArticleTranslation;
|
|
602
627
|
th?: ArticlesAPI.ArticleTranslation;
|
|
628
|
+
tl?: ArticlesAPI.ArticleTranslation;
|
|
603
629
|
tr?: ArticlesAPI.ArticleTranslation;
|
|
604
630
|
uk?: ArticlesAPI.ArticleTranslation;
|
|
631
|
+
ur?: ArticlesAPI.ArticleTranslation;
|
|
632
|
+
uz?: ArticlesAPI.ArticleTranslation;
|
|
605
633
|
vi?: ArticlesAPI.ArticleTranslation;
|
|
634
|
+
yo?: ArticlesAPI.ArticleTranslation;
|
|
606
635
|
'zh-CN'?: ArticlesAPI.ArticleTranslation;
|
|
607
636
|
'zh-TW'?: ArticlesAPI.ArticleTranslation;
|
|
608
637
|
}
|
|
@@ -742,7 +771,7 @@ export interface EditArticleBodyBody {
|
|
|
742
771
|
/**
|
|
743
772
|
* Locale of the body to edit. Defaults to the help center's default locale.
|
|
744
773
|
*/
|
|
745
|
-
locale?: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
774
|
+
locale?: 'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
746
775
|
/**
|
|
747
776
|
* Replace every match. When omitted (or false) and `expectedReplacements` is not
|
|
748
777
|
* set, the edit requires exactly one match and returns `400` if `oldText` is
|
|
@@ -858,7 +887,7 @@ export declare namespace ArticleSearchResponse {
|
|
|
858
887
|
/**
|
|
859
888
|
* Available locales
|
|
860
889
|
*/
|
|
861
|
-
availableLocales: Array<'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi'>;
|
|
890
|
+
availableLocales: Array<'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi'>;
|
|
862
891
|
/**
|
|
863
892
|
* ISO 8601 timestamp when created
|
|
864
893
|
*/
|
|
@@ -870,7 +899,7 @@ export declare namespace ArticleSearchResponse {
|
|
|
870
899
|
/**
|
|
871
900
|
* Current locale
|
|
872
901
|
*/
|
|
873
|
-
locale: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
902
|
+
locale: 'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
874
903
|
/**
|
|
875
904
|
* Object type identifier
|
|
876
905
|
*/
|
|
@@ -898,7 +927,7 @@ export declare namespace ArticleSearchResponse {
|
|
|
898
927
|
/**
|
|
899
928
|
* Default locale
|
|
900
929
|
*/
|
|
901
|
-
defaultLocale?: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
930
|
+
defaultLocale?: 'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
902
931
|
/**
|
|
903
932
|
* Article description
|
|
904
933
|
*/
|
|
@@ -942,7 +971,7 @@ export declare namespace ArticleSearchResponse {
|
|
|
942
971
|
/**
|
|
943
972
|
* Published locales
|
|
944
973
|
*/
|
|
945
|
-
publishedLocales?: Array<'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi'>;
|
|
974
|
+
publishedLocales?: Array<'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi'>;
|
|
946
975
|
/**
|
|
947
976
|
* URL slug
|
|
948
977
|
*/
|
|
@@ -978,6 +1007,9 @@ export declare namespace ArticleSearchResponse {
|
|
|
978
1007
|
*/
|
|
979
1008
|
interface Translations {
|
|
980
1009
|
id?: ArticlesAPI.ArticleTranslation;
|
|
1010
|
+
am?: ArticlesAPI.ArticleTranslation;
|
|
1011
|
+
ar?: ArticlesAPI.ArticleTranslation;
|
|
1012
|
+
az?: ArticlesAPI.ArticleTranslation;
|
|
981
1013
|
bg?: ArticlesAPI.ArticleTranslation;
|
|
982
1014
|
bn?: ArticlesAPI.ArticleTranslation;
|
|
983
1015
|
bs?: ArticlesAPI.ArticleTranslation;
|
|
@@ -989,60 +1021,65 @@ export declare namespace ArticleSearchResponse {
|
|
|
989
1021
|
en?: ArticlesAPI.ArticleTranslation;
|
|
990
1022
|
es?: ArticlesAPI.ArticleTranslation;
|
|
991
1023
|
et?: ArticlesAPI.ArticleTranslation;
|
|
1024
|
+
fa?: ArticlesAPI.ArticleTranslation;
|
|
992
1025
|
fi?: ArticlesAPI.ArticleTranslation;
|
|
993
1026
|
fr?: ArticlesAPI.ArticleTranslation;
|
|
1027
|
+
gu?: ArticlesAPI.ArticleTranslation;
|
|
1028
|
+
ha?: ArticlesAPI.ArticleTranslation;
|
|
1029
|
+
he?: ArticlesAPI.ArticleTranslation;
|
|
994
1030
|
hi?: ArticlesAPI.ArticleTranslation;
|
|
995
1031
|
hr?: ArticlesAPI.ArticleTranslation;
|
|
1032
|
+
ht?: ArticlesAPI.ArticleTranslation;
|
|
996
1033
|
hu?: ArticlesAPI.ArticleTranslation;
|
|
1034
|
+
ig?: ArticlesAPI.ArticleTranslation;
|
|
997
1035
|
it?: ArticlesAPI.ArticleTranslation;
|
|
998
1036
|
ja?: ArticlesAPI.ArticleTranslation;
|
|
1037
|
+
jv?: ArticlesAPI.ArticleTranslation;
|
|
1038
|
+
kk?: ArticlesAPI.ArticleTranslation;
|
|
1039
|
+
km?: ArticlesAPI.ArticleTranslation;
|
|
1040
|
+
kn?: ArticlesAPI.ArticleTranslation;
|
|
999
1041
|
ko?: ArticlesAPI.ArticleTranslation;
|
|
1042
|
+
lo?: ArticlesAPI.ArticleTranslation;
|
|
1000
1043
|
lt?: ArticlesAPI.ArticleTranslation;
|
|
1001
1044
|
lv?: ArticlesAPI.ArticleTranslation;
|
|
1045
|
+
ml?: ArticlesAPI.ArticleTranslation;
|
|
1002
1046
|
mn?: ArticlesAPI.ArticleTranslation;
|
|
1047
|
+
mr?: ArticlesAPI.ArticleTranslation;
|
|
1003
1048
|
ms?: ArticlesAPI.ArticleTranslation;
|
|
1049
|
+
my?: ArticlesAPI.ArticleTranslation;
|
|
1004
1050
|
nb?: ArticlesAPI.ArticleTranslation;
|
|
1051
|
+
ne?: ArticlesAPI.ArticleTranslation;
|
|
1005
1052
|
nl?: ArticlesAPI.ArticleTranslation;
|
|
1053
|
+
pa?: ArticlesAPI.ArticleTranslation;
|
|
1006
1054
|
pl?: ArticlesAPI.ArticleTranslation;
|
|
1055
|
+
ps?: ArticlesAPI.ArticleTranslation;
|
|
1007
1056
|
pt?: ArticlesAPI.ArticleTranslation;
|
|
1008
1057
|
'pt-BR'?: ArticlesAPI.ArticleTranslation;
|
|
1009
1058
|
ro?: ArticlesAPI.ArticleTranslation;
|
|
1010
1059
|
ru?: ArticlesAPI.ArticleTranslation;
|
|
1060
|
+
sd?: ArticlesAPI.ArticleTranslation;
|
|
1061
|
+
si?: ArticlesAPI.ArticleTranslation;
|
|
1011
1062
|
sk?: ArticlesAPI.ArticleTranslation;
|
|
1012
1063
|
sl?: ArticlesAPI.ArticleTranslation;
|
|
1064
|
+
so?: ArticlesAPI.ArticleTranslation;
|
|
1013
1065
|
sr?: ArticlesAPI.ArticleTranslation;
|
|
1014
1066
|
sv?: ArticlesAPI.ArticleTranslation;
|
|
1015
1067
|
sw?: ArticlesAPI.ArticleTranslation;
|
|
1068
|
+
ta?: ArticlesAPI.ArticleTranslation;
|
|
1069
|
+
te?: ArticlesAPI.ArticleTranslation;
|
|
1016
1070
|
th?: ArticlesAPI.ArticleTranslation;
|
|
1071
|
+
tl?: ArticlesAPI.ArticleTranslation;
|
|
1017
1072
|
tr?: ArticlesAPI.ArticleTranslation;
|
|
1018
1073
|
uk?: ArticlesAPI.ArticleTranslation;
|
|
1074
|
+
ur?: ArticlesAPI.ArticleTranslation;
|
|
1075
|
+
uz?: ArticlesAPI.ArticleTranslation;
|
|
1019
1076
|
vi?: ArticlesAPI.ArticleTranslation;
|
|
1077
|
+
yo?: ArticlesAPI.ArticleTranslation;
|
|
1020
1078
|
'zh-CN'?: ArticlesAPI.ArticleTranslation;
|
|
1021
1079
|
'zh-TW'?: ArticlesAPI.ArticleTranslation;
|
|
1022
1080
|
}
|
|
1023
1081
|
}
|
|
1024
1082
|
}
|
|
1025
|
-
export interface ArticleListParams extends CursorPageParams {
|
|
1026
|
-
/**
|
|
1027
|
-
* Query param: Filter articles by help center ID. If omitted, returns articles
|
|
1028
|
-
* across all help centers.
|
|
1029
|
-
*/
|
|
1030
|
-
helpCenterId?: string;
|
|
1031
|
-
/**
|
|
1032
|
-
* Query param: Filter articles by parent collection ID
|
|
1033
|
-
*/
|
|
1034
|
-
parentId?: string;
|
|
1035
|
-
/**
|
|
1036
|
-
* Query param: Filter articles by state. Use "all" to get both draft and live
|
|
1037
|
-
* articles.
|
|
1038
|
-
*/
|
|
1039
|
-
state?: 'live' | 'draft' | 'all';
|
|
1040
|
-
/**
|
|
1041
|
-
* Header param: API version for this request. Defaults to your organization's
|
|
1042
|
-
* configured API version if not specified.
|
|
1043
|
-
*/
|
|
1044
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1045
|
-
}
|
|
1046
1083
|
export interface ArticleCreateParams {
|
|
1047
1084
|
/**
|
|
1048
1085
|
* Body param: The title of the article
|
|
@@ -1095,7 +1132,7 @@ export interface ArticleCreateParams {
|
|
|
1095
1132
|
* Header param: API version for this request. Defaults to your organization's
|
|
1096
1133
|
* configured API version if not specified.
|
|
1097
1134
|
*/
|
|
1098
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1135
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1099
1136
|
}
|
|
1100
1137
|
export declare namespace ArticleCreateParams {
|
|
1101
1138
|
/**
|
|
@@ -1103,6 +1140,9 @@ export declare namespace ArticleCreateParams {
|
|
|
1103
1140
|
*/
|
|
1104
1141
|
interface Translations {
|
|
1105
1142
|
id?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1143
|
+
am?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1144
|
+
ar?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1145
|
+
az?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1106
1146
|
bg?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1107
1147
|
bn?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1108
1148
|
bs?: ArticlesAPI.ArticleTranslationInputNova;
|
|
@@ -1114,34 +1154,60 @@ export declare namespace ArticleCreateParams {
|
|
|
1114
1154
|
en?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1115
1155
|
es?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1116
1156
|
et?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1157
|
+
fa?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1117
1158
|
fi?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1118
1159
|
fr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1160
|
+
gu?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1161
|
+
ha?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1162
|
+
he?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1119
1163
|
hi?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1120
1164
|
hr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1165
|
+
ht?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1121
1166
|
hu?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1167
|
+
ig?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1122
1168
|
it?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1123
1169
|
ja?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1170
|
+
jv?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1171
|
+
kk?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1172
|
+
km?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1173
|
+
kn?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1124
1174
|
ko?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1175
|
+
lo?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1125
1176
|
lt?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1126
1177
|
lv?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1178
|
+
ml?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1127
1179
|
mn?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1180
|
+
mr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1128
1181
|
ms?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1182
|
+
my?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1129
1183
|
nb?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1184
|
+
ne?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1130
1185
|
nl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1186
|
+
pa?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1131
1187
|
pl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1188
|
+
ps?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1132
1189
|
pt?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1133
1190
|
'pt-BR'?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1134
1191
|
ro?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1135
1192
|
ru?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1193
|
+
sd?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1194
|
+
si?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1136
1195
|
sk?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1137
1196
|
sl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1197
|
+
so?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1138
1198
|
sr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1139
1199
|
sv?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1140
1200
|
sw?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1201
|
+
ta?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1202
|
+
te?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1141
1203
|
th?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1204
|
+
tl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1142
1205
|
tr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1143
1206
|
uk?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1207
|
+
ur?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1208
|
+
uz?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1144
1209
|
vi?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1210
|
+
yo?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1145
1211
|
'zh-CN'?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1146
1212
|
'zh-TW'?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1147
1213
|
}
|
|
@@ -1155,7 +1221,7 @@ export interface ArticleRetrieveParams {
|
|
|
1155
1221
|
* Header param: API version for this request. Defaults to your organization's
|
|
1156
1222
|
* configured API version if not specified.
|
|
1157
1223
|
*/
|
|
1158
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1224
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1159
1225
|
}
|
|
1160
1226
|
export interface ArticleUpdateParams {
|
|
1161
1227
|
/**
|
|
@@ -1207,7 +1273,7 @@ export interface ArticleUpdateParams {
|
|
|
1207
1273
|
* Header param: API version for this request. Defaults to your organization's
|
|
1208
1274
|
* configured API version if not specified.
|
|
1209
1275
|
*/
|
|
1210
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1276
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1211
1277
|
}
|
|
1212
1278
|
export declare namespace ArticleUpdateParams {
|
|
1213
1279
|
/**
|
|
@@ -1215,6 +1281,9 @@ export declare namespace ArticleUpdateParams {
|
|
|
1215
1281
|
*/
|
|
1216
1282
|
interface Translations {
|
|
1217
1283
|
id?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1284
|
+
am?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1285
|
+
ar?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1286
|
+
az?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1218
1287
|
bg?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1219
1288
|
bn?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1220
1289
|
bs?: ArticlesAPI.ArticleTranslationInputNova;
|
|
@@ -1226,44 +1295,91 @@ export declare namespace ArticleUpdateParams {
|
|
|
1226
1295
|
en?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1227
1296
|
es?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1228
1297
|
et?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1298
|
+
fa?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1229
1299
|
fi?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1230
1300
|
fr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1301
|
+
gu?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1302
|
+
ha?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1303
|
+
he?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1231
1304
|
hi?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1232
1305
|
hr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1306
|
+
ht?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1233
1307
|
hu?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1308
|
+
ig?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1234
1309
|
it?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1235
1310
|
ja?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1311
|
+
jv?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1312
|
+
kk?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1313
|
+
km?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1314
|
+
kn?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1236
1315
|
ko?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1316
|
+
lo?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1237
1317
|
lt?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1238
1318
|
lv?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1319
|
+
ml?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1239
1320
|
mn?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1321
|
+
mr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1240
1322
|
ms?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1323
|
+
my?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1241
1324
|
nb?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1325
|
+
ne?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1242
1326
|
nl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1327
|
+
pa?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1243
1328
|
pl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1329
|
+
ps?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1244
1330
|
pt?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1245
1331
|
'pt-BR'?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1246
1332
|
ro?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1247
1333
|
ru?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1334
|
+
sd?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1335
|
+
si?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1248
1336
|
sk?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1249
1337
|
sl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1338
|
+
so?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1250
1339
|
sr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1251
1340
|
sv?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1252
1341
|
sw?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1342
|
+
ta?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1343
|
+
te?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1253
1344
|
th?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1345
|
+
tl?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1254
1346
|
tr?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1255
1347
|
uk?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1348
|
+
ur?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1349
|
+
uz?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1256
1350
|
vi?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1351
|
+
yo?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1257
1352
|
'zh-CN'?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1258
1353
|
'zh-TW'?: ArticlesAPI.ArticleTranslationInputNova;
|
|
1259
1354
|
}
|
|
1260
1355
|
}
|
|
1356
|
+
export interface ArticleListParams extends CursorPageParams {
|
|
1357
|
+
/**
|
|
1358
|
+
* Query param: Filter articles by help center ID. If omitted, returns articles
|
|
1359
|
+
* across all help centers.
|
|
1360
|
+
*/
|
|
1361
|
+
helpCenterId?: string;
|
|
1362
|
+
/**
|
|
1363
|
+
* Query param: Filter articles by parent collection ID
|
|
1364
|
+
*/
|
|
1365
|
+
parentId?: string;
|
|
1366
|
+
/**
|
|
1367
|
+
* Query param: Filter articles by state. Use "all" to get both draft and live
|
|
1368
|
+
* articles.
|
|
1369
|
+
*/
|
|
1370
|
+
state?: 'live' | 'draft' | 'all';
|
|
1371
|
+
/**
|
|
1372
|
+
* Header param: API version for this request. Defaults to your organization's
|
|
1373
|
+
* configured API version if not specified.
|
|
1374
|
+
*/
|
|
1375
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1376
|
+
}
|
|
1261
1377
|
export interface ArticleDeleteParams {
|
|
1262
1378
|
/**
|
|
1263
1379
|
* API version for this request. Defaults to your organization's configured API
|
|
1264
1380
|
* version if not specified.
|
|
1265
1381
|
*/
|
|
1266
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1382
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1267
1383
|
}
|
|
1268
1384
|
export interface ArticleEditBodyParams {
|
|
1269
1385
|
/**
|
|
@@ -1304,7 +1420,7 @@ export interface ArticleEditBodyParams {
|
|
|
1304
1420
|
* Body param: Locale of the body to edit. Defaults to the help center's default
|
|
1305
1421
|
* locale.
|
|
1306
1422
|
*/
|
|
1307
|
-
locale?: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
1423
|
+
locale?: 'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
1308
1424
|
/**
|
|
1309
1425
|
* Body param: Replace every match. When omitted (or false) and
|
|
1310
1426
|
* `expectedReplacements` is not set, the edit requires exactly one match and
|
|
@@ -1322,7 +1438,7 @@ export interface ArticleEditBodyParams {
|
|
|
1322
1438
|
* Header param: API version for this request. Defaults to your organization's
|
|
1323
1439
|
* configured API version if not specified.
|
|
1324
1440
|
*/
|
|
1325
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1441
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1326
1442
|
}
|
|
1327
1443
|
export interface ArticleSearchParams {
|
|
1328
1444
|
/**
|
|
@@ -1359,9 +1475,9 @@ export interface ArticleSearchParams {
|
|
|
1359
1475
|
* Header param: API version for this request. Defaults to your organization's
|
|
1360
1476
|
* configured API version if not specified.
|
|
1361
1477
|
*/
|
|
1362
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1478
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1363
1479
|
}
|
|
1364
1480
|
export declare namespace Articles {
|
|
1365
|
-
export { type Article as Article, type ArticleAuthor as ArticleAuthor, type ArticleIcon as ArticleIcon, type ArticleIconInputNova as ArticleIconInputNova, type ArticleTranslation as ArticleTranslation, type ArticleTranslationInputNova as ArticleTranslationInputNova, type EditArticleBodyBody as EditArticleBodyBody, type EditArticleBodyPreview as EditArticleBodyPreview, type EditArticleBodyResponse as EditArticleBodyResponse, type ArticleDeleteResponse as ArticleDeleteResponse, type ArticleSearchResponse as ArticleSearchResponse, type ArticlesCursorPage as ArticlesCursorPage, type
|
|
1481
|
+
export { type Article as Article, type ArticleAuthor as ArticleAuthor, type ArticleIcon as ArticleIcon, type ArticleIconInputNova as ArticleIconInputNova, type ArticleTranslation as ArticleTranslation, type ArticleTranslationInputNova as ArticleTranslationInputNova, type EditArticleBodyBody as EditArticleBodyBody, type EditArticleBodyPreview as EditArticleBodyPreview, type EditArticleBodyResponse as EditArticleBodyResponse, type ArticleDeleteResponse as ArticleDeleteResponse, type ArticleSearchResponse as ArticleSearchResponse, type ArticlesCursorPage as ArticlesCursorPage, type ArticleCreateParams as ArticleCreateParams, type ArticleRetrieveParams as ArticleRetrieveParams, type ArticleUpdateParams as ArticleUpdateParams, type ArticleListParams as ArticleListParams, type ArticleDeleteParams as ArticleDeleteParams, type ArticleEditBodyParams as ArticleEditBodyParams, type ArticleSearchParams as ArticleSearchParams, };
|
|
1366
1482
|
}
|
|
1367
1483
|
//# sourceMappingURL=articles.d.mts.map
|