featurebase-node 0.14.2 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/client.d.mts +5 -5
- package/client.d.mts.map +1 -1
- package/client.d.ts +5 -5
- package/client.d.ts.map +1 -1
- package/package.json +1 -1
- package/resources/audit-logs.d.mts +3 -3
- package/resources/audit-logs.d.mts.map +1 -1
- package/resources/audit-logs.d.ts +3 -3
- package/resources/audit-logs.d.ts.map +1 -1
- package/resources/changelogs/changelogs.d.mts +116 -116
- package/resources/changelogs/changelogs.d.mts.map +1 -1
- package/resources/changelogs/changelogs.d.ts +116 -116
- package/resources/changelogs/changelogs.d.ts.map +1 -1
- package/resources/changelogs/changelogs.js +74 -74
- package/resources/changelogs/changelogs.js.map +1 -1
- package/resources/changelogs/changelogs.mjs +74 -74
- package/resources/changelogs/changelogs.mjs.map +1 -1
- package/resources/changelogs/index.d.mts +1 -1
- package/resources/changelogs/index.d.mts.map +1 -1
- package/resources/changelogs/index.d.ts +1 -1
- package/resources/changelogs/index.d.ts.map +1 -1
- package/resources/changelogs/subscribers.d.mts +3 -3
- package/resources/changelogs/subscribers.d.mts.map +1 -1
- package/resources/changelogs/subscribers.d.ts +3 -3
- package/resources/changelogs/subscribers.d.ts.map +1 -1
- package/resources/conversation-attributes.d.mts +17 -17
- package/resources/conversation-attributes.d.mts.map +1 -1
- package/resources/conversation-attributes.d.ts +17 -17
- package/resources/conversation-attributes.d.ts.map +1 -1
- package/resources/conversation-attributes.js +19 -19
- package/resources/conversation-attributes.js.map +1 -1
- package/resources/conversation-attributes.mjs +19 -19
- package/resources/conversation-attributes.mjs.map +1 -1
- package/resources/feedback/boards.d.mts +19 -19
- package/resources/feedback/boards.d.mts.map +1 -1
- package/resources/feedback/boards.d.ts +19 -19
- package/resources/feedback/boards.d.ts.map +1 -1
- package/resources/feedback/boards.js +20 -20
- package/resources/feedback/boards.js.map +1 -1
- package/resources/feedback/boards.mjs +20 -20
- package/resources/feedback/boards.mjs.map +1 -1
- package/resources/feedback/comments.d.mts +113 -113
- package/resources/feedback/comments.d.mts.map +1 -1
- package/resources/feedback/comments.d.ts +113 -113
- package/resources/feedback/comments.d.ts.map +1 -1
- package/resources/feedback/comments.js +93 -93
- package/resources/feedback/comments.js.map +1 -1
- package/resources/feedback/comments.mjs +93 -93
- package/resources/feedback/comments.mjs.map +1 -1
- package/resources/feedback/custom-fields.d.mts +36 -36
- package/resources/feedback/custom-fields.d.mts.map +1 -1
- package/resources/feedback/custom-fields.d.ts +36 -36
- package/resources/feedback/custom-fields.d.ts.map +1 -1
- package/resources/feedback/custom-fields.js +36 -36
- package/resources/feedback/custom-fields.js.map +1 -1
- package/resources/feedback/custom-fields.mjs +36 -36
- package/resources/feedback/custom-fields.mjs.map +1 -1
- package/resources/feedback/feedback.d.mts +6 -6
- package/resources/feedback/feedback.d.mts.map +1 -1
- package/resources/feedback/feedback.d.ts +6 -6
- package/resources/feedback/feedback.d.ts.map +1 -1
- package/resources/feedback/feedback.js.map +1 -1
- package/resources/feedback/feedback.mjs.map +1 -1
- package/resources/feedback/index.d.mts +5 -5
- package/resources/feedback/index.d.mts.map +1 -1
- package/resources/feedback/index.d.ts +5 -5
- package/resources/feedback/index.d.ts.map +1 -1
- package/resources/feedback/index.js.map +1 -1
- package/resources/feedback/index.mjs.map +1 -1
- package/resources/feedback/post-statuses.d.mts +20 -20
- package/resources/feedback/post-statuses.d.mts.map +1 -1
- package/resources/feedback/post-statuses.d.ts +20 -20
- package/resources/feedback/post-statuses.d.ts.map +1 -1
- package/resources/feedback/post-statuses.js +23 -23
- package/resources/feedback/post-statuses.js.map +1 -1
- package/resources/feedback/post-statuses.mjs +23 -23
- package/resources/feedback/post-statuses.mjs.map +1 -1
- package/resources/feedback/posts/index.d.mts +1 -1
- package/resources/feedback/posts/index.d.mts.map +1 -1
- package/resources/feedback/posts/index.d.ts +1 -1
- package/resources/feedback/posts/index.d.ts.map +1 -1
- package/resources/feedback/posts/index.js.map +1 -1
- package/resources/feedback/posts/index.mjs.map +1 -1
- package/resources/feedback/posts/posts.d.mts +169 -102
- package/resources/feedback/posts/posts.d.mts.map +1 -1
- package/resources/feedback/posts/posts.d.ts +169 -102
- package/resources/feedback/posts/posts.d.ts.map +1 -1
- package/resources/feedback/posts/posts.js +144 -75
- package/resources/feedback/posts/posts.js.map +1 -1
- package/resources/feedback/posts/posts.mjs +144 -75
- package/resources/feedback/posts/posts.mjs.map +1 -1
- package/resources/feedback/posts/voters.d.mts +3 -3
- package/resources/feedback/posts/voters.d.mts.map +1 -1
- package/resources/feedback/posts/voters.d.ts +3 -3
- package/resources/feedback/posts/voters.d.ts.map +1 -1
- package/resources/help-center/articles.d.mts +213 -97
- package/resources/help-center/articles.d.mts.map +1 -1
- package/resources/help-center/articles.d.ts +213 -97
- package/resources/help-center/articles.d.ts.map +1 -1
- package/resources/help-center/articles.js +73 -73
- package/resources/help-center/articles.js.map +1 -1
- package/resources/help-center/articles.mjs +73 -73
- package/resources/help-center/articles.mjs.map +1 -1
- package/resources/help-center/collections.d.mts +158 -71
- package/resources/help-center/collections.d.mts.map +1 -1
- package/resources/help-center/collections.d.ts +158 -71
- package/resources/help-center/collections.d.ts.map +1 -1
- package/resources/help-center/collections.js +65 -65
- package/resources/help-center/collections.js.map +1 -1
- package/resources/help-center/collections.mjs +65 -65
- package/resources/help-center/collections.mjs.map +1 -1
- package/resources/help-center/help-center.d.mts +4 -4
- package/resources/help-center/help-center.d.mts.map +1 -1
- package/resources/help-center/help-center.d.ts +4 -4
- package/resources/help-center/help-center.d.ts.map +1 -1
- package/resources/help-center/help-centers.d.mts +77 -48
- package/resources/help-center/help-centers.d.mts.map +1 -1
- package/resources/help-center/help-centers.d.ts +77 -48
- package/resources/help-center/help-centers.d.ts.map +1 -1
- package/resources/help-center/help-centers.js +43 -43
- package/resources/help-center/help-centers.js.map +1 -1
- package/resources/help-center/help-centers.mjs +43 -43
- package/resources/help-center/help-centers.mjs.map +1 -1
- package/resources/help-center/index.d.mts +4 -4
- package/resources/help-center/index.d.mts.map +1 -1
- package/resources/help-center/index.d.ts +4 -4
- package/resources/help-center/index.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.d.mts +124 -124
- package/resources/help-center/redirect-rules.d.mts.map +1 -1
- package/resources/help-center/redirect-rules.d.ts +124 -124
- package/resources/help-center/redirect-rules.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.js +112 -112
- package/resources/help-center/redirect-rules.js.map +1 -1
- package/resources/help-center/redirect-rules.mjs +112 -112
- package/resources/help-center/redirect-rules.mjs.map +1 -1
- package/resources/index.d.mts +5 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +5 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/organization/admins.d.mts +26 -26
- package/resources/organization/admins.d.mts.map +1 -1
- package/resources/organization/admins.d.ts +26 -26
- package/resources/organization/admins.d.ts.map +1 -1
- package/resources/organization/admins.js +25 -25
- package/resources/organization/admins.js.map +1 -1
- package/resources/organization/admins.mjs +25 -25
- package/resources/organization/admins.mjs.map +1 -1
- package/resources/organization/brands.d.mts +52 -52
- package/resources/organization/brands.d.mts.map +1 -1
- package/resources/organization/brands.d.ts +52 -52
- package/resources/organization/brands.d.ts.map +1 -1
- package/resources/organization/brands.js +54 -54
- package/resources/organization/brands.js.map +1 -1
- package/resources/organization/brands.mjs +54 -54
- package/resources/organization/brands.mjs.map +1 -1
- package/resources/organization/index.d.mts +3 -3
- package/resources/organization/index.d.mts.map +1 -1
- package/resources/organization/index.d.ts +3 -3
- package/resources/organization/index.d.ts.map +1 -1
- package/resources/organization/organization.d.mts +3 -3
- package/resources/organization/organization.d.mts.map +1 -1
- package/resources/organization/organization.d.ts +3 -3
- package/resources/organization/organization.d.ts.map +1 -1
- package/resources/organization/teams.d.mts +47 -47
- package/resources/organization/teams.d.mts.map +1 -1
- package/resources/organization/teams.d.ts +47 -47
- package/resources/organization/teams.d.ts.map +1 -1
- package/resources/organization/teams.js +44 -44
- package/resources/organization/teams.js.map +1 -1
- package/resources/organization/teams.mjs +44 -44
- package/resources/organization/teams.mjs.map +1 -1
- package/resources/reports.d.mts +347 -180
- package/resources/reports.d.mts.map +1 -1
- package/resources/reports.d.ts +347 -180
- package/resources/reports.d.ts.map +1 -1
- package/resources/reports.js +124 -99
- package/resources/reports.js.map +1 -1
- package/resources/reports.mjs +124 -99
- package/resources/reports.mjs.map +1 -1
- package/resources/support/conversation-tags.d.mts +43 -43
- package/resources/support/conversation-tags.d.mts.map +1 -1
- package/resources/support/conversation-tags.d.ts +43 -43
- package/resources/support/conversation-tags.d.ts.map +1 -1
- package/resources/support/conversation-tags.js +32 -32
- package/resources/support/conversation-tags.js.map +1 -1
- package/resources/support/conversation-tags.mjs +32 -32
- package/resources/support/conversation-tags.mjs.map +1 -1
- package/resources/support/conversations/conversations.d.mts +402 -351
- package/resources/support/conversations/conversations.d.mts.map +1 -1
- package/resources/support/conversations/conversations.d.ts +402 -351
- package/resources/support/conversations/conversations.d.ts.map +1 -1
- package/resources/support/conversations/conversations.js +340 -295
- package/resources/support/conversations/conversations.js.map +1 -1
- package/resources/support/conversations/conversations.mjs +340 -295
- package/resources/support/conversations/conversations.mjs.map +1 -1
- package/resources/support/conversations/index.d.mts +1 -1
- package/resources/support/conversations/index.d.mts.map +1 -1
- package/resources/support/conversations/index.d.ts +1 -1
- package/resources/support/conversations/index.d.ts.map +1 -1
- package/resources/support/conversations/participants.d.mts +2 -2
- package/resources/support/conversations/participants.d.mts.map +1 -1
- package/resources/support/conversations/participants.d.ts +2 -2
- package/resources/support/conversations/participants.d.ts.map +1 -1
- package/resources/support/index.d.mts +3 -3
- package/resources/support/index.d.mts.map +1 -1
- package/resources/support/index.d.ts +3 -3
- package/resources/support/index.d.ts.map +1 -1
- package/resources/support/support.d.mts +3 -3
- package/resources/support/support.d.mts.map +1 -1
- package/resources/support/support.d.ts +3 -3
- package/resources/support/support.d.ts.map +1 -1
- package/resources/support/tickets/categories.d.mts +20 -20
- package/resources/support/tickets/categories.d.mts.map +1 -1
- package/resources/support/tickets/categories.d.ts +20 -20
- package/resources/support/tickets/categories.d.ts.map +1 -1
- package/resources/support/tickets/categories.js +25 -25
- package/resources/support/tickets/categories.js.map +1 -1
- package/resources/support/tickets/categories.mjs +25 -25
- package/resources/support/tickets/categories.mjs.map +1 -1
- package/resources/support/tickets/custom-fields.d.mts +22 -22
- package/resources/support/tickets/custom-fields.d.mts.map +1 -1
- package/resources/support/tickets/custom-fields.d.ts +22 -22
- package/resources/support/tickets/custom-fields.d.ts.map +1 -1
- package/resources/support/tickets/custom-fields.js +19 -19
- package/resources/support/tickets/custom-fields.js.map +1 -1
- package/resources/support/tickets/custom-fields.mjs +19 -19
- package/resources/support/tickets/custom-fields.mjs.map +1 -1
- package/resources/support/tickets/index.d.mts +4 -4
- package/resources/support/tickets/index.d.mts.map +1 -1
- package/resources/support/tickets/index.d.ts +4 -4
- package/resources/support/tickets/index.d.ts.map +1 -1
- package/resources/support/tickets/statuses.d.mts +19 -19
- package/resources/support/tickets/statuses.d.mts.map +1 -1
- package/resources/support/tickets/statuses.d.ts +19 -19
- package/resources/support/tickets/statuses.d.ts.map +1 -1
- package/resources/support/tickets/statuses.js +21 -21
- package/resources/support/tickets/statuses.js.map +1 -1
- package/resources/support/tickets/statuses.mjs +21 -21
- package/resources/support/tickets/statuses.mjs.map +1 -1
- package/resources/support/tickets/tickets.d.mts +75 -75
- package/resources/support/tickets/tickets.d.mts.map +1 -1
- package/resources/support/tickets/tickets.d.ts +75 -75
- package/resources/support/tickets/tickets.d.ts.map +1 -1
- package/resources/support/tickets/tickets.js +44 -44
- package/resources/support/tickets/tickets.js.map +1 -1
- package/resources/support/tickets/tickets.mjs +44 -44
- package/resources/support/tickets/tickets.mjs.map +1 -1
- package/resources/surveys.d.mts +43 -43
- package/resources/surveys.d.mts.map +1 -1
- package/resources/surveys.d.ts +43 -43
- package/resources/surveys.d.ts.map +1 -1
- package/resources/surveys.js +44 -44
- package/resources/surveys.js.map +1 -1
- package/resources/surveys.mjs +44 -44
- package/resources/surveys.mjs.map +1 -1
- package/resources/users/companies/companies.d.mts +121 -130
- package/resources/users/companies/companies.d.mts.map +1 -1
- package/resources/users/companies/companies.d.ts +121 -130
- package/resources/users/companies/companies.d.ts.map +1 -1
- package/resources/users/companies/companies.js +125 -125
- package/resources/users/companies/companies.js.map +1 -1
- package/resources/users/companies/companies.mjs +125 -125
- package/resources/users/companies/companies.mjs.map +1 -1
- package/resources/users/companies/contacts.d.mts +3 -3
- package/resources/users/companies/contacts.d.mts.map +1 -1
- package/resources/users/companies/contacts.d.ts +3 -3
- package/resources/users/companies/contacts.d.ts.map +1 -1
- package/resources/users/companies/index.d.mts +1 -1
- package/resources/users/companies/index.d.mts.map +1 -1
- package/resources/users/companies/index.d.ts +1 -1
- package/resources/users/companies/index.d.ts.map +1 -1
- package/resources/users/contacts/by-user-id/by-user-id.d.mts +2 -2
- package/resources/users/contacts/by-user-id/by-user-id.d.mts.map +1 -1
- package/resources/users/contacts/by-user-id/by-user-id.d.ts +2 -2
- package/resources/users/contacts/by-user-id/by-user-id.d.ts.map +1 -1
- package/resources/users/contacts/by-user-id/email-preferences.d.mts +2 -2
- package/resources/users/contacts/by-user-id/email-preferences.d.mts.map +1 -1
- package/resources/users/contacts/by-user-id/email-preferences.d.ts +2 -2
- package/resources/users/contacts/by-user-id/email-preferences.d.ts.map +1 -1
- package/resources/users/contacts/contacts.d.mts +249 -235
- package/resources/users/contacts/contacts.d.mts.map +1 -1
- package/resources/users/contacts/contacts.d.ts +249 -235
- package/resources/users/contacts/contacts.d.ts.map +1 -1
- package/resources/users/contacts/contacts.js +211 -184
- package/resources/users/contacts/contacts.js.map +1 -1
- package/resources/users/contacts/contacts.mjs +211 -184
- package/resources/users/contacts/contacts.mjs.map +1 -1
- package/resources/users/contacts/email-preferences.d.mts +2 -2
- package/resources/users/contacts/email-preferences.d.mts.map +1 -1
- package/resources/users/contacts/email-preferences.d.ts +2 -2
- package/resources/users/contacts/email-preferences.d.ts.map +1 -1
- package/resources/users/contacts/index.d.mts +1 -1
- package/resources/users/contacts/index.d.mts.map +1 -1
- package/resources/users/contacts/index.d.ts +1 -1
- package/resources/users/contacts/index.d.ts.map +1 -1
- package/resources/users/index.d.mts +2 -2
- package/resources/users/index.d.mts.map +1 -1
- package/resources/users/index.d.ts +2 -2
- package/resources/users/index.d.ts.map +1 -1
- package/resources/users/users.d.mts +2 -2
- package/resources/users/users.d.mts.map +1 -1
- package/resources/users/users.d.ts +2 -2
- package/resources/users/users.d.ts.map +1 -1
- package/resources/webhooks.d.mts +83 -83
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +83 -83
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +77 -77
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +77 -77
- package/resources/webhooks.mjs.map +1 -1
- package/src/client.ts +6 -6
- package/src/resources/audit-logs.ts +7 -1
- package/src/resources/changelogs/changelogs.ts +320 -175
- package/src/resources/changelogs/index.ts +1 -1
- package/src/resources/changelogs/subscribers.ts +31 -2
- package/src/resources/conversation-attributes.ts +34 -34
- package/src/resources/feedback/boards.ts +30 -30
- package/src/resources/feedback/comments.ts +137 -137
- package/src/resources/feedback/custom-fields.ts +46 -46
- package/src/resources/feedback/feedback.ts +9 -5
- package/src/resources/feedback/index.ts +7 -5
- package/src/resources/feedback/post-statuses.ts +33 -33
- package/src/resources/feedback/posts/index.ts +3 -1
- package/src/resources/feedback/posts/posts.ts +232 -128
- package/src/resources/feedback/posts/voters.ts +3 -3
- package/src/resources/help-center/articles.ts +631 -109
- package/src/resources/help-center/collections.ts +349 -88
- package/src/resources/help-center/help-center.ts +5 -5
- package/src/resources/help-center/help-centers.ts +202 -57
- package/src/resources/help-center/index.ts +5 -5
- package/src/resources/help-center/redirect-rules.ts +294 -178
- package/src/resources/index.ts +6 -6
- package/src/resources/organization/admins.ts +36 -36
- package/src/resources/organization/brands.ts +68 -68
- package/src/resources/organization/index.ts +3 -3
- package/src/resources/organization/organization.ts +3 -3
- package/src/resources/organization/teams.ts +54 -54
- package/src/resources/reports.ts +454 -232
- package/src/resources/support/conversation-tags.ts +62 -62
- package/src/resources/support/conversations/conversations.ts +489 -438
- package/src/resources/support/conversations/index.ts +4 -4
- package/src/resources/support/conversations/participants.ts +2 -2
- package/src/resources/support/index.ts +7 -7
- package/src/resources/support/support.ts +7 -7
- package/src/resources/support/tickets/categories.ts +35 -35
- package/src/resources/support/tickets/custom-fields.ts +29 -29
- package/src/resources/support/tickets/index.ts +4 -4
- package/src/resources/support/tickets/statuses.ts +31 -31
- package/src/resources/support/tickets/tickets.ts +101 -101
- package/src/resources/surveys.ts +60 -60
- package/src/resources/users/companies/companies.ts +158 -172
- package/src/resources/users/companies/contacts.ts +3 -3
- package/src/resources/users/companies/index.ts +2 -2
- package/src/resources/users/contacts/by-user-id/by-user-id.ts +2 -2
- package/src/resources/users/contacts/by-user-id/email-preferences.ts +2 -2
- package/src/resources/users/contacts/contacts.ts +284 -280
- package/src/resources/users/contacts/email-preferences.ts +2 -2
- package/src/resources/users/contacts/index.ts +3 -3
- package/src/resources/users/index.ts +5 -5
- package/src/resources/users/users.ts +5 -5
- package/src/resources/webhooks.ts +106 -100
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -23,54 +23,6 @@ export class Tickets extends APIResource {
|
|
|
23
23
|
categories: CategoriesAPI.Categories = new CategoriesAPI.Categories(this._client);
|
|
24
24
|
statuses: StatusesAPI.Statuses = new StatusesAPI.Statuses(this._client);
|
|
25
25
|
|
|
26
|
-
/**
|
|
27
|
-
* Returns a list of tickets in your organization using cursor-based pagination.
|
|
28
|
-
*
|
|
29
|
-
* ### Query Parameters
|
|
30
|
-
*
|
|
31
|
-
* | Parameter | Type | Description |
|
|
32
|
-
* | ------------------- | -------- | ---------------------------------------------------------------- |
|
|
33
|
-
* | `limit` | number | Number of tickets to return (1-100, default 10) |
|
|
34
|
-
* | `cursor` | string | Cursor from previous response for pagination |
|
|
35
|
-
* | `ticketCategoryIds` | string[] | Filter by ticket category IDs |
|
|
36
|
-
* | `statusIds` | string[] | Filter by status IDs |
|
|
37
|
-
* | `q` | string | Search query |
|
|
38
|
-
* | `assigneeId` | string | Filter by assignee ID |
|
|
39
|
-
* | `categoryType` | string | Filter by category type: "customer", "tracker", or "back-office" |
|
|
40
|
-
* | `sortBy` | string | Sort field: "date" (default), "recent", or "ticketNumber" |
|
|
41
|
-
* | `sortOrder` | string | Sort direction: "asc" or "desc" (default) |
|
|
42
|
-
*
|
|
43
|
-
* ### Response
|
|
44
|
-
*
|
|
45
|
-
* Returns a list object with `data` (array of ticket objects) and `nextCursor`.
|
|
46
|
-
*
|
|
47
|
-
* @example
|
|
48
|
-
* ```ts
|
|
49
|
-
* // Automatically fetches more pages as needed.
|
|
50
|
-
* for await (const ticket of client.support.tickets.list()) {
|
|
51
|
-
* // ...
|
|
52
|
-
* }
|
|
53
|
-
* ```
|
|
54
|
-
*/
|
|
55
|
-
list(
|
|
56
|
-
params: TicketListParams | null | undefined = {},
|
|
57
|
-
options?: RequestOptions,
|
|
58
|
-
): PagePromise<TicketsCursorPage, Ticket> {
|
|
59
|
-
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
60
|
-
return this._client.getAPIList('/v2/tickets', CursorPage<Ticket>, {
|
|
61
|
-
query,
|
|
62
|
-
...options,
|
|
63
|
-
headers: buildHeaders([
|
|
64
|
-
{
|
|
65
|
-
...(featurebaseVersion?.toString() != null ?
|
|
66
|
-
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
67
|
-
: undefined),
|
|
68
|
-
},
|
|
69
|
-
options?.headers,
|
|
70
|
-
]),
|
|
71
|
-
});
|
|
72
|
-
}
|
|
73
|
-
|
|
74
26
|
/**
|
|
75
27
|
* Creates a new ticket.
|
|
76
28
|
*
|
|
@@ -248,6 +200,54 @@ export class Tickets extends APIResource {
|
|
|
248
200
|
});
|
|
249
201
|
}
|
|
250
202
|
|
|
203
|
+
/**
|
|
204
|
+
* Returns a list of tickets in your organization using cursor-based pagination.
|
|
205
|
+
*
|
|
206
|
+
* ### Query Parameters
|
|
207
|
+
*
|
|
208
|
+
* | Parameter | Type | Description |
|
|
209
|
+
* | ------------------- | -------- | ---------------------------------------------------------------- |
|
|
210
|
+
* | `limit` | number | Number of tickets to return (1-100, default 10) |
|
|
211
|
+
* | `cursor` | string | Cursor from previous response for pagination |
|
|
212
|
+
* | `ticketCategoryIds` | string[] | Filter by ticket category IDs |
|
|
213
|
+
* | `statusIds` | string[] | Filter by status IDs |
|
|
214
|
+
* | `q` | string | Search query |
|
|
215
|
+
* | `assigneeId` | string | Filter by assignee ID |
|
|
216
|
+
* | `categoryType` | string | Filter by category type: "customer", "tracker", or "back-office" |
|
|
217
|
+
* | `sortBy` | string | Sort field: "date" (default), "recent", or "ticketNumber" |
|
|
218
|
+
* | `sortOrder` | string | Sort direction: "asc" or "desc" (default) |
|
|
219
|
+
*
|
|
220
|
+
* ### Response
|
|
221
|
+
*
|
|
222
|
+
* Returns a list object with `data` (array of ticket objects) and `nextCursor`.
|
|
223
|
+
*
|
|
224
|
+
* @example
|
|
225
|
+
* ```ts
|
|
226
|
+
* // Automatically fetches more pages as needed.
|
|
227
|
+
* for await (const ticket of client.support.tickets.list()) {
|
|
228
|
+
* // ...
|
|
229
|
+
* }
|
|
230
|
+
* ```
|
|
231
|
+
*/
|
|
232
|
+
list(
|
|
233
|
+
params: TicketListParams | null | undefined = {},
|
|
234
|
+
options?: RequestOptions,
|
|
235
|
+
): PagePromise<TicketsCursorPage, Ticket> {
|
|
236
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
237
|
+
return this._client.getAPIList('/v2/tickets', CursorPage<Ticket>, {
|
|
238
|
+
query,
|
|
239
|
+
...options,
|
|
240
|
+
headers: buildHeaders([
|
|
241
|
+
{
|
|
242
|
+
...(featurebaseVersion?.toString() != null ?
|
|
243
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
244
|
+
: undefined),
|
|
245
|
+
},
|
|
246
|
+
options?.headers,
|
|
247
|
+
]),
|
|
248
|
+
});
|
|
249
|
+
}
|
|
250
|
+
|
|
251
251
|
/**
|
|
252
252
|
* Permanently deletes a ticket by its ticket number.
|
|
253
253
|
*
|
|
@@ -710,49 +710,6 @@ export interface TicketDeleteResponse {
|
|
|
710
710
|
object: 'ticket';
|
|
711
711
|
}
|
|
712
712
|
|
|
713
|
-
export interface TicketListParams extends CursorPageParams {
|
|
714
|
-
/**
|
|
715
|
-
* Query param
|
|
716
|
-
*/
|
|
717
|
-
assigneeId?: string;
|
|
718
|
-
|
|
719
|
-
/**
|
|
720
|
-
* Query param
|
|
721
|
-
*/
|
|
722
|
-
categoryType?: 'customer' | 'tracker' | 'back-office';
|
|
723
|
-
|
|
724
|
-
/**
|
|
725
|
-
* Query param
|
|
726
|
-
*/
|
|
727
|
-
q?: string;
|
|
728
|
-
|
|
729
|
-
/**
|
|
730
|
-
* Query param
|
|
731
|
-
*/
|
|
732
|
-
sortBy?: 'date' | 'recent' | 'ticketNumber';
|
|
733
|
-
|
|
734
|
-
/**
|
|
735
|
-
* Query param
|
|
736
|
-
*/
|
|
737
|
-
sortOrder?: 'asc' | 'desc';
|
|
738
|
-
|
|
739
|
-
/**
|
|
740
|
-
* Query param
|
|
741
|
-
*/
|
|
742
|
-
statusIds?: Array<string>;
|
|
743
|
-
|
|
744
|
-
/**
|
|
745
|
-
* Query param
|
|
746
|
-
*/
|
|
747
|
-
ticketCategoryIds?: Array<string>;
|
|
748
|
-
|
|
749
|
-
/**
|
|
750
|
-
* Header param: API version for this request. Defaults to your organization's
|
|
751
|
-
* configured API version if not specified.
|
|
752
|
-
*/
|
|
753
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
754
|
-
}
|
|
755
|
-
|
|
756
713
|
export interface TicketCreateParams {
|
|
757
714
|
/**
|
|
758
715
|
* Body param: Author to attribute the post to. If not provided, uses the
|
|
@@ -815,7 +772,7 @@ export interface TicketCreateParams {
|
|
|
815
772
|
* Header param: API version for this request. Defaults to your organization's
|
|
816
773
|
* configured API version if not specified.
|
|
817
774
|
*/
|
|
818
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
775
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
819
776
|
}
|
|
820
777
|
|
|
821
778
|
export interface TicketRetrieveParams {
|
|
@@ -823,7 +780,7 @@ export interface TicketRetrieveParams {
|
|
|
823
780
|
* API version for this request. Defaults to your organization's configured API
|
|
824
781
|
* version if not specified.
|
|
825
782
|
*/
|
|
826
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
783
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
827
784
|
}
|
|
828
785
|
|
|
829
786
|
export interface TicketUpdateParams {
|
|
@@ -876,7 +833,50 @@ export interface TicketUpdateParams {
|
|
|
876
833
|
* Header param: API version for this request. Defaults to your organization's
|
|
877
834
|
* configured API version if not specified.
|
|
878
835
|
*/
|
|
879
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
836
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
837
|
+
}
|
|
838
|
+
|
|
839
|
+
export interface TicketListParams extends CursorPageParams {
|
|
840
|
+
/**
|
|
841
|
+
* Query param
|
|
842
|
+
*/
|
|
843
|
+
assigneeId?: string;
|
|
844
|
+
|
|
845
|
+
/**
|
|
846
|
+
* Query param
|
|
847
|
+
*/
|
|
848
|
+
categoryType?: 'customer' | 'tracker' | 'back-office';
|
|
849
|
+
|
|
850
|
+
/**
|
|
851
|
+
* Query param
|
|
852
|
+
*/
|
|
853
|
+
q?: string;
|
|
854
|
+
|
|
855
|
+
/**
|
|
856
|
+
* Query param
|
|
857
|
+
*/
|
|
858
|
+
sortBy?: 'date' | 'recent' | 'ticketNumber';
|
|
859
|
+
|
|
860
|
+
/**
|
|
861
|
+
* Query param
|
|
862
|
+
*/
|
|
863
|
+
sortOrder?: 'asc' | 'desc';
|
|
864
|
+
|
|
865
|
+
/**
|
|
866
|
+
* Query param
|
|
867
|
+
*/
|
|
868
|
+
statusIds?: Array<string>;
|
|
869
|
+
|
|
870
|
+
/**
|
|
871
|
+
* Query param
|
|
872
|
+
*/
|
|
873
|
+
ticketCategoryIds?: Array<string>;
|
|
874
|
+
|
|
875
|
+
/**
|
|
876
|
+
* Header param: API version for this request. Defaults to your organization's
|
|
877
|
+
* configured API version if not specified.
|
|
878
|
+
*/
|
|
879
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
880
880
|
}
|
|
881
881
|
|
|
882
882
|
export interface TicketDeleteParams {
|
|
@@ -884,7 +884,7 @@ export interface TicketDeleteParams {
|
|
|
884
884
|
* API version for this request. Defaults to your organization's configured API
|
|
885
885
|
* version if not specified.
|
|
886
886
|
*/
|
|
887
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
887
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
888
888
|
}
|
|
889
889
|
|
|
890
890
|
export type TicketReplyParams = TicketReplyParams.Variant0 | TicketReplyParams.Variant1;
|
|
@@ -935,7 +935,7 @@ export declare namespace TicketReplyParams {
|
|
|
935
935
|
* Header param: API version for this request. Defaults to your organization's
|
|
936
936
|
* configured API version if not specified.
|
|
937
937
|
*/
|
|
938
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
938
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
939
939
|
}
|
|
940
940
|
|
|
941
941
|
export interface Variant1 {
|
|
@@ -978,7 +978,7 @@ export declare namespace TicketReplyParams {
|
|
|
978
978
|
* Header param: API version for this request. Defaults to your organization's
|
|
979
979
|
* configured API version if not specified.
|
|
980
980
|
*/
|
|
981
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
981
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
982
982
|
}
|
|
983
983
|
}
|
|
984
984
|
|
|
@@ -992,31 +992,31 @@ export declare namespace Tickets {
|
|
|
992
992
|
type Ticket as Ticket,
|
|
993
993
|
type TicketDeleteResponse as TicketDeleteResponse,
|
|
994
994
|
type TicketsCursorPage as TicketsCursorPage,
|
|
995
|
-
type TicketListParams as TicketListParams,
|
|
996
995
|
type TicketCreateParams as TicketCreateParams,
|
|
997
996
|
type TicketRetrieveParams as TicketRetrieveParams,
|
|
998
997
|
type TicketUpdateParams as TicketUpdateParams,
|
|
998
|
+
type TicketListParams as TicketListParams,
|
|
999
999
|
type TicketDeleteParams as TicketDeleteParams,
|
|
1000
1000
|
type TicketReplyParams as TicketReplyParams,
|
|
1001
1001
|
};
|
|
1002
1002
|
|
|
1003
1003
|
export {
|
|
1004
1004
|
CustomFields as CustomFields,
|
|
1005
|
-
type CustomFieldListParams as CustomFieldListParams,
|
|
1006
1005
|
type CustomFieldRetrieveParams as CustomFieldRetrieveParams,
|
|
1006
|
+
type CustomFieldListParams as CustomFieldListParams,
|
|
1007
1007
|
};
|
|
1008
1008
|
|
|
1009
1009
|
export {
|
|
1010
1010
|
Categories as Categories,
|
|
1011
1011
|
type CategoryListResponse as CategoryListResponse,
|
|
1012
|
-
type CategoryListParams as CategoryListParams,
|
|
1013
1012
|
type CategoryRetrieveParams as CategoryRetrieveParams,
|
|
1013
|
+
type CategoryListParams as CategoryListParams,
|
|
1014
1014
|
};
|
|
1015
1015
|
|
|
1016
1016
|
export {
|
|
1017
1017
|
Statuses as Statuses,
|
|
1018
1018
|
type StatusListResponse as StatusListResponse,
|
|
1019
|
-
type StatusListParams as StatusListParams,
|
|
1020
1019
|
type StatusRetrieveParams as StatusRetrieveParams,
|
|
1020
|
+
type StatusListParams as StatusListParams,
|
|
1021
1021
|
};
|
|
1022
1022
|
}
|
package/src/resources/surveys.ts
CHANGED
|
@@ -14,44 +14,45 @@ import { path } from '../internal/utils/path';
|
|
|
14
14
|
*/
|
|
15
15
|
export class Surveys extends APIResource {
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
* ### Query Parameters
|
|
20
|
-
*
|
|
21
|
-
* - `limit` - Number of items to return (1-100, default 10)
|
|
22
|
-
* - `cursor` - Cursor for pagination
|
|
23
|
-
* - `type` - Filter by survey page type (text, link, rating, multiple-choice)
|
|
24
|
-
* - `isActive` - Filter by active status
|
|
25
|
-
*
|
|
26
|
-
* ### Response Format
|
|
27
|
-
*
|
|
28
|
-
* Returns a list object with:
|
|
17
|
+
* Retrieves a single survey by its unique identifier.
|
|
29
18
|
*
|
|
30
|
-
*
|
|
31
|
-
* - `data` - Array of survey objects
|
|
32
|
-
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
19
|
+
* Returns the survey object if found in your organization.
|
|
33
20
|
*
|
|
34
|
-
* ###
|
|
21
|
+
* ### Response
|
|
35
22
|
*
|
|
36
|
-
*
|
|
23
|
+
* Returns a survey object with:
|
|
37
24
|
*
|
|
38
25
|
* - `id` - Unique identifier
|
|
39
26
|
* - `title` - Survey title
|
|
40
27
|
* - `description` - Survey description
|
|
41
28
|
* - `isActive` - Whether the survey is active
|
|
42
29
|
* - `responseCount` - Number of responses received
|
|
43
|
-
* - `targeting` - Targeting configuration
|
|
30
|
+
* - `targeting` - Targeting configuration
|
|
44
31
|
* - `pages` - Array of survey pages/questions
|
|
45
32
|
* - `createdAt` - ISO 8601 timestamp when created
|
|
46
33
|
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
34
|
+
*
|
|
35
|
+
* ### Survey Pages
|
|
36
|
+
*
|
|
37
|
+
* Each page represents a question or screen in the survey:
|
|
38
|
+
*
|
|
39
|
+
* - `type` - Page type (text, link, rating, multiple-choice)
|
|
40
|
+
* - `title` - Question title
|
|
41
|
+
* - `description` - Optional description
|
|
42
|
+
* - `logic` - Conditional logic rules
|
|
43
|
+
* - `defaultAction` - Default action when no logic matches
|
|
44
|
+
*
|
|
45
|
+
* ### Errors
|
|
46
|
+
*
|
|
47
|
+
* - `404` - Survey not found in your organization
|
|
47
48
|
*/
|
|
48
|
-
|
|
49
|
-
|
|
49
|
+
retrieve(
|
|
50
|
+
id: string,
|
|
51
|
+
params: SurveyRetrieveParams | null | undefined = {},
|
|
50
52
|
options?: RequestOptions,
|
|
51
|
-
):
|
|
52
|
-
const { 'Featurebase-Version': featurebaseVersion
|
|
53
|
-
return this._client.
|
|
54
|
-
query,
|
|
53
|
+
): APIPromise<Survey> {
|
|
54
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
55
|
+
return this._client.get(path`/v2/surveys/${id}`, {
|
|
55
56
|
...options,
|
|
56
57
|
headers: buildHeaders([
|
|
57
58
|
{
|
|
@@ -65,45 +66,44 @@ export class Surveys extends APIResource {
|
|
|
65
66
|
}
|
|
66
67
|
|
|
67
68
|
/**
|
|
68
|
-
*
|
|
69
|
+
* Returns all surveys configured in your Featurebase organization.
|
|
69
70
|
*
|
|
70
|
-
*
|
|
71
|
+
* ### Query Parameters
|
|
71
72
|
*
|
|
72
|
-
*
|
|
73
|
+
* - `limit` - Number of items to return (1-100, default 10)
|
|
74
|
+
* - `cursor` - Cursor for pagination
|
|
75
|
+
* - `type` - Filter by survey page type (text, link, rating, multiple-choice)
|
|
76
|
+
* - `isActive` - Filter by active status
|
|
73
77
|
*
|
|
74
|
-
*
|
|
78
|
+
* ### Response Format
|
|
79
|
+
*
|
|
80
|
+
* Returns a list object with:
|
|
81
|
+
*
|
|
82
|
+
* - `object` - Always "list"
|
|
83
|
+
* - `data` - Array of survey objects
|
|
84
|
+
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
85
|
+
*
|
|
86
|
+
* ### Survey Object
|
|
87
|
+
*
|
|
88
|
+
* Each survey includes:
|
|
75
89
|
*
|
|
76
90
|
* - `id` - Unique identifier
|
|
77
91
|
* - `title` - Survey title
|
|
78
92
|
* - `description` - Survey description
|
|
79
93
|
* - `isActive` - Whether the survey is active
|
|
80
94
|
* - `responseCount` - Number of responses received
|
|
81
|
-
* - `targeting` - Targeting configuration
|
|
95
|
+
* - `targeting` - Targeting configuration (segments, URLs, CSS selectors)
|
|
82
96
|
* - `pages` - Array of survey pages/questions
|
|
83
97
|
* - `createdAt` - ISO 8601 timestamp when created
|
|
84
98
|
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
85
|
-
*
|
|
86
|
-
* ### Survey Pages
|
|
87
|
-
*
|
|
88
|
-
* Each page represents a question or screen in the survey:
|
|
89
|
-
*
|
|
90
|
-
* - `type` - Page type (text, link, rating, multiple-choice)
|
|
91
|
-
* - `title` - Question title
|
|
92
|
-
* - `description` - Optional description
|
|
93
|
-
* - `logic` - Conditional logic rules
|
|
94
|
-
* - `defaultAction` - Default action when no logic matches
|
|
95
|
-
*
|
|
96
|
-
* ### Errors
|
|
97
|
-
*
|
|
98
|
-
* - `404` - Survey not found in your organization
|
|
99
99
|
*/
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
params: SurveyRetrieveParams | null | undefined = {},
|
|
100
|
+
list(
|
|
101
|
+
params: SurveyListParams | null | undefined = {},
|
|
103
102
|
options?: RequestOptions,
|
|
104
|
-
):
|
|
105
|
-
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
106
|
-
return this._client.
|
|
103
|
+
): PagePromise<SurveysCursorPage, Survey> {
|
|
104
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
105
|
+
return this._client.getAPIList('/v2/surveys', CursorPage<Survey>, {
|
|
106
|
+
query,
|
|
107
107
|
...options,
|
|
108
108
|
headers: buildHeaders([
|
|
109
109
|
{
|
|
@@ -487,6 +487,14 @@ export namespace SurveyListResponsesResponse {
|
|
|
487
487
|
}
|
|
488
488
|
}
|
|
489
489
|
|
|
490
|
+
export interface SurveyRetrieveParams {
|
|
491
|
+
/**
|
|
492
|
+
* API version for this request. Defaults to your organization's configured API
|
|
493
|
+
* version if not specified.
|
|
494
|
+
*/
|
|
495
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
496
|
+
}
|
|
497
|
+
|
|
490
498
|
export interface SurveyListParams extends CursorPageParams {
|
|
491
499
|
/**
|
|
492
500
|
* Query param: Filter by active status
|
|
@@ -502,15 +510,7 @@ export interface SurveyListParams extends CursorPageParams {
|
|
|
502
510
|
* Header param: API version for this request. Defaults to your organization's
|
|
503
511
|
* configured API version if not specified.
|
|
504
512
|
*/
|
|
505
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
506
|
-
}
|
|
507
|
-
|
|
508
|
-
export interface SurveyRetrieveParams {
|
|
509
|
-
/**
|
|
510
|
-
* API version for this request. Defaults to your organization's configured API
|
|
511
|
-
* version if not specified.
|
|
512
|
-
*/
|
|
513
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
513
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
514
514
|
}
|
|
515
515
|
|
|
516
516
|
export interface SurveyListResponsesParams extends CursorPageParams {
|
|
@@ -523,7 +523,7 @@ export interface SurveyListResponsesParams extends CursorPageParams {
|
|
|
523
523
|
* Header param: API version for this request. Defaults to your organization's
|
|
524
524
|
* configured API version if not specified.
|
|
525
525
|
*/
|
|
526
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
526
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
527
527
|
}
|
|
528
528
|
|
|
529
529
|
export declare namespace Surveys {
|
|
@@ -533,8 +533,8 @@ export declare namespace Surveys {
|
|
|
533
533
|
type SurveyListResponsesResponse as SurveyListResponsesResponse,
|
|
534
534
|
type SurveysCursorPage as SurveysCursorPage,
|
|
535
535
|
type SurveyListResponsesResponsesCursorPage as SurveyListResponsesResponsesCursorPage,
|
|
536
|
-
type SurveyListParams as SurveyListParams,
|
|
537
536
|
type SurveyRetrieveParams as SurveyRetrieveParams,
|
|
537
|
+
type SurveyListParams as SurveyListParams,
|
|
538
538
|
type SurveyListResponsesParams as SurveyListResponsesParams,
|
|
539
539
|
};
|
|
540
540
|
}
|