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
|
@@ -11,22 +11,13 @@ import { path } from '../../internal/utils/path';
|
|
|
11
11
|
*/
|
|
12
12
|
export class CustomFields extends APIResource {
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* This endpoint returns all custom fields at once (typically a small list). No
|
|
17
|
-
* pagination is supported.
|
|
18
|
-
*
|
|
19
|
-
* ### Response Format
|
|
20
|
-
*
|
|
21
|
-
* Returns a list object with:
|
|
14
|
+
* Retrieves a single custom field by its unique identifier.
|
|
22
15
|
*
|
|
23
|
-
*
|
|
24
|
-
* - `data` - Array of custom field objects
|
|
25
|
-
* - `nextCursor` - Always null
|
|
16
|
+
* Returns the custom field object if found in your organization.
|
|
26
17
|
*
|
|
27
|
-
* ###
|
|
18
|
+
* ### Response
|
|
28
19
|
*
|
|
29
|
-
*
|
|
20
|
+
* Returns a custom field object with:
|
|
30
21
|
*
|
|
31
22
|
* - `id` - Unique field identifier
|
|
32
23
|
* - `label` - Field label displayed to users
|
|
@@ -37,27 +28,25 @@ export class CustomFields extends APIResource {
|
|
|
37
28
|
* - `internal` - Whether the field is for internal use only
|
|
38
29
|
* - `options` - Array of options (for select/multi-select fields)
|
|
39
30
|
*
|
|
40
|
-
* ###
|
|
31
|
+
* ### Errors
|
|
41
32
|
*
|
|
42
|
-
* - `
|
|
43
|
-
* - `number` - Numeric input
|
|
44
|
-
* - `select` - Single-choice dropdown
|
|
45
|
-
* - `multi-select` - Multiple-choice dropdown
|
|
46
|
-
* - `checkbox` - Boolean checkbox
|
|
47
|
-
* - `date` - Date picker
|
|
33
|
+
* - `404` - Custom field not found in your organization
|
|
48
34
|
*
|
|
49
35
|
* @example
|
|
50
36
|
* ```ts
|
|
51
|
-
* const
|
|
52
|
-
* await client.feedback.customFields.
|
|
37
|
+
* const customField =
|
|
38
|
+
* await client.feedback.customFields.retrieve(
|
|
39
|
+
* '65d26304b2e65b1e1278170c',
|
|
40
|
+
* );
|
|
53
41
|
* ```
|
|
54
42
|
*/
|
|
55
|
-
|
|
56
|
-
|
|
43
|
+
retrieve(
|
|
44
|
+
id: string,
|
|
45
|
+
params: CustomFieldRetrieveParams | null | undefined = {},
|
|
57
46
|
options?: RequestOptions,
|
|
58
|
-
): APIPromise<
|
|
47
|
+
): APIPromise<CustomField> {
|
|
59
48
|
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
60
|
-
return this._client.get(
|
|
49
|
+
return this._client.get(path`/v2/custom_fields/${id}`, {
|
|
61
50
|
...options,
|
|
62
51
|
headers: buildHeaders([
|
|
63
52
|
{
|
|
@@ -71,13 +60,22 @@ export class CustomFields extends APIResource {
|
|
|
71
60
|
}
|
|
72
61
|
|
|
73
62
|
/**
|
|
74
|
-
*
|
|
63
|
+
* Returns all custom fields configured in your organization.
|
|
75
64
|
*
|
|
76
|
-
*
|
|
65
|
+
* This endpoint returns all custom fields at once (typically a small list). No
|
|
66
|
+
* pagination is supported.
|
|
77
67
|
*
|
|
78
|
-
* ### Response
|
|
68
|
+
* ### Response Format
|
|
79
69
|
*
|
|
80
|
-
* Returns a
|
|
70
|
+
* Returns a list object with:
|
|
71
|
+
*
|
|
72
|
+
* - `object` - Always "list"
|
|
73
|
+
* - `data` - Array of custom field objects
|
|
74
|
+
* - `nextCursor` - Always null
|
|
75
|
+
*
|
|
76
|
+
* ### Custom Field Object
|
|
77
|
+
*
|
|
78
|
+
* Each custom field includes:
|
|
81
79
|
*
|
|
82
80
|
* - `id` - Unique field identifier
|
|
83
81
|
* - `label` - Field label displayed to users
|
|
@@ -88,25 +86,27 @@ export class CustomFields extends APIResource {
|
|
|
88
86
|
* - `internal` - Whether the field is for internal use only
|
|
89
87
|
* - `options` - Array of options (for select/multi-select fields)
|
|
90
88
|
*
|
|
91
|
-
* ###
|
|
89
|
+
* ### Field Types
|
|
92
90
|
*
|
|
93
|
-
* - `
|
|
91
|
+
* - `text` - Single line text input
|
|
92
|
+
* - `number` - Numeric input
|
|
93
|
+
* - `select` - Single-choice dropdown
|
|
94
|
+
* - `multi-select` - Multiple-choice dropdown
|
|
95
|
+
* - `checkbox` - Boolean checkbox
|
|
96
|
+
* - `date` - Date picker
|
|
94
97
|
*
|
|
95
98
|
* @example
|
|
96
99
|
* ```ts
|
|
97
|
-
* const
|
|
98
|
-
* await client.feedback.customFields.
|
|
99
|
-
* '65d26304b2e65b1e1278170c',
|
|
100
|
-
* );
|
|
100
|
+
* const customFieldList =
|
|
101
|
+
* await client.feedback.customFields.list();
|
|
101
102
|
* ```
|
|
102
103
|
*/
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
params: CustomFieldRetrieveParams | null | undefined = {},
|
|
104
|
+
list(
|
|
105
|
+
params: CustomFieldListParams | null | undefined = {},
|
|
106
106
|
options?: RequestOptions,
|
|
107
|
-
): APIPromise<
|
|
107
|
+
): APIPromise<CustomFieldList> {
|
|
108
108
|
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
109
|
-
return this._client.get(
|
|
109
|
+
return this._client.get('/v2/custom_fields', {
|
|
110
110
|
...options,
|
|
111
111
|
headers: buildHeaders([
|
|
112
112
|
{
|
|
@@ -245,27 +245,27 @@ export namespace CustomFieldList {
|
|
|
245
245
|
}
|
|
246
246
|
}
|
|
247
247
|
|
|
248
|
-
export interface
|
|
248
|
+
export interface CustomFieldRetrieveParams {
|
|
249
249
|
/**
|
|
250
250
|
* API version for this request. Defaults to your organization's configured API
|
|
251
251
|
* version if not specified.
|
|
252
252
|
*/
|
|
253
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
253
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
254
254
|
}
|
|
255
255
|
|
|
256
|
-
export interface
|
|
256
|
+
export interface CustomFieldListParams {
|
|
257
257
|
/**
|
|
258
258
|
* API version for this request. Defaults to your organization's configured API
|
|
259
259
|
* version if not specified.
|
|
260
260
|
*/
|
|
261
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
261
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
262
262
|
}
|
|
263
263
|
|
|
264
264
|
export declare namespace CustomFields {
|
|
265
265
|
export {
|
|
266
266
|
type CustomField as CustomField,
|
|
267
267
|
type CustomFieldList as CustomFieldList,
|
|
268
|
-
type CustomFieldListParams as CustomFieldListParams,
|
|
269
268
|
type CustomFieldRetrieveParams as CustomFieldRetrieveParams,
|
|
269
|
+
type CustomFieldListParams as CustomFieldListParams,
|
|
270
270
|
};
|
|
271
271
|
}
|
|
@@ -78,8 +78,8 @@ export declare namespace Feedback {
|
|
|
78
78
|
Boards as Boards,
|
|
79
79
|
type Board as Board,
|
|
80
80
|
type BoardListResponse as BoardListResponse,
|
|
81
|
-
type BoardListParams as BoardListParams,
|
|
82
81
|
type BoardRetrieveParams as BoardRetrieveParams,
|
|
82
|
+
type BoardListParams as BoardListParams,
|
|
83
83
|
};
|
|
84
84
|
|
|
85
85
|
export {
|
|
@@ -94,22 +94,22 @@ export declare namespace Feedback {
|
|
|
94
94
|
type PostDeleteResponse as PostDeleteResponse,
|
|
95
95
|
type PostSearchResponse as PostSearchResponse,
|
|
96
96
|
type PostsCursorPage as PostsCursorPage,
|
|
97
|
-
type PostListParams as PostListParams,
|
|
98
97
|
type PostCreateParams as PostCreateParams,
|
|
99
98
|
type PostRetrieveParams as PostRetrieveParams,
|
|
100
99
|
type PostUpdateParams as PostUpdateParams,
|
|
100
|
+
type PostListParams as PostListParams,
|
|
101
101
|
type PostDeleteParams as PostDeleteParams,
|
|
102
102
|
type PostMergeParams as PostMergeParams,
|
|
103
|
-
type PostUnmergeParams as PostUnmergeParams,
|
|
104
103
|
type PostSearchParams as PostSearchParams,
|
|
104
|
+
type PostUnmergeParams as PostUnmergeParams,
|
|
105
105
|
};
|
|
106
106
|
|
|
107
107
|
export {
|
|
108
108
|
PostStatuses as PostStatuses,
|
|
109
109
|
type PostStatus as PostStatus,
|
|
110
110
|
type PostStatusListResponse as PostStatusListResponse,
|
|
111
|
-
type PostStatusListParams as PostStatusListParams,
|
|
112
111
|
type PostStatusRetrieveParams as PostStatusRetrieveParams,
|
|
112
|
+
type PostStatusListParams as PostStatusListParams,
|
|
113
113
|
};
|
|
114
114
|
|
|
115
115
|
export {
|
|
@@ -120,10 +120,10 @@ export declare namespace Feedback {
|
|
|
120
120
|
type CommentDelete1Response as CommentDelete1Response,
|
|
121
121
|
type CommentSearchResponse as CommentSearchResponse,
|
|
122
122
|
type CommentsCursorPage as CommentsCursorPage,
|
|
123
|
-
type CommentListParams as CommentListParams,
|
|
124
123
|
type CommentCreateParams as CommentCreateParams,
|
|
125
124
|
type CommentRetrieveParams as CommentRetrieveParams,
|
|
126
125
|
type CommentUpdateParams as CommentUpdateParams,
|
|
126
|
+
type CommentListParams as CommentListParams,
|
|
127
127
|
type CommentDelete0Params as CommentDelete0Params,
|
|
128
128
|
type CommentDelete1Params as CommentDelete1Params,
|
|
129
129
|
type CommentSearchParams as CommentSearchParams,
|
|
@@ -133,7 +133,7 @@ export declare namespace Feedback {
|
|
|
133
133
|
CustomFields as CustomFields,
|
|
134
134
|
type CustomField as CustomField,
|
|
135
135
|
type CustomFieldList as CustomFieldList,
|
|
136
|
-
type CustomFieldListParams as CustomFieldListParams,
|
|
137
136
|
type CustomFieldRetrieveParams as CustomFieldRetrieveParams,
|
|
137
|
+
type CustomFieldListParams as CustomFieldListParams,
|
|
138
138
|
};
|
|
139
139
|
}
|
|
@@ -4,8 +4,8 @@ export {
|
|
|
4
4
|
Boards,
|
|
5
5
|
type Board,
|
|
6
6
|
type BoardListResponse,
|
|
7
|
-
type BoardListParams,
|
|
8
7
|
type BoardRetrieveParams,
|
|
8
|
+
type BoardListParams,
|
|
9
9
|
} from './boards';
|
|
10
10
|
export {
|
|
11
11
|
Comments,
|
|
@@ -14,10 +14,10 @@ export {
|
|
|
14
14
|
type CommentDelete0Response,
|
|
15
15
|
type CommentDelete1Response,
|
|
16
16
|
type CommentSearchResponse,
|
|
17
|
-
type CommentListParams,
|
|
18
17
|
type CommentCreateParams,
|
|
19
18
|
type CommentRetrieveParams,
|
|
20
19
|
type CommentUpdateParams,
|
|
20
|
+
type CommentListParams,
|
|
21
21
|
type CommentDelete0Params,
|
|
22
22
|
type CommentDelete1Params,
|
|
23
23
|
type CommentSearchParams,
|
|
@@ -27,16 +27,16 @@ export {
|
|
|
27
27
|
CustomFields,
|
|
28
28
|
type CustomField,
|
|
29
29
|
type CustomFieldList,
|
|
30
|
-
type CustomFieldListParams,
|
|
31
30
|
type CustomFieldRetrieveParams,
|
|
31
|
+
type CustomFieldListParams,
|
|
32
32
|
} from './custom-fields';
|
|
33
33
|
export { Feedback } from './feedback';
|
|
34
34
|
export {
|
|
35
35
|
PostStatuses,
|
|
36
36
|
type PostStatus,
|
|
37
37
|
type PostStatusListResponse,
|
|
38
|
-
type PostStatusListParams,
|
|
39
38
|
type PostStatusRetrieveParams,
|
|
39
|
+
type PostStatusListParams,
|
|
40
40
|
} from './post-statuses';
|
|
41
41
|
export {
|
|
42
42
|
Posts,
|
|
@@ -49,13 +49,13 @@ export {
|
|
|
49
49
|
type SearchFilterGroup,
|
|
50
50
|
type PostDeleteResponse,
|
|
51
51
|
type PostSearchResponse,
|
|
52
|
-
type PostListParams,
|
|
53
52
|
type PostCreateParams,
|
|
54
53
|
type PostRetrieveParams,
|
|
55
54
|
type PostUpdateParams,
|
|
55
|
+
type PostListParams,
|
|
56
56
|
type PostDeleteParams,
|
|
57
57
|
type PostMergeParams,
|
|
58
|
-
type PostUnmergeParams,
|
|
59
58
|
type PostSearchParams,
|
|
59
|
+
type PostUnmergeParams,
|
|
60
60
|
type PostsCursorPage,
|
|
61
61
|
} from './posts/index';
|
|
@@ -11,30 +11,26 @@ import { path } from '../../internal/utils/path';
|
|
|
11
11
|
*/
|
|
12
12
|
export class PostStatuses extends APIResource {
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* Post statuses define workflow stages for posts. Each status has:
|
|
17
|
-
*
|
|
18
|
-
* - A display name and color
|
|
19
|
-
* - A type indicating the workflow stage (reviewing, unstarted, active, completed,
|
|
20
|
-
* canceled)
|
|
21
|
-
* - A flag indicating if it's the default status for new posts
|
|
14
|
+
* Retrieves a single post status by its unique identifier.
|
|
22
15
|
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
16
|
+
* Returns the full post status object including name, color, type, and default
|
|
17
|
+
* flag.
|
|
25
18
|
*
|
|
26
19
|
* @example
|
|
27
20
|
* ```ts
|
|
28
|
-
* const
|
|
29
|
-
* await client.feedback.postStatuses.
|
|
21
|
+
* const postStatus =
|
|
22
|
+
* await client.feedback.postStatuses.retrieve(
|
|
23
|
+
* '507f1f77bcf86cd799439011',
|
|
24
|
+
* );
|
|
30
25
|
* ```
|
|
31
26
|
*/
|
|
32
|
-
|
|
33
|
-
|
|
27
|
+
retrieve(
|
|
28
|
+
id: string,
|
|
29
|
+
params: PostStatusRetrieveParams | null | undefined = {},
|
|
34
30
|
options?: RequestOptions,
|
|
35
|
-
): APIPromise<
|
|
31
|
+
): APIPromise<PostStatus> {
|
|
36
32
|
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
37
|
-
return this._client.get(
|
|
33
|
+
return this._client.get(path`/v2/post_statuses/${id}`, {
|
|
38
34
|
...options,
|
|
39
35
|
headers: buildHeaders([
|
|
40
36
|
{
|
|
@@ -48,26 +44,30 @@ export class PostStatuses extends APIResource {
|
|
|
48
44
|
}
|
|
49
45
|
|
|
50
46
|
/**
|
|
51
|
-
*
|
|
47
|
+
* Returns all post statuses for the authenticated organization.
|
|
52
48
|
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
49
|
+
* Post statuses define workflow stages for posts. Each status has:
|
|
50
|
+
*
|
|
51
|
+
* - A display name and color
|
|
52
|
+
* - A type indicating the workflow stage (reviewing, unstarted, active, completed,
|
|
53
|
+
* canceled)
|
|
54
|
+
* - A flag indicating if it's the default status for new posts
|
|
55
|
+
*
|
|
56
|
+
* This endpoint returns all post statuses without pagination. Organizations
|
|
57
|
+
* typically have a small number of statuses.
|
|
55
58
|
*
|
|
56
59
|
* @example
|
|
57
60
|
* ```ts
|
|
58
|
-
* const
|
|
59
|
-
* await client.feedback.postStatuses.
|
|
60
|
-
* '507f1f77bcf86cd799439011',
|
|
61
|
-
* );
|
|
61
|
+
* const postStatuses =
|
|
62
|
+
* await client.feedback.postStatuses.list();
|
|
62
63
|
* ```
|
|
63
64
|
*/
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
params: PostStatusRetrieveParams | null | undefined = {},
|
|
65
|
+
list(
|
|
66
|
+
params: PostStatusListParams | null | undefined = {},
|
|
67
67
|
options?: RequestOptions,
|
|
68
|
-
): APIPromise<
|
|
68
|
+
): APIPromise<PostStatusListResponse> {
|
|
69
69
|
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
70
|
-
return this._client.get(
|
|
70
|
+
return this._client.get('/v2/post_statuses', {
|
|
71
71
|
...options,
|
|
72
72
|
headers: buildHeaders([
|
|
73
73
|
{
|
|
@@ -115,27 +115,27 @@ export interface PostStatus {
|
|
|
115
115
|
|
|
116
116
|
export type PostStatusListResponse = Array<PostStatus>;
|
|
117
117
|
|
|
118
|
-
export interface
|
|
118
|
+
export interface PostStatusRetrieveParams {
|
|
119
119
|
/**
|
|
120
120
|
* API version for this request. Defaults to your organization's configured API
|
|
121
121
|
* version if not specified.
|
|
122
122
|
*/
|
|
123
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
123
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
124
124
|
}
|
|
125
125
|
|
|
126
|
-
export interface
|
|
126
|
+
export interface PostStatusListParams {
|
|
127
127
|
/**
|
|
128
128
|
* API version for this request. Defaults to your organization's configured API
|
|
129
129
|
* version if not specified.
|
|
130
130
|
*/
|
|
131
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
131
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
132
132
|
}
|
|
133
133
|
|
|
134
134
|
export declare namespace PostStatuses {
|
|
135
135
|
export {
|
|
136
136
|
type PostStatus as PostStatus,
|
|
137
137
|
type PostStatusListResponse as PostStatusListResponse,
|
|
138
|
-
type PostStatusListParams as PostStatusListParams,
|
|
139
138
|
type PostStatusRetrieveParams as PostStatusRetrieveParams,
|
|
139
|
+
type PostStatusListParams as PostStatusListParams,
|
|
140
140
|
};
|
|
141
141
|
}
|
|
@@ -11,14 +11,14 @@ export {
|
|
|
11
11
|
type SearchFilterGroup,
|
|
12
12
|
type PostDeleteResponse,
|
|
13
13
|
type PostSearchResponse,
|
|
14
|
-
type PostListParams,
|
|
15
14
|
type PostCreateParams,
|
|
16
15
|
type PostRetrieveParams,
|
|
17
16
|
type PostUpdateParams,
|
|
17
|
+
type PostListParams,
|
|
18
18
|
type PostDeleteParams,
|
|
19
19
|
type PostMergeParams,
|
|
20
|
-
type PostUnmergeParams,
|
|
21
20
|
type PostSearchParams,
|
|
21
|
+
type PostUnmergeParams,
|
|
22
22
|
type PostsCursorPage,
|
|
23
23
|
} from './posts';
|
|
24
24
|
export {
|