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
|
@@ -27,85 +27,6 @@ import { path } from '../../../internal/utils/path';
|
|
|
27
27
|
export class Posts extends APIResource {
|
|
28
28
|
voters: VotersAPI.Voters = new VotersAPI.Voters(this._client);
|
|
29
29
|
|
|
30
|
-
/**
|
|
31
|
-
* Returns all posts (feedback submissions) for the authenticated organization.
|
|
32
|
-
*
|
|
33
|
-
* Posts are user-submitted feedback items. Each post belongs to a board and can
|
|
34
|
-
* have:
|
|
35
|
-
*
|
|
36
|
-
* - Status (in progress, complete, etc.)
|
|
37
|
-
* - Tags for categorization
|
|
38
|
-
* - Upvotes from users
|
|
39
|
-
* - Comments (if enabled)
|
|
40
|
-
* - Custom field values
|
|
41
|
-
*
|
|
42
|
-
* ### Pagination
|
|
43
|
-
*
|
|
44
|
-
* This endpoint uses **cursor-based pagination**:
|
|
45
|
-
*
|
|
46
|
-
* - `limit` - Number of posts to return (1-100, default 10)
|
|
47
|
-
* - `cursor` - Opaque cursor from a previous response's `nextCursor` field
|
|
48
|
-
*
|
|
49
|
-
* **Example:** To paginate through results:
|
|
50
|
-
*
|
|
51
|
-
* 1. First request: `GET /v2/posts?limit=10`
|
|
52
|
-
* 2. If `nextCursor` is not null, use it for the next page
|
|
53
|
-
* 3. Next request: `GET /v2/posts?limit=10&cursor={nextCursor}`
|
|
54
|
-
*
|
|
55
|
-
* ### Response Format
|
|
56
|
-
*
|
|
57
|
-
* Returns a list object with:
|
|
58
|
-
*
|
|
59
|
-
* - `object` - Always "list"
|
|
60
|
-
* - `data` - Array of post objects
|
|
61
|
-
* - `nextCursor` - Cursor for the next page (null if no more results)
|
|
62
|
-
*
|
|
63
|
-
* ### Filtering
|
|
64
|
-
*
|
|
65
|
-
* Filter posts using query parameters:
|
|
66
|
-
*
|
|
67
|
-
* - `boardId` - Filter by board (category) ID
|
|
68
|
-
* - `statusId` - Filter by status ID
|
|
69
|
-
* - `tags` - Filter by tag names (can be comma-separated or repeated)
|
|
70
|
-
* - `q` - Search query for title/content
|
|
71
|
-
* - `inReview` - Include posts pending moderation
|
|
72
|
-
*
|
|
73
|
-
* ### Sorting
|
|
74
|
-
*
|
|
75
|
-
* Use `sortBy` to sort results:
|
|
76
|
-
*
|
|
77
|
-
* - `createdAt` - Sort by creation date (default)
|
|
78
|
-
* - `upvotes` - Sort by vote count
|
|
79
|
-
* - `trending` - Sort by trending score
|
|
80
|
-
* - `recent` - Sort by most recently updated
|
|
81
|
-
*
|
|
82
|
-
* @example
|
|
83
|
-
* ```ts
|
|
84
|
-
* // Automatically fetches more pages as needed.
|
|
85
|
-
* for await (const post of client.feedback.posts.list()) {
|
|
86
|
-
* // ...
|
|
87
|
-
* }
|
|
88
|
-
* ```
|
|
89
|
-
*/
|
|
90
|
-
list(
|
|
91
|
-
params: PostListParams | null | undefined = {},
|
|
92
|
-
options?: RequestOptions,
|
|
93
|
-
): PagePromise<PostsCursorPage, Post> {
|
|
94
|
-
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
95
|
-
return this._client.getAPIList('/v2/posts', CursorPage<Post>, {
|
|
96
|
-
query,
|
|
97
|
-
...options,
|
|
98
|
-
headers: buildHeaders([
|
|
99
|
-
{
|
|
100
|
-
...(featurebaseVersion?.toString() != null ?
|
|
101
|
-
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
102
|
-
: undefined),
|
|
103
|
-
},
|
|
104
|
-
options?.headers,
|
|
105
|
-
]),
|
|
106
|
-
});
|
|
107
|
-
}
|
|
108
|
-
|
|
109
30
|
/**
|
|
110
31
|
* Creates a new post (feedback submission) in the specified board.
|
|
111
32
|
*
|
|
@@ -265,6 +186,85 @@ export class Posts extends APIResource {
|
|
|
265
186
|
});
|
|
266
187
|
}
|
|
267
188
|
|
|
189
|
+
/**
|
|
190
|
+
* Returns all posts (feedback submissions) for the authenticated organization.
|
|
191
|
+
*
|
|
192
|
+
* Posts are user-submitted feedback items. Each post belongs to a board and can
|
|
193
|
+
* have:
|
|
194
|
+
*
|
|
195
|
+
* - Status (in progress, complete, etc.)
|
|
196
|
+
* - Tags for categorization
|
|
197
|
+
* - Upvotes from users
|
|
198
|
+
* - Comments (if enabled)
|
|
199
|
+
* - Custom field values
|
|
200
|
+
*
|
|
201
|
+
* ### Pagination
|
|
202
|
+
*
|
|
203
|
+
* This endpoint uses **cursor-based pagination**:
|
|
204
|
+
*
|
|
205
|
+
* - `limit` - Number of posts to return (1-100, default 10)
|
|
206
|
+
* - `cursor` - Opaque cursor from a previous response's `nextCursor` field
|
|
207
|
+
*
|
|
208
|
+
* **Example:** To paginate through results:
|
|
209
|
+
*
|
|
210
|
+
* 1. First request: `GET /v2/posts?limit=10`
|
|
211
|
+
* 2. If `nextCursor` is not null, use it for the next page
|
|
212
|
+
* 3. Next request: `GET /v2/posts?limit=10&cursor={nextCursor}`
|
|
213
|
+
*
|
|
214
|
+
* ### Response Format
|
|
215
|
+
*
|
|
216
|
+
* Returns a list object with:
|
|
217
|
+
*
|
|
218
|
+
* - `object` - Always "list"
|
|
219
|
+
* - `data` - Array of post objects
|
|
220
|
+
* - `nextCursor` - Cursor for the next page (null if no more results)
|
|
221
|
+
*
|
|
222
|
+
* ### Filtering
|
|
223
|
+
*
|
|
224
|
+
* Filter posts using query parameters:
|
|
225
|
+
*
|
|
226
|
+
* - `boardId` - Filter by board (category) ID
|
|
227
|
+
* - `statusId` - Filter by status ID
|
|
228
|
+
* - `tags` - Filter by tag names (can be comma-separated or repeated)
|
|
229
|
+
* - `q` - Search query for title/content
|
|
230
|
+
* - `inReview` - Include posts pending moderation
|
|
231
|
+
*
|
|
232
|
+
* ### Sorting
|
|
233
|
+
*
|
|
234
|
+
* Use `sortBy` to sort results:
|
|
235
|
+
*
|
|
236
|
+
* - `createdAt` - Sort by creation date (default)
|
|
237
|
+
* - `upvotes` - Sort by vote count
|
|
238
|
+
* - `trending` - Sort by trending score
|
|
239
|
+
* - `recent` - Sort by most recently updated
|
|
240
|
+
*
|
|
241
|
+
* @example
|
|
242
|
+
* ```ts
|
|
243
|
+
* // Automatically fetches more pages as needed.
|
|
244
|
+
* for await (const post of client.feedback.posts.list()) {
|
|
245
|
+
* // ...
|
|
246
|
+
* }
|
|
247
|
+
* ```
|
|
248
|
+
*/
|
|
249
|
+
list(
|
|
250
|
+
params: PostListParams | null | undefined = {},
|
|
251
|
+
options?: RequestOptions,
|
|
252
|
+
): PagePromise<PostsCursorPage, Post> {
|
|
253
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
254
|
+
return this._client.getAPIList('/v2/posts', CursorPage<Post>, {
|
|
255
|
+
query,
|
|
256
|
+
...options,
|
|
257
|
+
headers: buildHeaders([
|
|
258
|
+
{
|
|
259
|
+
...(featurebaseVersion?.toString() != null ?
|
|
260
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
261
|
+
: undefined),
|
|
262
|
+
},
|
|
263
|
+
options?.headers,
|
|
264
|
+
]),
|
|
265
|
+
});
|
|
266
|
+
}
|
|
267
|
+
|
|
268
268
|
/**
|
|
269
269
|
* Permanently deletes a post. This action cannot be undone.
|
|
270
270
|
*
|
|
@@ -353,39 +353,6 @@ export class Posts extends APIResource {
|
|
|
353
353
|
});
|
|
354
354
|
}
|
|
355
355
|
|
|
356
|
-
/**
|
|
357
|
-
* Restores a post that was previously merged.
|
|
358
|
-
*
|
|
359
|
-
* The restored post returns to public post lists. Its votes and comments are
|
|
360
|
-
* removed from the destination post and restored on the source post.
|
|
361
|
-
*
|
|
362
|
-
* Retrying an unmerge after it succeeds is safe and returns the restored post.
|
|
363
|
-
*
|
|
364
|
-
* The response contains the restored post.
|
|
365
|
-
*
|
|
366
|
-
* @example
|
|
367
|
-
* ```ts
|
|
368
|
-
* const post = await client.feedback.posts.unmerge({
|
|
369
|
-
* postId: '507f1f77bcf86cd799439011',
|
|
370
|
-
* });
|
|
371
|
-
* ```
|
|
372
|
-
*/
|
|
373
|
-
unmerge(params: PostUnmergeParams, options?: RequestOptions): APIPromise<Post> {
|
|
374
|
-
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
375
|
-
return this._client.post('/v2/posts/unmerge', {
|
|
376
|
-
body,
|
|
377
|
-
...options,
|
|
378
|
-
headers: buildHeaders([
|
|
379
|
-
{
|
|
380
|
-
...(featurebaseVersion?.toString() != null ?
|
|
381
|
-
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
382
|
-
: undefined),
|
|
383
|
-
},
|
|
384
|
-
options?.headers,
|
|
385
|
-
]),
|
|
386
|
-
});
|
|
387
|
-
}
|
|
388
|
-
|
|
389
356
|
/**
|
|
390
357
|
* Search feedback posts with a structured filter AST, full-text search, sorting,
|
|
391
358
|
* and cursor pagination.
|
|
@@ -567,6 +534,39 @@ export class Posts extends APIResource {
|
|
|
567
534
|
]),
|
|
568
535
|
});
|
|
569
536
|
}
|
|
537
|
+
|
|
538
|
+
/**
|
|
539
|
+
* Restores a post that was previously merged.
|
|
540
|
+
*
|
|
541
|
+
* The restored post returns to public post lists. Its votes and comments are
|
|
542
|
+
* removed from the destination post and restored on the source post.
|
|
543
|
+
*
|
|
544
|
+
* Retrying an unmerge after it succeeds is safe and returns the restored post.
|
|
545
|
+
*
|
|
546
|
+
* The response contains the restored post.
|
|
547
|
+
*
|
|
548
|
+
* @example
|
|
549
|
+
* ```ts
|
|
550
|
+
* const post = await client.feedback.posts.unmerge({
|
|
551
|
+
* postId: '507f1f77bcf86cd799439011',
|
|
552
|
+
* });
|
|
553
|
+
* ```
|
|
554
|
+
*/
|
|
555
|
+
unmerge(params: PostUnmergeParams, options?: RequestOptions): APIPromise<Post> {
|
|
556
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
557
|
+
return this._client.post('/v2/posts/unmerge', {
|
|
558
|
+
body,
|
|
559
|
+
...options,
|
|
560
|
+
headers: buildHeaders([
|
|
561
|
+
{
|
|
562
|
+
...(featurebaseVersion?.toString() != null ?
|
|
563
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
564
|
+
: undefined),
|
|
565
|
+
},
|
|
566
|
+
options?.headers,
|
|
567
|
+
]),
|
|
568
|
+
});
|
|
569
|
+
}
|
|
570
570
|
}
|
|
571
571
|
|
|
572
572
|
export type PostsCursorPage = CursorPage<Post>;
|
|
@@ -1260,49 +1260,6 @@ export namespace PostSearchResponse {
|
|
|
1260
1260
|
}
|
|
1261
1261
|
}
|
|
1262
1262
|
|
|
1263
|
-
export interface PostListParams extends CursorPageParams {
|
|
1264
|
-
/**
|
|
1265
|
-
* Query param: Filter by board (category) ID(s)
|
|
1266
|
-
*/
|
|
1267
|
-
boardId?: string | Array<string>;
|
|
1268
|
-
|
|
1269
|
-
/**
|
|
1270
|
-
* Query param: Include posts that are in review
|
|
1271
|
-
*/
|
|
1272
|
-
inReview?: boolean | null;
|
|
1273
|
-
|
|
1274
|
-
/**
|
|
1275
|
-
* Query param: Search query to filter posts by title/content
|
|
1276
|
-
*/
|
|
1277
|
-
q?: string;
|
|
1278
|
-
|
|
1279
|
-
/**
|
|
1280
|
-
* Query param: Sort order for posts
|
|
1281
|
-
*/
|
|
1282
|
-
sortBy?: 'createdAt' | 'upvotes' | 'trending' | 'recent';
|
|
1283
|
-
|
|
1284
|
-
/**
|
|
1285
|
-
* Query param: Sort direction
|
|
1286
|
-
*/
|
|
1287
|
-
sortOrder?: 'asc' | 'desc';
|
|
1288
|
-
|
|
1289
|
-
/**
|
|
1290
|
-
* Query param: Filter by status ID(s)
|
|
1291
|
-
*/
|
|
1292
|
-
statusId?: string | Array<string>;
|
|
1293
|
-
|
|
1294
|
-
/**
|
|
1295
|
-
* Query param: Filter by tag names
|
|
1296
|
-
*/
|
|
1297
|
-
tags?: string | Array<string>;
|
|
1298
|
-
|
|
1299
|
-
/**
|
|
1300
|
-
* Header param: API version for this request. Defaults to your organization's
|
|
1301
|
-
* configured API version if not specified.
|
|
1302
|
-
*/
|
|
1303
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1304
|
-
}
|
|
1305
|
-
|
|
1306
1263
|
export interface PostCreateParams {
|
|
1307
1264
|
/**
|
|
1308
1265
|
* Body param: Board ID to create post in
|
|
@@ -1399,7 +1356,7 @@ export interface PostCreateParams {
|
|
|
1399
1356
|
* Header param: API version for this request. Defaults to your organization's
|
|
1400
1357
|
* configured API version if not specified.
|
|
1401
1358
|
*/
|
|
1402
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1359
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1403
1360
|
}
|
|
1404
1361
|
|
|
1405
1362
|
export namespace PostCreateParams {
|
|
@@ -1446,7 +1403,7 @@ export interface PostRetrieveParams {
|
|
|
1446
1403
|
* API version for this request. Defaults to your organization's configured API
|
|
1447
1404
|
* version if not specified.
|
|
1448
1405
|
*/
|
|
1449
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1406
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1450
1407
|
}
|
|
1451
1408
|
|
|
1452
1409
|
export interface PostUpdateParams {
|
|
@@ -1536,46 +1493,76 @@ export interface PostUpdateParams {
|
|
|
1536
1493
|
* Header param: API version for this request. Defaults to your organization's
|
|
1537
1494
|
* configured API version if not specified.
|
|
1538
1495
|
*/
|
|
1539
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1496
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1540
1497
|
}
|
|
1541
1498
|
|
|
1542
|
-
export interface
|
|
1499
|
+
export interface PostListParams extends CursorPageParams {
|
|
1543
1500
|
/**
|
|
1544
|
-
*
|
|
1545
|
-
* version if not specified.
|
|
1501
|
+
* Query param: Filter by board (category) ID(s)
|
|
1546
1502
|
*/
|
|
1547
|
-
|
|
1548
|
-
}
|
|
1503
|
+
boardId?: string | Array<string>;
|
|
1549
1504
|
|
|
1550
|
-
export interface PostMergeParams {
|
|
1551
1505
|
/**
|
|
1552
|
-
*
|
|
1506
|
+
* Query param: Include posts that are in review
|
|
1553
1507
|
*/
|
|
1554
|
-
|
|
1508
|
+
inReview?: boolean | null;
|
|
1555
1509
|
|
|
1556
1510
|
/**
|
|
1557
|
-
*
|
|
1511
|
+
* Query param: Search query to filter posts by title/content
|
|
1558
1512
|
*/
|
|
1559
|
-
|
|
1513
|
+
q?: string;
|
|
1514
|
+
|
|
1515
|
+
/**
|
|
1516
|
+
* Query param: Sort order for posts
|
|
1517
|
+
*/
|
|
1518
|
+
sortBy?: 'createdAt' | 'upvotes' | 'trending' | 'recent';
|
|
1519
|
+
|
|
1520
|
+
/**
|
|
1521
|
+
* Query param: Sort direction
|
|
1522
|
+
*/
|
|
1523
|
+
sortOrder?: 'asc' | 'desc';
|
|
1524
|
+
|
|
1525
|
+
/**
|
|
1526
|
+
* Query param: Filter by status ID(s)
|
|
1527
|
+
*/
|
|
1528
|
+
statusId?: string | Array<string>;
|
|
1529
|
+
|
|
1530
|
+
/**
|
|
1531
|
+
* Query param: Filter by tag names
|
|
1532
|
+
*/
|
|
1533
|
+
tags?: string | Array<string>;
|
|
1560
1534
|
|
|
1561
1535
|
/**
|
|
1562
1536
|
* Header param: API version for this request. Defaults to your organization's
|
|
1563
1537
|
* configured API version if not specified.
|
|
1564
1538
|
*/
|
|
1565
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1539
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1566
1540
|
}
|
|
1567
1541
|
|
|
1568
|
-
export interface
|
|
1542
|
+
export interface PostDeleteParams {
|
|
1569
1543
|
/**
|
|
1570
|
-
*
|
|
1544
|
+
* API version for this request. Defaults to your organization's configured API
|
|
1545
|
+
* version if not specified.
|
|
1571
1546
|
*/
|
|
1572
|
-
|
|
1547
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1548
|
+
}
|
|
1549
|
+
|
|
1550
|
+
export interface PostMergeParams {
|
|
1551
|
+
/**
|
|
1552
|
+
* Body param: ID of the post that receives the source post data
|
|
1553
|
+
*/
|
|
1554
|
+
destinationPostId: string;
|
|
1555
|
+
|
|
1556
|
+
/**
|
|
1557
|
+
* Body param: ID of the post to merge into the destination post
|
|
1558
|
+
*/
|
|
1559
|
+
sourcePostId: string;
|
|
1573
1560
|
|
|
1574
1561
|
/**
|
|
1575
1562
|
* Header param: API version for this request. Defaults to your organization's
|
|
1576
1563
|
* configured API version if not specified.
|
|
1577
1564
|
*/
|
|
1578
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1565
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1579
1566
|
}
|
|
1580
1567
|
|
|
1581
1568
|
export interface PostSearchParams {
|
|
@@ -1641,7 +1628,20 @@ export interface PostSearchParams {
|
|
|
1641
1628
|
* Header param: API version for this request. Defaults to your organization's
|
|
1642
1629
|
* configured API version if not specified.
|
|
1643
1630
|
*/
|
|
1644
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1631
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1632
|
+
}
|
|
1633
|
+
|
|
1634
|
+
export interface PostUnmergeParams {
|
|
1635
|
+
/**
|
|
1636
|
+
* Body param: ID of the merged post to restore
|
|
1637
|
+
*/
|
|
1638
|
+
postId: string;
|
|
1639
|
+
|
|
1640
|
+
/**
|
|
1641
|
+
* Header param: API version for this request. Defaults to your organization's
|
|
1642
|
+
* configured API version if not specified.
|
|
1643
|
+
*/
|
|
1644
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1645
1645
|
}
|
|
1646
1646
|
|
|
1647
1647
|
Posts.Voters = Voters;
|
|
@@ -1658,14 +1658,14 @@ export declare namespace Posts {
|
|
|
1658
1658
|
type PostDeleteResponse as PostDeleteResponse,
|
|
1659
1659
|
type PostSearchResponse as PostSearchResponse,
|
|
1660
1660
|
type PostsCursorPage as PostsCursorPage,
|
|
1661
|
-
type PostListParams as PostListParams,
|
|
1662
1661
|
type PostCreateParams as PostCreateParams,
|
|
1663
1662
|
type PostRetrieveParams as PostRetrieveParams,
|
|
1664
1663
|
type PostUpdateParams as PostUpdateParams,
|
|
1664
|
+
type PostListParams as PostListParams,
|
|
1665
1665
|
type PostDeleteParams as PostDeleteParams,
|
|
1666
1666
|
type PostMergeParams as PostMergeParams,
|
|
1667
|
-
type PostUnmergeParams as PostUnmergeParams,
|
|
1668
1667
|
type PostSearchParams as PostSearchParams,
|
|
1668
|
+
type PostUnmergeParams as PostUnmergeParams,
|
|
1669
1669
|
};
|
|
1670
1670
|
|
|
1671
1671
|
export {
|
|
@@ -340,7 +340,7 @@ export interface VoterListParams extends CursorPageParams {
|
|
|
340
340
|
* Header param: API version for this request. Defaults to your organization's
|
|
341
341
|
* configured API version if not specified.
|
|
342
342
|
*/
|
|
343
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
343
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
344
344
|
}
|
|
345
345
|
|
|
346
346
|
export interface VoterAddParams {
|
|
@@ -373,7 +373,7 @@ export interface VoterAddParams {
|
|
|
373
373
|
* Header param: API version for this request. Defaults to your organization's
|
|
374
374
|
* configured API version if not specified.
|
|
375
375
|
*/
|
|
376
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
376
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
377
377
|
}
|
|
378
378
|
|
|
379
379
|
export interface VoterRemoveParams {
|
|
@@ -396,7 +396,7 @@ export interface VoterRemoveParams {
|
|
|
396
396
|
* Header param: API version for this request. Defaults to your organization's
|
|
397
397
|
* configured API version if not specified.
|
|
398
398
|
*/
|
|
399
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
399
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
400
400
|
}
|
|
401
401
|
|
|
402
402
|
export declare namespace Voters {
|