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
|
@@ -13,80 +13,6 @@ export class Changelogs extends APIResource {
|
|
|
13
13
|
super(...arguments);
|
|
14
14
|
this.subscribers = new SubscribersAPI.Subscribers(this._client);
|
|
15
15
|
}
|
|
16
|
-
/**
|
|
17
|
-
* Returns all changelogs for the authenticated organization.
|
|
18
|
-
*
|
|
19
|
-
* Changelogs are release notes and updates that keep users informed about new
|
|
20
|
-
* features, improvements, and bug fixes. Each changelog can have:
|
|
21
|
-
*
|
|
22
|
-
* - Multiple translations (locales)
|
|
23
|
-
* - Categories for organization
|
|
24
|
-
* - Featured images
|
|
25
|
-
* - Scheduled publishing
|
|
26
|
-
*
|
|
27
|
-
* ### Pagination
|
|
28
|
-
*
|
|
29
|
-
* This endpoint uses **cursor-based pagination**:
|
|
30
|
-
*
|
|
31
|
-
* - `limit` - Number of changelogs to return (1-100, default 10)
|
|
32
|
-
* - `cursor` - Opaque cursor from a previous response's `nextCursor` field
|
|
33
|
-
*
|
|
34
|
-
* **Example:** To paginate through results:
|
|
35
|
-
*
|
|
36
|
-
* 1. First request: `GET /v2/changelogs?limit=10`
|
|
37
|
-
* 2. If `nextCursor` is not null, use it for the next page
|
|
38
|
-
* 3. Next request: `GET /v2/changelogs?limit=10&cursor={nextCursor}`
|
|
39
|
-
*
|
|
40
|
-
* ### Response Format
|
|
41
|
-
*
|
|
42
|
-
* Returns a list object with:
|
|
43
|
-
*
|
|
44
|
-
* - `object` - Always "list"
|
|
45
|
-
* - `data` - Array of changelog objects
|
|
46
|
-
* - `nextCursor` - Cursor for the next page (null if no more results)
|
|
47
|
-
*
|
|
48
|
-
* ### Filtering
|
|
49
|
-
*
|
|
50
|
-
* Filter changelogs using query parameters:
|
|
51
|
-
*
|
|
52
|
-
* - `id` - Find a specific changelog by ID or slug
|
|
53
|
-
* - `q` - Search query for title/content
|
|
54
|
-
* - `categories` - Filter by category names
|
|
55
|
-
* - `locale` - Get changelogs in a specific locale (defaults to org default)
|
|
56
|
-
* - `state` - Filter by state: `live`, `draft`, or `all`
|
|
57
|
-
* - `startDate` - Include changelogs dated on or after this date
|
|
58
|
-
* - `endDate` - Include changelogs dated on or before this date
|
|
59
|
-
*
|
|
60
|
-
* ### Sorting
|
|
61
|
-
*
|
|
62
|
-
* Results are sorted by date (descending by default):
|
|
63
|
-
*
|
|
64
|
-
* - `sortBy` - Field to sort by (currently only `date`)
|
|
65
|
-
* - `sortOrder` - Sort direction: `asc` or `desc` (default: `desc`)
|
|
66
|
-
*
|
|
67
|
-
* @example
|
|
68
|
-
* ```ts
|
|
69
|
-
* // Automatically fetches more pages as needed.
|
|
70
|
-
* for await (const changelog of client.changelogs.list()) {
|
|
71
|
-
* // ...
|
|
72
|
-
* }
|
|
73
|
-
* ```
|
|
74
|
-
*/
|
|
75
|
-
list(params = {}, options) {
|
|
76
|
-
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
77
|
-
return this._client.getAPIList('/v2/changelogs', (CursorPage), {
|
|
78
|
-
query,
|
|
79
|
-
...options,
|
|
80
|
-
headers: buildHeaders([
|
|
81
|
-
{
|
|
82
|
-
...(featurebaseVersion?.toString() != null ?
|
|
83
|
-
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
84
|
-
: undefined),
|
|
85
|
-
},
|
|
86
|
-
options?.headers,
|
|
87
|
-
]),
|
|
88
|
-
});
|
|
89
|
-
}
|
|
90
16
|
/**
|
|
91
17
|
* Creates a new changelog for the authenticated organization.
|
|
92
18
|
*
|
|
@@ -250,6 +176,80 @@ export class Changelogs extends APIResource {
|
|
|
250
176
|
]),
|
|
251
177
|
});
|
|
252
178
|
}
|
|
179
|
+
/**
|
|
180
|
+
* Returns all changelogs for the authenticated organization.
|
|
181
|
+
*
|
|
182
|
+
* Changelogs are release notes and updates that keep users informed about new
|
|
183
|
+
* features, improvements, and bug fixes. Each changelog can have:
|
|
184
|
+
*
|
|
185
|
+
* - Multiple translations (locales)
|
|
186
|
+
* - Categories for organization
|
|
187
|
+
* - Featured images
|
|
188
|
+
* - Scheduled publishing
|
|
189
|
+
*
|
|
190
|
+
* ### Pagination
|
|
191
|
+
*
|
|
192
|
+
* This endpoint uses **cursor-based pagination**:
|
|
193
|
+
*
|
|
194
|
+
* - `limit` - Number of changelogs to return (1-100, default 10)
|
|
195
|
+
* - `cursor` - Opaque cursor from a previous response's `nextCursor` field
|
|
196
|
+
*
|
|
197
|
+
* **Example:** To paginate through results:
|
|
198
|
+
*
|
|
199
|
+
* 1. First request: `GET /v2/changelogs?limit=10`
|
|
200
|
+
* 2. If `nextCursor` is not null, use it for the next page
|
|
201
|
+
* 3. Next request: `GET /v2/changelogs?limit=10&cursor={nextCursor}`
|
|
202
|
+
*
|
|
203
|
+
* ### Response Format
|
|
204
|
+
*
|
|
205
|
+
* Returns a list object with:
|
|
206
|
+
*
|
|
207
|
+
* - `object` - Always "list"
|
|
208
|
+
* - `data` - Array of changelog objects
|
|
209
|
+
* - `nextCursor` - Cursor for the next page (null if no more results)
|
|
210
|
+
*
|
|
211
|
+
* ### Filtering
|
|
212
|
+
*
|
|
213
|
+
* Filter changelogs using query parameters:
|
|
214
|
+
*
|
|
215
|
+
* - `id` - Find a specific changelog by ID or slug
|
|
216
|
+
* - `q` - Search query for title/content
|
|
217
|
+
* - `categories` - Filter by category names
|
|
218
|
+
* - `locale` - Get changelogs in a specific locale (defaults to org default)
|
|
219
|
+
* - `state` - Filter by state: `live`, `draft`, or `all`
|
|
220
|
+
* - `startDate` - Include changelogs dated on or after this date
|
|
221
|
+
* - `endDate` - Include changelogs dated on or before this date
|
|
222
|
+
*
|
|
223
|
+
* ### Sorting
|
|
224
|
+
*
|
|
225
|
+
* Results are sorted by date (descending by default):
|
|
226
|
+
*
|
|
227
|
+
* - `sortBy` - Field to sort by (currently only `date`)
|
|
228
|
+
* - `sortOrder` - Sort direction: `asc` or `desc` (default: `desc`)
|
|
229
|
+
*
|
|
230
|
+
* @example
|
|
231
|
+
* ```ts
|
|
232
|
+
* // Automatically fetches more pages as needed.
|
|
233
|
+
* for await (const changelog of client.changelogs.list()) {
|
|
234
|
+
* // ...
|
|
235
|
+
* }
|
|
236
|
+
* ```
|
|
237
|
+
*/
|
|
238
|
+
list(params = {}, options) {
|
|
239
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
240
|
+
return this._client.getAPIList('/v2/changelogs', (CursorPage), {
|
|
241
|
+
query,
|
|
242
|
+
...options,
|
|
243
|
+
headers: buildHeaders([
|
|
244
|
+
{
|
|
245
|
+
...(featurebaseVersion?.toString() != null ?
|
|
246
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
247
|
+
: undefined),
|
|
248
|
+
},
|
|
249
|
+
options?.headers,
|
|
250
|
+
]),
|
|
251
|
+
});
|
|
252
|
+
}
|
|
253
253
|
/**
|
|
254
254
|
* Deletes a changelog by its unique identifier.
|
|
255
255
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"changelogs.mjs","sourceRoot":"","sources":["../../src/resources/changelogs/changelogs.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,EAKL,WAAW,GACZ,0BAAsB;AAEvB,OAAO,EAAE,UAAU,EAAsC,kCAA8B;AACvF,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IAA3C;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0bzF,CAAC;IAxbC
|
|
1
|
+
{"version":3,"file":"changelogs.mjs","sourceRoot":"","sources":["../../src/resources/changelogs/changelogs.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,EAKL,WAAW,GACZ,0BAAsB;AAEvB,OAAO,EAAE,UAAU,EAAsC,kCAA8B;AACvF,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IAA3C;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0bzF,CAAC;IAxbC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,MAAM,CAAC,MAA6B,EAAE,OAAwB;QAC5D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE;YACzC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CACN,EAAU,EACV,SAAqD,EAAE,EACvD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,EAAE,EAAE,EAAE;YAClD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,MAAM,CAAC,EAAU,EAAE,MAA6B,EAAE,OAAwB;QACxE,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,kBAAkB,EAAE,EAAE,EAAE;YACpD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,IAAI,CACF,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,UAAqB,CAAA,EAAE;YACtE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,kBAAkB,EAAE,EAAE,EAAE;YACrD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACH,OAAO,CACL,EAAU,EACV,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,EAAE,UAAU,EAAE;YAC3D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,SAAS,CACP,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,EAAE,YAAY,EAAE;YAC7D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAywBD,UAAU,CAAC,WAAW,GAAG,WAAW,CAAC"}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { Changelogs, type Changelog, type PublishUnpublishSuccess, type ChangelogDeleteResponse, type
|
|
1
|
+
export { Changelogs, type Changelog, type PublishUnpublishSuccess, type ChangelogDeleteResponse, type ChangelogCreateParams, type ChangelogRetrieveParams, type ChangelogUpdateParams, type ChangelogListParams, type ChangelogDeleteParams, type ChangelogPublishParams, type ChangelogUnpublishParams, type ChangelogsCursorPage, } from "./changelogs.mjs";
|
|
2
2
|
export { Subscribers, type SubscriberAddResponse, type SubscriberRemoveResponse, type SubscriberAddParams, type SubscriberRemoveParams, } from "./subscribers.mjs";
|
|
3
3
|
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/changelogs/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,UAAU,EACV,KAAK,SAAS,EACd,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/changelogs/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,UAAU,EACV,KAAK,SAAS,EACd,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,GAC1B,yBAAqB;AACtB,OAAO,EACL,WAAW,EACX,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B,0BAAsB"}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { Changelogs, type Changelog, type PublishUnpublishSuccess, type ChangelogDeleteResponse, type
|
|
1
|
+
export { Changelogs, type Changelog, type PublishUnpublishSuccess, type ChangelogDeleteResponse, type ChangelogCreateParams, type ChangelogRetrieveParams, type ChangelogUpdateParams, type ChangelogListParams, type ChangelogDeleteParams, type ChangelogPublishParams, type ChangelogUnpublishParams, type ChangelogsCursorPage, } from "./changelogs.js";
|
|
2
2
|
export { Subscribers, type SubscriberAddResponse, type SubscriberRemoveResponse, type SubscriberAddParams, type SubscriberRemoveParams, } from "./subscribers.js";
|
|
3
3
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/changelogs/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,UAAU,EACV,KAAK,SAAS,EACd,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/changelogs/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,UAAU,EACV,KAAK,SAAS,EACd,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,GAC1B,wBAAqB;AACtB,OAAO,EACL,WAAW,EACX,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B,yBAAsB"}
|
|
@@ -121,12 +121,12 @@ export interface SubscriberAddParams {
|
|
|
121
121
|
* Body param: The locale for the subscribers. Defaults to organization default
|
|
122
122
|
* locale.
|
|
123
123
|
*/
|
|
124
|
-
locale?: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
124
|
+
locale?: 'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
125
125
|
/**
|
|
126
126
|
* Header param: API version for this request. Defaults to your organization's
|
|
127
127
|
* configured API version if not specified.
|
|
128
128
|
*/
|
|
129
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
129
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
130
130
|
}
|
|
131
131
|
export interface SubscriberRemoveParams {
|
|
132
132
|
/**
|
|
@@ -137,7 +137,7 @@ export interface SubscriberRemoveParams {
|
|
|
137
137
|
* Header param: API version for this request. Defaults to your organization's
|
|
138
138
|
* configured API version if not specified.
|
|
139
139
|
*/
|
|
140
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
140
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
141
141
|
}
|
|
142
142
|
export declare namespace Subscribers {
|
|
143
143
|
export { type SubscriberAddResponse as SubscriberAddResponse, type SubscriberRemoveResponse as SubscriberRemoveResponse, type SubscriberAddParams as SubscriberAddParams, type SubscriberRemoveParams as SubscriberRemoveParams, };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subscribers.d.mts","sourceRoot":"","sources":["../../src/resources/changelogs/subscribers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,GAAG,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAgB7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAevG;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,8BAA8B,CAAC;CACxC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,+BAA+B,CAAC;CACzC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EACH,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"subscribers.d.mts","sourceRoot":"","sources":["../../src/resources/changelogs/subscribers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,GAAG,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAgB7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAevG;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,8BAA8B,CAAC;CACxC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,+BAA+B,CAAC;CACzC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EACH,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -121,12 +121,12 @@ export interface SubscriberAddParams {
|
|
|
121
121
|
* Body param: The locale for the subscribers. Defaults to organization default
|
|
122
122
|
* locale.
|
|
123
123
|
*/
|
|
124
|
-
locale?: 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
124
|
+
locale?: 'ar' | 'am' | 'fa' | 'ht' | 'lo' | 'my' | 'pa' | 'ps' | 'so' | 'tl' | 'ur' | 'he' | 'ta' | 'te' | 'mr' | 'gu' | 'kn' | 'ml' | 'ha' | 'jv' | 'yo' | 'ig' | 'uz' | 'ne' | 'sd' | 'az' | 'si' | 'km' | 'kk' | 'bn' | 'bs' | 'pt-BR' | 'bg' | 'ca' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'et' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'lv' | 'lt' | 'ms' | 'mn' | 'nb' | 'pl' | 'pt' | 'ro' | 'ru' | 'sr' | 'zh-CN' | 'sk' | 'sl' | 'es' | 'sw' | 'sv' | 'th' | 'zh-TW' | 'tr' | 'uk' | 'vi';
|
|
125
125
|
/**
|
|
126
126
|
* Header param: API version for this request. Defaults to your organization's
|
|
127
127
|
* configured API version if not specified.
|
|
128
128
|
*/
|
|
129
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
129
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
130
130
|
}
|
|
131
131
|
export interface SubscriberRemoveParams {
|
|
132
132
|
/**
|
|
@@ -137,7 +137,7 @@ export interface SubscriberRemoveParams {
|
|
|
137
137
|
* Header param: API version for this request. Defaults to your organization's
|
|
138
138
|
* configured API version if not specified.
|
|
139
139
|
*/
|
|
140
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
140
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
141
141
|
}
|
|
142
142
|
export declare namespace Subscribers {
|
|
143
143
|
export { type SubscriberAddResponse as SubscriberAddResponse, type SubscriberRemoveResponse as SubscriberRemoveResponse, type SubscriberAddParams as SubscriberAddParams, type SubscriberRemoveParams as SubscriberRemoveParams, };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subscribers.d.ts","sourceRoot":"","sources":["../../src/resources/changelogs/subscribers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,GAAG,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAgB7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAevG;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,8BAA8B,CAAC;CACxC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,+BAA+B,CAAC;CACzC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EACH,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;;OAGG;IACH,qBAAqB,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"subscribers.d.ts","sourceRoot":"","sources":["../../src/resources/changelogs/subscribers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,GAAG,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAgB7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAevG;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,8BAA8B,CAAC;CACxC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,+BAA+B,CAAC;CACzC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EACH,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -5,6 +5,14 @@ import { RequestOptions } from "../internal/request-options.mjs";
|
|
|
5
5
|
* Conversation custom attribute definitions configured in your Featurebase organization. Use these definitions to map ID-keyed conversation custom attributes to human-readable names and value types.
|
|
6
6
|
*/
|
|
7
7
|
export declare class ConversationAttributes extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Retrieves a single conversation custom attribute definition by its stable ID.
|
|
10
|
+
*
|
|
11
|
+
* Use this when a conversation response contains a `customAttributes` key and you
|
|
12
|
+
* need the corresponding display name, identifier, data type, field subtype, or
|
|
13
|
+
* options.
|
|
14
|
+
*/
|
|
15
|
+
retrieve(id: string, params?: ConversationAttributeRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ConversationAttribute>;
|
|
8
16
|
/**
|
|
9
17
|
* Returns conversation custom attribute definitions configured in your
|
|
10
18
|
* organization.
|
|
@@ -17,14 +25,6 @@ export declare class ConversationAttributes extends APIResource {
|
|
|
17
25
|
* include archived definitions.
|
|
18
26
|
*/
|
|
19
27
|
list(params?: ConversationAttributeListParams | null | undefined, options?: RequestOptions): APIPromise<ConversationAttributeListResponse>;
|
|
20
|
-
/**
|
|
21
|
-
* Retrieves a single conversation custom attribute definition by its stable ID.
|
|
22
|
-
*
|
|
23
|
-
* Use this when a conversation response contains a `customAttributes` key and you
|
|
24
|
-
* need the corresponding display name, identifier, data type, field subtype, or
|
|
25
|
-
* options.
|
|
26
|
-
*/
|
|
27
|
-
retrieve(id: string, params?: ConversationAttributeRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ConversationAttribute>;
|
|
28
28
|
}
|
|
29
29
|
export interface ConversationAttribute {
|
|
30
30
|
/**
|
|
@@ -93,6 +93,13 @@ export interface ConversationAttributeListResponse {
|
|
|
93
93
|
*/
|
|
94
94
|
object: 'list';
|
|
95
95
|
}
|
|
96
|
+
export interface ConversationAttributeRetrieveParams {
|
|
97
|
+
/**
|
|
98
|
+
* API version for this request. Defaults to your organization's configured API
|
|
99
|
+
* version if not specified.
|
|
100
|
+
*/
|
|
101
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
102
|
+
}
|
|
96
103
|
export interface ConversationAttributeListParams {
|
|
97
104
|
/**
|
|
98
105
|
* Query param: Include archived conversation custom attributes in the response.
|
|
@@ -102,16 +109,9 @@ export interface ConversationAttributeListParams {
|
|
|
102
109
|
* Header param: API version for this request. Defaults to your organization's
|
|
103
110
|
* configured API version if not specified.
|
|
104
111
|
*/
|
|
105
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
106
|
-
}
|
|
107
|
-
export interface ConversationAttributeRetrieveParams {
|
|
108
|
-
/**
|
|
109
|
-
* API version for this request. Defaults to your organization's configured API
|
|
110
|
-
* version if not specified.
|
|
111
|
-
*/
|
|
112
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
112
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
113
113
|
}
|
|
114
114
|
export declare namespace ConversationAttributes {
|
|
115
|
-
export { type ConversationAttribute as ConversationAttribute, type ConversationAttributeOption as ConversationAttributeOption, type ConversationAttributeListResponse as ConversationAttributeListResponse, type
|
|
115
|
+
export { type ConversationAttribute as ConversationAttribute, type ConversationAttributeOption as ConversationAttributeOption, type ConversationAttributeListResponse as ConversationAttributeListResponse, type ConversationAttributeRetrieveParams as ConversationAttributeRetrieveParams, type ConversationAttributeListParams as ConversationAttributeListParams, };
|
|
116
116
|
}
|
|
117
117
|
//# sourceMappingURL=conversation-attributes.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conversation-attributes.d.mts","sourceRoot":"","sources":["../src/resources/conversation-attributes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IACrD
|
|
1
|
+
{"version":3,"file":"conversation-attributes.d.mts","sourceRoot":"","sources":["../src/resources/conversation-attributes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IACrD;;;;;;OAMG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mCAAmC,GAAG,IAAI,GAAG,SAAc,EACnE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAepC;;;;;;;;;;OAUG;IACH,IAAI,CACF,MAAM,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;CAejD;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IAExE;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,cAAc,GAAG,UAAU,GAAG,MAAM,CAAC;IAElF;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,wBAAwB,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEnC;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mCAAmC;IAClD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;IAE7C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
|
|
@@ -5,6 +5,14 @@ import { RequestOptions } from "../internal/request-options.js";
|
|
|
5
5
|
* Conversation custom attribute definitions configured in your Featurebase organization. Use these definitions to map ID-keyed conversation custom attributes to human-readable names and value types.
|
|
6
6
|
*/
|
|
7
7
|
export declare class ConversationAttributes extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Retrieves a single conversation custom attribute definition by its stable ID.
|
|
10
|
+
*
|
|
11
|
+
* Use this when a conversation response contains a `customAttributes` key and you
|
|
12
|
+
* need the corresponding display name, identifier, data type, field subtype, or
|
|
13
|
+
* options.
|
|
14
|
+
*/
|
|
15
|
+
retrieve(id: string, params?: ConversationAttributeRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ConversationAttribute>;
|
|
8
16
|
/**
|
|
9
17
|
* Returns conversation custom attribute definitions configured in your
|
|
10
18
|
* organization.
|
|
@@ -17,14 +25,6 @@ export declare class ConversationAttributes extends APIResource {
|
|
|
17
25
|
* include archived definitions.
|
|
18
26
|
*/
|
|
19
27
|
list(params?: ConversationAttributeListParams | null | undefined, options?: RequestOptions): APIPromise<ConversationAttributeListResponse>;
|
|
20
|
-
/**
|
|
21
|
-
* Retrieves a single conversation custom attribute definition by its stable ID.
|
|
22
|
-
*
|
|
23
|
-
* Use this when a conversation response contains a `customAttributes` key and you
|
|
24
|
-
* need the corresponding display name, identifier, data type, field subtype, or
|
|
25
|
-
* options.
|
|
26
|
-
*/
|
|
27
|
-
retrieve(id: string, params?: ConversationAttributeRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ConversationAttribute>;
|
|
28
28
|
}
|
|
29
29
|
export interface ConversationAttribute {
|
|
30
30
|
/**
|
|
@@ -93,6 +93,13 @@ export interface ConversationAttributeListResponse {
|
|
|
93
93
|
*/
|
|
94
94
|
object: 'list';
|
|
95
95
|
}
|
|
96
|
+
export interface ConversationAttributeRetrieveParams {
|
|
97
|
+
/**
|
|
98
|
+
* API version for this request. Defaults to your organization's configured API
|
|
99
|
+
* version if not specified.
|
|
100
|
+
*/
|
|
101
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
102
|
+
}
|
|
96
103
|
export interface ConversationAttributeListParams {
|
|
97
104
|
/**
|
|
98
105
|
* Query param: Include archived conversation custom attributes in the response.
|
|
@@ -102,16 +109,9 @@ export interface ConversationAttributeListParams {
|
|
|
102
109
|
* Header param: API version for this request. Defaults to your organization's
|
|
103
110
|
* configured API version if not specified.
|
|
104
111
|
*/
|
|
105
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
106
|
-
}
|
|
107
|
-
export interface ConversationAttributeRetrieveParams {
|
|
108
|
-
/**
|
|
109
|
-
* API version for this request. Defaults to your organization's configured API
|
|
110
|
-
* version if not specified.
|
|
111
|
-
*/
|
|
112
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
112
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
113
113
|
}
|
|
114
114
|
export declare namespace ConversationAttributes {
|
|
115
|
-
export { type ConversationAttribute as ConversationAttribute, type ConversationAttributeOption as ConversationAttributeOption, type ConversationAttributeListResponse as ConversationAttributeListResponse, type
|
|
115
|
+
export { type ConversationAttribute as ConversationAttribute, type ConversationAttributeOption as ConversationAttributeOption, type ConversationAttributeListResponse as ConversationAttributeListResponse, type ConversationAttributeRetrieveParams as ConversationAttributeRetrieveParams, type ConversationAttributeListParams as ConversationAttributeListParams, };
|
|
116
116
|
}
|
|
117
117
|
//# sourceMappingURL=conversation-attributes.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conversation-attributes.d.ts","sourceRoot":"","sources":["../src/resources/conversation-attributes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IACrD
|
|
1
|
+
{"version":3,"file":"conversation-attributes.d.ts","sourceRoot":"","sources":["../src/resources/conversation-attributes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IACrD;;;;;;OAMG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mCAAmC,GAAG,IAAI,GAAG,SAAc,EACnE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAepC;;;;;;;;;;OAUG;IACH,IAAI,CACF,MAAM,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;CAejD;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IAExE;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,cAAc,GAAG,UAAU,GAAG,MAAM,CAAC;IAElF;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,wBAAwB,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEnC;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mCAAmC;IAClD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;IAE7C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
|
|
@@ -10,20 +10,15 @@ const path_1 = require("../internal/utils/path.js");
|
|
|
10
10
|
*/
|
|
11
11
|
class ConversationAttributes extends resource_1.APIResource {
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
14
|
-
* organization.
|
|
15
|
-
*
|
|
16
|
-
* Conversation payloads expose `customAttributes` keyed by stable attribute IDs.
|
|
17
|
-
* Use this endpoint to map those IDs to display names, identifiers, data types,
|
|
18
|
-
* field subtypes, and select options.
|
|
13
|
+
* Retrieves a single conversation custom attribute definition by its stable ID.
|
|
19
14
|
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
15
|
+
* Use this when a conversation response contains a `customAttributes` key and you
|
|
16
|
+
* need the corresponding display name, identifier, data type, field subtype, or
|
|
17
|
+
* options.
|
|
22
18
|
*/
|
|
23
|
-
|
|
24
|
-
const { 'Featurebase-Version': featurebaseVersion
|
|
25
|
-
return this._client.get(
|
|
26
|
-
query,
|
|
19
|
+
retrieve(id, params = {}, options) {
|
|
20
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
21
|
+
return this._client.get((0, path_1.path) `/v2/conversation_attributes/${id}`, {
|
|
27
22
|
...options,
|
|
28
23
|
headers: (0, headers_1.buildHeaders)([
|
|
29
24
|
{
|
|
@@ -36,15 +31,20 @@ class ConversationAttributes extends resource_1.APIResource {
|
|
|
36
31
|
});
|
|
37
32
|
}
|
|
38
33
|
/**
|
|
39
|
-
*
|
|
34
|
+
* Returns conversation custom attribute definitions configured in your
|
|
35
|
+
* organization.
|
|
40
36
|
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
* options.
|
|
37
|
+
* Conversation payloads expose `customAttributes` keyed by stable attribute IDs.
|
|
38
|
+
* Use this endpoint to map those IDs to display names, identifiers, data types,
|
|
39
|
+
* field subtypes, and select options.
|
|
40
|
+
*
|
|
41
|
+
* By default, archived definitions are excluded. Set `includeArchived=true` to
|
|
42
|
+
* include archived definitions.
|
|
44
43
|
*/
|
|
45
|
-
|
|
46
|
-
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
47
|
-
return this._client.get(
|
|
44
|
+
list(params = {}, options) {
|
|
45
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
46
|
+
return this._client.get('/v2/conversation_attributes', {
|
|
47
|
+
query,
|
|
48
48
|
...options,
|
|
49
49
|
headers: (0, headers_1.buildHeaders)([
|
|
50
50
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conversation-attributes.js","sourceRoot":"","sources":["../src/resources/conversation-attributes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,sBAAuB,SAAQ,sBAAW;IACrD
|
|
1
|
+
{"version":3,"file":"conversation-attributes.js","sourceRoot":"","sources":["../src/resources/conversation-attributes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,sBAAuB,SAAQ,sBAAW;IACrD;;;;;;OAMG;IACH,QAAQ,CACN,EAAU,EACV,SAAiE,EAAE,EACnE,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,EAAE,EAAE;YAC/D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAA6D,EAAE,EAC/D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE;YACrD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAxDD,wDAwDC"}
|
|
@@ -7,20 +7,15 @@ import { path } from "../internal/utils/path.mjs";
|
|
|
7
7
|
*/
|
|
8
8
|
export class ConversationAttributes extends APIResource {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
11
|
-
* organization.
|
|
12
|
-
*
|
|
13
|
-
* Conversation payloads expose `customAttributes` keyed by stable attribute IDs.
|
|
14
|
-
* Use this endpoint to map those IDs to display names, identifiers, data types,
|
|
15
|
-
* field subtypes, and select options.
|
|
10
|
+
* Retrieves a single conversation custom attribute definition by its stable ID.
|
|
16
11
|
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
12
|
+
* Use this when a conversation response contains a `customAttributes` key and you
|
|
13
|
+
* need the corresponding display name, identifier, data type, field subtype, or
|
|
14
|
+
* options.
|
|
19
15
|
*/
|
|
20
|
-
|
|
21
|
-
const { 'Featurebase-Version': featurebaseVersion
|
|
22
|
-
return this._client.get(
|
|
23
|
-
query,
|
|
16
|
+
retrieve(id, params = {}, options) {
|
|
17
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
18
|
+
return this._client.get(path `/v2/conversation_attributes/${id}`, {
|
|
24
19
|
...options,
|
|
25
20
|
headers: buildHeaders([
|
|
26
21
|
{
|
|
@@ -33,15 +28,20 @@ export class ConversationAttributes extends APIResource {
|
|
|
33
28
|
});
|
|
34
29
|
}
|
|
35
30
|
/**
|
|
36
|
-
*
|
|
31
|
+
* Returns conversation custom attribute definitions configured in your
|
|
32
|
+
* organization.
|
|
37
33
|
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
* options.
|
|
34
|
+
* Conversation payloads expose `customAttributes` keyed by stable attribute IDs.
|
|
35
|
+
* Use this endpoint to map those IDs to display names, identifiers, data types,
|
|
36
|
+
* field subtypes, and select options.
|
|
37
|
+
*
|
|
38
|
+
* By default, archived definitions are excluded. Set `includeArchived=true` to
|
|
39
|
+
* include archived definitions.
|
|
41
40
|
*/
|
|
42
|
-
|
|
43
|
-
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
44
|
-
return this._client.get(
|
|
41
|
+
list(params = {}, options) {
|
|
42
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
43
|
+
return this._client.get('/v2/conversation_attributes', {
|
|
44
|
+
query,
|
|
45
45
|
...options,
|
|
46
46
|
headers: buildHeaders([
|
|
47
47
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conversation-attributes.mjs","sourceRoot":"","sources":["../src/resources/conversation-attributes.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,WAAW;IACrD
|
|
1
|
+
{"version":3,"file":"conversation-attributes.mjs","sourceRoot":"","sources":["../src/resources/conversation-attributes.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,WAAW;IACrD;;;;;;OAMG;IACH,QAAQ,CACN,EAAU,EACV,SAAiE,EAAE,EACnE,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,EAAE,EAAE,EAAE;YAC/D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAA6D,EAAE,EAC/D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE;YACrD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,kBAAkB,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,CAAC;wBAC1C,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE;wBAC3D,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
|