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
|
@@ -7,65 +7,6 @@ import { path } from "../../internal/utils/path.mjs";
|
|
|
7
7
|
* Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
|
|
8
8
|
*/
|
|
9
9
|
export class RedirectRules extends APIResource {
|
|
10
|
-
/**
|
|
11
|
-
* Returns a paginated list of redirect rules within your organization.
|
|
12
|
-
*
|
|
13
|
-
* Redirect rules map old Help Center URLs to new article or collection
|
|
14
|
-
* destinations, enabling seamless migration from legacy help center systems. Only
|
|
15
|
-
* Help Centers with a custom domain configured support redirect rules.
|
|
16
|
-
*
|
|
17
|
-
* ### Query Parameters
|
|
18
|
-
*
|
|
19
|
-
* - `limit` - Number of items to return (1-100, default 10)
|
|
20
|
-
* - `cursor` - Cursor for pagination
|
|
21
|
-
* - `helpCenterId` - Filter by help center ID
|
|
22
|
-
* - `locale` - Filter by locale code
|
|
23
|
-
* - `targetType` - Filter by target type ("article" or "collection")
|
|
24
|
-
*
|
|
25
|
-
* ### Response Format
|
|
26
|
-
*
|
|
27
|
-
* Returns a list object with:
|
|
28
|
-
*
|
|
29
|
-
* - `object` - Always "list"
|
|
30
|
-
* - `data` - Array of redirect rule objects
|
|
31
|
-
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
32
|
-
*
|
|
33
|
-
* ### Redirect Rule Object
|
|
34
|
-
*
|
|
35
|
-
* Each redirect rule includes:
|
|
36
|
-
*
|
|
37
|
-
* - `id` - Unique identifier (MongoDB ObjectId)
|
|
38
|
-
* - `helpCenterId` - Help center this rule belongs to
|
|
39
|
-
* - `locale` - Locale code used to resolve the target translation
|
|
40
|
-
* - `fromUrl` - Canonical source URL (query/hash stripped, hostname lowercased)
|
|
41
|
-
* - `targetType` - "article" or "collection"
|
|
42
|
-
* - `targetId` - ID of the target article or collection
|
|
43
|
-
* - `createdAt` - ISO 8601 timestamp when created
|
|
44
|
-
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
45
|
-
*
|
|
46
|
-
* @example
|
|
47
|
-
* ```ts
|
|
48
|
-
* // Automatically fetches more pages as needed.
|
|
49
|
-
* for await (const redirectRule of client.helpCenter.redirectRules.list()) {
|
|
50
|
-
* // ...
|
|
51
|
-
* }
|
|
52
|
-
* ```
|
|
53
|
-
*/
|
|
54
|
-
list(params = {}, options) {
|
|
55
|
-
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
56
|
-
return this._client.getAPIList('/v2/help_center/redirect_rules', (CursorPage), {
|
|
57
|
-
query,
|
|
58
|
-
...options,
|
|
59
|
-
headers: buildHeaders([
|
|
60
|
-
{
|
|
61
|
-
...(featurebaseVersion?.toString() != null ?
|
|
62
|
-
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
63
|
-
: undefined),
|
|
64
|
-
},
|
|
65
|
-
options?.headers,
|
|
66
|
-
]),
|
|
67
|
-
});
|
|
68
|
-
}
|
|
69
10
|
/**
|
|
70
11
|
* Creates a new redirect rule in your organization.
|
|
71
12
|
*
|
|
@@ -124,59 +65,6 @@ export class RedirectRules extends APIResource {
|
|
|
124
65
|
]),
|
|
125
66
|
});
|
|
126
67
|
}
|
|
127
|
-
/**
|
|
128
|
-
* Retrieves a specific redirect rule by its source URL.
|
|
129
|
-
*
|
|
130
|
-
* The `url` query parameter is normalized before matching: query parameters and
|
|
131
|
-
* hash fragments are stripped, the hostname is lowercased, and trailing slashes
|
|
132
|
-
* are removed. This is the same normalization applied when creating a redirect
|
|
133
|
-
* rule.
|
|
134
|
-
*
|
|
135
|
-
* ### Query Parameters
|
|
136
|
-
*
|
|
137
|
-
* - `url` (required) - Full absolute URL to look up (http or https)
|
|
138
|
-
*
|
|
139
|
-
* ### Response
|
|
140
|
-
*
|
|
141
|
-
* Returns a redirect rule object with:
|
|
142
|
-
*
|
|
143
|
-
* - `id` - Unique identifier (MongoDB ObjectId)
|
|
144
|
-
* - `helpCenterId` - Help center this rule belongs to
|
|
145
|
-
* - `locale` - Locale code
|
|
146
|
-
* - `fromUrl` - Canonical source URL being redirected from
|
|
147
|
-
* - `targetType` - "article" or "collection"
|
|
148
|
-
* - `targetId` - ID of the target article or collection
|
|
149
|
-
* - `createdAt` - ISO 8601 timestamp when created
|
|
150
|
-
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
151
|
-
*
|
|
152
|
-
* ### Errors
|
|
153
|
-
*
|
|
154
|
-
* - `400` - Invalid URL format
|
|
155
|
-
* - `404` - No redirect rule exists for the given URL
|
|
156
|
-
*
|
|
157
|
-
* @example
|
|
158
|
-
* ```ts
|
|
159
|
-
* const redirectRule =
|
|
160
|
-
* await client.helpCenter.redirectRules.retrieveByURL({
|
|
161
|
-
* url: 'https://help.example.com/en/old/getting-started',
|
|
162
|
-
* });
|
|
163
|
-
* ```
|
|
164
|
-
*/
|
|
165
|
-
retrieveByURL(params, options) {
|
|
166
|
-
const { 'Featurebase-Version': featurebaseVersion, ...query } = params;
|
|
167
|
-
return this._client.get('/v2/help_center/redirect_rules/by-url', {
|
|
168
|
-
query,
|
|
169
|
-
...options,
|
|
170
|
-
headers: buildHeaders([
|
|
171
|
-
{
|
|
172
|
-
...(featurebaseVersion?.toString() != null ?
|
|
173
|
-
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
174
|
-
: undefined),
|
|
175
|
-
},
|
|
176
|
-
options?.headers,
|
|
177
|
-
]),
|
|
178
|
-
});
|
|
179
|
-
}
|
|
180
68
|
/**
|
|
181
69
|
* Retrieves a specific redirect rule by its unique identifier.
|
|
182
70
|
*
|
|
@@ -274,6 +162,65 @@ export class RedirectRules extends APIResource {
|
|
|
274
162
|
]),
|
|
275
163
|
});
|
|
276
164
|
}
|
|
165
|
+
/**
|
|
166
|
+
* Returns a paginated list of redirect rules within your organization.
|
|
167
|
+
*
|
|
168
|
+
* Redirect rules map old Help Center URLs to new article or collection
|
|
169
|
+
* destinations, enabling seamless migration from legacy help center systems. Only
|
|
170
|
+
* Help Centers with a custom domain configured support redirect rules.
|
|
171
|
+
*
|
|
172
|
+
* ### Query Parameters
|
|
173
|
+
*
|
|
174
|
+
* - `limit` - Number of items to return (1-100, default 10)
|
|
175
|
+
* - `cursor` - Cursor for pagination
|
|
176
|
+
* - `helpCenterId` - Filter by help center ID
|
|
177
|
+
* - `locale` - Filter by locale code
|
|
178
|
+
* - `targetType` - Filter by target type ("article" or "collection")
|
|
179
|
+
*
|
|
180
|
+
* ### Response Format
|
|
181
|
+
*
|
|
182
|
+
* Returns a list object with:
|
|
183
|
+
*
|
|
184
|
+
* - `object` - Always "list"
|
|
185
|
+
* - `data` - Array of redirect rule objects
|
|
186
|
+
* - `nextCursor` - Cursor for next page (null if no more results)
|
|
187
|
+
*
|
|
188
|
+
* ### Redirect Rule Object
|
|
189
|
+
*
|
|
190
|
+
* Each redirect rule includes:
|
|
191
|
+
*
|
|
192
|
+
* - `id` - Unique identifier (MongoDB ObjectId)
|
|
193
|
+
* - `helpCenterId` - Help center this rule belongs to
|
|
194
|
+
* - `locale` - Locale code used to resolve the target translation
|
|
195
|
+
* - `fromUrl` - Canonical source URL (query/hash stripped, hostname lowercased)
|
|
196
|
+
* - `targetType` - "article" or "collection"
|
|
197
|
+
* - `targetId` - ID of the target article or collection
|
|
198
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
199
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
200
|
+
*
|
|
201
|
+
* @example
|
|
202
|
+
* ```ts
|
|
203
|
+
* // Automatically fetches more pages as needed.
|
|
204
|
+
* for await (const redirectRule of client.helpCenter.redirectRules.list()) {
|
|
205
|
+
* // ...
|
|
206
|
+
* }
|
|
207
|
+
* ```
|
|
208
|
+
*/
|
|
209
|
+
list(params = {}, options) {
|
|
210
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
211
|
+
return this._client.getAPIList('/v2/help_center/redirect_rules', (CursorPage), {
|
|
212
|
+
query,
|
|
213
|
+
...options,
|
|
214
|
+
headers: buildHeaders([
|
|
215
|
+
{
|
|
216
|
+
...(featurebaseVersion?.toString() != null ?
|
|
217
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
218
|
+
: undefined),
|
|
219
|
+
},
|
|
220
|
+
options?.headers,
|
|
221
|
+
]),
|
|
222
|
+
});
|
|
223
|
+
}
|
|
277
224
|
/**
|
|
278
225
|
* Deletes an existing redirect rule. The associated Redis cache entry is also
|
|
279
226
|
* invalidated.
|
|
@@ -316,5 +263,58 @@ export class RedirectRules extends APIResource {
|
|
|
316
263
|
]),
|
|
317
264
|
});
|
|
318
265
|
}
|
|
266
|
+
/**
|
|
267
|
+
* Retrieves a specific redirect rule by its source URL.
|
|
268
|
+
*
|
|
269
|
+
* The `url` query parameter is normalized before matching: query parameters and
|
|
270
|
+
* hash fragments are stripped, the hostname is lowercased, and trailing slashes
|
|
271
|
+
* are removed. This is the same normalization applied when creating a redirect
|
|
272
|
+
* rule.
|
|
273
|
+
*
|
|
274
|
+
* ### Query Parameters
|
|
275
|
+
*
|
|
276
|
+
* - `url` (required) - Full absolute URL to look up (http or https)
|
|
277
|
+
*
|
|
278
|
+
* ### Response
|
|
279
|
+
*
|
|
280
|
+
* Returns a redirect rule object with:
|
|
281
|
+
*
|
|
282
|
+
* - `id` - Unique identifier (MongoDB ObjectId)
|
|
283
|
+
* - `helpCenterId` - Help center this rule belongs to
|
|
284
|
+
* - `locale` - Locale code
|
|
285
|
+
* - `fromUrl` - Canonical source URL being redirected from
|
|
286
|
+
* - `targetType` - "article" or "collection"
|
|
287
|
+
* - `targetId` - ID of the target article or collection
|
|
288
|
+
* - `createdAt` - ISO 8601 timestamp when created
|
|
289
|
+
* - `updatedAt` - ISO 8601 timestamp when last updated
|
|
290
|
+
*
|
|
291
|
+
* ### Errors
|
|
292
|
+
*
|
|
293
|
+
* - `400` - Invalid URL format
|
|
294
|
+
* - `404` - No redirect rule exists for the given URL
|
|
295
|
+
*
|
|
296
|
+
* @example
|
|
297
|
+
* ```ts
|
|
298
|
+
* const redirectRule =
|
|
299
|
+
* await client.helpCenter.redirectRules.retrieveByURL({
|
|
300
|
+
* url: 'https://help.example.com/en/old/getting-started',
|
|
301
|
+
* });
|
|
302
|
+
* ```
|
|
303
|
+
*/
|
|
304
|
+
retrieveByURL(params, options) {
|
|
305
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params;
|
|
306
|
+
return this._client.get('/v2/help_center/redirect_rules/by-url', {
|
|
307
|
+
query,
|
|
308
|
+
...options,
|
|
309
|
+
headers: buildHeaders([
|
|
310
|
+
{
|
|
311
|
+
...(featurebaseVersion?.toString() != null ?
|
|
312
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
313
|
+
: undefined),
|
|
314
|
+
},
|
|
315
|
+
options?.headers,
|
|
316
|
+
]),
|
|
317
|
+
});
|
|
318
|
+
}
|
|
319
319
|
}
|
|
320
320
|
//# sourceMappingURL=redirect-rules.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redirect-rules.mjs","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,UAAU,EAAsC,kCAA8B;AACvF,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C
|
|
1
|
+
{"version":3,"file":"redirect-rules.mjs","sourceRoot":"","sources":["../../src/resources/help-center/redirect-rules.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,UAAU,EAAsC,kCAA8B;AACvF,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,MAAM,CAAC,MAAgC,EAAE,OAAwB;QAC/D,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE;YACzD,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,SAAwD,EAAE,EAC1D,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kCAAkC,EAAE,EAAE,EAAE;YAClE,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,MAAM,CAAC,EAAU,EAAE,MAAgC,EAAE,OAAwB;QAC3E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,kCAAkC,EAAE,EAAE,EAAE;YACpE,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,IAAI,CACF,SAAoD,EAAE,EACtD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gCAAgC,EAAE,CAAA,UAAwB,CAAA,EAAE;YACzF,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;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CACJ,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,kCAAkC,EAAE,EAAE,EAAE;YACrE,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,aAAa,CAAC,MAAuC,EAAE,OAAwB;QAC7E,MAAM,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uCAAuC,EAAE;YAC/D,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"}
|
package/resources/index.d.mts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
export { AuditLogs, type AuditLogListResponse, type AuditLogListParams, type AuditLogListResponsesCursorPage, } from "./audit-logs.mjs";
|
|
2
|
-
export { Changelogs, type Changelog, type PublishUnpublishSuccess, type ChangelogDeleteResponse, type
|
|
3
|
-
export { ConversationAttributes, type ConversationAttribute, type ConversationAttributeOption, type ConversationAttributeListResponse, type
|
|
2
|
+
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/changelogs.mjs";
|
|
3
|
+
export { ConversationAttributes, type ConversationAttribute, type ConversationAttributeOption, type ConversationAttributeListResponse, type ConversationAttributeRetrieveParams, type ConversationAttributeListParams, } from "./conversation-attributes.mjs";
|
|
4
4
|
export { Feedback } from "./feedback/feedback.mjs";
|
|
5
5
|
export { HelpCenter } from "./help-center/help-center.mjs";
|
|
6
6
|
export { Organization } from "./organization/organization.mjs";
|
|
7
|
-
export { Reports, type ReportAttribute, type ReportAttributeOption, type ReportDataset, type ReportFilterExpression, type ReportFilterRule, type ReportGroupedDatum, type ReportMetric, type ReportSegmentDatum, type ReportTimeSeriesDatum, type ReportDrillInResponse, type ReportListDatasetsResponse, type ReportLookupFilterValuesResponse, type ReportQueryResponse, type
|
|
7
|
+
export { Reports, type ReportAttribute, type ReportAttributeOption, type ReportDataset, type ReportFilterExpression, type ReportFilterRule, type ReportGroupedDatum, type ReportMetric, type ReportSegmentDatum, type ReportTimeSeriesDatum, type ReportDrillInResponse, type ReportListDatasetsResponse, type ReportLookupFilterValuesResponse, type ReportQueryResponse, type ReportDrillInParams, type ReportListDatasetsParams, type ReportLookupFilterValuesParams, type ReportQueryParams, } from "./reports.mjs";
|
|
8
8
|
export { Support } from "./support/support.mjs";
|
|
9
|
-
export { Surveys, type Survey, type SurveyNextAction, type SurveyListResponsesResponse, type
|
|
9
|
+
export { Surveys, type Survey, type SurveyNextAction, type SurveyListResponsesResponse, type SurveyRetrieveParams, type SurveyListParams, type SurveyListResponsesParams, type SurveysCursorPage, type SurveyListResponsesResponsesCursorPage, } from "./surveys.mjs";
|
|
10
10
|
export { Users } from "./users/users.mjs";
|
|
11
|
-
export { Webhooks, type Webhook, type WebhookRequestConfigInput, type WebhookDeleteResponse, type
|
|
11
|
+
export { Webhooks, type Webhook, type WebhookRequestConfigInput, type WebhookDeleteResponse, type WebhookCreateParams, type WebhookRetrieveParams, type WebhookUpdateParams, type WebhookListParams, type WebhookDeleteParams, type WebhookRefreshSecretParams, type WebhooksCursorPage, } from "./webhooks.mjs";
|
|
12
12
|
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,SAAS,EACT,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,+BAA+B,GACrC,yBAAqB;AACtB,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/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,SAAS,EACT,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,+BAA+B,GACrC,yBAAqB;AACtB,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,oCAAgC;AACjC,OAAO,EACL,sBAAsB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,2BAA2B,EAChC,KAAK,iCAAiC,EACtC,KAAK,mCAAmC,EACxC,KAAK,+BAA+B,GACrC,sCAAkC;AACnC,OAAO,EAAE,QAAQ,EAAE,gCAA4B;AAC/C,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,YAAY,EAAE,wCAAoC;AAC3D,OAAO,EACL,OAAO,EACP,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,aAAa,EAClB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,0BAA0B,EAC/B,KAAK,gCAAgC,EACrC,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,8BAA8B,EACnC,KAAK,iBAAiB,GACvB,sBAAkB;AACnB,OAAO,EAAE,OAAO,EAAE,8BAA0B;AAC5C,OAAO,EACL,OAAO,EACP,KAAK,MAAM,EACX,KAAK,gBAAgB,EACrB,KAAK,2BAA2B,EAChC,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,KAAK,sCAAsC,GAC5C,sBAAkB;AACnB,OAAO,EAAE,KAAK,EAAE,0BAAsB;AACtC,OAAO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,yBAAyB,EAC9B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,EAC/B,KAAK,kBAAkB,GACxB,uBAAmB"}
|
package/resources/index.d.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
export { AuditLogs, type AuditLogListResponse, type AuditLogListParams, type AuditLogListResponsesCursorPage, } from "./audit-logs.js";
|
|
2
|
-
export { Changelogs, type Changelog, type PublishUnpublishSuccess, type ChangelogDeleteResponse, type
|
|
3
|
-
export { ConversationAttributes, type ConversationAttribute, type ConversationAttributeOption, type ConversationAttributeListResponse, type
|
|
2
|
+
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/changelogs.js";
|
|
3
|
+
export { ConversationAttributes, type ConversationAttribute, type ConversationAttributeOption, type ConversationAttributeListResponse, type ConversationAttributeRetrieveParams, type ConversationAttributeListParams, } from "./conversation-attributes.js";
|
|
4
4
|
export { Feedback } from "./feedback/feedback.js";
|
|
5
5
|
export { HelpCenter } from "./help-center/help-center.js";
|
|
6
6
|
export { Organization } from "./organization/organization.js";
|
|
7
|
-
export { Reports, type ReportAttribute, type ReportAttributeOption, type ReportDataset, type ReportFilterExpression, type ReportFilterRule, type ReportGroupedDatum, type ReportMetric, type ReportSegmentDatum, type ReportTimeSeriesDatum, type ReportDrillInResponse, type ReportListDatasetsResponse, type ReportLookupFilterValuesResponse, type ReportQueryResponse, type
|
|
7
|
+
export { Reports, type ReportAttribute, type ReportAttributeOption, type ReportDataset, type ReportFilterExpression, type ReportFilterRule, type ReportGroupedDatum, type ReportMetric, type ReportSegmentDatum, type ReportTimeSeriesDatum, type ReportDrillInResponse, type ReportListDatasetsResponse, type ReportLookupFilterValuesResponse, type ReportQueryResponse, type ReportDrillInParams, type ReportListDatasetsParams, type ReportLookupFilterValuesParams, type ReportQueryParams, } from "./reports.js";
|
|
8
8
|
export { Support } from "./support/support.js";
|
|
9
|
-
export { Surveys, type Survey, type SurveyNextAction, type SurveyListResponsesResponse, type
|
|
9
|
+
export { Surveys, type Survey, type SurveyNextAction, type SurveyListResponsesResponse, type SurveyRetrieveParams, type SurveyListParams, type SurveyListResponsesParams, type SurveysCursorPage, type SurveyListResponsesResponsesCursorPage, } from "./surveys.js";
|
|
10
10
|
export { Users } from "./users/users.js";
|
|
11
|
-
export { Webhooks, type Webhook, type WebhookRequestConfigInput, type WebhookDeleteResponse, type
|
|
11
|
+
export { Webhooks, type Webhook, type WebhookRequestConfigInput, type WebhookDeleteResponse, type WebhookCreateParams, type WebhookRetrieveParams, type WebhookUpdateParams, type WebhookListParams, type WebhookDeleteParams, type WebhookRefreshSecretParams, type WebhooksCursorPage, } from "./webhooks.js";
|
|
12
12
|
//# sourceMappingURL=index.d.ts.map
|
package/resources/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,SAAS,EACT,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,+BAA+B,GACrC,wBAAqB;AACtB,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/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,SAAS,EACT,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,+BAA+B,GACrC,wBAAqB;AACtB,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,mCAAgC;AACjC,OAAO,EACL,sBAAsB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,2BAA2B,EAChC,KAAK,iCAAiC,EACtC,KAAK,mCAAmC,EACxC,KAAK,+BAA+B,GACrC,qCAAkC;AACnC,OAAO,EAAE,QAAQ,EAAE,+BAA4B;AAC/C,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,YAAY,EAAE,uCAAoC;AAC3D,OAAO,EACL,OAAO,EACP,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,aAAa,EAClB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,0BAA0B,EAC/B,KAAK,gCAAgC,EACrC,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,8BAA8B,EACnC,KAAK,iBAAiB,GACvB,qBAAkB;AACnB,OAAO,EAAE,OAAO,EAAE,6BAA0B;AAC5C,OAAO,EACL,OAAO,EACP,KAAK,MAAM,EACX,KAAK,gBAAgB,EACrB,KAAK,2BAA2B,EAChC,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,KAAK,sCAAsC,GAC5C,qBAAkB;AACnB,OAAO,EAAE,KAAK,EAAE,yBAAsB;AACtC,OAAO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,yBAAyB,EAC9B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,EAC/B,KAAK,kBAAkB,GACxB,sBAAmB"}
|
|
@@ -5,6 +5,26 @@ import { RequestOptions } from "../../internal/request-options.mjs";
|
|
|
5
5
|
* Team members who manage your Featurebase organization. Admins have roles that define their permissions.
|
|
6
6
|
*/
|
|
7
7
|
export declare class Admins extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Retrieves a single admin by their unique identifier.
|
|
10
|
+
*
|
|
11
|
+
* Returns the admin object if found and they belong to your organization.
|
|
12
|
+
*
|
|
13
|
+
* ### Response
|
|
14
|
+
*
|
|
15
|
+
* Returns an admin object with:
|
|
16
|
+
*
|
|
17
|
+
* - `id` - Unique admin identifier
|
|
18
|
+
* - `name` - Admin's display name
|
|
19
|
+
* - `email` - Admin's email address
|
|
20
|
+
* - `picture` - Profile picture URL
|
|
21
|
+
* - `roleId` - ID of the role assigned to this admin
|
|
22
|
+
*
|
|
23
|
+
* ### Errors
|
|
24
|
+
*
|
|
25
|
+
* - `404` - Admin not found or doesn't belong to your organization
|
|
26
|
+
*/
|
|
27
|
+
retrieve(id: string, params?: AdminRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Admin>;
|
|
8
28
|
/**
|
|
9
29
|
* Returns all admins for your organization.
|
|
10
30
|
*
|
|
@@ -30,26 +50,6 @@ export declare class Admins extends APIResource {
|
|
|
30
50
|
* - `roleId` - ID of the role assigned to this admin
|
|
31
51
|
*/
|
|
32
52
|
list(params?: AdminListParams | null | undefined, options?: RequestOptions): APIPromise<AdminListResponse>;
|
|
33
|
-
/**
|
|
34
|
-
* Retrieves a single admin by their unique identifier.
|
|
35
|
-
*
|
|
36
|
-
* Returns the admin object if found and they belong to your organization.
|
|
37
|
-
*
|
|
38
|
-
* ### Response
|
|
39
|
-
*
|
|
40
|
-
* Returns an admin object with:
|
|
41
|
-
*
|
|
42
|
-
* - `id` - Unique admin identifier
|
|
43
|
-
* - `name` - Admin's display name
|
|
44
|
-
* - `email` - Admin's email address
|
|
45
|
-
* - `picture` - Profile picture URL
|
|
46
|
-
* - `roleId` - ID of the role assigned to this admin
|
|
47
|
-
*
|
|
48
|
-
* ### Errors
|
|
49
|
-
*
|
|
50
|
-
* - `404` - Admin not found or doesn't belong to your organization
|
|
51
|
-
*/
|
|
52
|
-
retrieve(id: string, params?: AdminRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Admin>;
|
|
53
53
|
/**
|
|
54
54
|
* Returns all available admin roles and their permissions.
|
|
55
55
|
*
|
|
@@ -420,28 +420,28 @@ export declare namespace AdminListRolesResponse {
|
|
|
420
420
|
}
|
|
421
421
|
}
|
|
422
422
|
}
|
|
423
|
-
export interface
|
|
423
|
+
export interface AdminRetrieveParams {
|
|
424
424
|
/**
|
|
425
425
|
* API version for this request. Defaults to your organization's configured API
|
|
426
426
|
* version if not specified.
|
|
427
427
|
*/
|
|
428
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
428
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
429
429
|
}
|
|
430
|
-
export interface
|
|
430
|
+
export interface AdminListParams {
|
|
431
431
|
/**
|
|
432
432
|
* API version for this request. Defaults to your organization's configured API
|
|
433
433
|
* version if not specified.
|
|
434
434
|
*/
|
|
435
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
435
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
436
436
|
}
|
|
437
437
|
export interface AdminListRolesParams {
|
|
438
438
|
/**
|
|
439
439
|
* API version for this request. Defaults to your organization's configured API
|
|
440
440
|
* version if not specified.
|
|
441
441
|
*/
|
|
442
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
442
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
443
443
|
}
|
|
444
444
|
export declare namespace Admins {
|
|
445
|
-
export { type Admin as Admin, type AdminListResponse as AdminListResponse, type AdminListRolesResponse as AdminListRolesResponse, type
|
|
445
|
+
export { type Admin as Admin, type AdminListResponse as AdminListResponse, type AdminListRolesResponse as AdminListRolesResponse, type AdminRetrieveParams as AdminRetrieveParams, type AdminListParams as AdminListParams, type AdminListRolesParams as AdminListRolesParams, };
|
|
446
446
|
}
|
|
447
447
|
//# sourceMappingURL=admins.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"admins.d.mts","sourceRoot":"","sources":["../../src/resources/organization/admins.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC
|
|
1
|
+
{"version":3,"file":"admins.d.mts","sourceRoot":"","sources":["../../src/resources/organization/admins.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAepB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAI,CACF,MAAM,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAehC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuEG;IACH,SAAS,CACP,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;CActC;AAED,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC;CAC3C;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,EAAE,YAAY,CAAC;QAErB;;WAEG;QACH,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC;KAC/B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;YAErB;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC;YAExB;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;YAElC;;eAEG;YACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;YAEnC;;eAEG;YACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;YAE/B;;eAEG;YACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;YAE/B;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;YAE9B;;eAEG;YACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;YAErC;;eAEG;YACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;YAE/B;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAEhC;;eAEG;YACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;YAE3B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAEhC;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;YAErB;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;YAE9B;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,YAAY,CAAC,EAAE,OAAO,CAAC;YAEvB;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,WAAW,CAAC,EAAE,OAAO,CAAC;YAEtB;;eAEG;YACH,WAAW,CAAC,EAAE,OAAO,CAAC;YAEtB;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;YAErB;;eAEG;YACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;YAE9B;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAEhC;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;YAEjC;;eAEG;YACH,YAAY,CAAC,EAAE,OAAO,CAAC;YAEvB;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC;YAExB;;eAEG;YACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;YAE3B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAEhC;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;YAEjC;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -5,6 +5,26 @@ import { RequestOptions } from "../../internal/request-options.js";
|
|
|
5
5
|
* Team members who manage your Featurebase organization. Admins have roles that define their permissions.
|
|
6
6
|
*/
|
|
7
7
|
export declare class Admins extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Retrieves a single admin by their unique identifier.
|
|
10
|
+
*
|
|
11
|
+
* Returns the admin object if found and they belong to your organization.
|
|
12
|
+
*
|
|
13
|
+
* ### Response
|
|
14
|
+
*
|
|
15
|
+
* Returns an admin object with:
|
|
16
|
+
*
|
|
17
|
+
* - `id` - Unique admin identifier
|
|
18
|
+
* - `name` - Admin's display name
|
|
19
|
+
* - `email` - Admin's email address
|
|
20
|
+
* - `picture` - Profile picture URL
|
|
21
|
+
* - `roleId` - ID of the role assigned to this admin
|
|
22
|
+
*
|
|
23
|
+
* ### Errors
|
|
24
|
+
*
|
|
25
|
+
* - `404` - Admin not found or doesn't belong to your organization
|
|
26
|
+
*/
|
|
27
|
+
retrieve(id: string, params?: AdminRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Admin>;
|
|
8
28
|
/**
|
|
9
29
|
* Returns all admins for your organization.
|
|
10
30
|
*
|
|
@@ -30,26 +50,6 @@ export declare class Admins extends APIResource {
|
|
|
30
50
|
* - `roleId` - ID of the role assigned to this admin
|
|
31
51
|
*/
|
|
32
52
|
list(params?: AdminListParams | null | undefined, options?: RequestOptions): APIPromise<AdminListResponse>;
|
|
33
|
-
/**
|
|
34
|
-
* Retrieves a single admin by their unique identifier.
|
|
35
|
-
*
|
|
36
|
-
* Returns the admin object if found and they belong to your organization.
|
|
37
|
-
*
|
|
38
|
-
* ### Response
|
|
39
|
-
*
|
|
40
|
-
* Returns an admin object with:
|
|
41
|
-
*
|
|
42
|
-
* - `id` - Unique admin identifier
|
|
43
|
-
* - `name` - Admin's display name
|
|
44
|
-
* - `email` - Admin's email address
|
|
45
|
-
* - `picture` - Profile picture URL
|
|
46
|
-
* - `roleId` - ID of the role assigned to this admin
|
|
47
|
-
*
|
|
48
|
-
* ### Errors
|
|
49
|
-
*
|
|
50
|
-
* - `404` - Admin not found or doesn't belong to your organization
|
|
51
|
-
*/
|
|
52
|
-
retrieve(id: string, params?: AdminRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Admin>;
|
|
53
53
|
/**
|
|
54
54
|
* Returns all available admin roles and their permissions.
|
|
55
55
|
*
|
|
@@ -420,28 +420,28 @@ export declare namespace AdminListRolesResponse {
|
|
|
420
420
|
}
|
|
421
421
|
}
|
|
422
422
|
}
|
|
423
|
-
export interface
|
|
423
|
+
export interface AdminRetrieveParams {
|
|
424
424
|
/**
|
|
425
425
|
* API version for this request. Defaults to your organization's configured API
|
|
426
426
|
* version if not specified.
|
|
427
427
|
*/
|
|
428
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
428
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
429
429
|
}
|
|
430
|
-
export interface
|
|
430
|
+
export interface AdminListParams {
|
|
431
431
|
/**
|
|
432
432
|
* API version for this request. Defaults to your organization's configured API
|
|
433
433
|
* version if not specified.
|
|
434
434
|
*/
|
|
435
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
435
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
436
436
|
}
|
|
437
437
|
export interface AdminListRolesParams {
|
|
438
438
|
/**
|
|
439
439
|
* API version for this request. Defaults to your organization's configured API
|
|
440
440
|
* version if not specified.
|
|
441
441
|
*/
|
|
442
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
442
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
443
443
|
}
|
|
444
444
|
export declare namespace Admins {
|
|
445
|
-
export { type Admin as Admin, type AdminListResponse as AdminListResponse, type AdminListRolesResponse as AdminListRolesResponse, type
|
|
445
|
+
export { type Admin as Admin, type AdminListResponse as AdminListResponse, type AdminListRolesResponse as AdminListRolesResponse, type AdminRetrieveParams as AdminRetrieveParams, type AdminListParams as AdminListParams, type AdminListRolesParams as AdminListRolesParams, };
|
|
446
446
|
}
|
|
447
447
|
//# sourceMappingURL=admins.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"admins.d.ts","sourceRoot":"","sources":["../../src/resources/organization/admins.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC
|
|
1
|
+
{"version":3,"file":"admins.d.ts","sourceRoot":"","sources":["../../src/resources/organization/admins.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAepB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAI,CACF,MAAM,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAehC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuEG;IACH,SAAS,CACP,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;CActC;AAED,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC;CAC3C;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,EAAE,YAAY,CAAC;QAErB;;WAEG;QACH,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC;KAC/B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;YAErB;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC;YAExB;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;YAElC;;eAEG;YACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;YAEnC;;eAEG;YACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;YAE/B;;eAEG;YACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;YAE/B;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;YAE9B;;eAEG;YACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;YAErC;;eAEG;YACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;YAE/B;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAEhC;;eAEG;YACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;YAE3B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAEhC;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;YAErB;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;YAE9B;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,YAAY,CAAC,EAAE,OAAO,CAAC;YAEvB;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;YAEzB;;eAEG;YACH,WAAW,CAAC,EAAE,OAAO,CAAC;YAEtB;;eAEG;YACH,WAAW,CAAC,EAAE,OAAO,CAAC;YAEtB;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;YAErB;;eAEG;YACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;YAE9B;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAEhC;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B;;eAEG;YACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;YAEjC;;eAEG;YACH,YAAY,CAAC,EAAE,OAAO,CAAC;YAEvB;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,eAAe,CAAC,EAAE,OAAO,CAAC;YAE1B;;eAEG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC;YAExB;;eAEG;YACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;YAE3B;;eAEG;YACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;YAEhC;;eAEG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;YAEjC;;eAEG;YACH,UAAU,CAAC,EAAE,OAAO,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|
|
@@ -10,32 +10,27 @@ const path_1 = require("../../internal/utils/path.js");
|
|
|
10
10
|
*/
|
|
11
11
|
class Admins extends resource_1.APIResource {
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* This endpoint returns all admins at once (typically a small list). No pagination
|
|
16
|
-
* is supported.
|
|
17
|
-
*
|
|
18
|
-
* ### Response Format
|
|
19
|
-
*
|
|
20
|
-
* Returns a list object with:
|
|
13
|
+
* Retrieves a single admin by their unique identifier.
|
|
21
14
|
*
|
|
22
|
-
*
|
|
23
|
-
* - `data` - Array of admin objects
|
|
24
|
-
* - `nextCursor` - Always null
|
|
15
|
+
* Returns the admin object if found and they belong to your organization.
|
|
25
16
|
*
|
|
26
|
-
* ###
|
|
17
|
+
* ### Response
|
|
27
18
|
*
|
|
28
|
-
*
|
|
19
|
+
* Returns an admin object with:
|
|
29
20
|
*
|
|
30
21
|
* - `id` - Unique admin identifier
|
|
31
22
|
* - `name` - Admin's display name
|
|
32
23
|
* - `email` - Admin's email address
|
|
33
24
|
* - `picture` - Profile picture URL
|
|
34
25
|
* - `roleId` - ID of the role assigned to this admin
|
|
26
|
+
*
|
|
27
|
+
* ### Errors
|
|
28
|
+
*
|
|
29
|
+
* - `404` - Admin not found or doesn't belong to your organization
|
|
35
30
|
*/
|
|
36
|
-
|
|
31
|
+
retrieve(id, params = {}, options) {
|
|
37
32
|
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
38
|
-
return this._client.get(
|
|
33
|
+
return this._client.get((0, path_1.path) `/v2/admins/${id}`, {
|
|
39
34
|
...options,
|
|
40
35
|
headers: (0, headers_1.buildHeaders)([
|
|
41
36
|
{
|
|
@@ -48,27 +43,32 @@ class Admins extends resource_1.APIResource {
|
|
|
48
43
|
});
|
|
49
44
|
}
|
|
50
45
|
/**
|
|
51
|
-
*
|
|
46
|
+
* Returns all admins for your organization.
|
|
52
47
|
*
|
|
53
|
-
*
|
|
48
|
+
* This endpoint returns all admins at once (typically a small list). No pagination
|
|
49
|
+
* is supported.
|
|
54
50
|
*
|
|
55
|
-
* ### Response
|
|
51
|
+
* ### Response Format
|
|
56
52
|
*
|
|
57
|
-
* Returns
|
|
53
|
+
* Returns a list object with:
|
|
54
|
+
*
|
|
55
|
+
* - `object` - Always "list"
|
|
56
|
+
* - `data` - Array of admin objects
|
|
57
|
+
* - `nextCursor` - Always null
|
|
58
|
+
*
|
|
59
|
+
* ### Admin Object
|
|
60
|
+
*
|
|
61
|
+
* Each admin includes:
|
|
58
62
|
*
|
|
59
63
|
* - `id` - Unique admin identifier
|
|
60
64
|
* - `name` - Admin's display name
|
|
61
65
|
* - `email` - Admin's email address
|
|
62
66
|
* - `picture` - Profile picture URL
|
|
63
67
|
* - `roleId` - ID of the role assigned to this admin
|
|
64
|
-
*
|
|
65
|
-
* ### Errors
|
|
66
|
-
*
|
|
67
|
-
* - `404` - Admin not found or doesn't belong to your organization
|
|
68
68
|
*/
|
|
69
|
-
|
|
69
|
+
list(params = {}, options) {
|
|
70
70
|
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
71
|
-
return this._client.get(
|
|
71
|
+
return this._client.get('/v2/admins', {
|
|
72
72
|
...options,
|
|
73
73
|
headers: (0, headers_1.buildHeaders)([
|
|
74
74
|
{
|