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
|
@@ -7,6 +7,42 @@ import { RequestOptions } from "../../internal/request-options.js";
|
|
|
7
7
|
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
8
8
|
*/
|
|
9
9
|
export declare class HelpCenters extends APIResource {
|
|
10
|
+
/**
|
|
11
|
+
* Retrieves a single help center by its unique identifier.
|
|
12
|
+
*
|
|
13
|
+
* Returns the help center object if found in your organization.
|
|
14
|
+
*
|
|
15
|
+
* ### Response
|
|
16
|
+
*
|
|
17
|
+
* Returns a help center object with:
|
|
18
|
+
*
|
|
19
|
+
* - `id` - Unique identifier
|
|
20
|
+
* - `displayName` - Help center display name
|
|
21
|
+
* - `title` - Help center title
|
|
22
|
+
* - `description` - Help center description
|
|
23
|
+
* - `searchPlaceholder` - Search input placeholder text
|
|
24
|
+
* - `isPublic` - Whether the help center is publicly accessible
|
|
25
|
+
* - `defaultLocale` - Default locale for content
|
|
26
|
+
* - `locale` - Current locale
|
|
27
|
+
* - `availableLocales` - Array of available locales
|
|
28
|
+
* - `navItems` - Navigation items configuration
|
|
29
|
+
* - `urls` - URL configuration (subpath, custom domain)
|
|
30
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
31
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
32
|
+
*
|
|
33
|
+
* ### Errors
|
|
34
|
+
*
|
|
35
|
+
* - `404` - Help center not found in your organization
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* const helpCenter =
|
|
40
|
+
* await client.helpCenter.helpCenters.retrieve(
|
|
41
|
+
* '2tgy0ig982j54qfl',
|
|
42
|
+
* );
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
retrieve(id: string, params?: HelpCenterRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<HelpCenter>;
|
|
10
46
|
/**
|
|
11
47
|
* Returns all help centers configured in your Featurebase organization.
|
|
12
48
|
*
|
|
@@ -51,42 +87,6 @@ export declare class HelpCenters extends APIResource {
|
|
|
51
87
|
* ```
|
|
52
88
|
*/
|
|
53
89
|
list(params?: HelpCenterListParams | null | undefined, options?: RequestOptions): PagePromise<HelpCentersCursorPage, HelpCenter>;
|
|
54
|
-
/**
|
|
55
|
-
* Retrieves a single help center by its unique identifier.
|
|
56
|
-
*
|
|
57
|
-
* Returns the help center object if found in your organization.
|
|
58
|
-
*
|
|
59
|
-
* ### Response
|
|
60
|
-
*
|
|
61
|
-
* Returns a help center object with:
|
|
62
|
-
*
|
|
63
|
-
* - `id` - Unique identifier
|
|
64
|
-
* - `displayName` - Help center display name
|
|
65
|
-
* - `title` - Help center title
|
|
66
|
-
* - `description` - Help center description
|
|
67
|
-
* - `searchPlaceholder` - Search input placeholder text
|
|
68
|
-
* - `isPublic` - Whether the help center is publicly accessible
|
|
69
|
-
* - `defaultLocale` - Default locale for content
|
|
70
|
-
* - `locale` - Current locale
|
|
71
|
-
* - `availableLocales` - Array of available locales
|
|
72
|
-
* - `navItems` - Navigation items configuration
|
|
73
|
-
* - `urls` - URL configuration (subpath, custom domain)
|
|
74
|
-
* - `createdAt` - ISO 8601 timestamp when created
|
|
75
|
-
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
76
|
-
*
|
|
77
|
-
* ### Errors
|
|
78
|
-
*
|
|
79
|
-
* - `404` - Help center not found in your organization
|
|
80
|
-
*
|
|
81
|
-
* @example
|
|
82
|
-
* ```ts
|
|
83
|
-
* const helpCenter =
|
|
84
|
-
* await client.helpCenter.helpCenters.retrieve(
|
|
85
|
-
* '2tgy0ig982j54qfl',
|
|
86
|
-
* );
|
|
87
|
-
* ```
|
|
88
|
-
*/
|
|
89
|
-
retrieve(id: string, params?: HelpCenterRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<HelpCenter>;
|
|
90
90
|
}
|
|
91
91
|
export type HelpCentersCursorPage = CursorPage<HelpCenter>;
|
|
92
92
|
export interface HelpCenter {
|
|
@@ -97,7 +97,7 @@ export interface HelpCenter {
|
|
|
97
97
|
/**
|
|
98
98
|
* Available locales
|
|
99
99
|
*/
|
|
100
|
-
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'>;
|
|
100
|
+
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'>;
|
|
101
101
|
/**
|
|
102
102
|
* ISO 8601 timestamp when created
|
|
103
103
|
*/
|
|
@@ -105,7 +105,7 @@ export interface HelpCenter {
|
|
|
105
105
|
/**
|
|
106
106
|
* Default locale for the help center
|
|
107
107
|
*/
|
|
108
|
-
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';
|
|
108
|
+
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';
|
|
109
109
|
/**
|
|
110
110
|
* Whether the help center is public
|
|
111
111
|
*/
|
|
@@ -113,7 +113,7 @@ export interface HelpCenter {
|
|
|
113
113
|
/**
|
|
114
114
|
* Current locale
|
|
115
115
|
*/
|
|
116
|
-
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';
|
|
116
|
+
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';
|
|
117
117
|
/**
|
|
118
118
|
* Object type identifier
|
|
119
119
|
*/
|
|
@@ -177,6 +177,9 @@ export declare namespace HelpCenter {
|
|
|
177
177
|
*/
|
|
178
178
|
interface Translations {
|
|
179
179
|
id?: HelpCentersAPI.HelpCenterTranslation;
|
|
180
|
+
am?: HelpCentersAPI.HelpCenterTranslation;
|
|
181
|
+
ar?: HelpCentersAPI.HelpCenterTranslation;
|
|
182
|
+
az?: HelpCentersAPI.HelpCenterTranslation;
|
|
180
183
|
bg?: HelpCentersAPI.HelpCenterTranslation;
|
|
181
184
|
bn?: HelpCentersAPI.HelpCenterTranslation;
|
|
182
185
|
bs?: HelpCentersAPI.HelpCenterTranslation;
|
|
@@ -188,34 +191,60 @@ export declare namespace HelpCenter {
|
|
|
188
191
|
en?: HelpCentersAPI.HelpCenterTranslation;
|
|
189
192
|
es?: HelpCentersAPI.HelpCenterTranslation;
|
|
190
193
|
et?: HelpCentersAPI.HelpCenterTranslation;
|
|
194
|
+
fa?: HelpCentersAPI.HelpCenterTranslation;
|
|
191
195
|
fi?: HelpCentersAPI.HelpCenterTranslation;
|
|
192
196
|
fr?: HelpCentersAPI.HelpCenterTranslation;
|
|
197
|
+
gu?: HelpCentersAPI.HelpCenterTranslation;
|
|
198
|
+
ha?: HelpCentersAPI.HelpCenterTranslation;
|
|
199
|
+
he?: HelpCentersAPI.HelpCenterTranslation;
|
|
193
200
|
hi?: HelpCentersAPI.HelpCenterTranslation;
|
|
194
201
|
hr?: HelpCentersAPI.HelpCenterTranslation;
|
|
202
|
+
ht?: HelpCentersAPI.HelpCenterTranslation;
|
|
195
203
|
hu?: HelpCentersAPI.HelpCenterTranslation;
|
|
204
|
+
ig?: HelpCentersAPI.HelpCenterTranslation;
|
|
196
205
|
it?: HelpCentersAPI.HelpCenterTranslation;
|
|
197
206
|
ja?: HelpCentersAPI.HelpCenterTranslation;
|
|
207
|
+
jv?: HelpCentersAPI.HelpCenterTranslation;
|
|
208
|
+
kk?: HelpCentersAPI.HelpCenterTranslation;
|
|
209
|
+
km?: HelpCentersAPI.HelpCenterTranslation;
|
|
210
|
+
kn?: HelpCentersAPI.HelpCenterTranslation;
|
|
198
211
|
ko?: HelpCentersAPI.HelpCenterTranslation;
|
|
212
|
+
lo?: HelpCentersAPI.HelpCenterTranslation;
|
|
199
213
|
lt?: HelpCentersAPI.HelpCenterTranslation;
|
|
200
214
|
lv?: HelpCentersAPI.HelpCenterTranslation;
|
|
215
|
+
ml?: HelpCentersAPI.HelpCenterTranslation;
|
|
201
216
|
mn?: HelpCentersAPI.HelpCenterTranslation;
|
|
217
|
+
mr?: HelpCentersAPI.HelpCenterTranslation;
|
|
202
218
|
ms?: HelpCentersAPI.HelpCenterTranslation;
|
|
219
|
+
my?: HelpCentersAPI.HelpCenterTranslation;
|
|
203
220
|
nb?: HelpCentersAPI.HelpCenterTranslation;
|
|
221
|
+
ne?: HelpCentersAPI.HelpCenterTranslation;
|
|
204
222
|
nl?: HelpCentersAPI.HelpCenterTranslation;
|
|
223
|
+
pa?: HelpCentersAPI.HelpCenterTranslation;
|
|
205
224
|
pl?: HelpCentersAPI.HelpCenterTranslation;
|
|
225
|
+
ps?: HelpCentersAPI.HelpCenterTranslation;
|
|
206
226
|
pt?: HelpCentersAPI.HelpCenterTranslation;
|
|
207
227
|
'pt-BR'?: HelpCentersAPI.HelpCenterTranslation;
|
|
208
228
|
ro?: HelpCentersAPI.HelpCenterTranslation;
|
|
209
229
|
ru?: HelpCentersAPI.HelpCenterTranslation;
|
|
230
|
+
sd?: HelpCentersAPI.HelpCenterTranslation;
|
|
231
|
+
si?: HelpCentersAPI.HelpCenterTranslation;
|
|
210
232
|
sk?: HelpCentersAPI.HelpCenterTranslation;
|
|
211
233
|
sl?: HelpCentersAPI.HelpCenterTranslation;
|
|
234
|
+
so?: HelpCentersAPI.HelpCenterTranslation;
|
|
212
235
|
sr?: HelpCentersAPI.HelpCenterTranslation;
|
|
213
236
|
sv?: HelpCentersAPI.HelpCenterTranslation;
|
|
214
237
|
sw?: HelpCentersAPI.HelpCenterTranslation;
|
|
238
|
+
ta?: HelpCentersAPI.HelpCenterTranslation;
|
|
239
|
+
te?: HelpCentersAPI.HelpCenterTranslation;
|
|
215
240
|
th?: HelpCentersAPI.HelpCenterTranslation;
|
|
241
|
+
tl?: HelpCentersAPI.HelpCenterTranslation;
|
|
216
242
|
tr?: HelpCentersAPI.HelpCenterTranslation;
|
|
217
243
|
uk?: HelpCentersAPI.HelpCenterTranslation;
|
|
244
|
+
ur?: HelpCentersAPI.HelpCenterTranslation;
|
|
245
|
+
uz?: HelpCentersAPI.HelpCenterTranslation;
|
|
218
246
|
vi?: HelpCentersAPI.HelpCenterTranslation;
|
|
247
|
+
yo?: HelpCentersAPI.HelpCenterTranslation;
|
|
219
248
|
'zh-CN'?: HelpCentersAPI.HelpCenterTranslation;
|
|
220
249
|
'zh-TW'?: HelpCentersAPI.HelpCenterTranslation;
|
|
221
250
|
}
|
|
@@ -273,21 +302,21 @@ export interface HelpCenterTranslation {
|
|
|
273
302
|
*/
|
|
274
303
|
title?: string;
|
|
275
304
|
}
|
|
276
|
-
export interface HelpCenterListParams extends CursorPageParams {
|
|
277
|
-
/**
|
|
278
|
-
* Header param: API version for this request. Defaults to your organization's
|
|
279
|
-
* configured API version if not specified.
|
|
280
|
-
*/
|
|
281
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
282
|
-
}
|
|
283
305
|
export interface HelpCenterRetrieveParams {
|
|
284
306
|
/**
|
|
285
307
|
* API version for this request. Defaults to your organization's configured API
|
|
286
308
|
* version if not specified.
|
|
287
309
|
*/
|
|
288
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
310
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
311
|
+
}
|
|
312
|
+
export interface HelpCenterListParams extends CursorPageParams {
|
|
313
|
+
/**
|
|
314
|
+
* Header param: API version for this request. Defaults to your organization's
|
|
315
|
+
* configured API version if not specified.
|
|
316
|
+
*/
|
|
317
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
289
318
|
}
|
|
290
319
|
export declare namespace HelpCenters {
|
|
291
|
-
export { type HelpCenter as HelpCenter, type HelpCenterNavItem as HelpCenterNavItem, type HelpCenterTranslation as HelpCenterTranslation, type HelpCentersCursorPage as HelpCentersCursorPage, type
|
|
320
|
+
export { type HelpCenter as HelpCenter, type HelpCenterNavItem as HelpCenterNavItem, type HelpCenterTranslation as HelpCenterTranslation, type HelpCentersCursorPage as HelpCentersCursorPage, type HelpCenterRetrieveParams as HelpCenterRetrieveParams, type HelpCenterListParams as HelpCenterListParams, };
|
|
292
321
|
}
|
|
293
322
|
//# sourceMappingURL=help-centers.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-centers.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,cAAc,0BAAuB;AACjD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,iCAA8B;AAEvF,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"help-centers.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,cAAc,0BAAuB;AACjD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,iCAA8B;AAEvF,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC;IAezB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CACF,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,UAAU,CAAC;CAelD;AAED,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;AAE3D,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,KAAK,CACnB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CACP,CAAC;IAEF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,EACT,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,EACF,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC;CACxB;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,YAAY;QAC3B,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE/C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,EAAE,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE1C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;QAE/C,OAAO,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;KAChD;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAExB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -11,52 +11,43 @@ const path_1 = require("../../internal/utils/path.js");
|
|
|
11
11
|
*/
|
|
12
12
|
class HelpCenters extends resource_1.APIResource {
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* Currently, Featurebase only supports one help center per organization, but we
|
|
17
|
-
* plan on supporting multiple help centers in the future.
|
|
18
|
-
*
|
|
19
|
-
* ### Query Parameters
|
|
20
|
-
*
|
|
21
|
-
* - `limit` - Number of items to return (1-100, default 10)
|
|
22
|
-
* - `cursor` - Cursor for pagination
|
|
23
|
-
*
|
|
24
|
-
* ### Response Format
|
|
25
|
-
*
|
|
26
|
-
* Returns a list object with:
|
|
14
|
+
* Retrieves a single help center by its unique identifier.
|
|
27
15
|
*
|
|
28
|
-
*
|
|
29
|
-
* - `data` - Array of help center objects
|
|
30
|
-
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
16
|
+
* Returns the help center object if found in your organization.
|
|
31
17
|
*
|
|
32
|
-
* ###
|
|
18
|
+
* ### Response
|
|
33
19
|
*
|
|
34
|
-
*
|
|
20
|
+
* Returns a help center object with:
|
|
35
21
|
*
|
|
36
22
|
* - `id` - Unique identifier
|
|
37
23
|
* - `displayName` - Help center display name
|
|
38
24
|
* - `title` - Help center title
|
|
39
25
|
* - `description` - Help center description
|
|
26
|
+
* - `searchPlaceholder` - Search input placeholder text
|
|
40
27
|
* - `isPublic` - Whether the help center is publicly accessible
|
|
41
28
|
* - `defaultLocale` - Default locale for content
|
|
29
|
+
* - `locale` - Current locale
|
|
42
30
|
* - `availableLocales` - Array of available locales
|
|
43
31
|
* - `navItems` - Navigation items configuration
|
|
44
32
|
* - `urls` - URL configuration (subpath, custom domain)
|
|
45
33
|
* - `createdAt` - ISO 8601 timestamp when created
|
|
46
34
|
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
47
35
|
*
|
|
36
|
+
* ### Errors
|
|
37
|
+
*
|
|
38
|
+
* - `404` - Help center not found in your organization
|
|
39
|
+
*
|
|
48
40
|
* @example
|
|
49
41
|
* ```ts
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
42
|
+
* const helpCenter =
|
|
43
|
+
* await client.helpCenter.helpCenters.retrieve(
|
|
44
|
+
* '2tgy0ig982j54qfl',
|
|
45
|
+
* );
|
|
54
46
|
* ```
|
|
55
47
|
*/
|
|
56
|
-
|
|
57
|
-
const { 'Featurebase-Version': featurebaseVersion
|
|
58
|
-
return this._client.
|
|
59
|
-
query,
|
|
48
|
+
retrieve(id, params = {}, options) {
|
|
49
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
50
|
+
return this._client.get((0, path_1.path) `/v2/help_center/help_centers/${id}`, {
|
|
60
51
|
...options,
|
|
61
52
|
headers: (0, headers_1.buildHeaders)([
|
|
62
53
|
{
|
|
@@ -69,43 +60,52 @@ class HelpCenters extends resource_1.APIResource {
|
|
|
69
60
|
});
|
|
70
61
|
}
|
|
71
62
|
/**
|
|
72
|
-
*
|
|
63
|
+
* Returns all help centers configured in your Featurebase organization.
|
|
73
64
|
*
|
|
74
|
-
*
|
|
65
|
+
* Currently, Featurebase only supports one help center per organization, but we
|
|
66
|
+
* plan on supporting multiple help centers in the future.
|
|
75
67
|
*
|
|
76
|
-
* ###
|
|
68
|
+
* ### Query Parameters
|
|
77
69
|
*
|
|
78
|
-
*
|
|
70
|
+
* - `limit` - Number of items to return (1-100, default 10)
|
|
71
|
+
* - `cursor` - Cursor for pagination
|
|
72
|
+
*
|
|
73
|
+
* ### Response Format
|
|
74
|
+
*
|
|
75
|
+
* Returns a list object with:
|
|
76
|
+
*
|
|
77
|
+
* - `object` - Always "list"
|
|
78
|
+
* - `data` - Array of help center objects
|
|
79
|
+
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
80
|
+
*
|
|
81
|
+
* ### Help Center Object
|
|
82
|
+
*
|
|
83
|
+
* Each help center includes:
|
|
79
84
|
*
|
|
80
85
|
* - `id` - Unique identifier
|
|
81
86
|
* - `displayName` - Help center display name
|
|
82
87
|
* - `title` - Help center title
|
|
83
88
|
* - `description` - Help center description
|
|
84
|
-
* - `searchPlaceholder` - Search input placeholder text
|
|
85
89
|
* - `isPublic` - Whether the help center is publicly accessible
|
|
86
90
|
* - `defaultLocale` - Default locale for content
|
|
87
|
-
* - `locale` - Current locale
|
|
88
91
|
* - `availableLocales` - Array of available locales
|
|
89
92
|
* - `navItems` - Navigation items configuration
|
|
90
93
|
* - `urls` - URL configuration (subpath, custom domain)
|
|
91
94
|
* - `createdAt` - ISO 8601 timestamp when created
|
|
92
95
|
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
93
96
|
*
|
|
94
|
-
* ### Errors
|
|
95
|
-
*
|
|
96
|
-
* - `404` - Help center not found in your organization
|
|
97
|
-
*
|
|
98
97
|
* @example
|
|
99
98
|
* ```ts
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
99
|
+
* // Automatically fetches more pages as needed.
|
|
100
|
+
* for await (const helpCenter of client.helpCenter.helpCenters.list()) {
|
|
101
|
+
* // ...
|
|
102
|
+
* }
|
|
104
103
|
* ```
|
|
105
104
|
*/
|
|
106
|
-
|
|
107
|
-
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
108
|
-
return this._client.
|
|
105
|
+
list(params = {}, options) {
|
|
106
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
107
|
+
return this._client.getAPIList('/v2/help_center/help_centers', (pagination_1.CursorPage), {
|
|
108
|
+
query,
|
|
109
109
|
...options,
|
|
110
110
|
headers: (0, headers_1.buildHeaders)([
|
|
111
111
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-centers.js","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,yDAAuF;AACvF,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"help-centers.js","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,yDAAuF;AACvF,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gCAAgC,EAAE,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,8BAA8B,EAAE,CAAA,uBAAsB,CAAA,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AApHD,kCAoHC"}
|
|
@@ -8,52 +8,43 @@ import { path } from "../../internal/utils/path.mjs";
|
|
|
8
8
|
*/
|
|
9
9
|
export class HelpCenters extends APIResource {
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* Currently, Featurebase only supports one help center per organization, but we
|
|
14
|
-
* plan on supporting multiple help centers in the future.
|
|
15
|
-
*
|
|
16
|
-
* ### Query Parameters
|
|
17
|
-
*
|
|
18
|
-
* - `limit` - Number of items to return (1-100, default 10)
|
|
19
|
-
* - `cursor` - Cursor for pagination
|
|
20
|
-
*
|
|
21
|
-
* ### Response Format
|
|
22
|
-
*
|
|
23
|
-
* Returns a list object with:
|
|
11
|
+
* Retrieves a single help center by its unique identifier.
|
|
24
12
|
*
|
|
25
|
-
*
|
|
26
|
-
* - `data` - Array of help center objects
|
|
27
|
-
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
13
|
+
* Returns the help center object if found in your organization.
|
|
28
14
|
*
|
|
29
|
-
* ###
|
|
15
|
+
* ### Response
|
|
30
16
|
*
|
|
31
|
-
*
|
|
17
|
+
* Returns a help center object with:
|
|
32
18
|
*
|
|
33
19
|
* - `id` - Unique identifier
|
|
34
20
|
* - `displayName` - Help center display name
|
|
35
21
|
* - `title` - Help center title
|
|
36
22
|
* - `description` - Help center description
|
|
23
|
+
* - `searchPlaceholder` - Search input placeholder text
|
|
37
24
|
* - `isPublic` - Whether the help center is publicly accessible
|
|
38
25
|
* - `defaultLocale` - Default locale for content
|
|
26
|
+
* - `locale` - Current locale
|
|
39
27
|
* - `availableLocales` - Array of available locales
|
|
40
28
|
* - `navItems` - Navigation items configuration
|
|
41
29
|
* - `urls` - URL configuration (subpath, custom domain)
|
|
42
30
|
* - `createdAt` - ISO 8601 timestamp when created
|
|
43
31
|
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
44
32
|
*
|
|
33
|
+
* ### Errors
|
|
34
|
+
*
|
|
35
|
+
* - `404` - Help center not found in your organization
|
|
36
|
+
*
|
|
45
37
|
* @example
|
|
46
38
|
* ```ts
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
39
|
+
* const helpCenter =
|
|
40
|
+
* await client.helpCenter.helpCenters.retrieve(
|
|
41
|
+
* '2tgy0ig982j54qfl',
|
|
42
|
+
* );
|
|
51
43
|
* ```
|
|
52
44
|
*/
|
|
53
|
-
|
|
54
|
-
const { 'Featurebase-Version': featurebaseVersion
|
|
55
|
-
return this._client.
|
|
56
|
-
query,
|
|
45
|
+
retrieve(id, params = {}, options) {
|
|
46
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
47
|
+
return this._client.get(path `/v2/help_center/help_centers/${id}`, {
|
|
57
48
|
...options,
|
|
58
49
|
headers: buildHeaders([
|
|
59
50
|
{
|
|
@@ -66,43 +57,52 @@ export class HelpCenters extends APIResource {
|
|
|
66
57
|
});
|
|
67
58
|
}
|
|
68
59
|
/**
|
|
69
|
-
*
|
|
60
|
+
* Returns all help centers configured in your Featurebase organization.
|
|
70
61
|
*
|
|
71
|
-
*
|
|
62
|
+
* Currently, Featurebase only supports one help center per organization, but we
|
|
63
|
+
* plan on supporting multiple help centers in the future.
|
|
72
64
|
*
|
|
73
|
-
* ###
|
|
65
|
+
* ### Query Parameters
|
|
74
66
|
*
|
|
75
|
-
*
|
|
67
|
+
* - `limit` - Number of items to return (1-100, default 10)
|
|
68
|
+
* - `cursor` - Cursor for pagination
|
|
69
|
+
*
|
|
70
|
+
* ### Response Format
|
|
71
|
+
*
|
|
72
|
+
* Returns a list object with:
|
|
73
|
+
*
|
|
74
|
+
* - `object` - Always "list"
|
|
75
|
+
* - `data` - Array of help center objects
|
|
76
|
+
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
77
|
+
*
|
|
78
|
+
* ### Help Center Object
|
|
79
|
+
*
|
|
80
|
+
* Each help center includes:
|
|
76
81
|
*
|
|
77
82
|
* - `id` - Unique identifier
|
|
78
83
|
* - `displayName` - Help center display name
|
|
79
84
|
* - `title` - Help center title
|
|
80
85
|
* - `description` - Help center description
|
|
81
|
-
* - `searchPlaceholder` - Search input placeholder text
|
|
82
86
|
* - `isPublic` - Whether the help center is publicly accessible
|
|
83
87
|
* - `defaultLocale` - Default locale for content
|
|
84
|
-
* - `locale` - Current locale
|
|
85
88
|
* - `availableLocales` - Array of available locales
|
|
86
89
|
* - `navItems` - Navigation items configuration
|
|
87
90
|
* - `urls` - URL configuration (subpath, custom domain)
|
|
88
91
|
* - `createdAt` - ISO 8601 timestamp when created
|
|
89
92
|
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
90
93
|
*
|
|
91
|
-
* ### Errors
|
|
92
|
-
*
|
|
93
|
-
* - `404` - Help center not found in your organization
|
|
94
|
-
*
|
|
95
94
|
* @example
|
|
96
95
|
* ```ts
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
96
|
+
* // Automatically fetches more pages as needed.
|
|
97
|
+
* for await (const helpCenter of client.helpCenter.helpCenters.list()) {
|
|
98
|
+
* // ...
|
|
99
|
+
* }
|
|
101
100
|
* ```
|
|
102
101
|
*/
|
|
103
|
-
|
|
104
|
-
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
105
|
-
return this._client.
|
|
102
|
+
list(params = {}, options) {
|
|
103
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
104
|
+
return this._client.getAPIList('/v2/help_center/help_centers', (CursorPage), {
|
|
105
|
+
query,
|
|
106
106
|
...options,
|
|
107
107
|
headers: buildHeaders([
|
|
108
108
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-centers.mjs","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,UAAU,EAAsC,kCAA8B;AACvF,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"help-centers.mjs","sourceRoot":"","sources":["../../src/resources/help-center/help-centers.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,UAAU,EAAsC,kCAA8B;AACvF,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,QAAQ,CACN,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gCAAgC,EAAE,EAAE,EAAE;YAChE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,8BAA8B,EAAE,CAAA,UAAsB,CAAA,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export { Articles, type Article, type ArticleAuthor, type ArticleIcon, type ArticleIconInputNova, type ArticleTranslation, type ArticleTranslationInputNova, type EditArticleBodyBody, type EditArticleBodyPreview, type EditArticleBodyResponse, type ArticleDeleteResponse, type ArticleSearchResponse, type
|
|
2
|
-
export { Collections, type Collection, type CollectionIconNova, type CollectionTranslation, type CollectionTranslationInputNova, type CollectionDeleteResponse, type
|
|
1
|
+
export { Articles, type Article, type ArticleAuthor, type ArticleIcon, type ArticleIconInputNova, type ArticleTranslation, type ArticleTranslationInputNova, type EditArticleBodyBody, type EditArticleBodyPreview, type EditArticleBodyResponse, type ArticleDeleteResponse, type ArticleSearchResponse, type ArticleCreateParams, type ArticleRetrieveParams, type ArticleUpdateParams, type ArticleListParams, type ArticleDeleteParams, type ArticleEditBodyParams, type ArticleSearchParams, type ArticlesCursorPage, } from "./articles.mjs";
|
|
2
|
+
export { Collections, type Collection, type CollectionIconNova, type CollectionTranslation, type CollectionTranslationInputNova, type CollectionDeleteResponse, type CollectionCreateParams, type CollectionRetrieveParams, type CollectionUpdateParams, type CollectionListParams, type CollectionDeleteParams, type CollectionsCursorPage, } from "./collections.mjs";
|
|
3
3
|
export { HelpCenter } from "./help-center.mjs";
|
|
4
|
-
export { HelpCenters, type HelpCenterNavItem, type HelpCenterTranslation, type
|
|
5
|
-
export { RedirectRules, type RedirectRule, type RedirectRuleDeleteResponse, type
|
|
4
|
+
export { HelpCenters, type HelpCenterNavItem, type HelpCenterTranslation, type HelpCenterRetrieveParams, type HelpCenterListParams, type HelpCentersCursorPage, } from "./help-centers.mjs";
|
|
5
|
+
export { RedirectRules, type RedirectRule, type RedirectRuleDeleteResponse, type RedirectRuleCreateParams, type RedirectRuleRetrieveParams, type RedirectRuleUpdateParams, type RedirectRuleListParams, type RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams, type RedirectRulesCursorPage, } from "./redirect-rules.mjs";
|
|
6
6
|
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,GACxB,uBAAmB;AACpB,OAAO,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,GAC3B,0BAAsB;AACvB,OAAO,EAAE,UAAU,EAAE,0BAAsB;AAC3C,OAAO,EACL,WAAW,EACX,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,GAC3B,2BAAuB;AACxB,OAAO,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,+BAA+B,EACpC,KAAK,uBAAuB,GAC7B,6BAAyB"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export { Articles, type Article, type ArticleAuthor, type ArticleIcon, type ArticleIconInputNova, type ArticleTranslation, type ArticleTranslationInputNova, type EditArticleBodyBody, type EditArticleBodyPreview, type EditArticleBodyResponse, type ArticleDeleteResponse, type ArticleSearchResponse, type
|
|
2
|
-
export { Collections, type Collection, type CollectionIconNova, type CollectionTranslation, type CollectionTranslationInputNova, type CollectionDeleteResponse, type
|
|
1
|
+
export { Articles, type Article, type ArticleAuthor, type ArticleIcon, type ArticleIconInputNova, type ArticleTranslation, type ArticleTranslationInputNova, type EditArticleBodyBody, type EditArticleBodyPreview, type EditArticleBodyResponse, type ArticleDeleteResponse, type ArticleSearchResponse, type ArticleCreateParams, type ArticleRetrieveParams, type ArticleUpdateParams, type ArticleListParams, type ArticleDeleteParams, type ArticleEditBodyParams, type ArticleSearchParams, type ArticlesCursorPage, } from "./articles.js";
|
|
2
|
+
export { Collections, type Collection, type CollectionIconNova, type CollectionTranslation, type CollectionTranslationInputNova, type CollectionDeleteResponse, type CollectionCreateParams, type CollectionRetrieveParams, type CollectionUpdateParams, type CollectionListParams, type CollectionDeleteParams, type CollectionsCursorPage, } from "./collections.js";
|
|
3
3
|
export { HelpCenter } from "./help-center.js";
|
|
4
|
-
export { HelpCenters, type HelpCenterNavItem, type HelpCenterTranslation, type
|
|
5
|
-
export { RedirectRules, type RedirectRule, type RedirectRuleDeleteResponse, type
|
|
4
|
+
export { HelpCenters, type HelpCenterNavItem, type HelpCenterTranslation, type HelpCenterRetrieveParams, type HelpCenterListParams, type HelpCentersCursorPage, } from "./help-centers.js";
|
|
5
|
+
export { RedirectRules, type RedirectRule, type RedirectRuleDeleteResponse, type RedirectRuleCreateParams, type RedirectRuleRetrieveParams, type RedirectRuleUpdateParams, type RedirectRuleListParams, type RedirectRuleDeleteParams, type RedirectRuleRetrieveByURLParams, type RedirectRulesCursorPage, } from "./redirect-rules.js";
|
|
6
6
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/help-center/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,GACxB,sBAAmB;AACpB,OAAO,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,GAC3B,yBAAsB;AACvB,OAAO,EAAE,UAAU,EAAE,yBAAsB;AAC3C,OAAO,EACL,WAAW,EACX,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,GAC3B,0BAAuB;AACxB,OAAO,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,+BAA+B,EACpC,KAAK,uBAAuB,GAC7B,4BAAyB"}
|