featurebase-node 0.14.3 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/client.d.mts +5 -5
- package/client.d.mts.map +1 -1
- package/client.d.ts +5 -5
- package/client.d.ts.map +1 -1
- package/package.json +1 -1
- package/resources/audit-logs.d.mts +3 -3
- package/resources/audit-logs.d.mts.map +1 -1
- package/resources/audit-logs.d.ts +3 -3
- package/resources/audit-logs.d.ts.map +1 -1
- package/resources/changelogs/changelogs.d.mts +116 -116
- package/resources/changelogs/changelogs.d.mts.map +1 -1
- package/resources/changelogs/changelogs.d.ts +116 -116
- package/resources/changelogs/changelogs.d.ts.map +1 -1
- package/resources/changelogs/changelogs.js +74 -74
- package/resources/changelogs/changelogs.js.map +1 -1
- package/resources/changelogs/changelogs.mjs +74 -74
- package/resources/changelogs/changelogs.mjs.map +1 -1
- package/resources/changelogs/index.d.mts +1 -1
- package/resources/changelogs/index.d.mts.map +1 -1
- package/resources/changelogs/index.d.ts +1 -1
- package/resources/changelogs/index.d.ts.map +1 -1
- package/resources/changelogs/subscribers.d.mts +3 -3
- package/resources/changelogs/subscribers.d.mts.map +1 -1
- package/resources/changelogs/subscribers.d.ts +3 -3
- package/resources/changelogs/subscribers.d.ts.map +1 -1
- package/resources/conversation-attributes.d.mts +17 -17
- package/resources/conversation-attributes.d.mts.map +1 -1
- package/resources/conversation-attributes.d.ts +17 -17
- package/resources/conversation-attributes.d.ts.map +1 -1
- package/resources/conversation-attributes.js +19 -19
- package/resources/conversation-attributes.js.map +1 -1
- package/resources/conversation-attributes.mjs +19 -19
- package/resources/conversation-attributes.mjs.map +1 -1
- package/resources/feedback/boards.d.mts +19 -19
- package/resources/feedback/boards.d.mts.map +1 -1
- package/resources/feedback/boards.d.ts +19 -19
- package/resources/feedback/boards.d.ts.map +1 -1
- package/resources/feedback/boards.js +20 -20
- package/resources/feedback/boards.js.map +1 -1
- package/resources/feedback/boards.mjs +20 -20
- package/resources/feedback/boards.mjs.map +1 -1
- package/resources/feedback/comments.d.mts +113 -113
- package/resources/feedback/comments.d.mts.map +1 -1
- package/resources/feedback/comments.d.ts +113 -113
- package/resources/feedback/comments.d.ts.map +1 -1
- package/resources/feedback/comments.js +93 -93
- package/resources/feedback/comments.js.map +1 -1
- package/resources/feedback/comments.mjs +93 -93
- package/resources/feedback/comments.mjs.map +1 -1
- package/resources/feedback/custom-fields.d.mts +36 -36
- package/resources/feedback/custom-fields.d.mts.map +1 -1
- package/resources/feedback/custom-fields.d.ts +36 -36
- package/resources/feedback/custom-fields.d.ts.map +1 -1
- package/resources/feedback/custom-fields.js +36 -36
- package/resources/feedback/custom-fields.js.map +1 -1
- package/resources/feedback/custom-fields.mjs +36 -36
- package/resources/feedback/custom-fields.mjs.map +1 -1
- package/resources/feedback/feedback.d.mts +5 -5
- package/resources/feedback/feedback.d.mts.map +1 -1
- package/resources/feedback/feedback.d.ts +5 -5
- package/resources/feedback/feedback.d.ts.map +1 -1
- package/resources/feedback/index.d.mts +5 -5
- package/resources/feedback/index.d.mts.map +1 -1
- package/resources/feedback/index.d.ts +5 -5
- package/resources/feedback/index.d.ts.map +1 -1
- package/resources/feedback/post-statuses.d.mts +20 -20
- package/resources/feedback/post-statuses.d.mts.map +1 -1
- package/resources/feedback/post-statuses.d.ts +20 -20
- package/resources/feedback/post-statuses.d.ts.map +1 -1
- package/resources/feedback/post-statuses.js +23 -23
- package/resources/feedback/post-statuses.js.map +1 -1
- package/resources/feedback/post-statuses.mjs +23 -23
- package/resources/feedback/post-statuses.mjs.map +1 -1
- package/resources/feedback/posts/index.d.mts +1 -1
- package/resources/feedback/posts/index.d.mts.map +1 -1
- package/resources/feedback/posts/index.d.ts +1 -1
- package/resources/feedback/posts/index.d.ts.map +1 -1
- package/resources/feedback/posts/posts.d.mts +132 -132
- package/resources/feedback/posts/posts.d.mts.map +1 -1
- package/resources/feedback/posts/posts.d.ts +132 -132
- package/resources/feedback/posts/posts.d.ts.map +1 -1
- package/resources/feedback/posts/posts.js +107 -107
- package/resources/feedback/posts/posts.js.map +1 -1
- package/resources/feedback/posts/posts.mjs +107 -107
- package/resources/feedback/posts/posts.mjs.map +1 -1
- package/resources/feedback/posts/voters.d.mts +3 -3
- package/resources/feedback/posts/voters.d.mts.map +1 -1
- package/resources/feedback/posts/voters.d.ts +3 -3
- package/resources/feedback/posts/voters.d.ts.map +1 -1
- package/resources/help-center/articles.d.mts +213 -97
- package/resources/help-center/articles.d.mts.map +1 -1
- package/resources/help-center/articles.d.ts +213 -97
- package/resources/help-center/articles.d.ts.map +1 -1
- package/resources/help-center/articles.js +73 -73
- package/resources/help-center/articles.js.map +1 -1
- package/resources/help-center/articles.mjs +73 -73
- package/resources/help-center/articles.mjs.map +1 -1
- package/resources/help-center/collections.d.mts +158 -71
- package/resources/help-center/collections.d.mts.map +1 -1
- package/resources/help-center/collections.d.ts +158 -71
- package/resources/help-center/collections.d.ts.map +1 -1
- package/resources/help-center/collections.js +65 -65
- package/resources/help-center/collections.js.map +1 -1
- package/resources/help-center/collections.mjs +65 -65
- package/resources/help-center/collections.mjs.map +1 -1
- package/resources/help-center/help-center.d.mts +4 -4
- package/resources/help-center/help-center.d.mts.map +1 -1
- package/resources/help-center/help-center.d.ts +4 -4
- package/resources/help-center/help-center.d.ts.map +1 -1
- package/resources/help-center/help-centers.d.mts +77 -48
- package/resources/help-center/help-centers.d.mts.map +1 -1
- package/resources/help-center/help-centers.d.ts +77 -48
- package/resources/help-center/help-centers.d.ts.map +1 -1
- package/resources/help-center/help-centers.js +43 -43
- package/resources/help-center/help-centers.js.map +1 -1
- package/resources/help-center/help-centers.mjs +43 -43
- package/resources/help-center/help-centers.mjs.map +1 -1
- package/resources/help-center/index.d.mts +4 -4
- package/resources/help-center/index.d.mts.map +1 -1
- package/resources/help-center/index.d.ts +4 -4
- package/resources/help-center/index.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.d.mts +124 -124
- package/resources/help-center/redirect-rules.d.mts.map +1 -1
- package/resources/help-center/redirect-rules.d.ts +124 -124
- package/resources/help-center/redirect-rules.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.js +112 -112
- package/resources/help-center/redirect-rules.js.map +1 -1
- package/resources/help-center/redirect-rules.mjs +112 -112
- package/resources/help-center/redirect-rules.mjs.map +1 -1
- package/resources/index.d.mts +5 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +5 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/organization/admins.d.mts +26 -26
- package/resources/organization/admins.d.mts.map +1 -1
- package/resources/organization/admins.d.ts +26 -26
- package/resources/organization/admins.d.ts.map +1 -1
- package/resources/organization/admins.js +25 -25
- package/resources/organization/admins.js.map +1 -1
- package/resources/organization/admins.mjs +25 -25
- package/resources/organization/admins.mjs.map +1 -1
- package/resources/organization/brands.d.mts +52 -52
- package/resources/organization/brands.d.mts.map +1 -1
- package/resources/organization/brands.d.ts +52 -52
- package/resources/organization/brands.d.ts.map +1 -1
- package/resources/organization/brands.js +54 -54
- package/resources/organization/brands.js.map +1 -1
- package/resources/organization/brands.mjs +54 -54
- package/resources/organization/brands.mjs.map +1 -1
- package/resources/organization/index.d.mts +3 -3
- package/resources/organization/index.d.mts.map +1 -1
- package/resources/organization/index.d.ts +3 -3
- package/resources/organization/index.d.ts.map +1 -1
- package/resources/organization/organization.d.mts +3 -3
- package/resources/organization/organization.d.mts.map +1 -1
- package/resources/organization/organization.d.ts +3 -3
- package/resources/organization/organization.d.ts.map +1 -1
- package/resources/organization/teams.d.mts +47 -47
- package/resources/organization/teams.d.mts.map +1 -1
- package/resources/organization/teams.d.ts +47 -47
- package/resources/organization/teams.d.ts.map +1 -1
- package/resources/organization/teams.js +44 -44
- package/resources/organization/teams.js.map +1 -1
- package/resources/organization/teams.mjs +44 -44
- package/resources/organization/teams.mjs.map +1 -1
- package/resources/reports.d.mts +249 -215
- package/resources/reports.d.mts.map +1 -1
- package/resources/reports.d.ts +249 -215
- package/resources/reports.d.ts.map +1 -1
- package/resources/reports.js +99 -99
- package/resources/reports.js.map +1 -1
- package/resources/reports.mjs +99 -99
- package/resources/reports.mjs.map +1 -1
- package/resources/support/conversation-tags.d.mts +43 -43
- package/resources/support/conversation-tags.d.mts.map +1 -1
- package/resources/support/conversation-tags.d.ts +43 -43
- package/resources/support/conversation-tags.d.ts.map +1 -1
- package/resources/support/conversation-tags.js +32 -32
- package/resources/support/conversation-tags.js.map +1 -1
- package/resources/support/conversation-tags.mjs +32 -32
- package/resources/support/conversation-tags.mjs.map +1 -1
- package/resources/support/conversations/conversations.d.mts +337 -327
- package/resources/support/conversations/conversations.d.mts.map +1 -1
- package/resources/support/conversations/conversations.d.ts +337 -327
- package/resources/support/conversations/conversations.d.ts.map +1 -1
- package/resources/support/conversations/conversations.js +293 -283
- package/resources/support/conversations/conversations.js.map +1 -1
- package/resources/support/conversations/conversations.mjs +293 -283
- package/resources/support/conversations/conversations.mjs.map +1 -1
- package/resources/support/conversations/index.d.mts +1 -1
- package/resources/support/conversations/index.d.mts.map +1 -1
- package/resources/support/conversations/index.d.ts +1 -1
- package/resources/support/conversations/index.d.ts.map +1 -1
- package/resources/support/conversations/participants.d.mts +2 -2
- package/resources/support/conversations/participants.d.mts.map +1 -1
- package/resources/support/conversations/participants.d.ts +2 -2
- package/resources/support/conversations/participants.d.ts.map +1 -1
- package/resources/support/index.d.mts +3 -3
- package/resources/support/index.d.mts.map +1 -1
- package/resources/support/index.d.ts +3 -3
- package/resources/support/index.d.ts.map +1 -1
- package/resources/support/support.d.mts +3 -3
- package/resources/support/support.d.mts.map +1 -1
- package/resources/support/support.d.ts +3 -3
- package/resources/support/support.d.ts.map +1 -1
- package/resources/support/tickets/categories.d.mts +20 -20
- package/resources/support/tickets/categories.d.mts.map +1 -1
- package/resources/support/tickets/categories.d.ts +20 -20
- package/resources/support/tickets/categories.d.ts.map +1 -1
- package/resources/support/tickets/categories.js +25 -25
- package/resources/support/tickets/categories.js.map +1 -1
- package/resources/support/tickets/categories.mjs +25 -25
- package/resources/support/tickets/categories.mjs.map +1 -1
- package/resources/support/tickets/custom-fields.d.mts +22 -22
- package/resources/support/tickets/custom-fields.d.mts.map +1 -1
- package/resources/support/tickets/custom-fields.d.ts +22 -22
- package/resources/support/tickets/custom-fields.d.ts.map +1 -1
- package/resources/support/tickets/custom-fields.js +19 -19
- package/resources/support/tickets/custom-fields.js.map +1 -1
- package/resources/support/tickets/custom-fields.mjs +19 -19
- package/resources/support/tickets/custom-fields.mjs.map +1 -1
- package/resources/support/tickets/index.d.mts +4 -4
- package/resources/support/tickets/index.d.mts.map +1 -1
- package/resources/support/tickets/index.d.ts +4 -4
- package/resources/support/tickets/index.d.ts.map +1 -1
- package/resources/support/tickets/statuses.d.mts +19 -19
- package/resources/support/tickets/statuses.d.mts.map +1 -1
- package/resources/support/tickets/statuses.d.ts +19 -19
- package/resources/support/tickets/statuses.d.ts.map +1 -1
- package/resources/support/tickets/statuses.js +21 -21
- package/resources/support/tickets/statuses.js.map +1 -1
- package/resources/support/tickets/statuses.mjs +21 -21
- package/resources/support/tickets/statuses.mjs.map +1 -1
- package/resources/support/tickets/tickets.d.mts +75 -75
- package/resources/support/tickets/tickets.d.mts.map +1 -1
- package/resources/support/tickets/tickets.d.ts +75 -75
- package/resources/support/tickets/tickets.d.ts.map +1 -1
- package/resources/support/tickets/tickets.js +44 -44
- package/resources/support/tickets/tickets.js.map +1 -1
- package/resources/support/tickets/tickets.mjs +44 -44
- package/resources/support/tickets/tickets.mjs.map +1 -1
- package/resources/surveys.d.mts +43 -43
- package/resources/surveys.d.mts.map +1 -1
- package/resources/surveys.d.ts +43 -43
- package/resources/surveys.d.ts.map +1 -1
- package/resources/surveys.js +44 -44
- package/resources/surveys.js.map +1 -1
- package/resources/surveys.mjs +44 -44
- package/resources/surveys.mjs.map +1 -1
- package/resources/users/companies/companies.d.mts +121 -130
- package/resources/users/companies/companies.d.mts.map +1 -1
- package/resources/users/companies/companies.d.ts +121 -130
- package/resources/users/companies/companies.d.ts.map +1 -1
- package/resources/users/companies/companies.js +125 -125
- package/resources/users/companies/companies.js.map +1 -1
- package/resources/users/companies/companies.mjs +125 -125
- package/resources/users/companies/companies.mjs.map +1 -1
- package/resources/users/companies/contacts.d.mts +3 -3
- package/resources/users/companies/contacts.d.mts.map +1 -1
- package/resources/users/companies/contacts.d.ts +3 -3
- package/resources/users/companies/contacts.d.ts.map +1 -1
- package/resources/users/companies/index.d.mts +1 -1
- package/resources/users/companies/index.d.mts.map +1 -1
- package/resources/users/companies/index.d.ts +1 -1
- package/resources/users/companies/index.d.ts.map +1 -1
- package/resources/users/contacts/by-user-id/by-user-id.d.mts +2 -2
- package/resources/users/contacts/by-user-id/by-user-id.d.mts.map +1 -1
- package/resources/users/contacts/by-user-id/by-user-id.d.ts +2 -2
- package/resources/users/contacts/by-user-id/by-user-id.d.ts.map +1 -1
- package/resources/users/contacts/by-user-id/email-preferences.d.mts +2 -2
- package/resources/users/contacts/by-user-id/email-preferences.d.mts.map +1 -1
- package/resources/users/contacts/by-user-id/email-preferences.d.ts +2 -2
- package/resources/users/contacts/by-user-id/email-preferences.d.ts.map +1 -1
- package/resources/users/contacts/contacts.d.mts +249 -235
- package/resources/users/contacts/contacts.d.mts.map +1 -1
- package/resources/users/contacts/contacts.d.ts +249 -235
- package/resources/users/contacts/contacts.d.ts.map +1 -1
- package/resources/users/contacts/contacts.js +211 -184
- package/resources/users/contacts/contacts.js.map +1 -1
- package/resources/users/contacts/contacts.mjs +211 -184
- package/resources/users/contacts/contacts.mjs.map +1 -1
- package/resources/users/contacts/email-preferences.d.mts +2 -2
- package/resources/users/contacts/email-preferences.d.mts.map +1 -1
- package/resources/users/contacts/email-preferences.d.ts +2 -2
- package/resources/users/contacts/email-preferences.d.ts.map +1 -1
- package/resources/users/contacts/index.d.mts +1 -1
- package/resources/users/contacts/index.d.mts.map +1 -1
- package/resources/users/contacts/index.d.ts +1 -1
- package/resources/users/contacts/index.d.ts.map +1 -1
- package/resources/users/index.d.mts +2 -2
- package/resources/users/index.d.mts.map +1 -1
- package/resources/users/index.d.ts +2 -2
- package/resources/users/index.d.ts.map +1 -1
- package/resources/users/users.d.mts +2 -2
- package/resources/users/users.d.mts.map +1 -1
- package/resources/users/users.d.ts +2 -2
- package/resources/users/users.d.ts.map +1 -1
- package/resources/webhooks.d.mts +83 -83
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +83 -83
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +77 -77
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +77 -77
- package/resources/webhooks.mjs.map +1 -1
- package/src/client.ts +6 -6
- package/src/resources/audit-logs.ts +7 -1
- package/src/resources/changelogs/changelogs.ts +320 -175
- package/src/resources/changelogs/index.ts +1 -1
- package/src/resources/changelogs/subscribers.ts +31 -2
- package/src/resources/conversation-attributes.ts +34 -34
- package/src/resources/feedback/boards.ts +30 -30
- package/src/resources/feedback/comments.ts +137 -137
- package/src/resources/feedback/custom-fields.ts +46 -46
- package/src/resources/feedback/feedback.ts +6 -6
- package/src/resources/feedback/index.ts +6 -6
- package/src/resources/feedback/post-statuses.ts +33 -33
- package/src/resources/feedback/posts/index.ts +2 -2
- package/src/resources/feedback/posts/posts.ts +176 -176
- package/src/resources/feedback/posts/voters.ts +3 -3
- package/src/resources/help-center/articles.ts +631 -109
- package/src/resources/help-center/collections.ts +349 -88
- package/src/resources/help-center/help-center.ts +5 -5
- package/src/resources/help-center/help-centers.ts +202 -57
- package/src/resources/help-center/index.ts +5 -5
- package/src/resources/help-center/redirect-rules.ts +294 -178
- package/src/resources/index.ts +6 -6
- package/src/resources/organization/admins.ts +36 -36
- package/src/resources/organization/brands.ts +68 -68
- package/src/resources/organization/index.ts +3 -3
- package/src/resources/organization/organization.ts +3 -3
- package/src/resources/organization/teams.ts +54 -54
- package/src/resources/reports.ts +311 -262
- package/src/resources/support/conversation-tags.ts +62 -62
- package/src/resources/support/conversations/conversations.ts +429 -419
- package/src/resources/support/conversations/index.ts +4 -4
- package/src/resources/support/conversations/participants.ts +2 -2
- package/src/resources/support/index.ts +7 -7
- package/src/resources/support/support.ts +7 -7
- package/src/resources/support/tickets/categories.ts +35 -35
- package/src/resources/support/tickets/custom-fields.ts +29 -29
- package/src/resources/support/tickets/index.ts +4 -4
- package/src/resources/support/tickets/statuses.ts +31 -31
- package/src/resources/support/tickets/tickets.ts +101 -101
- package/src/resources/surveys.ts +60 -60
- package/src/resources/users/companies/companies.ts +158 -172
- package/src/resources/users/companies/contacts.ts +3 -3
- package/src/resources/users/companies/index.ts +2 -2
- package/src/resources/users/contacts/by-user-id/by-user-id.ts +2 -2
- package/src/resources/users/contacts/by-user-id/email-preferences.ts +2 -2
- package/src/resources/users/contacts/contacts.ts +284 -280
- package/src/resources/users/contacts/email-preferences.ts +2 -2
- package/src/resources/users/contacts/index.ts +3 -3
- package/src/resources/users/index.ts +5 -5
- package/src/resources/users/users.ts +5 -5
- package/src/resources/webhooks.ts +106 -100
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -82,8 +82,8 @@ export declare namespace HelpCenter {
|
|
|
82
82
|
type HelpCenterNavItem as HelpCenterNavItem,
|
|
83
83
|
type HelpCenterTranslation as HelpCenterTranslation,
|
|
84
84
|
type HelpCentersCursorPage as HelpCentersCursorPage,
|
|
85
|
-
type HelpCenterListParams as HelpCenterListParams,
|
|
86
85
|
type HelpCenterRetrieveParams as HelpCenterRetrieveParams,
|
|
86
|
+
type HelpCenterListParams as HelpCenterListParams,
|
|
87
87
|
};
|
|
88
88
|
|
|
89
89
|
export {
|
|
@@ -94,10 +94,10 @@ export declare namespace HelpCenter {
|
|
|
94
94
|
type CollectionTranslationInputNova as CollectionTranslationInputNova,
|
|
95
95
|
type CollectionDeleteResponse as CollectionDeleteResponse,
|
|
96
96
|
type CollectionsCursorPage as CollectionsCursorPage,
|
|
97
|
-
type CollectionListParams as CollectionListParams,
|
|
98
97
|
type CollectionCreateParams as CollectionCreateParams,
|
|
99
98
|
type CollectionRetrieveParams as CollectionRetrieveParams,
|
|
100
99
|
type CollectionUpdateParams as CollectionUpdateParams,
|
|
100
|
+
type CollectionListParams as CollectionListParams,
|
|
101
101
|
type CollectionDeleteParams as CollectionDeleteParams,
|
|
102
102
|
};
|
|
103
103
|
|
|
@@ -115,10 +115,10 @@ export declare namespace HelpCenter {
|
|
|
115
115
|
type ArticleDeleteResponse as ArticleDeleteResponse,
|
|
116
116
|
type ArticleSearchResponse as ArticleSearchResponse,
|
|
117
117
|
type ArticlesCursorPage as ArticlesCursorPage,
|
|
118
|
-
type ArticleListParams as ArticleListParams,
|
|
119
118
|
type ArticleCreateParams as ArticleCreateParams,
|
|
120
119
|
type ArticleRetrieveParams as ArticleRetrieveParams,
|
|
121
120
|
type ArticleUpdateParams as ArticleUpdateParams,
|
|
121
|
+
type ArticleListParams as ArticleListParams,
|
|
122
122
|
type ArticleDeleteParams as ArticleDeleteParams,
|
|
123
123
|
type ArticleEditBodyParams as ArticleEditBodyParams,
|
|
124
124
|
type ArticleSearchParams as ArticleSearchParams,
|
|
@@ -129,11 +129,11 @@ export declare namespace HelpCenter {
|
|
|
129
129
|
type RedirectRule as RedirectRule,
|
|
130
130
|
type RedirectRuleDeleteResponse as RedirectRuleDeleteResponse,
|
|
131
131
|
type RedirectRulesCursorPage as RedirectRulesCursorPage,
|
|
132
|
-
type RedirectRuleListParams as RedirectRuleListParams,
|
|
133
132
|
type RedirectRuleCreateParams as RedirectRuleCreateParams,
|
|
134
|
-
type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams,
|
|
135
133
|
type RedirectRuleRetrieveParams as RedirectRuleRetrieveParams,
|
|
136
134
|
type RedirectRuleUpdateParams as RedirectRuleUpdateParams,
|
|
135
|
+
type RedirectRuleListParams as RedirectRuleListParams,
|
|
137
136
|
type RedirectRuleDeleteParams as RedirectRuleDeleteParams,
|
|
137
|
+
type RedirectRuleRetrieveByURLParams as RedirectRuleRetrieveByURLParams,
|
|
138
138
|
};
|
|
139
139
|
}
|
|
@@ -13,55 +13,47 @@ import { path } from '../../internal/utils/path';
|
|
|
13
13
|
*/
|
|
14
14
|
export class HelpCenters extends APIResource {
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* Currently, Featurebase only supports one help center per organization, but we
|
|
19
|
-
* plan on supporting multiple help centers in the future.
|
|
20
|
-
*
|
|
21
|
-
* ### Query Parameters
|
|
22
|
-
*
|
|
23
|
-
* - `limit` - Number of items to return (1-100, default 10)
|
|
24
|
-
* - `cursor` - Cursor for pagination
|
|
25
|
-
*
|
|
26
|
-
* ### Response Format
|
|
27
|
-
*
|
|
28
|
-
* Returns a list object with:
|
|
16
|
+
* Retrieves a single help center by its unique identifier.
|
|
29
17
|
*
|
|
30
|
-
*
|
|
31
|
-
* - `data` - Array of help center objects
|
|
32
|
-
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
18
|
+
* Returns the help center object if found in your organization.
|
|
33
19
|
*
|
|
34
|
-
* ###
|
|
20
|
+
* ### Response
|
|
35
21
|
*
|
|
36
|
-
*
|
|
22
|
+
* Returns a help center object with:
|
|
37
23
|
*
|
|
38
24
|
* - `id` - Unique identifier
|
|
39
25
|
* - `displayName` - Help center display name
|
|
40
26
|
* - `title` - Help center title
|
|
41
27
|
* - `description` - Help center description
|
|
28
|
+
* - `searchPlaceholder` - Search input placeholder text
|
|
42
29
|
* - `isPublic` - Whether the help center is publicly accessible
|
|
43
30
|
* - `defaultLocale` - Default locale for content
|
|
31
|
+
* - `locale` - Current locale
|
|
44
32
|
* - `availableLocales` - Array of available locales
|
|
45
33
|
* - `navItems` - Navigation items configuration
|
|
46
34
|
* - `urls` - URL configuration (subpath, custom domain)
|
|
47
35
|
* - `createdAt` - ISO 8601 timestamp when created
|
|
48
36
|
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
49
37
|
*
|
|
38
|
+
* ### Errors
|
|
39
|
+
*
|
|
40
|
+
* - `404` - Help center not found in your organization
|
|
41
|
+
*
|
|
50
42
|
* @example
|
|
51
43
|
* ```ts
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
44
|
+
* const helpCenter =
|
|
45
|
+
* await client.helpCenter.helpCenters.retrieve(
|
|
46
|
+
* '2tgy0ig982j54qfl',
|
|
47
|
+
* );
|
|
56
48
|
* ```
|
|
57
49
|
*/
|
|
58
|
-
|
|
59
|
-
|
|
50
|
+
retrieve(
|
|
51
|
+
id: string,
|
|
52
|
+
params: HelpCenterRetrieveParams | null | undefined = {},
|
|
60
53
|
options?: RequestOptions,
|
|
61
|
-
):
|
|
62
|
-
const { 'Featurebase-Version': featurebaseVersion
|
|
63
|
-
return this._client.
|
|
64
|
-
query,
|
|
54
|
+
): APIPromise<HelpCenter> {
|
|
55
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
56
|
+
return this._client.get(path`/v2/help_center/help_centers/${id}`, {
|
|
65
57
|
...options,
|
|
66
58
|
headers: buildHeaders([
|
|
67
59
|
{
|
|
@@ -75,47 +67,55 @@ export class HelpCenters extends APIResource {
|
|
|
75
67
|
}
|
|
76
68
|
|
|
77
69
|
/**
|
|
78
|
-
*
|
|
70
|
+
* Returns all help centers configured in your Featurebase organization.
|
|
79
71
|
*
|
|
80
|
-
*
|
|
72
|
+
* Currently, Featurebase only supports one help center per organization, but we
|
|
73
|
+
* plan on supporting multiple help centers in the future.
|
|
81
74
|
*
|
|
82
|
-
* ###
|
|
75
|
+
* ### Query Parameters
|
|
83
76
|
*
|
|
84
|
-
*
|
|
77
|
+
* - `limit` - Number of items to return (1-100, default 10)
|
|
78
|
+
* - `cursor` - Cursor for pagination
|
|
79
|
+
*
|
|
80
|
+
* ### Response Format
|
|
81
|
+
*
|
|
82
|
+
* Returns a list object with:
|
|
83
|
+
*
|
|
84
|
+
* - `object` - Always "list"
|
|
85
|
+
* - `data` - Array of help center objects
|
|
86
|
+
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
87
|
+
*
|
|
88
|
+
* ### Help Center Object
|
|
89
|
+
*
|
|
90
|
+
* Each help center includes:
|
|
85
91
|
*
|
|
86
92
|
* - `id` - Unique identifier
|
|
87
93
|
* - `displayName` - Help center display name
|
|
88
94
|
* - `title` - Help center title
|
|
89
95
|
* - `description` - Help center description
|
|
90
|
-
* - `searchPlaceholder` - Search input placeholder text
|
|
91
96
|
* - `isPublic` - Whether the help center is publicly accessible
|
|
92
97
|
* - `defaultLocale` - Default locale for content
|
|
93
|
-
* - `locale` - Current locale
|
|
94
98
|
* - `availableLocales` - Array of available locales
|
|
95
99
|
* - `navItems` - Navigation items configuration
|
|
96
100
|
* - `urls` - URL configuration (subpath, custom domain)
|
|
97
101
|
* - `createdAt` - ISO 8601 timestamp when created
|
|
98
102
|
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
99
103
|
*
|
|
100
|
-
* ### Errors
|
|
101
|
-
*
|
|
102
|
-
* - `404` - Help center not found in your organization
|
|
103
|
-
*
|
|
104
104
|
* @example
|
|
105
105
|
* ```ts
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
106
|
+
* // Automatically fetches more pages as needed.
|
|
107
|
+
* for await (const helpCenter of client.helpCenter.helpCenters.list()) {
|
|
108
|
+
* // ...
|
|
109
|
+
* }
|
|
110
110
|
* ```
|
|
111
111
|
*/
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
params: HelpCenterRetrieveParams | null | undefined = {},
|
|
112
|
+
list(
|
|
113
|
+
params: HelpCenterListParams | null | undefined = {},
|
|
115
114
|
options?: RequestOptions,
|
|
116
|
-
):
|
|
117
|
-
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
118
|
-
return this._client.
|
|
115
|
+
): PagePromise<HelpCentersCursorPage, HelpCenter> {
|
|
116
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
117
|
+
return this._client.getAPIList('/v2/help_center/help_centers', CursorPage<HelpCenter>, {
|
|
118
|
+
query,
|
|
119
119
|
...options,
|
|
120
120
|
headers: buildHeaders([
|
|
121
121
|
{
|
|
@@ -141,6 +141,35 @@ export interface HelpCenter {
|
|
|
141
141
|
* Available locales
|
|
142
142
|
*/
|
|
143
143
|
availableLocales: Array<
|
|
144
|
+
| 'ar'
|
|
145
|
+
| 'am'
|
|
146
|
+
| 'fa'
|
|
147
|
+
| 'ht'
|
|
148
|
+
| 'lo'
|
|
149
|
+
| 'my'
|
|
150
|
+
| 'pa'
|
|
151
|
+
| 'ps'
|
|
152
|
+
| 'so'
|
|
153
|
+
| 'tl'
|
|
154
|
+
| 'ur'
|
|
155
|
+
| 'he'
|
|
156
|
+
| 'ta'
|
|
157
|
+
| 'te'
|
|
158
|
+
| 'mr'
|
|
159
|
+
| 'gu'
|
|
160
|
+
| 'kn'
|
|
161
|
+
| 'ml'
|
|
162
|
+
| 'ha'
|
|
163
|
+
| 'jv'
|
|
164
|
+
| 'yo'
|
|
165
|
+
| 'ig'
|
|
166
|
+
| 'uz'
|
|
167
|
+
| 'ne'
|
|
168
|
+
| 'sd'
|
|
169
|
+
| 'az'
|
|
170
|
+
| 'si'
|
|
171
|
+
| 'km'
|
|
172
|
+
| 'kk'
|
|
144
173
|
| 'bn'
|
|
145
174
|
| 'bs'
|
|
146
175
|
| 'pt-BR'
|
|
@@ -194,6 +223,35 @@ export interface HelpCenter {
|
|
|
194
223
|
* Default locale for the help center
|
|
195
224
|
*/
|
|
196
225
|
defaultLocale:
|
|
226
|
+
| 'ar'
|
|
227
|
+
| 'am'
|
|
228
|
+
| 'fa'
|
|
229
|
+
| 'ht'
|
|
230
|
+
| 'lo'
|
|
231
|
+
| 'my'
|
|
232
|
+
| 'pa'
|
|
233
|
+
| 'ps'
|
|
234
|
+
| 'so'
|
|
235
|
+
| 'tl'
|
|
236
|
+
| 'ur'
|
|
237
|
+
| 'he'
|
|
238
|
+
| 'ta'
|
|
239
|
+
| 'te'
|
|
240
|
+
| 'mr'
|
|
241
|
+
| 'gu'
|
|
242
|
+
| 'kn'
|
|
243
|
+
| 'ml'
|
|
244
|
+
| 'ha'
|
|
245
|
+
| 'jv'
|
|
246
|
+
| 'yo'
|
|
247
|
+
| 'ig'
|
|
248
|
+
| 'uz'
|
|
249
|
+
| 'ne'
|
|
250
|
+
| 'sd'
|
|
251
|
+
| 'az'
|
|
252
|
+
| 'si'
|
|
253
|
+
| 'km'
|
|
254
|
+
| 'kk'
|
|
197
255
|
| 'bn'
|
|
198
256
|
| 'bs'
|
|
199
257
|
| 'pt-BR'
|
|
@@ -246,6 +304,35 @@ export interface HelpCenter {
|
|
|
246
304
|
* Current locale
|
|
247
305
|
*/
|
|
248
306
|
locale:
|
|
307
|
+
| 'ar'
|
|
308
|
+
| 'am'
|
|
309
|
+
| 'fa'
|
|
310
|
+
| 'ht'
|
|
311
|
+
| 'lo'
|
|
312
|
+
| 'my'
|
|
313
|
+
| 'pa'
|
|
314
|
+
| 'ps'
|
|
315
|
+
| 'so'
|
|
316
|
+
| 'tl'
|
|
317
|
+
| 'ur'
|
|
318
|
+
| 'he'
|
|
319
|
+
| 'ta'
|
|
320
|
+
| 'te'
|
|
321
|
+
| 'mr'
|
|
322
|
+
| 'gu'
|
|
323
|
+
| 'kn'
|
|
324
|
+
| 'ml'
|
|
325
|
+
| 'ha'
|
|
326
|
+
| 'jv'
|
|
327
|
+
| 'yo'
|
|
328
|
+
| 'ig'
|
|
329
|
+
| 'uz'
|
|
330
|
+
| 'ne'
|
|
331
|
+
| 'sd'
|
|
332
|
+
| 'az'
|
|
333
|
+
| 'si'
|
|
334
|
+
| 'km'
|
|
335
|
+
| 'kk'
|
|
249
336
|
| 'bn'
|
|
250
337
|
| 'bs'
|
|
251
338
|
| 'pt-BR'
|
|
@@ -367,6 +454,12 @@ export namespace HelpCenter {
|
|
|
367
454
|
export interface Translations {
|
|
368
455
|
id?: HelpCentersAPI.HelpCenterTranslation;
|
|
369
456
|
|
|
457
|
+
am?: HelpCentersAPI.HelpCenterTranslation;
|
|
458
|
+
|
|
459
|
+
ar?: HelpCentersAPI.HelpCenterTranslation;
|
|
460
|
+
|
|
461
|
+
az?: HelpCentersAPI.HelpCenterTranslation;
|
|
462
|
+
|
|
370
463
|
bg?: HelpCentersAPI.HelpCenterTranslation;
|
|
371
464
|
|
|
372
465
|
bn?: HelpCentersAPI.HelpCenterTranslation;
|
|
@@ -389,36 +482,70 @@ export namespace HelpCenter {
|
|
|
389
482
|
|
|
390
483
|
et?: HelpCentersAPI.HelpCenterTranslation;
|
|
391
484
|
|
|
485
|
+
fa?: HelpCentersAPI.HelpCenterTranslation;
|
|
486
|
+
|
|
392
487
|
fi?: HelpCentersAPI.HelpCenterTranslation;
|
|
393
488
|
|
|
394
489
|
fr?: HelpCentersAPI.HelpCenterTranslation;
|
|
395
490
|
|
|
491
|
+
gu?: HelpCentersAPI.HelpCenterTranslation;
|
|
492
|
+
|
|
493
|
+
ha?: HelpCentersAPI.HelpCenterTranslation;
|
|
494
|
+
|
|
495
|
+
he?: HelpCentersAPI.HelpCenterTranslation;
|
|
496
|
+
|
|
396
497
|
hi?: HelpCentersAPI.HelpCenterTranslation;
|
|
397
498
|
|
|
398
499
|
hr?: HelpCentersAPI.HelpCenterTranslation;
|
|
399
500
|
|
|
501
|
+
ht?: HelpCentersAPI.HelpCenterTranslation;
|
|
502
|
+
|
|
400
503
|
hu?: HelpCentersAPI.HelpCenterTranslation;
|
|
401
504
|
|
|
505
|
+
ig?: HelpCentersAPI.HelpCenterTranslation;
|
|
506
|
+
|
|
402
507
|
it?: HelpCentersAPI.HelpCenterTranslation;
|
|
403
508
|
|
|
404
509
|
ja?: HelpCentersAPI.HelpCenterTranslation;
|
|
405
510
|
|
|
511
|
+
jv?: HelpCentersAPI.HelpCenterTranslation;
|
|
512
|
+
|
|
513
|
+
kk?: HelpCentersAPI.HelpCenterTranslation;
|
|
514
|
+
|
|
515
|
+
km?: HelpCentersAPI.HelpCenterTranslation;
|
|
516
|
+
|
|
517
|
+
kn?: HelpCentersAPI.HelpCenterTranslation;
|
|
518
|
+
|
|
406
519
|
ko?: HelpCentersAPI.HelpCenterTranslation;
|
|
407
520
|
|
|
521
|
+
lo?: HelpCentersAPI.HelpCenterTranslation;
|
|
522
|
+
|
|
408
523
|
lt?: HelpCentersAPI.HelpCenterTranslation;
|
|
409
524
|
|
|
410
525
|
lv?: HelpCentersAPI.HelpCenterTranslation;
|
|
411
526
|
|
|
527
|
+
ml?: HelpCentersAPI.HelpCenterTranslation;
|
|
528
|
+
|
|
412
529
|
mn?: HelpCentersAPI.HelpCenterTranslation;
|
|
413
530
|
|
|
531
|
+
mr?: HelpCentersAPI.HelpCenterTranslation;
|
|
532
|
+
|
|
414
533
|
ms?: HelpCentersAPI.HelpCenterTranslation;
|
|
415
534
|
|
|
535
|
+
my?: HelpCentersAPI.HelpCenterTranslation;
|
|
536
|
+
|
|
416
537
|
nb?: HelpCentersAPI.HelpCenterTranslation;
|
|
417
538
|
|
|
539
|
+
ne?: HelpCentersAPI.HelpCenterTranslation;
|
|
540
|
+
|
|
418
541
|
nl?: HelpCentersAPI.HelpCenterTranslation;
|
|
419
542
|
|
|
543
|
+
pa?: HelpCentersAPI.HelpCenterTranslation;
|
|
544
|
+
|
|
420
545
|
pl?: HelpCentersAPI.HelpCenterTranslation;
|
|
421
546
|
|
|
547
|
+
ps?: HelpCentersAPI.HelpCenterTranslation;
|
|
548
|
+
|
|
422
549
|
pt?: HelpCentersAPI.HelpCenterTranslation;
|
|
423
550
|
|
|
424
551
|
'pt-BR'?: HelpCentersAPI.HelpCenterTranslation;
|
|
@@ -427,24 +554,42 @@ export namespace HelpCenter {
|
|
|
427
554
|
|
|
428
555
|
ru?: HelpCentersAPI.HelpCenterTranslation;
|
|
429
556
|
|
|
557
|
+
sd?: HelpCentersAPI.HelpCenterTranslation;
|
|
558
|
+
|
|
559
|
+
si?: HelpCentersAPI.HelpCenterTranslation;
|
|
560
|
+
|
|
430
561
|
sk?: HelpCentersAPI.HelpCenterTranslation;
|
|
431
562
|
|
|
432
563
|
sl?: HelpCentersAPI.HelpCenterTranslation;
|
|
433
564
|
|
|
565
|
+
so?: HelpCentersAPI.HelpCenterTranslation;
|
|
566
|
+
|
|
434
567
|
sr?: HelpCentersAPI.HelpCenterTranslation;
|
|
435
568
|
|
|
436
569
|
sv?: HelpCentersAPI.HelpCenterTranslation;
|
|
437
570
|
|
|
438
571
|
sw?: HelpCentersAPI.HelpCenterTranslation;
|
|
439
572
|
|
|
573
|
+
ta?: HelpCentersAPI.HelpCenterTranslation;
|
|
574
|
+
|
|
575
|
+
te?: HelpCentersAPI.HelpCenterTranslation;
|
|
576
|
+
|
|
440
577
|
th?: HelpCentersAPI.HelpCenterTranslation;
|
|
441
578
|
|
|
579
|
+
tl?: HelpCentersAPI.HelpCenterTranslation;
|
|
580
|
+
|
|
442
581
|
tr?: HelpCentersAPI.HelpCenterTranslation;
|
|
443
582
|
|
|
444
583
|
uk?: HelpCentersAPI.HelpCenterTranslation;
|
|
445
584
|
|
|
585
|
+
ur?: HelpCentersAPI.HelpCenterTranslation;
|
|
586
|
+
|
|
587
|
+
uz?: HelpCentersAPI.HelpCenterTranslation;
|
|
588
|
+
|
|
446
589
|
vi?: HelpCentersAPI.HelpCenterTranslation;
|
|
447
590
|
|
|
591
|
+
yo?: HelpCentersAPI.HelpCenterTranslation;
|
|
592
|
+
|
|
448
593
|
'zh-CN'?: HelpCentersAPI.HelpCenterTranslation;
|
|
449
594
|
|
|
450
595
|
'zh-TW'?: HelpCentersAPI.HelpCenterTranslation;
|
|
@@ -515,20 +660,20 @@ export interface HelpCenterTranslation {
|
|
|
515
660
|
title?: string;
|
|
516
661
|
}
|
|
517
662
|
|
|
518
|
-
export interface
|
|
663
|
+
export interface HelpCenterRetrieveParams {
|
|
519
664
|
/**
|
|
520
|
-
*
|
|
521
|
-
*
|
|
665
|
+
* API version for this request. Defaults to your organization's configured API
|
|
666
|
+
* version if not specified.
|
|
522
667
|
*/
|
|
523
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
668
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
524
669
|
}
|
|
525
670
|
|
|
526
|
-
export interface
|
|
671
|
+
export interface HelpCenterListParams extends CursorPageParams {
|
|
527
672
|
/**
|
|
528
|
-
* API version for this request. Defaults to your organization's
|
|
529
|
-
* version if not specified.
|
|
673
|
+
* Header param: API version for this request. Defaults to your organization's
|
|
674
|
+
* configured API version if not specified.
|
|
530
675
|
*/
|
|
531
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
676
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
532
677
|
}
|
|
533
678
|
|
|
534
679
|
export declare namespace HelpCenters {
|
|
@@ -537,7 +682,7 @@ export declare namespace HelpCenters {
|
|
|
537
682
|
type HelpCenterNavItem as HelpCenterNavItem,
|
|
538
683
|
type HelpCenterTranslation as HelpCenterTranslation,
|
|
539
684
|
type HelpCentersCursorPage as HelpCentersCursorPage,
|
|
540
|
-
type HelpCenterListParams as HelpCenterListParams,
|
|
541
685
|
type HelpCenterRetrieveParams as HelpCenterRetrieveParams,
|
|
686
|
+
type HelpCenterListParams as HelpCenterListParams,
|
|
542
687
|
};
|
|
543
688
|
}
|
|
@@ -13,10 +13,10 @@ export {
|
|
|
13
13
|
type EditArticleBodyResponse,
|
|
14
14
|
type ArticleDeleteResponse,
|
|
15
15
|
type ArticleSearchResponse,
|
|
16
|
-
type ArticleListParams,
|
|
17
16
|
type ArticleCreateParams,
|
|
18
17
|
type ArticleRetrieveParams,
|
|
19
18
|
type ArticleUpdateParams,
|
|
19
|
+
type ArticleListParams,
|
|
20
20
|
type ArticleDeleteParams,
|
|
21
21
|
type ArticleEditBodyParams,
|
|
22
22
|
type ArticleSearchParams,
|
|
@@ -29,10 +29,10 @@ export {
|
|
|
29
29
|
type CollectionTranslation,
|
|
30
30
|
type CollectionTranslationInputNova,
|
|
31
31
|
type CollectionDeleteResponse,
|
|
32
|
-
type CollectionListParams,
|
|
33
32
|
type CollectionCreateParams,
|
|
34
33
|
type CollectionRetrieveParams,
|
|
35
34
|
type CollectionUpdateParams,
|
|
35
|
+
type CollectionListParams,
|
|
36
36
|
type CollectionDeleteParams,
|
|
37
37
|
type CollectionsCursorPage,
|
|
38
38
|
} from './collections';
|
|
@@ -41,19 +41,19 @@ export {
|
|
|
41
41
|
HelpCenters,
|
|
42
42
|
type HelpCenterNavItem,
|
|
43
43
|
type HelpCenterTranslation,
|
|
44
|
-
type HelpCenterListParams,
|
|
45
44
|
type HelpCenterRetrieveParams,
|
|
45
|
+
type HelpCenterListParams,
|
|
46
46
|
type HelpCentersCursorPage,
|
|
47
47
|
} from './help-centers';
|
|
48
48
|
export {
|
|
49
49
|
RedirectRules,
|
|
50
50
|
type RedirectRule,
|
|
51
51
|
type RedirectRuleDeleteResponse,
|
|
52
|
-
type RedirectRuleListParams,
|
|
53
52
|
type RedirectRuleCreateParams,
|
|
54
|
-
type RedirectRuleRetrieveByURLParams,
|
|
55
53
|
type RedirectRuleRetrieveParams,
|
|
56
54
|
type RedirectRuleUpdateParams,
|
|
55
|
+
type RedirectRuleListParams,
|
|
57
56
|
type RedirectRuleDeleteParams,
|
|
57
|
+
type RedirectRuleRetrieveByURLParams,
|
|
58
58
|
type RedirectRulesCursorPage,
|
|
59
59
|
} from './redirect-rules';
|